Scenarios

scenarios is a built in app for managing subscenarios with the scenarios app in {{product name}} , you can return scenario outputs, call a subscenario, and start a subscenario modules with the scenarios app, you can use the following modules to build your {{scenario plural lowercase}} all scenarios modules are free to use, as they do not consume credits docid\ hh nrtakeqakbmg63uuin subscenarios call a subscenario calls a subscenario and allows you to send and receive data between scenarios you add this module to a parent or bridge scenario find out more about scenario types in subscenarios docid 9cmtjaptug8sqnm3uq ay all scenarios called by the call a subscenario module must be activated and scheduled on demand updates to scenario inputs and outputs in child scenarios are not automatically reflected in parent scenarios to sync changes, return to the parent scenario, open the call a subscenario module, and update the scenario input and/or output fields field description scenario select an existing subscenario or create a subscenario existing subscenario select a scenario in the dropdown it must be activated, scheduled to on demand , and with defined {{scenario singular lowercase}} inputs create a subscenario click the create scenario button in the dropdown to open a configuration dialog name name of the subscenario description description of the subscenario's purpose input structure input name(s) and characteristics (see scenarios docid\ f8fhrvoqwck48nx fjryf ) output structure output name(s) and characteristics label an optional display name for the input scenario inputs map the value of the input to pass into the called subscenario for example, from a preceding module's output bundle or a hard coded value (e g , a function) these fields are autogenerated after you define the {{scenario singular lowercase}} input names in the subscenario wait for subscenario output select y es or no select yes if the calling {{scenario singular lowercase}} needs to receive outputs from the called subscenario to continue its run with yes selected, the module waits for the subscenario to finish its run and return output for up to the maximum execution time allowed in the subscription select no if the calling scenario doesn't need outputs from the called subscenario to continue its run with no selected, the module calls the subscenario and continues its run start a subscenario starts a subscenario when called by the call a subscenario module you add this module at the start of the subscenario while the start a subscenario module is optional, it is recommended for a smoother user experience field description manage the data you receive using inputs click open scenario inputs to open scenario inputs and outputs in the scenario toolbar in scenario inputs , define the {{scenario singular lowercase}} inputs that you want to pass into this subscenario from the calling {{scenario singular lowercase}} name the name of the input description the description of the input type the data type default value the pre set value when an explicit value is not specified required whether the input is required multi line whether the input is displayed in a single line (no) or multiple lines (yes) outputs return output sends a subscenario's output back to a call a subscenario module or to an api client that calls the scenario endpoint you add this module to the end of a subscenario field description \[output name] map the value of the output to send back to the calling scenario this value can be from a preceding module's output bundle or a hard coded value (e g , function) these fields are autogenerated after you define scenario outputs in this module's scenario, in scenario inputs and outputs scenarios customize run name defines a custom {{scenario singular lowercase}} run name so you can easily identify and search for records add this module anywhere in your scenario to name runs conditionally based on data mapped from a preceding module you can add it multiple times in a scenario, such as at the end of each route, to name runs based on where data is processed you can find custom run names in the run name column of the scenario history docid 9z2xnh lyy62cfahjfhj5 the customize run name module furthest in the scenario route defines the name that appears in this table field description run name enter a custom run name you can map data from preceding modules to generate a unique value for each run for example new contact recipientname scenarios resources {{product name}} help center subscenarios docid 9cmtjaptug8sqnm3uq ay {{product name}} help center scenario inputs and outputs docid 7odicud0ke9 tr4xwuiqn