EMA C++ RDM Usage Guide : 3 Login Domain : 3.2 Usage : 3.2.2 Login Request Elements
 
3.2.2 Login Request Elements
You can use the Login Attrib elements to send additional authentication information and user preferences between components. The ReqMsg.Attrib is an ElementList. The predefined elements available on a Login Request are shown in the following table.
 
Table 6: Login Request Attrib Elements  
ELEMENT NAME
DATA TYPE ENUMERATION
RANGE/EXAMPLE
DESCRIPTION
AllowSuspectData
UInt
0 | 1
1: Indicates that the consumer application allows a OmmState.Suspect state. 1 is the default setting.
0: Indicates that the consumer application prefers any suspect data result in the stream being closed with an OmmState.ClosedRecover state.
For more information, refer to Section 3.4.5.
ApplicationAuthorizationToken
ASCII
Sequence of single byte characters from the base36 character set ([0-9][A-Z])
Indicates that application behaviors was inspected and approved by LSEG.
For more information on obtaining an application authorization token, contact your LSEG representative.
ApplicationId
ASCII
1 - 65535
e.g., 256
The Data Access Control System application ID. If the server authenticates with the Data Access Control System, the consumer application might need to pass in a valid ApplicationId. This must be unique for each application. IDs from 1 to 256 are reserved for permanent market data applications. These are assigned by LSEG and will be uniform across all client systems. IDs from 257 to 65535 are available for site-specific use.
ApplicationName
ASCII
Name of application e.g., Enterprise Message API
Identifies the application sending the Login request or response message. When present, the application name in the Login request identifies the consumer, and the application name in the Login response identifies the Open Message Model provider.
AuthenticationExtended
Buffer
Any binary buffer
This is a binary buffer whose content will be passed to the token authenticator as an additional means for verifying a user’s identity.
AuthenticationToken
ASCII
Any ASCII String, e.g., HOLDER
Conditional. AuthenticationToken is a client-generated token that identifies the user when operating in an environment that uses UserAuthn Authentication. On login reissue messages, this field contains a new token intended to replace the previous one about to expire.
If your LSEG Real-Time Distribution System has UserAuthn Authentication enabled, an AuthenticationToken is included in the message. For further details on UserAuthn Authentication, refer to the UserAuthn Authentication User Manual, accessible on MyAccount in the Data Access Control System product documentation set.
The default setting is: "" (an empty string).
DisableDataConversion
N/A
N/A
Reserved by LSEG.
DownloadConnectionConfig
UInt
0 | 1
Specifies whether to download the configuration:
1: Indicates the user wants to download connection configuration information.
0 (or if absent): Indicates that no connection configuration information is desired. 0 is the default setting.
InstanceId
ASCII
Any ASCII String, e.g., Instance1
InstanceId is used to differentiate applications that run on the same machine. However, because InstanceId is set by the user logging into the system, it does not guarantee uniqueness across different applications on the same machine.
Password
ASCII
my_password
Sets the password for logging into the system. This information may be required and encrypted in the future.
Position
ASCII
ip addr/hostnameip addr/net
e.g., 192.168.1.1/net
The Data Access Control System position. If the server is authenticating with the Data Access Control System, the consumer application might need to pass in a valid position.
ProvidePermissionExpressions
UInt
0 | 1
If specified on the Login Request, this indicates a consumer wants permission expression information to be sent with responses. Permission expressions allow for items to be proxy permissioned by a consumer via content-based entitlements.
ProvidePermissionExpressions defaults to 1.
ProvidePermissionProfile
UInt
0 | 1
When specified on a Login Request, indicates that a consumer desires the permission profile. An application can use the permission profile to perform proxy permissioning.
ProvidePermissionProfile defaults to 1.
Role
UInt
LOGIN_ROLE_CONS = 0,
LOGIN_ROLE_PROV = 1
Indicates the role of the application logging onto the system.
An Open Message Model consumer application should specify its role as LOGIN_ROLE_CONS.
An Open Message Model non-interactive provider application should specify its role as LOGIN_ROLE_PROV.
Enterprise Message API defaults the role element with a value of 1.
Open Message Model consumer applications typically connect to a different port number than non-interactive provider applications. Role information allows LSEG Real-Time Distribution System to detect and inform users of incorrect port use.
Role defaults to 0.
RoundTripLatency
UInt
2
Indicates whether the consumer supports Round Trip Time (RTT) latency monitoring. The presence of this element indicates that the consumer supports the RTT monitoring feature. Non-interactive providers do not use this element.
If the element is missing, the consumer does not support RTT Latency monitoring.
SingleOpen
UInt
0 | 1
1: Indicates the consumer application wants the provider to drive stream recovery.
0: Indicates that the consumer application will drive stream recovery.
For more information, refer to Section 3.4.5.
SingleOpen defaults to 1.
SupportProviderDictionaryDownload
UInt
0 | 1
Indicates whether the server supports the Provider Dictionary Download feature:
1: The server supports provider dictionary downloads.
0: The server does not support provider dictionary downloads.
If this element is missing, the server does not support provider dictionary downloads.
For more information on the provider dictionary download feature, refer to the Enterprise Message API C++ Edition Developers Guide.
SupportProviderDictionaryDownload defaults to 0.