Outputs

You can provide information about the output of the sub-playbook to assist other designers when they use the sub-playbook in a playbook.

The information that you enter in the output fields displays in the sub-playbook's Start Point. More importantly, it displays in the details panel when a designer clicks the sub-playbook within a playbook.

If the sub-playbook does not provide an output, you do not need to complete the output fields.

If the sub-playbook provides an output, you can provide the following information about the expected output result of the sub-playbook in the Start Point. Complete only those fields that are appropriate to the sub-playbook.
  • Under Describe output, provide text in Output description that describes the output of the sub-playbook.
  • If the sub-playbook return JSON data, you can add an example of the expected JSON data in the Provide output example field.
  • Also if returning JSON, you can provide the schema for the data in Provide output schema. The schema defines the structure of the JSON data.