Skip to main content

Custom scenario properties

Note

Only Enterprise customers have access to the Custom scenario properties feature.

To help organize and sort scenarios, you can use custom scenario properties to add customizable metadata to your scenarios. The properties you create appear on the scenario detail page and also in sortable columns in a table view of your scenarios. You can add as many custom properties as you like and edit which properties appear in your table view.

All organization members can view and use custom scenario properties. This includes using custom properties to filter the table view of scenarios.

For all properties, you can define the following:

  • Name - a descriptive name used like a unique identifier that only appears when you manage your custom properties

  • Label - the name visible on the table view and detail page

  • Hint text - a short message you add to help your organization members use your custom property

  • Field type - the kind of property, for example, dropdown or boolean

  • Required - select yes to make a property mandatory to include when applying custom properties to a scenario

Custom scenario properties support the following field types:

  • Short text - up to 200 characters; useful for email addresses, URLs

  • Long text - up to 1,000 characters; supports multiple lines

  • Number - supports integers

  • Boolean - a yes/no value that appears as radio buttons

  • Date - date and time according to ISO 8601

  • Dropdown - a list of items where users can select only one

  • Multichoice - a list of items where users can select multiple values

Create custom properties

Your organization dashboard has a Scenario properties tab where you can create and manage your custom properties.

Note

Only organization owners and admins can create and manage custom properties.

  1. In the left sidebar, click Organization.

  2. Click Scenario properties.

  3. Click Add property.

    CustomPropertiesCreate.png

  4. In the Add custom property dialog, enter and select your information. See descriptions above for details of each field. Click Save to create your custom property.

    customPropertyCreateDialog.png

Your custom property appears on the list on the Scenario properties tab.

Use custom scenario properties

All organization members can:

Apply and edit custom scenario properties

  1. In the left sidebar, click Scenarios.

  2. Click Screenshot_2023-08-01_at_4_45_18_PM.png next to the scenario whose custom properties you want to edit.

  3. Click Edit custom properties.

    editCSP.png

  4. In the dialog, edit your scenario properties.

    addCustomPropertiesModal.png

  5. Click Save.

The dialog closes and your properties appear on the scenario table view.

Tip

You can also apply and edit properties from the Scenario detail page.

addCustomProperties.png

Filter the Scenario list

  1. In the left sidebar, click Scenarios.

  2. Click the toggle to enter Table view.

    tableToggle.png

  3. Click editTable.png.

  4. In the dialog, select the properties you want to see in the table.

    tableDialog.png

  5. Click Apply.

  6. Use searchFilter.png next to the property you want to filter your scenarios by.

Only scenarios that match your filter criteria appear in the list.

Sort the scenario list

By default, scenarios are sorted by their names, with active scenarios at the top of the list. However, it is possible to change the sorting in both the List and Table views.

From the List:

  1. In the left sidebar, select Scenarios.

  2. Click the Sort by button.

  3. Choose a sorting option. You can sort scenarios by their name or creation date.

scenario_list_sorting.png

The scenarios will now be sorted based on the option you selected.

From the Table:

  1. In the left sidebar, click Scenarios.

  2. Click the toggle to enter Table view.

    tableToggle.png

  3. Click the title header of a column to sort the list by that property. Click again to see a descending sorted list.

The table appears with your scenarios sorted by the property you clicked.

Manage custom properties

You can edit or delete your custom scenario properties from the Scenario properties of your organization dashboard.

Edit custom properties

  1. In the left sidebar, click Organization.

  2. Click Scenario properties.

  3. Find the custom property you want to edit and click Edit.

  4. In the dialog, change the information as needed.

  5. Click Save.

A confirmation message appears at the bottom of the screen and your changes appear in the table.

Delete a custom property

  1. In the left sidebar, click Organization.

  2. Click Scenario properties.

  3. Find the custom property you want to delete and click Screenshot_2023-08-01_at_4_45_18_PM.png.

  4. Click Delete.

The property disappears from the table.

In this section: