Getting Started with Use Case Guides
What is a 'Use Case Guide'?
The Use Case Guides are Ardoq’s best practice approach on how to solve specific objectives or achieve a specific outcome. They help you realize value as fast as possible by providing a technique and pre-configured assets that can be populated with data to deliver business outcomes. Use Case Guides are for everyone looking for a fast and easy way to solve problems and generate insights quickly. For more information, please read What Are Ardoq’s Use Case Guides and Who Can Use Them
How to request a Use Case Guide
Your Ardoq admin can click on the Request Bundle toggle available in the Best Practice Module, which will notify the Ardoq support team to get everything set up.
When getting started with the Use Case guides there are a few considerations that need to be decided before loading the preconfigured use case assets into your production organization.
Sample data or no sample data
With every use case guide comes a bundle of preconfigured assets that can help you get started quickly. Each Use Case Bundle consists of the following pre-configured assets:
Metamodel (Component & Reference Types, Fields)
Import & Integration templates
Advanced & Gremlin Queries
Sample Data (optional)
Note: Access to pre-configured assets is included in all customer price plans with the exception of pre-configured viewpoints and scenarios, which require Discover and Scenario paid add-ons.
There are 2 versions of every use case guide bundle, one with sample data and one without. Having sample data is a great way to visualize the possibility of what can be done with the use case guides, but will misrepresent insights when operationalizing the assets. As it will skew presentations, surveys, visuals, dashboards, and reports with the sample data as well as with your real data.
Our recommendation is to load the preconfigured use case bundles into your organization with sample data to illustrate the various aspects of the use case guide content as well as Ardoq functionality, then remove the sample data when you are ready to get started with your data.
Loading the bundle into organizations without existing data
The easiest way to get started with the use cases guides is to start with them before loading any other data. Once your organization has been set up, you can ask your customer success manager to load in the use case bundles that are relevant to your objectives. Make sure to have them loaded without sample data so that it is easy to get your data into Ardoq using the preconfigured integration templates and workspaces.
Loading use case bundles into an organization with existing data
Preconfigured use case bundles are self-contained assets that will not impact any existing data that has been loaded into Ardoq. This means that use case bundles can be loaded into an organization at any time without impacting previous work. However, if the sample data has been loaded in then any collateral will visualize data that shares similar component modeling. For example, If you have an existing workspace with a component type called application and you load the application use case sample data then all assets that visualize application components will populate all applications from all workspaces that have that component type.
Below we have an example of 2 existing workspaces that existed within the organization before the bundle is loaded.
When loading the bundle with sample data it will load all the Use Case Assets as well as all the sample data workspaces.
You can see that the sample application workspace was with the Use Case Materials folder and did not overwrite or impact the existing Application workspace.
Removing All Use Case Assets from an Organization
Preconfigured use case bundles with or without sample data can easily be removed from an organization. This can be done by selecting the Use Case Materials folder and selecting the delete option.
This deletes all pre-configured assets that are in the asset manager (Workspaces, Presentations, Surveys, Metamodels, and folders). The collateral outside of the asset manager (broadcasts, queries, dashboards, perspectives) will need to be removed individually.
Removing Sample data from the preconfigured use case bundle
If you have loaded the preconfigured use case bundle and want to remove the sample data without removing the workspace and preconfigured assets you can do this by opening the respective workspace.
Open the Grid Editor and select “Show All Components”
Click the Name header to select all the components
Once all the components are selected you can right-click and select “remove rows”
This will remove all the components and references in the workspace while maintaining the integrity of the metamodel. If you want to remove sample data in other workspaces simply repeat these steps.
Note: If a bundle has to be reloaded with any changes, the Use Case Materials directory has to be deleted first in the Ardoq app by the user. Also, Do not rename the Use Case Materials directory.