Scenarios in Ardoq lets you select a subset of your components from across your workspaces, where you can make changes in isolation from the mainline. You can then compare, share and present the suggested changes - to your team, and to your stakeholders to get buy-in and alignment, and to find the best way forward.
Before creating a scenario, find the Ardoq components you want to make changes to, then create your scenario from the top of the navigator
You can either create a scenario from the components you have selected in the navigator, or from what you see in the view (not all views are supported yet)
- Give the scenario a name, and continue.
This will take a little while, and you'll be given the option to continue into scenario mode, with the components you have selected. All references between the components will be included.
In the scenario, all changes you do to components, references, and tags will not affect the mainline.
Manage what's in a Scenario
In your scenario, you'll see a sub-set of components from one or more workspaces. You will not see components that are not explicitly added to the scenario. This has the benefit that you have full control over what you're working with. The drawback is that you don't see related components that are outside your scenario. To get around this, there is a navigator section designated to show related components:
This navigator section has two purposes:
- To discover what your scenario is directly connected to, and how it's connected (shown in the Block Diagram). The section is also context-sensitive and reflects what you have selected in the main navigator. In the illustration above, when Ardoq is selected, only components outside the scope related to Ardoq are shown.
- To expand the scope of your scenario. The related components can be included in the scenario either via the three dots, and select "Include", or via the Block Diagram
The related components section is not a tool to manipulate the visualizations. It does not respect filters and cannot be included in presentations. The related components are read-only, and cannot be changed from a scenario.
What you see in the related section depends on your permissions in the workspaces outside the scenario.
If you highlight one or more related components, they will be rendered in the Block Diagram. You can then choose to add the component either from the Related component section or from the Block Diagram. When you have added something, there will be a short delay while the scenario reloads.
NB: Currently no other views support this kind of preview
NB: related components will not be part of slides in presentations. To include more components here, you have to add them to the scenario.
A prerequisite for the Related components section, and for the visual diff, is that the component types, reference types, and fields that exist on the mainline also exists in the scenario. If you make changes in the mainline, the related section will be unavailable.
To get back to a state where the metamodels are compatible, you'll need to use the Scenario Merge feature.
In the navigator you can see the components that are included in a scenario, as well as their parents, to provide necessary context. The contextual components are shown in a lighter color.
The contextual components can be included in the scenario with right-click and "Include component in Scenario". They will also be shown in the views where applicable, but the references going to and from them are not included. To include references, you'll have to include the contextual component explicitly.
If you have a scenario but want to explore different directions to take, you can make a copy of your scenario and make changes independently.
After the copy is made, there will be no relationship between the copy and the original.
Visually compare changes
When you have made some changes in a scenario, and you want to discuss the impact of the changes with your team and your stakeholders. For this, we have created the visual comparison functionality. It's currently only available in the Block Diagram and can be accessed either from the top of the navigator or from the top right section of the Block Diagram
This will enter a visual diff mode, where you can see changes introduced in the scenario.
The toggle button at the top enables you to switch between three different states.
- Changes seen from the scenario
- Changes seen from the mainline
- Diff with changes from both sides, with color-coding
Here's an example from the diff mode.
One component is removed (red), one is changed (blue) and one is added (green). Unchanged components are grey.
Here the example is seen from the scenario side, where the component that is removed is shown as an outline only
Seen from the mainline, the state of the mainline or AS-IS, is shown, with the new component in the scenario shown as an outline:
All components retain their positions, so it will be easier to compare.
The scenario permissions have the same levels as regular workspaces, with read, write and admin access, and apply to everything within the scenario. That means that everyone with access to the scenario will see the same thing.
This has two benefits in regards to governance:
- Safety for maintainers:
The asset owner can restrict access to the mainline to a few maintainers, and limit everyone else to have read access.
When someone else would like to make a change, this can be modeled in a scenario. The maintainers can then review and accept changes at their convenience.
- Safety for contributors:
Contributors can create a scenario from anything they have read access to, and make changes without being afraid of affecting anyone else. When the change suggestion is consistent, changes in the scenario can be reviewed and accepted into the mainline by someone with write access to the respective workspaces.
NB: There are some limitations as to what kind of changes you can do within a scenario. Currently, Scenarios only supports changes on components, references, and tags.
Scenarios in presentations
A presentation can contain slides from both the mainline and different scenarios at the same time. This will allow you to compare and communicate different options and alternatives in the same presentation.
It's also possible to add the visual diff mode of Block Diagram to a presentation. The selected viewpoint (mainline, diff, or your scenario) will be shown and can be toggled from within the presentation.