Edit the description field

The Description field lets you add and maintain a persistent description for roles, playbooks, and scripts. Use it to document purpose, usage context, or any other relevant metadata — particularly useful for knowledge transfer when onboarding users who need more context than a name alone provides.

Edit the description field

The following example uses a playbook to illustrate how to access the Description field.

Navigate to IAG

Navigate to Automation Gateway in your browser.

Select the playbook

Select the playbook from the left side navigation menu.

Open settings

Click the Gear icon in the upper-right corner of the canvas.

Add descriptive text

Add the descriptive text in the Description field. Click the Save button.

Modify the description

Click the Edit icon (pencil) under the Parameters heading to modify the descriptive text in the Description field.

Description field examples

The following code examples show the Description field for playbooks, roles, and scripts as a metadata key value.

Playbooks

This code sample shows the "description" field for playbooks.

1 {
2   "properties": {
3     "SPECIFY_PROP_NAME_HERE": {
4       "type": "string",
5       "description": "INSERT DESCRIPTION HERE"
6     }
7   },
8   "required": [],
9   "metadata": {
10     "description": ""
11   }
12 }

Roles

This code sample shows the "description" field for roles.

1 {
2   "properties": {},
3   "required": [],
4   "metadata": {
5     "description": ""
6   }
7 }

Scripts

This code sample shows the "description" field for scripts.

1 {
2   "properties": {
3     "argument_list": {
4       "type": "array",
5       "description": "Array of arguments to be passed to the script",
6       "items": {
7         "type": "string"
8       }
9     },
10     "env_vars": {
11       "type": "object",
12       "description": "Object containing environment variables to be passed to script",
13       "properties": {
14         "env_list": {
15           "type": "array",
16           "description": "Array of environment variable 'name=value' pairs for script",
17           "items": {
18             "type": "string"
19           }
20         }
21       }
22     }
23   },
24   "script_argument_order": [
25     "argument_list"
26   ],
27   "metadata": {
28     "description": ""
29   }
30 }