Difference between revisions of "System Values"
| Line 1: | Line 1: | ||
| + | ==System Values== | ||
| + | |||
A System Values databox can be one of a number of system values according to the system value selected on creation of the databox. For clarity, the databox name should reflect the selected type. | A System Values databox can be one of a number of system values according to the system value selected on creation of the databox. For clarity, the databox name should reflect the selected type. | ||
| Line 5: | Line 7: | ||
The value returned for each system value is described in the sections below. | The value returned for each system value is described in the sections below. | ||
| − | ==DataViewURL== | + | ===DataViewURL=== |
This returns the DataView URL for the current configuration and should only be used when DataView is installed (requires a separate licence). The URL returned will be formatted with the current users credentials each time the script is executed and the databox value is referenced. | This returns the DataView URL for the current configuration and should only be used when DataView is installed (requires a separate licence). The URL returned will be formatted with the current users credentials each time the script is executed and the databox value is referenced. | ||
This is typically used in message help button links with additional parameters to direct the advisor to specific additional data within DataView. | This is typically used in message help button links with additional parameters to direct the advisor to specific additional data within DataView. | ||
| − | ==Date== | + | ===Date=== |
This returns the current date and time. | This returns the current date and time. | ||
| − | ==CallRef== | + | ===CallRef=== |
This returns the Order Id reference where a service (SOR code) has been generated by the script. It can only be used as a task bookmark as the Order Id is not generated until after the system results script and only if any service has been generated by the script. | This returns the Order Id reference where a service (SOR code) has been generated by the script. It can only be used as a task bookmark as the Order Id is not generated until after the system results script and only if any service has been generated by the script. | ||
| − | ==Services== | + | ===Services=== |
This returns details of all services recorded in a script in an XML format as in the sample below. This is typically used in conjunction with a Transform expression to format the results into an html table for inclusion in an email. | This returns details of all services recorded in a script in an XML format as in the sample below. This is typically used in conjunction with a Transform expression to format the results into an html table for inclusion in an email. | ||
| Line 26: | Line 28: | ||
[[File:ServicesTransform.png]] | [[File:ServicesTransform.png]] | ||
| − | ==ScriptPath== | + | ===ScriptPath=== |
This returns an HTML formatted list of questions and responses. | This returns an HTML formatted list of questions and responses. | ||
| − | ==TaskCode== | + | ===TaskCode=== |
This should only be used in a task template and returns the task action code for the 'current' task being processed. This is typically used to place the task code on the template as a visible 'stamp' to identify the source of a letter or email after it has been sent. | This should only be used in a task template and returns the task action code for the 'current' task being processed. This is typically used to place the task code on the template as a visible 'stamp' to identify the source of a letter or email after it has been sent. | ||
| − | ==TaskId== | + | ===TaskId=== |
This returns the ContactView Task Id reference and is only relevant for installation with ContactView configured (requires a separate license). It can only be used as a template bookmark as the ContactView Task Id is not generated until after the system results script. | This returns the ContactView Task Id reference and is only relevant for installation with ContactView configured (requires a separate license). It can only be used as a template bookmark as the ContactView Task Id is not generated until after the system results script. | ||
| − | ==TotalCost== | + | ===TotalCost=== |
This returns the total cost based on the Services generated by a script. The total cost is based on the recorded services and quantities with a configurable fee plus VAT. This is formatted to 2 decimal places. | This returns the total cost based on the Services generated by a script. The total cost is based on the recorded services and quantities with a configurable fee plus VAT. This is formatted to 2 decimal places. | ||
Revision as of 16:03, 21 February 2018
Contents
System Values
A System Values databox can be one of a number of system values according to the system value selected on creation of the databox. For clarity, the databox name should reflect the selected type.
The value returned for each system value is described in the sections below.
DataViewURL
This returns the DataView URL for the current configuration and should only be used when DataView is installed (requires a separate licence). The URL returned will be formatted with the current users credentials each time the script is executed and the databox value is referenced.
This is typically used in message help button links with additional parameters to direct the advisor to specific additional data within DataView.
Date
This returns the current date and time.
CallRef
This returns the Order Id reference where a service (SOR code) has been generated by the script. It can only be used as a task bookmark as the Order Id is not generated until after the system results script and only if any service has been generated by the script.
Services
This returns details of all services recorded in a script in an XML format as in the sample below. This is typically used in conjunction with a Transform expression to format the results into an html table for inclusion in an email.
Specific elements and names may vary according to individual integration requirements. Other templates are available such as Services2SMV to include the Standard Minute Value. Please contact Omfax if you have any custom requests.
Transform Example:
ScriptPath
This returns an HTML formatted list of questions and responses.
TaskCode
This should only be used in a task template and returns the task action code for the 'current' task being processed. This is typically used to place the task code on the template as a visible 'stamp' to identify the source of a letter or email after it has been sent.
TaskId
This returns the ContactView Task Id reference and is only relevant for installation with ContactView configured (requires a separate license). It can only be used as a template bookmark as the ContactView Task Id is not generated until after the system results script.
TotalCost
This returns the total cost based on the Services generated by a script. The total cost is based on the recorded services and quantities with a configurable fee plus VAT. This is formatted to 2 decimal places.
