Difference between revisions of "Request Variables"
| Line 30: | Line 30: | ||
When working with variables it is important to understand what you can use, when and how. | When working with variables it is important to understand what you can use, when and how. | ||
| − | In many business process | + | In many business process node fields there will be the option to use variables, the nodes include: |
| + | * Human Tasks | ||
| + | * Custom Expressions following Decision nodes | ||
| + | * Integration Calls | ||
| + | * Automated Tasks | ||
| + | * Authorisations | ||
| + | The key consideration when looking to add variables into a field, or use a variable to make a decision in the process node, is do i have the variable information available to me, preceding the node i want to use it in? by this i mean have i used the '''Automated Task > Requests > Get Request Information''' nodes to load the required variables into my process, this could be: | ||
| + | * Request Details | ||
| + | * Customer Details | ||
| + | * Organisation Details | ||
| + | * Progressive Capture Answers | ||
| + | |||
| + | Or is the node preceded by a task off which i want to branch. | ||
| + | |||
| + | If you have included the relevant nodes before a node in which you want to use a variable then you can then either use the [[Variable Picker]] or in some cases manually add the variable in a field. | ||
==Manually Adding Variables== | ==Manually Adding Variables== | ||
| − | + | Hornbill have provided the [[Variable Picker]] to make the adding of variables easier, however if you wanted to manually add variables then the below will provide the format which can be used. | |
| − | |||
| − | + | * Request Details Variable: '''&[global["flowcode"]["summary"]]''' or '''&[global["flowcode"]["customFieldA"]]''' | |
| + | * | ||
| − | |||
Request variables are fairly self explanatory, and a list is provided below. Answer variables are specific to the '''Custom Form''' defined in the '''Get Request Information''' > '''Request Questions''' node specified before the task, authorisation or Update Request node, and can be included simply by referencing the number of the answers, as they are listed on the the custom form, so answer1, answer2, etc as needed. | Request variables are fairly self explanatory, and a list is provided below. Answer variables are specific to the '''Custom Form''' defined in the '''Get Request Information''' > '''Request Questions''' node specified before the task, authorisation or Update Request node, and can be included simply by referencing the number of the answers, as they are listed on the the custom form, so answer1, answer2, etc as needed. | ||
Revision as of 11:57, 5 January 2018
| Home > Administration > Service Manager > Business Processes > Request Variables | Index |
IntroductionAs a process designer it is beneficial to have access to and use variables in your process nodes for varying purposes, it could be to insert answers from progressive capture questions into the summary, description or custom fields of a request, to branch and make decisions in your process based on the site of the request customer, or the outcome to particular tasks. You may even want to add details into a task or authorisation details field which is made up of details from the parent request, progressive capture answers or related entities (Customer, Service, Organisation etc), or you may simple want to assign tasks and authorisations to variables such as a requestors owner. In all these examples and many more there is a need in the designer to be able to insert these variables into the relevant fields on the different business process forms |
Related Articles |
Using Variables
It is possible to both manually add variables to node fields and also use the Variable Picker to inject variable values into node fields. Please follow the link in the related articles section to learn more about using the variable picker.
When working with variables it is important to understand what you can use, when and how.
In many business process node fields there will be the option to use variables, the nodes include:
- Human Tasks
- Custom Expressions following Decision nodes
- Integration Calls
- Automated Tasks
- Authorisations
The key consideration when looking to add variables into a field, or use a variable to make a decision in the process node, is do i have the variable information available to me, preceding the node i want to use it in? by this i mean have i used the Automated Task > Requests > Get Request Information nodes to load the required variables into my process, this could be:
- Request Details
- Customer Details
- Organisation Details
- Progressive Capture Answers
Or is the node preceded by a task off which i want to branch.
If you have included the relevant nodes before a node in which you want to use a variable then you can then either use the Variable Picker or in some cases manually add the variable in a field.
Manually Adding Variables
Hornbill have provided the Variable Picker to make the adding of variables easier, however if you wanted to manually add variables then the below will provide the format which can be used.
- Request Details Variable: &[global["flowcode"]["summary"]] or &[global["flowcode"]["customFieldA"]]
Request variables are fairly self explanatory, and a list is provided below. Answer variables are specific to the Custom Form defined in the Get Request Information > Request Questions node specified before the task, authorisation or Update Request node, and can be included simply by referencing the number of the answers, as they are listed on the the custom form, so answer1, answer2, etc as needed.
List of Available Request Variables
- &[global["flowcode"]["assignedTeam"]]
- &[global["flowcode"]["authorisation"]]
- &[global["flowcode"]["closureCategory"]]
- &[global["flowcode"]["customer"]]
- &[global["flowcode"]["customerCompany"]]
- &[global["flowcode"]["customerManager"]]
- &[global["flowcode"]["customerPrimaryEmail"]]
- &[global["flowcode"]["customerPrimaryPhone"]]
- &[global["flowcode"]["customerSecondaryEmail"]]
- &[global["flowcode"]["customerSecondaryPhone"]]
- &[global["flowcode"]["dateLogged"]]
- &[global["flowcode"]["description"]]
- &[global["flowcode"]["impact"]]
- &[global["flowcode"]["loggingCategory"]]
- &[global["flowcode"]["owner"]]
- &[global["flowcode"]["ownerId"]]
- &[global["flowcode"]["priority"]]
- &[global["flowcode"]["requestId"]]
- &[global["flowcode"]["resolution"]]
- &[global["flowcode"]["service"]]
- &[global["flowcode"]["source"]]
- &[global["flowcode"]["site"]]
- &[global["flowcode"]["status"]]
- &[global["flowcode"]["summary"]]
- &[global["flowcode"]["timeLogged"]]
- &[global["flowcode"]["urgency"]]
- &[global["flowcode"]["withinFixTime"]]
- &[global["flowcode"]["withinResponseTime"]]
- Plus custom fields A through Q in the format : &[global["flowcode"]["customFieldA"]]