AppsStudioWorkflowsTasksReference

updateJobDescription

The updateJobDescription task lets you update the job’s description while the job is running. Job descriptions provide useful context for running, completed, and canceled jobs — for example, a customer name or job intent. Descriptions are visible in Active Jobs, Jobs (Operations Manager), and Active Tasks, where listed jobs can be filtered or sorted by their descriptions.

When jobs start, they receive an optional job description that can be edited when you manually start a job. You can also pass a description in the POST body of a REST API. However, some information isn’t available when the job begins — for example, a customer may need the job description to include service instance details learned during the job. Use updateJobDescription in those cases.

Properties

IncomingDescription
descriptionRequired. Select the appropriate reference task, then either select a reference variable or type a new description (for a static value).
updateJobDescription task configuration showing the description input field
OutgoingDescription
descriptionUse this immutable variable or create a job variable. Other tasks cannot directly access job descriptions, but the new description can be read from the updateJobDescription outgoing variable.