Connect
Use this command to sign on to the Data Server repository. This command is issued from within a Procedure document.
You can use this command with the user ID of an Administrator, or a regular user.
Syntax for Longview authentication
CONNECT User/Password Host Port LID Role [UserGroup] [LanguageCode]
where:
- User/Password is your user ID and password (separated by a forward slash). If the user name contains a space, it must be enclosed in double quotation marks ("").
- Host is the name of the host computer.
- Port is the port number used by the Listener (typically ending in 1).
- LIDis your Longview identifier.
- Role is the name of a symbol access role.
- UserGroup is a user group. This is a mandatory parameter if V3_COMPATIBLE_ACCESS is used for the Role parameter.
- LanguageCode is the optional language code.
Syntax example
CONNECT demov7/demov7 e3000 9701 Longview7 AnalystRole
Syntax for Windows authentication
CONNECT / Host Port LID Role [LanguageCode]
where:
- Host is the name of the host computer.
- Port is the port number used by the Listener (typically ending in 1).
- LID is your Longview identifier.
- Role is the name of a symbol access role.
- LanguageCode is the optional language code.
Syntax example
CONNECT / e3000 9701 Longview7 AnalystRole
Syntax for Single Sign-on
If your system is setup to use OAuth authentication, then you can use the following connect command to connect to AF using single sign-on:
CONNECT ClientId/Secret SSO Scope Host Port LID Role [UserGroup] [LangCode]
where:
- ClientID/Secret is the Client ID set in the OAuth flow of your IDP to create the Longview session with. The Client ID must exist in the Longview Database as a third-party user.
- Scope is the value configured in the IDP application, if the IDP application and Longview SSO Service has been configured to use a scope. If the application does not use scope then use "".
- Host is the name of the host computer.
- Port is the port number used by the Listener (typically ending in 1).
- LID is your Longview identifier.
- Role is the name of a symbol access role.
- UserGroup is a user group. This is a mandatory parameter if V3_COMPATIBLE_ACCESS is used for the Role parameter.
- LanguageCode is the optional language code.
Syntax example
CONNECT 0oagk9dfghK83OO405d7 SSO LVRestAPI e3000 9701 Longview7 Administrator
CONNECT 0oagk9dfghK83OO405d7 SSO "" e3000 9701 Longview7 Administrator
Syntax for ISW platform (AAD)
If your system is on ISW platform
You must have an Azure Active Directory setup to be able to use this connect syntax.
CONNECT ClientId/Secret AAD Tenant Environment ClientProxyURL LID Role [userGroup] [LangCode]
where:
- ClientID/Secret is the application registered in the Azure Active Directory server that is used to request an access token.
- Tenant is the name of the Azure Active Directory server that is used to populate the AAD URL to request access token.
- Environment is the target B2C platform name that is used to populate the scope of the access token.
- ClientProxyURL is the URL of the client proxy
- LID is your Longview identifier.
- Role is the name of a symbol access role.
- UserGroup is a user group. This is a mandatory parameter if V3_COMPATIBLE_ACCESS is used for the Role parameter.
- LanguageCode is the optional language code.
Syntax example
Syntax for ISW platform external authentication (OPENID)
If your system is on ISW platform and are using an external authenticated service account, then the following syntax must be used to be able to connect. The user must also be a service account with Connect to Application Framework authorization.
You must have an external authenticated service using OPENID setup to be able to use this connect syntax.
where:
- ClientID/Secret is the application registered in the Azure Active Directory server that is used to request an access token.
- Issuer is the external IDP issuer URI server that is used to request the access token.
- Environment is the target B2C platform name that is used to populate the scope of the access token.
- ClientProxyURL is the URL of the client proxy
- LID is your Longview identifier.
- Role is the name of a symbol access role.
- UserGroup is a user group. This is a mandatory parameter if V3_COMPATIBLE_ACCESS is used for the Role parameter.
- LanguageCode is the optional language code.
Syntax example