...
Text to enter:
| Code Block |
|---|
$plan. |
| Reference | Description | ||||
|---|---|---|---|---|---|
| name | Name of the plan that is run. | ||||
| duration | Length of time that the plan ran or has run so far
| ||||
| startTime | Timestamp for when the plan run began | ||||
| runId | Internal identifier for this run of the plan | ||||
| user | Internal identifier of the user who launched this run. | ||||
| taskCount | Count of tasks in the plan run. |
$http References
These references apply to HTTP tasks in the plan run.
Enter the following, after which you can see the two-letter codes for the HTTP tasks that have already executed in the current plan run:
| Code Block |
|---|
$http_ax. |
| Reference | Description |
|---|---|
| name | Name of the HTTP task |
| status | Current status of the task execution |
| duration | Length of time that the task ran or has run so far |
| startTime | Timestamp for when the task began. A null value if the task has not begun. |
| endTime | Timestamp for when the task ended. A null value if it has not ended yet. |
| statusCode | Status code (if any) returned from the receiving endpoint |
| response | Response information. See below. |
Response references
These references apply to the response returned as part of the task execution.
...
| Code Block |
|---|
$http_ax.response. |
| Reference | Description |
|---|---|
| body | Body of the response |
| json | JSON-formatted version of the response |
| headers | Headers returned with the response |
$slack References
You can reference metadata from Slack tasks in the current plan run using the following reference types:
...
Enter the following, after which you can see the two-letter codes for the HTTP tasks that have already executed in the current plan run:
| Code Block |
|---|
$flow_ax. |
| Reference | Description |
|---|---|
| name | Name of the flow task |
| status | Current status of the task execution |
| duration | Length of time that the task ran or has run so far |
| startTime | Timestamp for when the task began. A null value if the task has not begun. |
| endTime | Timestamp for when the task ended. A null value if it has not ended yet. |
| jobIds | Internal identifiers for the jobs that were run as part of this flow task |
| flowName | Name of the flow underlying this flow task |
| output | Metadata from the flow task's output. See below. |
| params | Parameters created in the flow can be referenced in the task. |
Output references
These references apply to the outputs that are generated in the flow tasks of the plan run.
...
| Code Block |
|---|
$flow_7p['My Output Name']. |
| Reference | Description | ||||
|---|---|---|---|---|---|
| name | Name of the flow | ||||
| status | Current status of the flow | ||||
| duration | Length of time that the flow execution ran or has run so far | ||||
| startTime | Timestamp for when the flow execution began. A null value if the run has not begun. | ||||
| endTime | Timestamp for when the flow execution ended. A null value if it has not ended yet. | ||||
| lastUpdate | Timestamp for when the flow was last modified | ||||
| jobId | Internal identifier for the job that was run or is running for the flow | ||||
| user | Internal identifier for the user who executed the job | ||||
| jobType | |||||
| fileSize | If the output generates a file or files, this value captures the size in KB of the output. | ||||
| environment | Running environment where the job was executed | ||||
| columnCount | Count of columns generated in the output | ||||
| rowCount | Count of rows generated in the output | ||||
| dataTypeCount | Count of
| ||||
| validValuesCount | Count of valid values in the output | ||||
| mismatchedValuesCount | Count of mismatched values in the output | ||||
| emptyValuesCount | Count of missing or empty values in the output | ||||
| columns | Column information from the selected output for the flow. | ||||
| sources | Source filename and table information from the imported datasets. |
Metadata Functions
The following functions can be applied to select metadata references to further filter the raw values.
humanizeDuration
In raw form, the duration metadata references return values that look like the following:
| Code Block |
|---|
PT7.523S |
You can apply the HumanizeDuration function to render the above into a more readable format:
| Code Block |
|---|
{{ $plan.duration | humanizeDuration }} |
The output of the above applied to the first value is the following:
| Code Block |
|---|
7.523 seconds |
uuid
You can generate a universally unique identifier, which can be delivered as part of a messaging payload:
| Code Block |
|---|
{{ uuid() }} |
Additional References
Plan metadata reference information leverages the Nunjucks templating language, which provides additional capabilities such as loops, conditions, filters, and helper functions.
...
