Create a Project with OmniStudio Project Explorer
Learning Objectives
After completing this unit, you’ll be able to:
- Create a project using OmniStudio Project Explorer.
- Migrate the project from one Salesforce org to another using IDX Workbench.
Meet OmniStudio Project Explorer
OmniStudio Project Explorer is a Chrome browser extension you use to add components to a project so that you can migrate the components between orgs as a group using IDX Workbench. Project Explorer supports all the Salesforce Industries components and some Salesforce metadata.
You can include any combination of OmniStudio components in a project, such as a group of OmniScripts, FlexCards, Integration Procedures, or Data Mappers that comprise an application. OmniStudio Project Explorer makes it easy to ensure that all the necessary DataPacks are included in a project and migrated together.
OmniStudio Project Explorer is not yet available for orgs that use the OmniStudio Foundations package.
Get Started with OmniStudio Project Explorer
Download the OmniStudio Project Explorer extension from the Chrome Web Store. Once downloaded, you can see the OmniStudio Project Explorer tile in your list of extensions.
OmniStudio Project Explorer only appears in the Chrome browser tab for a Salesforce org. To use Project Explorer, you must log in to initialize its communication with your org.
To log in and connect Project Explorer:
- Go to the browser tab that has your Salesforce org open.
- Click the Extensions icon (1), and select the OmniStudio Project Explorer (2) tile. A vertical bar appears on the left edge of the browser window.
- Click Log in using OAuth (3). Login proceeds automatically.
- Once the login completes, click Reload/Refresh Data (4). OmniStudio Project Explorer loads your org’s object metadata alphabetically.
To configure Project objects in your org using OmniStudio Project Explorer, ensure your user profile is set with the Module record type enabled for the Project object.
Create a Project
When you see your org’s object metadata in the Project Explorer bar, you’re ready to create a project and add components to it. Creating a new project allows you to group all the related components of an application under one project header.
Use the Active Projects (1) bar in OmniStudio Project Explorer to create, edit, clone, search for, select, and delete projects.
To create a new project:
- Click the Project Configuration (2) menu, and select Create New Project (3). The New Project (4) dialog appears.
- Type a Name (5) and optionally, a Description (6).
- Save the project (7).
You can now search for and select your newly created project in OmniStudio Project Explorer. Click the Select a Project (1) field, and select your project (2).
Next, let’s add components to the project.
Use the Search bar (1) and the Filter section (2) to find components and add them to your project. Select the checkboxes (3) next to the components you want to add and click Add Selected Items to Project (4). All the selected components are added to your project. To remove a component, right-click the component name, and select Remove from <Your Project Name> (5).
To hide Project Explorer in your org, hover your mouse over the left edge of your screen until you see a black vertical bar. Click the black bar each time you want to hide or show Project Explorer.
Migrate a Project in IDX Workbench
After you create a project using OmniStudio Project Explorer, use IDX Workbench to migrate the project and all its components from one Salesforce org to another. Let’s see how to do this.
From your IDX Workbench application, open the Configure Workspace (1) dialog. From the Project (2) dropdown list, select Load Projects from Source (3). This fetches all the active project objects in the source org.
Once the project objects finish loading, you can see the new project you created in the Project dropdown list.
While migrating objects from the source org to the target org, you can either:
- Migrate only the project object, which automatically migrates all components in the project, or
- Migrate only select components in the project
Interesting, right? Well, it doesn’t stop here. Wait until you learn more about the other amazing features available in IDX Workbench in the next unit.