Store scenario metadata as objects

You can define and store metadata of a scenario in the Ontology, where each object represents a scenario, to create a persisted scenario.

When stored in the Ontology, scenarios are shareable and collaborative. Teams can compare multiple persisted scenarios side-by-side, attach rich metadata including descriptions and authorship, and link scenarios to related objects for easy organization. Persisted scenarios inherit Foundry's permissions and governance model, ensuring proper access control, and create a durable audit trail of the decision-making process.

Configure scenario object type

To configure the scenario object type in Ontology Manager, follow the steps below:

1. In Ontology Manager, navigate to the Object types tab and select + New object type.

2. Follow the configuration wizard. At step 3 (Properties), choose to Add an interface, then search for the Ontology Scenario interface. Ensure that Scenario Reference is mapped to the primary key of your object type, then complete the remaining steps.
   
   
   
   

3. Once the new object type is created, open the Properties tab and confirm that the Primary Key property has a value type of Scenario Reference assigned to it.

4. Optionally, add additional properties to store metadata about the scenario, such as Created By or Description. Save the configuration and wait for the initial sync to complete.

Configure create/save action

1. In Ontology Manager, locate your Scenario Object Type. If you did not configure a Create Object action during the initial setup, select + New in the Action types card to create one.

2. Within the Create Object action configuration, add an additional parameter of type String. In the Constraints card, set the value type to Scenario Reference Value. Then disable the Visibility toggle to hide the parameter from end users.
   
   
   
   

3. In the Rules tab of the Action configuration page, ensure the Unique ID property is mapped to the new Scenario Reference parameter.
   
   
   
   

Persist an existing temporary scenario

Before proceeding, ensure you have completed the temporary scenario configuration tutorial. Once your first temporary scenario is in place, follow these steps in Workshop:

1. Add a Button Group widget to your application to handle saving the scenario.

2. Set the button's action to the Create Object action configured on your Scenario Object Type.

3. In the Default Value configuration, set the Scenario Reference parameter to be populated by the Active Scenario variable generated by the Scenario Manager widget.
   
   
   
   

Create new scenario object

Make the following adjustments in Workshop to display persistent scenarios:

1. In the Create or Save Scenario action, the Scenario reference parameter does not require a default value; it will be auto-generated upon action execution.

2. Replace the Scenario Manager widget with an Object List widget (or any other object display widget) configured to list your persisted Scenario objects.

3. Set the Scenario Object Type as the data source for the newly added widget.
   
   
   
   

4. Replace the Active Scenario variable with an Object-backed scenario variable, and set its value to the Active Object from the Object List widget. You should update the variable selection in other widgets.