1. Cloud
  2. Guides
  3. Tours
  4. Concepts
  5. Tools
    1. Alert Editor
    2. Analyzer
    3. Avro Extractor Tool
    4. Business Schema Designer
    5. Business Schema Manager
    6. CMC Logs Manager
    7. CMC Monitoring
    8. CMC Scheduler
    9. CMC Tenant Manager
    10. Content Manager
    11. Dashboard Filters Manager
    12. Dashboard Manager
    13. Data Agent
    14. Data Lineage Viewer
    15. Data Lineage Viewer v2
    16. Data Manager
    17. Formula Builder
    18. Inspector Tool
    19. Join Editor
    20. Load Job Details Viewer
    21. Load Job Viewer
    22. Load Plan DAG Viewer
    23. Model Update Viewer
    24. Notebook Editor
    25. Profile Manager
    26. Public API
    27. Query Plan Viewer
    28. Scheduler
    29. Schema Designer
    30. Schema Diagram Viewer
    31. Schema Manager
    32. Schema Wizard
    33. Security Manager
    34. Table Editor
    35. Upload Service Command Line Interface (CLI)
  6. References
  7. Integrations
  8. Data applications
  9. Releases

Tools → Business Schema Manager

About the Business Schema Manager

The Business Schema Manager allows a tenant user with the necessary access rights to search for, create, and manage one or more business schemas. A business schema represents a runtime, logical schema of one or more entity objects.

To learn more about how to design a business schema, review Tools → Business Schema Designer.

Note

Starting with the 2023.4.0 release, you can now add, edit, and delete business schemas when the Loader Service isn’t available or running.

Business Schema Manager access rights

A user that belongs to a group with the Schema Manager or the SuperRole role can access the Business Schema Manager. Available options vary according to the assigned access rights and tenant configurations.

Starting with the 2021.4.3 release, users with only the Analyze User or Individual Analyzer roles will have limited access to the Business Schema Manager where they can view a list of business schemas shared with them without the need to be assigned the Schema Manager role. They can only open a shared business schema in the Business Schema Designer view mode, export it, and view its description and sharing configurations.

To access the Business Schema Manager for a given tenant, in the Navigation bar, select Business Schema.

Note
  • Only the Super User tenant administrator or a user with the Schema Manager or SuperRole roles can create business schemas.
  • By default, a user can edit, copy, or delete business schemas that the user owns or has Edit access rights to.
  • A user with the SuperRole role or the Super User can edit, copy, or delete any business schema regardless of the assigned access rights if the Enable Super User Mode option is enabled in the Cluster Management Console (CMC) → Tenant Configurations → Security.
  • A user with only the Analyze User or Individual Analyzer roles cannot create, edit, copy, or delete a business schema even if the user is assigned Edit access rights to the business schema.
  • Only the Super User tenant administrator can view the list of all items on the Business Schema Manager regardless of the access rights to them and the Enable Super User mode option.

Business Schema Manager anatomy

Note

The 2022.12.0 release introduced an enhanced user interface (UI) that this document captures.

The Business Schema Manager consists of the following:

  • Search bar
  • Action bar
  • List view

The Search bar contains a search text box. Search for an exact match of the business schemas' name using a given search term.

The Search bar shows:

  • The number of business schemas on the list whether the total number you have access to or the number of business schemas that match the search term.
  • The number of selected items in the result list with the option (x) to deselect the items
  • With selected items in the List view, the More Options (⋮ vertical ellipsis) appears. The available options are:
    • Export: use to export the selected business schemas to a .zip file
    • Delete: use to delete all selected business schemas

Starting with 2024.1.0, you can semantically search for columns across all business schemas on the business schema list when Incorta Copilot is enabled and configured.

Action bar

The Action bar contains the following:

  • + New: Opens the Add New menu. The Add New menu options are:
    • Create Business Schema
    • Import Business Schema
  • Show/Hide Columns: Opens the column list to decide on columns to show or hide. This option is available starting with the 2022.12.0 release.

Starting with 2022.12.0, both the Search and Action bars are combined into one bar.

List view

The List view shows all results for a given search term and search context. By default, the list view only shows items where the given user has at least view access rights to the items.

Note

Only the Super User tenant administrator can view all items, regardless of the access rights to the objects.

The List view shows up to 40 items at a time. For lists with more than this number of items, the List view contains page controls. The page controls allow the user to navigate pages forwards or backwards as well as to the first page or to the last page of items. Selecting the checkbox in the header row selects all items on the current page only.

By default, the Business Schema items appear in alphabetical, ascending order. To sort the items by the column values in either ascending or descending order, select a specific column header except for Description. Select an item to open the business schema in the Business Schema Designer. The 2022.12.0 release introduced additional properties including the department, modifying user, and last modified date while 2023.1.0 introduced the Make a copy option.

Displayed columns and sorting options are preserved during the user session.

The List view shows the following properties:

PropertyControlDescription
Select Allcheck boxHeader control to add or remove all list view page items to a group for deletion, export, or email notification creation
Select Itemcheck boxSelect to add or remove an individual item to a group of zero or more items for deletion
NametextThe name of the business schema
DescriptiontextThe description of the business schema
PermissiontextThe access rights for business schema: View, Share, or Edit.
OwnertextThe display name of the user creator
DepartmenttextThe classification of the business schema according to the related department. Available starting with 2022.12.0. This column is hidden by default.
Modified bytextThe person name of the user who last modified the business schema. Available starting with 2022.12.0.
Last Modifieddate/timeThe date and time when the business schema was last modified. Available starting with 2022.12.0.
More Options → Make a copymenu linkOpens the Make a copy dialog to create a duplicate of the respective business schema. Available starting 2023.1.0.
More Options → Edit Description/Edit Informationmenu linkOpens the Edit Description/Edit Information dialog. The option and dialog are renamed to Edit Information starting with 2023.1.0. You can use this dialog to specify the department and description of the business schema.
More Options → Sharemenu linkOpens the Share dialog
More Options → Exportmenu linkExports the business schema to a .zip file
More Options → Deletemenu linkOpens the confirmation dialog for the business schema deletion

Business Schema Manager actions for business schemas

With the Business Schema Manager, you can perform the following actions for business schemas:

Business Schema Manager access rights matrix

The following table shows the required access rights for each item in the Business Schema Manager:

Action/Access RightsOwn/EditShareView
Business Schema → View as list✔✔✔
Business Schema → Search for✔✔✔
Business Schema → Open in Business Schema Designer✔✔✔
Business Schema → Edit in Business Schema Designer✔
Business Schema → Make a copy✔
Business Schema → View Information✔✔✔
Business Schema → Edit Information✔
Business Schema → Export✔✔✔
Business Schema → Share✔✔
Business Schema → Delete✔

Create a business schema

You can create a business schema using the Business Schema Manager. Once created, you can design the business schema using the Business Schema Designer.

Here are the steps to create a business schema using the Business Schema Manager:

  • In the Navigation bar, select Business Schema.
  • In the Action bar, select + New → Create Business Schema.
  • In the Create Business Schema dialog, specify the following:
  • the Name of the business schema
  • an optional Description for the business schema
  • In the dialog, select Save.
Important

Validation Rules for a business schema name A business schema name…

  • Must be unique.
  • Must be between 1 and 250 characters in length.
  • Must begin with an alpha character, lower or upper case.
  • After the first alpha character, can contain zero or more alphanumeric characters in lower, upper, or mixed case.
  • After the first alpha character, can contain zero or more underscore (_) or Dollar sign ($) characters.
  • Besides underscore (_) and Dollar sign ($), cannot contain special characters, symbols, or spaces.
  • Is not case-sensitive. (Starting with 2024.1.0)

To learn more about how to create a business schema view and an Incorta Analyzer View using the Business Schema Designer, refer to Tools → Business Schema Designer

Import a business schema

You can import one or more business schemas that exist in the same .zip file.

  • In the Navigation bar, select Business Schema.
  • In the Action bar, select + New → Import Business Schema.
  • In the Import Business Schema dialog, optionally select the Overwrite existing business schema check box to overwrite any existing business schema that shares the same name.
  • Do one of the following:
    • Drag the .zip file that contains the business schema(s) that you want to import to the Import Business Schema dialog.
    • Select Click or drag a file here to upload to select the .zip file, and then select Open.
  • In the Import Results dialog, review the status of the import operation.
  • Select Close.

The following are the details in the Import Results dialog:

PropertyDescription
NameName of the business schema
TypeThe type of the imported item
StatusThe status of the import operation. It can be one of the following:
  ●  Created
  ●  Overwritten
  ●  Failed
If the import operation fails, the reason is displayed.

View a list of business schemas

  • In the Navigation bar, select Business Schema.
  • Review the list view of business schemas.

Search for a business schema

  • In the Navigation bar, select Business Schema.
  • In the Search bar, enter a search term.
  • Review the list view of business schemas.

To reset the search, in the Search bar, in the search box, select the remove button (x).

View a business schema

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for a given business schema that you own or have access rights to, select any part of the row to open the Business Schema Designer.
  • Depending on your access rights, in the Business Schema Designer, you can perform different actions, such as:
    • view existing folders and views
    • add a new folder
    • add a new view
    • edit an existing business schema view, Incorta Analyzer View, or Incorta SQL View
    • delete a folder, business schema view, Incorta Analyzer View, or Incorta SQL View
    • explore the business schema data in the Analyzer

Copy a business schema

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for a given business schema that you own or have Edit access rights to, select More Options (⋮ vertical ellipsis).
  • Select Make a copy.
  • In the Make a copy dialog, update the name and other information of the new business schema as required.
  • Select Save.

Edit business schema information

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for a given business schema that you own or have Edit access rights to, select More Options (⋮ vertical ellipsis).
  • Select Edit Description/Edit Information.
  • In the Edit Description/Edit Information dialog, enter or update the business schema description and department. You can enter a description up to 500 and a department up to 250 alphanumeric characters, including spaces and special characters.
  • Select Save.

Share a business schema

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for a given business schema row, select More Options (⋮ vertical ellipsis).
  • Select Share.
  • In the Share dialog, you can do the following:
    • remove an existing user or group
    • modify the existing access rights for a user or group
    • add a new user or group with the access rights

Export a business schema

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for a given business schema row, select More Options (⋮ vertical ellipsis).
  • Select Export. The exported business schema .zip file is downloaded to your default Downloads folder.

Export one or more business schemas

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for each business schema that you want to export, select the check box.
  • In the Search bar, next to Selected, select More Options (⋮ vertical ellipsis).
  • Select Export. The exported business schema(s) .zip file is downloaded to the Downloads folder.

Delete a business schema

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for a given business schema row, select More Options (⋮ vertical ellipsis).
  • Select Delete.
  • In the dialog, select Delete.

Delete one or more business schemas

  • In the Navigation bar, select Business Schema.
  • In the list view of business schemas, for each business schema that you want to delete, select the check box.
  • In the Search bar, next to Selected, select More Options (⋮ vertical ellipsis).
  • Select Delete.
  • In the dialog, select Delete.