Working with an Entity
>Configuring the Columns to Display
>Importing and Exporting Entity Data
>Associations Within an Entity
All entity pages are made up of certain common components. This section describes how to work with those components:
Searching an Entity
The search bar is available on all entity screens. It is used for searching and filtering the entity list that appears on the entity page.
To search an entity:
1.Select a search criterion from the left drop-down list. For example, Namespace is a search criterion for all catalog entities. The search bar is displayed below:
2.Enter a search value, for the search criteria. As soon as the search value is entered, the Search Pattern drop-down list appears:
3.Select a Search Pattern as one of the following:
•Exact - Filters records after matching the exact search value entered.
•Any - Filters records based on the search value appearing anywhere in its search criterion.
•Starts with - Filters records based on the initial characters of the search criterion matching the search value entered.
4.Repeat above steps to add multiple search criteria. For multiple search criteria records are filtered if all criteria is met.
NOTE The search bar also appears in the entity association panes in entity creation or entity modification pages.
Sorting an Entity
You can sort columns by clicking the entity attribute name (column name).
> ▲: Sorts the entity list in ascending order.
> ▼: Sorts the entity list in descending order.
The sort button appears highlighted for the column on which the entity list is sorted. In the following example, the entity list below is sorted by Creation Date in ascending order.
Using the Pagination Bar
The pagination bar below the entity records is used to view and navigate through the entity list. This bar helps control the page view of this list. An example of the pagination bar is displayed below:
The following table explains the components of a pagination bar:
Label | Description |
---|---|
Specifies the records numbers and the total number of records listed for an entity. The format is <record number from> - <record number to> of <total number of records>. For example, 1 - 5 of 30 in the above image specifies record number 1 to 5 of total 30 records of the entity is displayed. |
|
The current page that is displayed. For example, page 1 is displayed in the above image. | |
These page numbers specify the separate pages where the entity records have been distributed. |
|
The Page Size drop-down list specifies the number of records to be listed in each page. |
Configuring the Columns to Display
You can show or hide the entity attribute columns that you want to view on a page. You do this using the Configure Columns tool, which is available next to the Actions column for vendor users with administrative rights.
To configure the grid data for an entity:
1.Navigate to the entity page for which you want to configure the columns.
2.Click the Configure Columns tool. The columns that can be configured for the entity appear in a pop-up, for example:
All of the columns that can be configured for the entity are listed under Columns. The check boxes for the columns that are already displayed for the entity are selected.
3.Select the check boxes for the columns that you want to display. Clear the check boxes for the columns that you want to remove from the display.
4.To sort the entity data by a specific column, select the required attribute under Sort by.
5.Click Apply to apply the settings.
Importing and Exporting Entity Data
The Import option enables you to import your legacy data into Sentinel EMS from a CSV or JSON file.
The Export option enables you to export the current data of an entity to a CSV or JSON file.
You can import and export data for the following entities:
Entity Type |
Import File Type | Export File Type | ||
---|---|---|---|---|
CSV | JSON | CSV | JSON | |
Customers | N/A | |||
Contacts (represents the User entity) | N/A | |||
Downloads | N/A | |||
Entitlements |
N/A | |||
Features | ||||
Products |
The Import | Export | Download Sample options are displayed below:
To import entity data:
1.Navigate to the entity page to import its data.
2.Click Import. The Open dialog box appears.
3.Browse to the file that you want to import. CSV files must conform to the format specified for that entity. For more information on entity-specific CSV formats, see CSV File Formats for Importing and Exporting Data.
4.Click Open to import the file. A success message is displayed stating that the file has been uploaded and can be accessed through the Job Queue.
To export entity data:
1.Navigate to the entity page to export its data.
2.Click Export to export the entity data to a CSV or JSON file. For more information on entity-specific CSV formats, see CSV File Formats for Importing and Exporting Data.
To download a sample CSV file:
1.Navigate to the relevant entity page.
2.Click the icon adjacent to Import.
3.Click the Download link to download a sample CSV file for the entity on the page you are currently viewing.
Creating an Entity
You use the Add <entity name> button available on an entity page to create a new entity. Some prerequisites must be met before an entity can be created. For example, to create a feature, the vendor user must be assigned a role that includes Add permissions for the relevant namespace under Catalog (Namespace).
To create an entity:
1.On the entity screen, click the Add <entity name> button. The screen to create the entity appears. A sample page to create a feature is displayed below:
The entity creation screen consists of the following:
Label | Label | Description |
---|---|---|
Define Attributes | List of attributes that are mandatory. Optional and frequently used attributes are also listed in this section. | |
Additional Attributes | Lists the custom attributes and less frequently used optional attributes. | |
Entity Association Pane | This section is available for entities, which need association with other entities during creation. | |
Save | Button to save and create the entity. | |
Cancel | Button to close the entity creation screen without saving information. |
2.Enter value for all mandatory attributes.
3.Enter optional attributes (including Additional Attributes) as required.
4.Associate other entities as required. For details on how to associate an entity, see Associations Within an Entity.
5.Click Save.
Associations Within an Entity
The Entity Association Pane is part of the entity create, copy and edit screens. This pane is used to associate other entities with the entity being created or modified. For example, license models are associated with a feature using the Entity Association Pane when a feature is created. Two views of the Entity Association Pane are:
>Thumbnail View: Displays the details of the entity being associated as thumbnails. This is the default view.
>Grid View: Displays the details of the entity being associated in a grid.
Thumbnail View
The following image displays the Entity Association Pane in thumbnail view:
The Entity Association Pane in the thumbnail view consists of the following:
Label | Label | Description |
---|---|---|
Thumbnail View | Tool to switch to the thumbnail view. This is the default view of the Entity Association Pane. | |
Available Entities |
List of entities that are available for association. Selecting an entity from this section associates it the entity being created or updated. The selected entity is moved to the Associated Entities section. NOTE The number of objects that can be listed for an entity in this view is limited to 200. |
|
Associated Entities | List of entities that are associated with the entity being created or updated. This section also displays the details of an associated entity. Some of the attributes available here can be configured from this section. | |
Actions | Actions that can be performed on an associated entity. Clicking the Delete button removes the association and moves the entity back to the Available Entities section. | |
Grid View | Tool to switch to the grid view. |
Grid View
The following image displays the Entity Association Pane in grid view:
Label | Label | Description |
---|---|---|
Grid View | Tool to switch to the grid view. | |
Available Entities | List of entities that are available for association. Entities are selected from this section and associated with the entity being created or updated. | |
Associated Entities | List of entities that are associated with the entity being created or updated. This section also displays the details of an associated entity. Some of the attributes available here, can be configured from this section. | |
Pagination Bar | Navigate through and customize the number of records available under Available Entities. | |
Add | Entities selected under Available Entities are moved to the Associated Entities section on the click of this button. | |
Thumbnail View | Tool to switch to the thumbnail view. This is the default view of the Entity Association Pane. | |
Actions | Actions that can be performed on an associated entity. Clicking the Delete button removes the association and moves the entity back to the Available Entities section. |
Editing an Entity
To edit an entity:
1.Navigate to the entity page.
2.Find the entity you want to edit.
3.In the Actions column for the relevant entity, click Edit to display the attributes for the selected entity in the Edit Entity page.
4.Update the entity attributes as required.
5.Click Save.
Deleting an Entity
To delete an entity:
1.Navigate to the entity page.
2.Find the entity you want to delete.
3.Ensure the requirements for deleting the entity are met.
4.In the Actions column for the relevant entity, click Delete to delete the selected entity.