Execution context information
When executing client scripts, an actionInfo object is automatically provided. This object contains contextual information about the user’s action that triggered the script. It helps the script identify which dataset, field, or document was involved, along with the relevant values.
To capture and review this information, you can log the actionInfo variable to the console. Here's how you can do it:
console.log(actionInfo);
Executing this code snippet will output an object to the console, containing comprehensive information about the action that initiated the script's execution, thereby providing context about your script's operational environment.
{
"datasetId": "78721b91-67d0-482d-b2d3-66bad6267a6d",
"fieldId": "4f5b9301-c7e1-4073-8d78-0d11d2f8f1e6",
"fieldName": "task",
"lineId": "1557d991-82ce-4992-be57-8e1d77afd4f6",
"lineName": "tasks",
"rowId": "0f5591f3-a8ef-4224-8e9b-c71920b7911a",
"path": "tasks.0f5591f3-a8ef-4224-8e9b-c71920b7911a.task",
"value": "65cf2974ef80941c64ccd8a2",
"documentId": "680ecc53cd72a11e544e451f"
}
| Property | Type | Description |
|---|---|---|
| datasetId | string |
Unique identifier of the dataset containing the field or line where the action occurred. |
| fieldId | string |
Unique identifier of the field that triggered the script. |
| fieldName | string |
Internal name of the field for reference or debugging. |
| lineId | string |
Unique identifier of the line where the field resides, if applicable. |
| lineName | string |
Internal name of the line group. |
| rowId | string |
Unique identifier of the specific row affected by the action. |
| path | string |
Full hierarchical path to the field within the document structure (e.g. tasks.0f5591f3-a8ef-4224-8e9b-c71920b7911a.task). |
| value | string |
The current value of the field that has triggered the script execution. |
| documentId | string |
Unique identifier of the document containing the modified field. |
Even though this information may not seem user-friendly, it can be used in the SDK available for Client scripts.