You use RemoteTurnkeyConnectGetSessionKey in OCL to establish a session with a remote Turnkey application when you need to work with that application's remote Turnkey operators.

What the operator does

RemoteTurnkeyConnectGetSessionKey connects to a remote Turnkey application and obtains a session key for that connection.

Provide these connection details:

Input	Purpose
Turnkey root URL	Identifies the root URL of the remote Turnkey application to connect to.
User	Identifies the user for the remote connection. The user is looked up in the remote application's SysUser collection.
Password	Supplies the password for that user. The password is checked against the remote application's SysUser collection.

Use it in a remote Turnkey workflow

Use this operator as the connection step before an operation that requires a remote Turnkey session.

1. Identify the root URL of the remote Turnkey application.
2. Supply a user name and password that correspond to an entry in the remote application's SysUser collection.
3. Call RemoteTurnkeyConnectGetSessionKey and retain the session key it obtains.
4. Use the same session when calling a remote operation, such as RemoteTurnkeyExecuteAction, RemoteTurnkeyGetStringValue, or RemoteTurnkeyGetByteArray.
5. When the remote work is complete, end the session with RemoteTurnkeyCloseSession.

For example, if a remote Turnkey application has a SysUser entry for a user named integrationuser, you connect by providing that application's root URL together with integrationuser and its corresponding password. The returned session key identifies that remote session for subsequent remote Turnkey calls.

Credential requirement

The supplied user and password are not arbitrary request values. They must be valid for the remote Turnkey application's SysUser collection. If the credentials do not correspond to a remote SysUser entry, the remote application cannot authenticate the connection.

Session lifecycle

Treat the session key as connection-specific state:

• Obtain it with RemoteTurnkeyConnectGetSessionKey.
• Use it only for the remote work that belongs to that connection.
• Close the session with RemoteTurnkeyCloseSession when finished.

Do not use RestGet as a replacement for this operator when you need a remote Turnkey session. RestGet sends an HTTP GET request; RemoteTurnkeyConnectGetSessionKey establishes a remote Turnkey connection using remote SysUser credentials.

See also

• Documentation:OCLOperators RemoteTurnkeyExecuteAction
• Documentation:OCLOperators RemoteTurnkeyGetStringValue
• Documentation:OCLOperators RemoteTurnkeyGetByteArray
• Documentation:OCLOperators RemoteTurnkeyCloseSession
• Documentation:OCLOperators RestGet