Difference between revisions of "Trigger a Workflow from a Custom Browser Script"

Revision as of 14:15, 16 August 2010

Workflows can be triggered based on a value in a custom field on the object using a browser script. The workflow id is passed to the system from the script.

Syntax

_triggerwf(objectid,workflowid,Entity ID);

The Entity ID should not be included for UTA Level 1 workflows

You must first create the workflow. Once it has been created you need to find the workflow ID (wfid) as follows:

• From the list view of Workflows right-click on the appropriate workflow and select Properties.
• The URL/Address displayed will have the wfid:

http://youraddress.smartsimple.com/WFE2/wf_viewworkflow.jsp?wfid=98765

For the above example the workflow ID is 98765

In the browser script you would use triggerwf with the following syntax:
Level 1: _triggerwf('@opportunityid@',workflowid);

Example:

_triggerwf('@opportunityid@',98765);

Level 2: _triggerwf('@eventid@',workflowid,26);

Example:

_triggerwf('@eventid@',98765,26);

(26 is the objecttype for Level 2 activities, and will be the same for all Level 2 workflows)

NOTE: For workflows triggered by a Browser Script within a UTA you should set Trigger When to --Deactivate-- rather than selecting a Status.

Examples

1) To create a button that triggers a workflow at Level 2:

Create a Read Only – System Variables Custom Field. In the Text/Link: section include the following:

<input type="button" class=Button value="Button Label" onClick="_triggerwf('@eventid@',workflowid,26);"/>

2) To trigger a workflow based on the value in a Custom Field at Level 1:

In order to trigger workflow #32123 when the Custom Field named My Field (Custom Field ID 123456) has the value This Value:

Create a Browser Script Custom Field:

function savefunc(frm){
if("@My Field@"!="This value" && frm.123456.value=="This value")
   {
   alert("The workflow will now be triggered");
   _triggerwf('@opportunityid@',32123);
   }
return true;
}

Notes:

• The function savefunc is run whenever a record is saved.
• The if statement will ensure that the workflow is only triggered when the My Field value is changed to This Value, not every time the page is saved with with This Value.

Notes

• You must not select Let current user select target user from this role for the Routing of workflows triggered by script, as they will not execute.
• Because the workflow is triggered when the script executes it happens before the record is saved. If the workflow tries to change the Status or a Custom Field value, when the record on the screen is actually saved it will overwrite any changes made by the workflow by those on the page that is being saved. Accordingly you should include any status or Custom Field changes within the JavaScript.

See Also

• Entity IDs