Outputs Tab
  • 26 Jul 2023
  • 2 Minutes to read
  • Dark
    Light

Outputs Tab

  • Dark
    Light

Article Summary

The Outputs tab is where you can determine and manage an App’s output variables (Figure 1).

 

Note
You can drag and drop this tab into a different area of the App Builder screen, if desired.

Creating Output Variables

To create a new output variable, click the + NEW OUTPUT button on the Outputs tab. The Create Output window will be displayed (Figure 2).

Graphical user interface, text, application, email  Description automatically generated

 

  • Name: Enter a name for the output variable.
  • Type: Select one or more variable types from the multi-select dropdown menu.
  • Encrypt: Select the checkbox to redact the output variable from the execution logs of a Playbook containing the App when the Playbook’s log level is set to DEBUG or TRACE.
    Note
    The App Developer is responsible for deciding whether to print the output variable in the execution logs for the Playbook containing the App.
  • Click the SAVE button to save the variable.

The variable will be displayed on the Outputs tab, along with letter representations of the data types it can be output as (Figure 3).

Graphical user interface, text, application  Description automatically generated

 

Hovering over one of the data types will display the Insert CodeIcon  Description automatically generatedicon for that data type. To insert the variable for that data type into the Code Editor, position the cursor in the desired location in the Code Editor and click Insert CodeIcon  Description automatically generated. For example, in Figure 4, the sample variable was inserted on line 24.

Important
The Insert Codefunctionality employs snippets to place output variables into the Code Editor. Because snippets are available only to Apps that use TcEx 4.0.x, the Insert Codeicon will not be displayed when you hover over an output variable when working with Apps that use a TcEx version older than 4.0.x. In this scenario, you must manually write the code that references the output variable in the Code Editor in order to use the variable in the App. To determine an App's TcEx version, refer to the App's requirements.txt file located in the Contents tab.
Note
You can use your browser’s “undo” function (e.g., Command-Z) to remove a variable that was erroneously inserted.

Graphical user interface, text, application  Description automatically generated

 

Managing Output Variables

Click the vertical ellipsisto the right of the variable name to access options for editing or deleting the variable.

Editing Output Variables

Select Edit to edit the variable. The Edit Output window will be displayed (Figure 5).

Graphical user interface, text, application, email  Description automatically generated

 

  • Make any desired changes to the variable.
  • Click the SAVE button.

Deleting Output Variables

Select Delete to delete the variable. The variable will be deleted immediately, with no window or message displayed to ask for confirmation first.

Note
If code for an output variable has been inserted into the Code Editor and then the variable is deleted, the inserted code will remain. It will not be automatically deleted with the variable.

ThreatConnect® is a registered trademark of ThreatConnect, Inc.

20084-11 v.07.B


Was this article helpful?

What's Next