RemoteTurnkeySetStringValue lets you write a string value to a specified column in a remote Turnkey application after you have opened a remote session.
Use this OCL operator when an application needs to pass text to a remote Turnkey ViewModel. A common use is to transfer tab-separated grid data as one string.
What it does
The operator sets one string value in the remote application. You supply the remote session, the target ViewModel class identifier, the target column name, and the value to write.
The operator takes these parameters:
| Parameter | Meaning | Example |
|---|---|---|
| Session | The session key returned when you connect to the remote Turnkey application. | The session returned by RemoteTurnkeyConnectGetSessionKey. |
| Remote-VMClassId | The identifier of the remote ViewModel class that contains the value to set. | The identifier for the remote grid or data-holding ViewModel class. |
| Remote-Column-name | The name of the column in the remote ViewModel class that receives the string. | ImportedRows
|
| value to set | The string to write to the remote column. | A tab-separated set of rows. |
Set a value in a remote Turnkey application
- Connect to the remote application with RemoteTurnkeyConnectGetSessionKey and retain the returned session key.
- Identify the remote VMClassId (ViewModel class identifier) and the column name that the remote application expects.
- Call RemoteTurnkeySetStringValue with the session key, VMClassId, column name, and string value.
- If the remote workflow requires an action after receiving the value, use RemoteTurnkeyExecuteAction.
- Close the remote session with RemoteTurnkeyCloseSession when the exchange is complete.
Transfer tab-separated grid data
You can use this operator to send a complete tab-separated data block produced by GetGridAsTabSepData. The remote column receives the entire block as one string; the receiving remote application is responsible for using that value.
For example, a grid export may contain:
Name Email
Ada ada@example.com
Ben ben@example.com
In this example, use the session key from the connection, the VMClassId for the remote receiver, the name of its import column, and the complete text above as the value. Do not send each cell as a separate value when the remote application expects the tab-separated grid payload.
Important considerations
- The session must belong to the remote application that owns the target ViewModel class and column.
- Use the remote VMClassId and column name expected by that application. A local ViewModel identifier or local column name is not a substitute.
- The value is a string. Use RemoteTurnkeyGetByteArray for the related byte-array retrieval operation, and RemoteTurnkeyGetStringValue when you need to read a string value from the remote application.
- Close sessions that are no longer needed with RemoteTurnkeyCloseSession.