System Variables
The Flow Service predefines read-only system variables that provide information about the system environment and execution environment.
Available System Variables
The table below shows the available system variables.
| System variable name | Description |
|---|---|
| Project and flow | |
| Project Owner | The user account of the project's creator. |
| Project Name | The project name. |
| Project Filename | The name of the .xfp file. |
| Project Folder | The project file's folder. |
| Flow Name | The flow name. |
| Installation Folder | The Flow Service installation folder. |
| Home Folder | The home folder of the user who created the project. |
| Execution | |
| Request ID | The request ID. |
| Session ID | The session ID. |
| User Name | The username of the execution user. |
| User Home Folder | The execution user's home folder. |
| Parent Project Name | If a subflow or an error processing flow references this system variable, the value will be the caller flow's project name. |
|
Parent Flow Name |
If a subflow or an error processing flow references this system variable, the value will be the caller flow's flow name. |
| Error processing (when an error processing flow references a system variable) | |
| Exception Component Name | The name of the component where the error happened. |
| Exception Message | The error message. |
| Exception Details | The error details, which include the following:
|
| Exception Error Code | The error code. |
| Exception Component Type | The type of the component where the error occurred. |
| Exception Parameter Value 1-5 | Parameter values of 1-5 parameters set by the component where the error occurred. |
| Exception Parameter Name 1-5 | Parameter names of 1-5 parameters set by the component where the error occurred. |
| Exception Function Name | The name of the mapper function where the error occurred. |
| HTTP requests | |
| HTTP Request URL | The execution URL of a flow triggered by HTTP. *The URL doesn't include the server name or the port number. |
| Client Hostname | The remote host that sent the HTTP request. |
| Client IP Address | The IP of the remote host that sent the HTTP request. |
| Server Name | The name of the HTTP server that received the HTTP request. |
| Port Number | The port of the HTTP server that received the HTTP request. |
| HTTP Method | The name of the HTTP method used in the request that triggered the flow. |
Referencing System Variables
You need to configure the flow to enable references to system variables:
- Open the flow in the workspace.
- Click the
button in the edit toolbar, next to the Save button. - Select the variables you want to reference.
- Double-click the mapper component to open the mapping window. Link the system variables from the input fields.
Note
- If you're referencing a system variable using a conditional expression or the Velocity component, you don't need to first enable the system variable in the configuration.