|
|
URL Popping - GET
Similarly to popping a Workflow via JavaScript, a Workflow can be invoked by navigating to a URL. Unlike popping via JavaScript, a URL pop will cause any current Activity to be immediately abandoned.
Data can be passed into the popped Workflow directly from parameters on the URL, but it is recommended to use an included record Reference to allow further data to be acquired from an external data source and mapped to Fields or Variables after popping the Workflow without having to pass it directly in the URL.
The minimal syntax for popping Agent Guidance via URL is:
AgentGuidanceWebsiteURL/executer/desktop/?function=start&diallerCampaign=CampaignName
The available parameters for this are:
|
Fragment
|
Description
|
Example
|
|
AgentGuidanceWebsiteURL/executer/
desktop/?function=start
|
Specifies the Agent Guidance website URL, and initiates the URL pop.
|
http://ag.example.com/executer/
desktop/?function=start
|
|
diallerCampaign=Identifier
|
The Identifier of the Campaign, Campaign Alias, or External Link to launch. This will be used to determine which Workflow is popped.
|
diallerCampaign=TestCampaign
|
|
diallerReference=Reference
|
(Optional) The Reference to be used for the record pop. If a record with this Reference does not exist, a new record will be created (as long as the Campaign permits this). If omitted or an empty string is passed, an automatically-generated Reference of the form CSAUTO-#-#-# will be used for the new record. This will be used as the value of [var_csReference] in the popped record.
|
diallerReference=4074
|
|
restartScript=Restart
|
(Optional) If set to true, the queued record will always start on the Start Page. If set to false and an existing Reference is provided, the queued record will pop on the Page reached in the previous record run. This is only typically set to false to carry on incomplete records, and the record must have been left without reaching the Last Page (for instance, via the Script.Finish() Helper Function) for this to work properly.
If omitted or an empty string is passed, the default behaviour of true is used.
|
restartScript=false
|
|
csUsername=Username
&csPassword=Password
|
(Optional) If the agent needs to be manually logged in, then their Agent Guidance username and password can be specified here.
These parameters are mutually exclusive with the sso parameter, and will fail if the Single Sign On Only setting is enabled.
|
csUsername=JoeBloggs
&csPassword=MyPassw0rd
|
|
sso=ConnectorName
|
(Optional) If using the Single Sign On integration, it is possible to provide the name of a configured and enabled Connector for the agent to be directed to on pop. The agent will either be directed to authenticate via the specified Identity Provider or automatically logged in, depending on whether they already have an authenticated token.
This parameter is mutually exclusive with the csUsername and csPassword parameters.
|
sso=Azure
|
|
ConnectorID=ConnectorID
&ConnectorType=ConnectorType
|
(Optional) Specifies the connector_id and connector_type that will be written to tbl_outbound_history for the record. These will be the values of [var_csConnectorID] and [var_csConnectorType] in the popped record.
|
ConnectorID=ExampleClient Unread
&ConnectorType=Connector-Email
|
|
var_variableName=value
|
(Optional) To directly populate the value of any Variable in the Workflow, it can simply be specified with its desired value in the URL.
|
var_CallerName=Joe Bloggs
|
|
popCount=DataItems
&popNameN=DataName
&popValueN=DataValue
|
(Optional) A list of key:value pairs of data can be passed through to the record, which will map the popValue of any popName that match the name of any Link Columns. The popCount needs to equal the number of data couplets being passed in, and each popName and popValue pair needs to have a unique, matching number between 1 and the number of pairs (inclusive) appended to them. This will also be available through the Script.Data layer.
|
popCount=2
&popName1=CustomerName
&popValue1=Joe Bloggs
&popName2=DaytimeNumber
&popValue2=01234 567890
|
Note: when including any parameters, you must include an & between any parameters.
Example for the SQL Plugin:
http://ag.testcompany.com/executer/desktop/?function=start&diallerCampaign=tbl_CustomerData&diallerReference=20&csUsername=JBloggs&csPassword=PassW0rd
This then pops our record, and populate all linked Fields with the values in their matched columns in tbl_CustomerData where the specified reference column = 20.
Example for Integration - Generic:
http://ag.testcompany.com/executer/desktop/?function=start&diallerCampaign=TestCampaign&var_CallerName=Joe Bloggs&popCount=1&popName1=DaytimeNumber&popValue1=01234 567890
This then pops our record, and populates the values "Joe Bloggs" into [var_CallerName] and "01234 567890" into any matching Link Column of the popped record.
The length of the URL that the browser can use is limited (approximately 2090 characters in Google Chrome). This may be further modified by IIS settings, but it is recommended that data be stored in an external data source which is then accessed via a provided record key where possible to avoid this limit.
All parameters used in this need to be URL compatible, or URL encoded. As such, it may be required that the passed data is decoded inside the Workflow for further usage.
Upon completing the record run, Agent Guidance will close the browser window if possible, or if not a page saying "Workflow Completed" will be shown with no further automatic action.
In earlier versios of Agent Guidance, the utilised endpoint for URL popping was /executer/script.aspx, however the current /executer/desktop/ endpoint should now be used in all cases.