Data Loader
About the Role Data Loader
The Role Data Loader allows existing or new Security Roles to be delivered to APM. You can load data into APM via the Excel workbook.
- To create new Security Roles and associate them with existing Security Users and Security Groups.
- To modify the Security Users and Security Groups associated with existing Security Roles.
About the Role Data Loader Requirements
To use the Role Data Loader, the Security Users and Security Groups that you want to associate with new and existing Security Roles must already exist in your APM system.
Mapping
The Role Data Loader maps the datasheet columns in the Excel workbook to fields in APM families.
Security Settings
The Security User performing the data load operation must be associated with either the MI Data Loader User or MI Data Loader Admin Security Role.
About the Role Data Loader General Loading Strategy
This section describes any prerequisites to loading the data and the order in which the data will be loaded.
Prerequisites
- The Security Users and Security Groups that you want to associate with new and existing Security Roles already exist in your APM system.
About the Role Data Loader Workbook Layout and Use
This section provides a high-level overview and explanation of how the data loader workbook is constructed.
To import data using the Role Data Loader, APM provides an Excel workbook, Role.xlsx, which supports the Security Role feature in APM. This workbook must be used to perform the data load. You can modify the Excel template to include custom fields used by your organization.
|
Worksheet |
Description |
|---|---|
| Role | This worksheet is used to specify data for import to the Security Role family. |
| RoleGroup | This worksheet is used to specify the Security Groups that should be associated with the Security Roles. |
| RoleUser | This worksheet is used to specify the Security Users that should be associated with the Security Roles. |
Each worksheet in the Role Data Loader Template workbook contains field values that must be mapped to the appropriate APM family/field combination.
Role Worksheet
On the Role worksheet, you will specify the information for the Security Role record.
| Field Caption | Field ID | Data Type (Length) | Comments |
|---|---|---|---|
| ID | ROLE_ID | Character (255) | This field is required, and represents the ID for the Security Role. |
| Caption | ROLE_CAPTION_TX | Character (255) | This field is required. A title or explanation that identifies the Security Role. A property that specifies how the Security Role is labeled throughout the software interface. Note that most captions can be localized. |
| Description | ROLE_DESC_TX | Character (255) | This field is optional, and can contain a detailed description of the Security Role. |
RoleGroup Worksheet
On the RoleGroup worksheet, you will specify existing Security Group records that you want to associate with Security Roles.
| Field Caption | Field ID | Data Type (Length) | Comments |
|---|---|---|---|
| RoleId | ROLE-ID | Character (255) | This field is required. Enter the ID of the Security Role with which Security Groups will be associated. |
| GroupId | SEGR_ID | Character (255) | This field is required. Enter the GroupId of the Security Group with which Security Role will be associated. |
RoleUser Worksheet
On the RoleUser worksheet, you will specify existing Security User records that you want to associate with Security Roles.
| Field Caption | Field ID | Data Type (Length) | Comments |
|---|---|---|---|
| RoleId | ROLE_ID | Character (255) | This field is required. Enter the ID of the Security Role with which Security Users will be associated. |
| UserId | SEUS_ID | Character (255) | This field is required. Enter the UserId of the Security User with which Security Role will be associated. |