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.

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.

Business Schema Manager anatomy

The Business Schema Manager consists of the following:

  • Action bar
  • Search bar
  • List view

Action bar

The Action bar shows the page title.

+ New in the Action bar opens the Add New menu. The Add New menu options are:

  • Create Business Schema
  • Import Business Schema

The Search bar contains a search text box. Search for any part of a given search term. The Search bar shows:

  • The number of items in the result list
  • The number of selected items in the result list with the option (x) to deselect the items
  • With select 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

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 SuperUser 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.

Business schemas list view

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.

For Schemas, 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 from the business schema
PermissiontextThe access rights for business schema: View, Share, or Edit.
OwnertextThe display name of the user creator
More Options → Edit Descriptionmenu linkOpens the Edit Description dialog
More Options → Sharemenu linkOpens the Share dialog
More Options → Exportmenu linkOpens the Export Schema(s) dialog
More Options → Deletemenu linkOpens the confirmation dialog for the physical schema deletion

Business Schema Manager actions for business schemas

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

Note
  • Only the SuperUser tenant administrator or a user with the Schema Manager or SuperRole roles can create business schemas.
  • By default, a user can edit or delete business schemas that the user has Edit access rights to.
  • A user with the SuperRole role or the SuperUser can edit 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, or delete a business schema even if the user is assigned Edit access rights to the business schema.

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 → View Description
Business Schema → Edit Description
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 + NewCreate 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

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 + NewImport 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 do the following:
    • view existing folders and views
    • add a new folder
    • add a new view
    • edit an existing business schema view
    • edit an existing Incorta Analyzer View
    • delete a folder, business schema view, or Incorta Analyzer View
    • explore the business schema data in the Analyzer

Edit a business schema description

  • 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 Edit Description.
  • In the Edit Description dialog, enter or update the business schema description. You can enter up to 500 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.