Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0822

...

Text to enter:

Code Block
$plan.


ReferenceDescription
nameName of the plan that is run.
duration

Length of time that the plan ran or has run so far

Tip

Tip: To return a more readable form of this duration value, use the following reference:

Code Block
{{$plan.duration|humanizeDuration}}
startTimeTimestamp for when the plan run began
runIdInternal identifier for this run of the plan
userInternal identifier of the user who launched this run.
taskCountCount 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.


ReferenceDescription
nameName of the HTTP task
statusCurrent status of the task execution
durationLength of time that the task ran or has run so far
startTimeTimestamp for when the task began. A null value if the task has not begun.
endTimeTimestamp for when the task ended. A null value if it has not ended yet.
statusCodeStatus code (if any) returned from the receiving endpoint
responseResponse information. See below.

Response references

These references apply to the response returned as part of the task execution.

...

Code Block
$http_ax.response.


ReferenceDescription
bodyBody of the response
jsonJSON-formatted version of the response
headersHeaders returned with the response

$flow References

These references apply to flow 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
$flow_ax.


ReferenceDescription
nameName of the flow task
statusCurrent status of the task execution
durationLength of time that the task ran or has run so far
startTimeTimestamp for when the task began. A null value if the task has not begun.
endTimeTimestamp for when the task ended. A null value if it has not ended yet.
jobIdsInternal identifiers for the jobs that were run as part of this flow task
flowNameName of the flow underlying this flow task
outputMetadata from the flow task's output. See below.

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'].


ReferenceDescription
nameName of the flow
statusCurrent status of the flow
durationLength of time that the flow execution ran or has run so far
startTimeTimestamp for when the flow execution began. A null value if the run has not begun.
endTimeTimestamp for when the flow execution ended. A null value if it has not ended yet.
lastUpdateTimestamp for when the flow was last modified
jobIdInternal identifier for the job that was run or is running for the flow
userInternal identifier for the user who executed the job
jobType
fileSizeIf the output generates a file or files, this value captures the size in KB of the output.
environmentRunning environment where the job was executed
columnCountCount of columns generated in the output
rowCountCount of rows generated in the output
dataTypeCount

Count of

D s item
itemdata types
detected in the output

validValuesCountCount of valid values in the output
mismatchedValuesCountCount of mismatched values in the output
emptyValuesCountCount of missing or empty values in the output
columns

Column information from the selected output for the flow.

sourcesSource filename and table information from the imported datasets.

Additional References

Plan metadata reference information leverages the Nunjucks templating language, which provides additional capabilities such as loops, conditions, filters, and helper functions.

...