UI Action Quick Action

role administrator minimum version 2019 about the ui action quick action the ui action executes an action within a form you can switch to a designated child tab and open a blank form for a user to fill out there is no way to pass parameters with this action; instead, use the insert child object action see insert child object action docid\ zuvlmigpioyijhiome1hn there are several actions used with incidents to see these, open the incident workspace, go to the action menu and look under system remember all commands are case sensitive; mixed case does not work use the values defined below you must enter null in the parameter if a command is not used leaving it empty is not the equivalent and produces different results not all parameters are mandatory for each action see example using the ui action quick action to open another workspace (cad) docid\ lego9tu3pglse zqk5ms3 and example using the ui action quick action to open a workflow (cad) docid\ byhuh o1fqhh1hcocz 4d for examples on how to use this action the ui action is not designed for use with the web service methods docid\ qociljcfllhuopxuwihvd execute quick action function use it for ui navigation within only parameters parameter description enter action name a unique name for the action enter action description optional a description of what the action does enter category optional the category select from the drop down list scope the access point of the action for a list of what to enter here, see list of ui actions docid 1txfl5vsrr tlqhyjc35f command id the command id to run, such as newchildobject striphtml is not supported in ui action for a list of what to enter here, see list of ui actions docid 1txfl5vsrr tlqhyjc35f confirmation optional the confirmation message to show when the application displays the confirmation message, you can continue the action or cancel see about the confirmation message docid 1txfl5vsrr tlqhyjc35f for more details for a list of what to enter here, see list of ui actions docid 1txfl5vsrr tlqhyjc35f command data the data that the command is run against for a list of what to enter here, see list of ui actions docid 1txfl5vsrr tlqhyjc35f actions button action save commits your settings cancel exits without saving about the confirmation message the following is a template for the confirmation message { "title" "\<text>", "message" "\<message>", "timeout" "\<timeout>", "timeoutaction" "\<action>", "ok" "\<action>", "cancel" "\<action>" } parameter type required description title string required dialog box title string message string required message displayed in the dialog box timeout int optional dialog countdown in seconds countdown does not occur if not provided timeoutaction string optional action to be executed when the timeout has expired 'continue' equivalent to user clicking ok use all lower case 'cancel' cancels the operation; equivalent to user clicking cancel use all lower case ok string optional action for the ok button can be 'continue' or 'cancel' the ok button is not shown if the parameter is empty the default value is assumed if no value is given cancel string optional action for the cancel button can be 'continue' or 'cancel' the cancel button is not shown if the parameter is empty the default value is assumed if no value is given for example { "title" "request to logout", "message" "do you want to log out now?", "timeout" 30, "timeoutaction" "continue", "ok" "continue", "cancel" "cancel" } about using the ui action quick action as a composite action we strongly discourage you from using the ui action with the composite action action does not support this configuration as it produces inconsistent results when using the ui action within the composite action action, note the following the ui action relies on the ui commands in the browser, not the server side non ui actions rely on server side actions the ui action is built as asynchronous send the request and return immediately (without waiting) to the composite framework to continue other actions use the ui action within a composite action action at your own risk this procedure is not recommended as it could cause unexpected results limitations about using the ui action quick action canceling the ui action does not cancel the remaining actions defined in the composite action action create the ui action as the last action ( highly recommended ) use only one ui action in a composite action action multiple actions can produce unintended results list of ui actions all values are case sensitive be sure to use the values exactly as documented logging out of the application docid 1txfl5vsrr tlqhyjc35frefreshing the application docid 1txfl5vsrr tlqhyjc35frefreshing the current tab docid 1txfl5vsrr tlqhyjc35fopening a url in a pop up browser docid 1txfl5vsrr tlqhyjc35fopening a link stored in a business object docid 1txfl5vsrr tlqhyjc35fopening a new layout tab by business object type docid 1txfl5vsrr tlqhyjc35fopening a web page in a sub tab of the application docid 1txfl5vsrr tlqhyjc35fsearching for results by condition from the current context docid 1txfl5vsrr tlqhyjc35fopening the object referenced in a different field docid 1txfl5vsrr tlqhyjc35fprompting for the incident number, then open it docid 1txfl5vsrr tlqhyjc35fcreating a new task business object in a workspace docid 1txfl5vsrr tlqhyjc35fcreating a new incident in a tab docid 1txfl5vsrr tlqhyjc35fclosing the current tab docid 1txfl5vsrr tlqhyjc35fcreating a new child business object docid 1txfl5vsrr tlqhyjc35f logging out of the application this action brings up a confirmation box asking the user if they want to log out if the user does not respond, they are automatically logged out log out dialog box field value to enter scope application command id logout confirmation { "title" "logout in", "message" "do you want to log out?", "timeout" 10, "timeoutaction" "continue", "ok" "continue", "cancel" "cancel" } command data null refreshing the application this action refreshes the window and updates the application data equivalent to f5 or refresh in the browser field value to enter scope application command id reload confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data null refreshing the current tab this action refreshes the current record displayed in the active tab after a specified delay use this when you want users to see updates made by quick actions or workflows without manually clicking the refresh button in the workspace toolbar field value to enter scope currenttab command id refresh confirmation optional command data { "delayms" 3000, "message" "refreshing to show changes " } delayms time in milliseconds before refresh (e g , 3000 = 3 seconds) message optional text shown to the user before refreshing when the refresh occurs, the system displays an update processing icon in the upper right corner to indicate that updates are being applied opening a url in a pop up browser this action automatically opens a new window to the specified url invalid urls result in a 404 error (page not found) field value to enter scope application command id openwindow confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "url" " https //www ivanti com ", "target" " blank", "options" "width=400,height=500", "replace" "false" } opening a link stored in a business object this action opens a pop up window to the url specified in the subject field of a business object field value to enter scope application command id openwindow confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "url" "$(subject)", "target" " blank", "options" "width=400,height=500" } opening a new layout tab by business object type this action opens a new tab field value to enter scope workspaceselector command id openobjecttab confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data use one of the following { "objecttype" "change#" } or { "objecttype" "incident#", "forcereload" false, "newnavistate" true } opening a web page in a sub tab of the application this action opens the web page defined in the url parameter of the command data field the web page opes in a new tab within the application the value of the url parameter can be external, such as https //www ivanti com https //www ivanti com/ or can reference an internal web page see logging in or accessing records using urls docid\ aln4xcfydvoqvr jwgpm2 for information about internal urls field value to enter scope workspaceselector command id openlinktab confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "name" "ivanti com", "id" "ivanticom", "closable" true, "url" " https //www ivanti com " } or { "name" "appstore partner", "id" "heatsoftwarecom", "closable" true, "url" "/?frameless=true\&scope=selfservice\&commandid=newservicerequestbyofferingid\&tab=servicecatalog\&template=7eff29bc6fb446d395509df1a0a99eee" } searching for results by condition from the current context this action passes the priority from the current business object field value to enter scope objectworkspace command id search confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "objecttype" "incident#", "searchcriteria" \[ { "objectid" "incident#", "fieldname" "priority", "condition" "=", "fieldvalue" "$(priority)" } ], "fillsearchpanel" false } opening the object referenced in a different field this action opens the incident that is referenced in the subject field of the current business object field value to enter scope (uses previous value) command id (uses previous value) confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "objecttype" "incident#", "searchcriteria" \[ { "objectid" "incident#", "fieldname" "incidentnumber", "condition" "=", "fieldvalue" "$(subject)" } ], "fillsearchpanel" false } prompting for the incident number, then open it this action asks the user for an incident number, then opens the incident field value to enter scope (uses previous value) command id (uses previous value) confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "objecttype" "incident#", "searchcriteria" \[ { "objectid" "incident#", "fieldname" "incidentnumber", "condition" "=", "fieldvalue" "$(prompt(\\"please enter incident number\\",\\"\\"))" } ], "fillsearchpanel" false } creating a new task business object in a workspace this action creates a new task in a layout and links the current business object the value from the current business object can be passed in this way including linking the parent incident to the task this is equivalent to the insert child object action this option allows the application to move the data from the current context to the child record you must supply the relationship details as part of creating the new business object if they need to be linked field value to enter scope objectworkspace command id newobject confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "objecttype" "task#assignment", "fields" \[ { "name" "parentlink category", "value" "incident" }, { "name" "parentlink recid", "value" "$(recid)" }, { "name" "ownerteam", "value" "$(ownerteam)" }, { "name" "owner", "value" "$(owner)" }, { "name" "subject", "value" "$(subject)" } ] } creating a new incident in a tab this action opens a new layout with a new object as referenced in the command data objecttype field value to enter scope objectworkspace command id newobject confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "objecttype" "incident#" } closing the current tab this action closes the current tab field value to enter scope currenttab command id closetab confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data null creating a new child business object this action creates a new child record with the default assigned to the new business object typically, a relationship push constraint is used to move the data from the main business object to the child business object field value to enter scope currenttab\ objectworkspace\ objectview command id newchildobject confirmation optional if empty, the application used the default brackets and generates the default confirmation box command data { "objecttype" "incident#", "childobjecttype" "change#", "newobjecttype" "change#" } this action does not respect the auto save checkbox option in the action settings tab it does save changes directly to the database, but please ensure that the behaviour you expect still occurs reference graphical action designer ui action quick action docid\ b4m4bh7zrgioke9n2exij