CLIENT SYNTAXES

Target Version Syntax Description
21R2-EA panel Defines the tabs that should be displayed inside the panel section
25R2-EA resizablearrange Resizable arrange definition
25R2-EA arrangeid ID for resizable arrange
21R1-GA repeatingsection Not Defined
25R1-EA jsonviewer Static control for displaying any JSON data.
25R1-EA attribute Attribute used for providing and showing JSON content
25R1-EA function Function used for providing and showing JSON content
25R1-EA true false Parameter Attribute or Value to use.
25R1-EA jsonviewer Reference to the JSON Viewer Definition
21R1-GA htmltext bind Static html text for explanations on pages etc.
21R1-GA conditionalformat Formats rows and cells depending on conditions.
21R1-GA when Allows conditional formatting.
21R1-GA backgroundformat Specify background related properties. Alter the visual properties of the background of rows or cells.
24R1-GA copy Defines the condition for enabling/disabling of the Copy option
24R1-GA paste Defines the condition for enabling/disabling of the Paste option
23R2-EA digitalsignature for Sets up digital signature
23R2-EA hashcontent Used for hash content generation of the digital signature
23R2-EA signaturemappingattribute Maps the field name to the column name of a different entity in digital signature.
23R2-EA excludefromsignaturemapping When true, the field will be excluded from hash calculations used for digital signatures.
25R2-EA tooltipicons Controls whether icons are displayed in tooltip content.
22R2-EA savesearchenabled Specifies whether saved searches are enabled
23R1-EA This will help the clients to identify the field with HTML content and process it properly
21R2-EA homepage Defines the page or tree being a HomePage for its corresponding Entity
22R1-EA shape Decides the shape of the pin.
22R2-EA contactimage Add contact image to the control. This syntax will only add the contact image to the control. If you want to display additional contact information you can use the contact widget synatx.
22R1-EA stepvalidation Turns on/off validation of steps where there is no explicit 'enabled' property defined for next and finish commands.
25R1-EA aggregate Aggregation definition
25R1-EA summarize Summarizes the defined attribute
25R1-EA compute Computes a result using based on the expression where standard number operators can be combined with the defined alias names.
25R1-EA expression Expression.
25R1-EA + - / * Not Defined
23R2-EA summaryfilter Condition defining which rows to include into summary when summarizing columns.
23R2-EA pasteoption Defines the rule to apply for the field when copied row(s) are being pasted
21R2-EA autopin This flag, defined as a boolean, determines if the command should autopin records (default) or not.
22R2-EA categorylabel label for pin category
23R2-EA onlinefunction Not Defined
23R2-EA This evaluates as a boolean expression to determine if the client UI control is searchable online or not.
24R1-GA hideimage A boolean value to determine if the contact image should be hidden.
25R1-EA duration Display format of field values to be shown as duration (elapsed time).
25R1-EA formatmask Display format mask to use.
21R2-EA chartmode Chart mode should be enabled or not.
26R1-EA expandreferences When true, any references will expand directly when the main record becomes refreshed.
23R2-EA datacleanup Action when assistant is closed.
25R2-EA enabledetails A boolean value to enable or disable the details button explicitly.
23R1-EA urlparameter A url parameter is defined and used within the execution of an action. When defined, it will be used to fetch parameters on the url for the page and will be accessible in commands.
23R1-EA name Describes the real parameter exactly as it's defined in the url.
22R2-EA lengthmeasure Used to enable LiDAR button in a number field
22R2-EA unit Used to specify the unit for LiDAR image capture
22R2-EA mediaattribute Used to specify binary attribute name to store image data
22R2-EA displaytimezones Use this to display client UI control in a timezone different from the user's default timezone
24R1-EA displaytimezone Defined to make the control display the timestamp in a different timezone
24R1-EA additionaltimezones Defining for showing the timestamp using additional timezone(s), typically in a popup in the application
25R1-EA workingtimezone servertimezone Predefined constants specifying what timezone to use upon display.
24R1-EA showtimezonebadge A boolean value to determine if the time zone badge should be displayed.
21R1-EA radiuslimit Set the radius value to limit the pins shown on a map element
22R2-EA maxhits Set the max hits value to limit the pins shown on a map element within the radius limit
22R2-EA heatmap This evaluates heatmap functionality is available or not
21R2-EA pinstyle Not Defined
21R2-EA pinstyle Pin style definition
22R1-EA clustercommand cluster command for pin
21R2-EA mapzoomlevel Decides the initial zoom level of the map.
21R2-EA location Location details of a position
21R2-EA polyline Polyline definition
21R2-EA route Route definition
23R1-EA region Region definition
23R1-EA regionid Not Defined
23R2-EA routeid Not Defined
23R1-EA radius Not Defined
21R2-EA startlocation Location details of a position
21R2-EA endlocation Location details of a position
21R2-EA drag This block maps mandatory values that need to initiate the dragging record(s) from an element to another.
21R2-EA ganttchart Should be added inside drag block in order to enable dragging into ganttchart.
21R2-EA duration Duration of the particular task/job/work.
21R1-GA toolbar Override the standard toolbar and customize toolbar items.
21R1-GA currentdatafilter Display relevant toggle details in search pane when current data filter is applied.
21R2-EA draggable This evaluates as a boolean expression to enable drag rows from the list.
21R2-EA tile Not Defined
22R2-EA searchoperator Operator which combines the values of MultiLOV for generating the search filter.
23R1-EA This will help the native client to identify if an offline check is unnecessary
23R2-GA displayarea Describes where the command should be placed in the native client.
23R2-EA onlineflow When true, the check marks the signing flow as online flow. Default value is false.
22R1-EA logout Logs out from the application. Should be the last call in a command.
24R1-EA formsubmit Executes a Form Submit request
24R1-EA action Sets or retrieves the URL to which the form content is sent for processing.
24R1-EA input Variable included within the Form Submit request
24R1-EA inputs A stringified list of variables included within the Form Submit request
22R1-EA httprequest Executes a HTTP request
21R1-GA signdocument into Triggers signing process of a document
22R1-EA keyref Not Defined
22R1-EA luname Not Defined
23R1-EA headerlogo Not Defined
23R2-EA filenameprefix Specifies the prefix used for formatting the filename, always being suffixed with a GUID.
24R2-EA tab Will navigate to a new tab.
21R1-GA navigateswitch
21R1-GA when
25R2-EA linkmessage Message passed in url to active subscriptions listening for message
22R1-EA editconditionalformat Opens conditional format edit dialog
21R2-EA refresh using Not Defined
21R1-EA enablerevisions To control if the 'Revise Document' section is shown in document attachments or not
22R1-EA cardclick command cardclick command
24R2-EA date Can use this syntax to define the date property of timeline Control as field
26R1-EA attach Not Defined
26R1-EA luname Not Defined
26R1-EA keyref Not Defined
26R1-EA filter Not Defined
21R1-GA documenttype Type of the document associated with the signing process.
21R1-EA remoteassistance Declare that the page is enabled for Remote Assistance.
21R1-GA exportenabled Enable or disable export option in toolbar.
21R1-GA sortenabled Enable or disable sort option in toolbar.
21R1-GA filterenabled Enable or disable filter in toolbar.
21R1-GA viewsettingsenabled Enable or disable toggling views.
21R1-GA notificationsenabled Enable or disable notifications
21R1-GA columnsettingsenabled Enable or disable column settings.
22R2-EA parameter Not Defined
22R2-EA wfcall Executes a workflow action. The action must be defined in a wfaction before it can be used.
25R1-EA smarteditor A control which enables users to enhance and format the content using AI features.
25R2-EA smartinputs Definition of smart inputs.
25R2-EA smartinputs Not Defined
25R1-EA improve command Improve command for smart editor.
25R2-EA smart command Defines smart editor commands
25R2-EA aisettings Defines AI related settings or features
25R2-EA indicateai Indicate AI flag
25R2-EA disclaimer Defines AI disclaimer properties
26R1-EA copilotprompt Copilot Prompt Definition
26R1-EA description Copilot Prompt Description Property
26R1-EA prompttext Copilot Prompt Text Property
26R1-EA copilotprompt Not Defined
21R1-EA autoswitch Specifies whether Ganttchart timescale is configurable. If autoswitch is set to false Ganttchart timescale is configurable.
21R1-EA primary Specifies which needs to be the primary timescale of GanttChart.
21R1-EA secondary Specifies which needs to be the secondary timescale of GanttChart
26R1-EA setsearchcontext Set search context on another gantt component
26R1-EA mapping Mapping of selected row fields to search context fields
21R2-EA drop command Drop command for gantt
21R2-EA headersort Gantt header sort should be enabled or not.
21R2-EA verticalmoveitems Gantt vertical move items should be enabled or not.
25R2-EA ganttchartitembandstart Not Defined
25R2-EA ganttchartitembandbottom Not Defined
21R2-EA ganttchartitemcategory Enable Gantt Item header categories
21R2-EA ganttchartitemcategory Enable Gantt Item header categories
22R2-EA zoomcontext This will set the zoom level which the Gantt item is enabled
22R2-EA zoomlevels Zoom Levels
24R2-EA quickscrolltodate quickscrolltodate property of gantt chart to display/hide today and calendar buttons
21R1-EA toggle Specifies whether items can be toggled by clicking on it in Gantt legend
21R1-EA alignment Define alignment property for an icon
21R1-EA value Default snaptime for the Ganttchart
21R1-EA unit Defines the unit that the value corresponds to
21R1-EA colorpalette A custom color palette customized using a predefined color palette in the design system
21R1-EA columns Defines number of columns in the color palette
21R1-EA colorvalue Specifies a color value in a palette
21R1-EA colorpalette Refers a custom color palette or an existing color palette in the design system.
21R1-EA itemfocus Decides the initial alignment of gantt items in the Gantt area.
21R1-EA showdependencies Decides whether gantt chart dependencies are hidden or visible.
26R1-EA hidesecondarytimescale Decides whether gantt chart secondary timescale labels are hidden or visible.
22R1-EA kanbanboard Not Defined
22R1-EA kanbanboard Definition of a Kanban Board
22R1-EA kanbancolumn Attribute from database tab.
22R1-EA kanbancard Not Defined
22R1-EA kanbancard Not Defined
22R2-EA groupby Group the data in the swimlanes of the kanban control with a field in the datasource
22R2-EA groupheader Not Defined
24R2-EA groupingrow To indicate the row acts as a grouping header row
24R2-EA rowgroupings Define multiple row groupings for the gantt
25R1-EA xdviewer Definition of an XdViewer.
25R1-EA xdviewer Not Defined
25R1-EA uri Attribute that holds the uri
25R1-EA view Attribute that holds the view
25R1-EA object Attribute that holds the object
25R1-EA detailsview Definition of an DetailsView
25R2-EA unifieddatamodel Verifies Gantt chart compatibility with the performance-enhanced version.
25R2-EA nodeentity Defines the name used to represent a row element.
25R2-EA nodetype Specifies the type of element being defined.
25R2-EA nodeganttrow Defines the name used to represent a row element.
25R2-EA nodeganttitem Specifies the name assigned to an individual item element.
25R2-EA nodeitemmove Indicates whether the item element can be repositioned by the user through drag-and-drop.
25R2-EA nodeitemresize Indicates whether the item element’s duration can be changed by the user.
25R2-EA nodeparent Specifies the identifier of the parent element, establishing a hierarchical relationship between elements.
25R2-EA noderowid Defines a unique identifier for a row within the chart.
25R2-EA nodeitemid Defines a unique identifier for an individual item within the chart.
25R2-EA nodeitemstyle Determines the visual style to be applied to an item element.
25R2-EA nodeitemstart Represents the start date and time of an item.
25R2-EA nodeitemend Represents the end date and time of an item.
25R2-EA nodedependencyentity Represents the top hierarchical identifier associated with the chart component.
25R2-EA nodepredecessorrowid Specifies the row ID of the predecessor item in a dependency relationship, indicating where the dependent item starts from.
25R2-EA nodepredecessoritemid Identifies the unique ID of the predecessor item that must be completed or started before the successor item, as part of a dependency chain.
25R2-EA nodesuccessorrowid Specifies the row ID of the successor item in a dependency relationship, typically used to identify where the dependent item is placed.
25R2-EA nodesuccessoritemid Identifies the unique ID of the successor item that follows the predecessor in a dependency chain.
25R2-EA nodedependencytype Indicates the type of dependency relationship between items.
25R2-EA nodeganttdependency Defines a general-purpose name for an element.
25R2-EA unifieddatasource Specifies the data source that returns the primary data used to render the gantt chart
25R2-EA unifieddependencysource Specifies the name of the property that provides dependency relationships between items.
25R2-EA onrowexpand Not Defined
25R2-EA unifieddetailsource Specifies the data source that returns the data used to render the gantt card and tooltip data.
25R2-EA updatesource Specifies the data source that returns the data used to render the gantt exceptions
25R2-EA lazyitemupdate Not Defined
Target Version Syntax Description