TIBCO ActiveMatrix BusinessWorks™ SmartMapper EPS Business UI User’s Guide
Version 6.0.1 August 2021
Copyright © 1999-2021. TIBCO Software Inc. All Rights Reserved. | ii Contents
Figures ...... iv
Tables ...... vi
Chapter 1 SmartMapper EPS Business UI Overview ...... 1 Product Overview...... 2
Chapter 2 Starting SmartMapper EPS Business UI ...... 3 Prerequisites ...... 4 Setting Up the Configuration File ...... 4 Starting Server...... 6 Logging in to SmartMapper EPS Business UI...... 7 Forgot Your Password...... 8 Logging out SmartMapper EPS Business UI ...... 8 Stopping Server ...... 10
Chapter 3 User Interface Overview...... 11 Home Page ...... 12 Main Menu ...... 13 Product and User Information...... 13 Quick Tips Panel...... 14 Recent Activity Panel ...... 14 Favorites Panel ...... 15 Relationship and Entity Management Page...... 16 Left Panel Overview ...... 16 Right Panel Overview ...... 19
Chapter 4 Managing Identity Relationships ...... 21 Identity Relationship Management Page Overview ...... 22 Left Panel of the Identity Relationship Management Page ...... 22 Right Panel of the Identity Relationship Management Page...... 23 Creating an Identity Relationship Instance ...... 25 Editing an Identity Relationship Instance...... 29 Setting Up Favorite Relationships ...... 30
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide iii | Contents
Chapter 5 Managing Association Relationships ...... 31 Association Relationship Management Page Overview ...... 32 Left Panel of the Association Relationship Management Page ...... 32 Right Panel of the Association Relationship Management Page ...... 33 Creating an Association Relationship Instance...... 34 Editing an Association Relationship Instance ...... 36 Setting Up Favorite Relationships ...... 37
Chapter 6 Managing Participants ...... 39 Adding a Participant Instance ...... 40 Changing Display Field and Setting Up Anchor Participant ...... 43
Chapter 7 Managing Entities ...... 47 Entity Management Page Overview ...... 48 Creating an Entity Instance...... 49 Changing Display Field ...... 50 Setting Up Favorite Entities...... 51
Chapter 8 Managing Users and Permissions...... 53 Profile Management ...... 54 User Management...... 56 Adding a User ...... 57 Permission Management ...... 59 Permission File ...... 60
Appendix A Anchor Participants and Relationship Types ...... 63 Entity and Anchor Participant ...... 64 Relationship Types ...... 65 Identity Relationship ...... 65 Association Relationship ...... 66
Index ...... 67
TIBCO Product Documentation and Support Services ...... 69 How to Access TIBCO Documentation ...... 69 How to Contact TIBCO Support...... 70 How to Join TIBCO Community ...... 70
Legal and Third-Party Notices ...... 71
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Figures | iv Figures
Figure 1 SmartMapper EPS Business UI Login Page ...... 8 Figure 2 Logging out ...... 9 Figure 3 SmartMapper EPS Business UI Home Page ...... 12 Figure 4 Identity Relationship Management Page ...... 16 Figure 5 One-key Defined Entity ...... 18 Figure 6 The Left Panel of an Identity Relationship ...... 19 Figure 7 Identity Relationship Management Page ...... 22 Figure 8 Total Relationship Instance Records ...... 23 Figure 9 Editing an Identity Relationship Instance ...... 24 Figure 10 New Relationship Instance Dialog ...... 25 Figure 11 Creating a New Entry ...... 26 Figure 12 Choosing From Existing Entries...... 26 Figure 13 Created Identity Relationship Instance ...... 27 Figure 14 Manage Labels and Favorites Dialog...... 30 Figure 15 Association Relationship Management Page...... 32 Figure 16 New Association Relationship Instance Dialog ...... 34 Figure 17 Two Participants of an Association Relationship ...... 35 Figure 18 Association Panel...... 36 Figure 19 Manage Labels and Favorites Dialog...... 37 Figure 20 New Participant Instance Dialog ...... 40 Figure 21 Creating a New Entry ...... 41 Figure 22 New Participant from Existing Entries ...... 41 Figure 23 Editing Participants Dialog ...... 43 Figure 24 Changing Display Field for the Anchor Participant...... 45 Figure 25 Entity Management Page...... 48 Figure 26 Manage Labels and Favorites Dialog...... 51 Figure 27 User Management Menu ...... 54 Figure 28 User Management Dialog ...... 56
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide v | Figures
Figure 29 Permission Management Dialog ...... 59 Figure 30 Permission File ...... 60
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Tables | vi Tables
Table 1 User Information and Permission Management ...... 14 Table 2 Editing Participants ...... 44 Table 3 Profile Information ...... 54 Table 4 Adding a User ...... 57 Table 5 Attributes in the Permission File ...... 61 Table 6 Identity relationship: Customer Record ...... 65 Table 7 Association Relationship ...... 66
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide vii | Tables
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 1
Chapter 1 SmartMapper EPS Business UI Overview
This chapter gives an overview of TIBCO ActiveMatrix BusinessWorks SmartMapper Enterprise Server Business UI.
Topics
• Product Overview, page 2
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 2 | Chapter 1 SmartMapper EPS Business UI Overview
Product Overview
ActiveMatrix BusinessWorks SmartMapper Enterprise Server streamlines integration processes by allowing users to easily model and access cross-referencing relationships and code conversion rules. By doing this, TIBCO ActiveMatrix BusinessWorks SmartMapper Enterprise Server lets organizations create centralized repository of data relationships that can be leveraged to harmonize data across multiple systems and support rapid creation and configuration of composite applications and business services. The cross-referencing data stored in the database can be managed by using SmartMapper EPS Business UI. TIBCO ActiveMatrix BusinessWorks SmartMapper Enterprise Server Business UI, a web-based application, allows users to fix issues, such as data duplicate, and to monitor critical data elements. The user-friendly graphic user interface of SmartMapper EPS Business UI provides an easy and agile way to create, delete and update relationship instances, participant instances, and entity instances. The entities, applications, and relationships in the database are defined in TIBCO Designer by using the SmartMapper resources and activities. See TIBCO ActiveMatrix BusinessWorks SmartMapper Enterprise Server User’s Guide for more details about creating ER Models and defining relationships. TIBCO ActiveMatrix BusinessWorks SmartMapper Enterprise Server Business UI provides the following functionalities: • Relationship Data Management The association and identity relationship data are managed separately. Users can look up, create, update, and delete relationship instances and participant instances within a relationship. See Managing Identity Relationships on page 21 and Managing Association Relationships on page 31 for more details. • Entity Data Management The entity data can be managed in the Entity page. Users can look up, create, update, and delete an entity instance. See Managing Entities on page 47 for more details. • User and Permission Management User information and user permissions can be managed in the User Management page. Only the system administrator has the privilege to create users, delete users, and manage user permissions. See Managing Users and Permissions on page 53 for more details. • Label Management Users can change the names of relationship and entity, and set up favorite relationships and entities. Note that only the system administrator has the privilege to change the display names of the relationship and entity.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 3
Chapter 2 Starting SmartMapper EPS Business UI
This chapter explains how to start and stop the SmartMapper EPS Business UI server and SmartMapper EPS Business UI.
Topics
• Prerequisites, page 4 • Starting Server, page 6 • Logging in to SmartMapper EPS Business UI, page 7 • Stopping Server, page 10
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 4 | Chapter 2 Starting SmartMapper EPS Business UI
Prerequisites
Prior to starting the SmartMapper EPS Business UI server, the bui_config.properties configuration file must be configured to specify a database in which the cross-referencing data is to be loaded in SmartMapper EPS Business UI. You can also set up the email configurations and other session timeout related configurations.
Setting Up the Configuration File
To configure the bui_config.properties file:
1. Navigate to the SmartMapper_HOME\admin\config directory.
2. Open the bui_config.properties file.
3. Configure the bui_config.properties file according to the following information: — jdbc properties related In this field, you can specify a database, storing the cross-referencing data that you want to manage, by directly modifying the database configurations in the given example. The supported database types are MySQL, Oracle, Microsoft SQL Server, and DB2.
Note: The database URL parameter takes precedence over the database driver parameter when JDBC 4.0 or above is used. — mail related In this field, you can configure email related settings. The email set up here is used to send emails when users forget the password. Note: The host can either be the host name of the SMTP server or the IP address of the SMTP server. — session timeout In this field, you can specify a session timeout value, in minutes. If no action is done before the session times out, the session ends. The user needs to login again. The default timeout value is 30 minutes.
The single-session-maximum-timeout parameter is used to set up a maximum timeout value for a single session. The default value is 60 minutes. When the session reaches the value specified here, the user will be logged out compulsively. 4. Save your configurations.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Prerequisites | 5
The minimum value specified for the session timeout parameter and the single-session timeout parameter is 10. If a smaller value is entered, the value does not take effect and 10 is used as the values for the parameters. When the user session reaches the value specified for the single-session-maximum-timeout parameter, users will be logged out compulsively even though the session time does not reach the specified session timeout value.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 6 | Chapter 2 Starting SmartMapper EPS Business UI
Starting Server
Before starting the SmartMapper EPS Business UI server, ensure that the bui_config.properties file has been configured. See Setting Up the Configuration File on page 4 for more details. To start the SmartMapper EPS Business UI server:
1. Navigate to the SmartMapper_HOME\admin directory.
2. Run startserver. When the server is running, a log file with the name server.log is generated in the log folder under the SmartMapper_HOME\admin\logs directory.
If the ER Model has been changed since last time the server is started, all the files residing in the SmartMapper_HOME\admin\config\system directory must be deleted prior to starting the server.
On Linux, the server is started by directly double-clicking the executable without popping up a terminal.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Logging in to SmartMapper EPS Business UI | 7
Logging in to SmartMapper EPS Business UI
Ensure that the SmartMapper EPS Business UI server is running prior to logging in to SmartMapper EPS Business UI. See Starting Server on page 6 for more details. To log in to SmartMapper EPS Business UI:
1. Navigate to the SmartMapper_HOME\admin\logs directory and locate the server.log file. The log file is automatically generated when the SmartMapper EPS Business UI server is started.
2. Open the server.log file and find the URL at the end of the text. 3. Open a web browser and go to the URL found in the log file. The supported web browsers are as follows: — Microsoft Internet Explorer 9 and above — Mozilla Firefox 10 and above — Google Chrome latest — Apple Safari 5 and above. 4. Enter your username and password in the corresponding text fields.
Note: An admin user is created by default. The initial password for the admin user is admin123. After logging in, see Profile Management on page 54 to change the password. 5. Click the button to log in to SmartMapper EPS Business UI. If you forget your password, click the Forgot your password? link under the Password field. See Forgot Your Password on page 8 for more details. If the Remember me check box is selected, you will be directly brought to the home page of SmartMapper EPS Business UI when your login session times out. However, if you manually log out from SmartMapper EPS Business UI, your username and password are not saved next time you log in to SmartMapper EPS Business UI.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 8 | Chapter 2 Starting SmartMapper EPS Business UI
Figure 1 SmartMapper EPS Business UI Login Page
Forgot Your Password The Forgot Password page is displayed after you click the Forgot your password? link. To get your password: 1. Enter your username in the Username field. 2. Enter the characters displayed in the image. The letters are not case sensitive. 3. Click the button to send an email to your email box where you can find the password. 4. Find your password in the email. 5. Click the Login link to return to the Sign In page. See Logging in to SmartMapper EPS Business UI on page 7 to log in to SmartMapper EPS Business UI.
Logging out SmartMapper EPS Business UI To log out of SmartMapper EPS Business UI: 1. Click your username at the upper-right corner of the SmartMapper EPS Business UI. 2. Click Log Out from the menu displayed.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Logging in to SmartMapper EPS Business UI | 9
Figure 2 Logging out
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 10 | Chapter 2 Starting SmartMapper EPS Business UI
Stopping Server
Users can stop the SmartMapper EPS Business UI server by running the executable. Once the SmartMapper EPS Business UI server is stopped, SmartMapper EPS Business UI will be inaccessible. To stop the SmartMapper EPS Business UI server:
1. Navigate to the SmartMapper_HOME\admin directory.
2. Run stopserver.
On Linux, the server is stopped by directly double-clicking the executable without popping up a terminal.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 11
Chapter 3 User Interface Overview
This chapter explains the user interface of SmartMapper EPS Business UI.
Topics
• Home Page, page 12 • Relationship and Entity Management Page, page 16
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 12 | Chapter 3 User Interface Overview
Home Page
This section introduces the home page of SmartMapper EPS Business UI. SmartMapper EPS Business UI launches with the home page displayed, as shown in Figure 3. The home page enables users to get quick access to the basic functionalities. Find the corresponding information in the following sections: • Main Menu, page 13 • Product and User Information, page 13 • Quick Tips Panel, page 14 • Recent Activity Panel, page 14 • Favorites Panel, page 15
Figure 3 SmartMapper EPS Business UI Home Page
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Home Page | 13
Main Menu Four tabs are displayed in the menu: • HOME Click the tab to go to the home page. • Identity All of the identity relationships that you have permission for are listed in this tab. See Managing Identity Relationships on page 21 for details about managing the identity relationships. • Association All of the association relationships that you have permission for are listed in this tab. See Managing Association Relationships on page 31 for details about managing the association relationships. • Entity All of the entities that you have permission for are listed in this tab. See Managing Entities on page 47 for details about managing the entities.
Favorites and All Tabs A menu is displayed when you click the Identity, Association, or Entity tab from the menu. In the displayed menu, you are presented with two tabs: Favorites and All. • Favorites lists all your favorite relationships or entities. If you have not set up any favorite relationship or entity, click the Add favorites button in the Favorites tab to add one. • All lists all the relationships or entities that you have permission for. For entities, the items listed in the Favorites and All tabs are displayed in a tree structure. The first level is the application level and the second level is entity level. Entities are grouped by application.
Product and User Information At the upper-right corner of the home page, three links are displayed: • About The product information is displayed in the pop-up window when clicking the About link. • Help The user’s guide of SmartMapper EPS Business UI is displayed in a new web page when clicking the Help link. • username A menu for managing user information and permissions is displayed when clicking the username link. If the login user is the system
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 14 | Chapter 3 User Interface Overview
administrator, the username displayed here is admin and cannot be changed. Table 1 lists the available options in the displayed menu.
Table 1 User Information and Permission Management Options Description Profile Allows the current user to view and manage the account information. See Profile Management on page 54 for more details.
User Allows the system administrator to manage the users using the TIBCO Management ActiveMatrix BusinessWorks SmartMapper Enterprise Server Business UI. See User Management on page 56 for more details. Note: This option is available only for the system administrator.
Permission Allows the system administrator to manage the permission roles assigned to the Management users. See Permission Management on page 59 for more details. Note: This option is available only for the system administrator.
Log out Clicks to log out of SmartMapper EPS Business UI.
Quick Tips Panel The Quick Tips panel, listed on the right-hand of the home page, introduces how to use SmartMapper EPS Business UI from the following topics: • Management Introduces how to manage cross-referencing data. • Analysis Introduces how to analyze the cross-referencing data. • Devices Introduces supported web browsers and devices. • Glossary Introduces the terms used in SmartMapper EPS Business UI. • Tutorial Introduces how to use SmartMapper EPS Business UI with a video. Click the button to watch the video. You can click the Tutorial link to hide the video. The Quick Tips panel expands with a short description for each topic when the video is hidden. Click corresponding link in the Quick Tips panel to get more information. A more detailed description is displayed in a new page. You can slide the scrollbar on the right side to view more.
Recent Activity Panel The Recent Activity panel lists operations performed in the last seven days by all of the users. The operations are listed by the operation time.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Home Page | 15
Favorites Panel The Favorites panel lists the relationship instances and entities that have been set as favorite. The favorite items are displayed in accordance with the recently used time. Click the favorite item, you are directly brought to the corresponding page.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 16 | Chapter 3 User Interface Overview
Relationship and Entity Management Page
After selecting the identity relationship, association relationship, or the entity that you want to manage from the menu, you are brought to the corresponding management page. Figure 4 is the management page of an identity relationship.
Figure 4 Identity Relationship Management Page
SmartMapper EPS Business UI management page is divided into two panels: a left panel and a right panel. See Left Panel Overview on page 16 and Right Panel Overview on page 19 for more details.
Left Panel Overview The left panel lists the relationship instances or the entity instances of the selected relationship or entity. For identity and association relationships, the relationship instances are represented by the corresponding anchor participants. See Entity and Anchor Participant on page 64 for more details about the anchor participant. The left panel includes the following common features:
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Relationship and Entity Management Page | 17
• List Title The name of the anchor participant or the entity is displayed at the top of the left panel. The anchor participant represents the selected relationship. At first, SmartMapper EPS Business UI automatically and randomly sets a participant of a relationship as the anchor participant to represent the relationship. After logging in, the system administrator can change the anchor participant and the display name of the anchor participant. See Changing Display Field and Setting Up Anchor Participant on page 43 for more details. • Number The number next to the list title, in brackets, is the number of the anchor participant instances or the entity instances.
If several SmartMapper EPS Business UI servers connect to a same database, there is a delay of the number between different servers when managing the relationships and entities simultaneously. The number is synchronized every 10 minutes.
• List Items The items listed in the left panel are relationship instances (represented by anchor participant instances) or entity instances. By default, twenty items are displayed in one page. When moussing over the left panel, you can slide the scrollbar to the bottom to view more items and click the button to go back to the top. • Display Field Each item listed in the left panel is of two-line context. The first line is the values of the display fields; The second line is the values of the key fields. The values are separated by commas. In TIBCO Designer, an entity can be configured with one or more key fields and non-key fields. When the SmartMapper EPS Business UI server is started, the system randomly sets a pre-defined field as the display field. The first line displays the value of the display field and the value is bolded; the second line displays the values of all the defined key fields. Whereas, if the entity only has one key field defined, the key field is set as the display field and just one line is displayed, as shown in Figure 5.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 18 | Chapter 3 User Interface Overview
Figure 5 One-key Defined Entity
• Pagination The pagination bar is located at the bottom of the left panel, which displays 8 pages at most.
The Select All check box at the top of the left panel only affects items in the current page. That is, when you select the Select All check box, only all the items in the current page are selected.
Take the Map_Acct_Part_Cust identity relationship as an example, which defines the relation of the customer information in the SAP, OAG, and Siebel systems. After selecting the Map_Acct_Part_Cust relationship in the Identity tab from the menu, you are brought to the identity relationship management page.
As shown in Figure 6, the Map_Acct_Part_Cust relationship is represented by anchor participant SAP_Customer. The relationship instances are represented by the corresponding participant instance of SAP_Customer. The SAP_Customer participant has 5 instances.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Relationship and Entity Management Page | 19
Figure 6 The Left Panel of an Identity Relationship
Right Panel Overview The content on the right panel varies depending on whether a relationship instance is selected. See Right Panel of the Identity Relationship Management Page on page 23, Right Panel of the Association Relationship Management Page on page 33, and Entity Management Page Overview on page 48 for more details.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 20 | Chapter 3 User Interface Overview
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 21
Chapter 4 Managing Identity Relationships
This chapter explains how to manage the identity relationships.
Topics
• Identity Relationship Management Page Overview, page 22 • Creating an Identity Relationship Instance, page 25 • Editing an Identity Relationship Instance, page 29 • Setting Up Favorite Relationships, page 30
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 22 | Chapter 4 Managing Identity Relationships
Identity Relationship Management Page Overview
After selecting an identity relationship in the Identity tab from the menu, you are brought to the Identity Relationship Management page, as shown in Figure 7.
Figure 7 Identity Relationship Management Page
Left Panel of the Identity Relationship Management Page The left panel is used to manage the identity relationship instances. See Left Panel Overview on page 16 for more details about the left panel. • To delete one or more identity relationship instances, select corresponding check boxes and click the Delete button at the top of the left panel. Note: The entity instances will not be deleted along with the deletion of the identity relationship instance. • To create a relationship instance, click the Create button at the top of the left panel. See Creating an Identity Relationship Instance on page 25 for more details.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Identity Relationship Management Page Overview | 23
Right Panel of the Identity Relationship Management Page The right panel is used to manage the participants in the relationship as well as the participant instance in the specified relationship instance. The content displayed on the right panel is often changed depending on what action is done in the left panel. If no relationship instance (anchor participant instance) is selected in the left panel, the Total Relationship Instance Records panel is displayed; if a relationship instance is selected in the left panel, the Record Sources panel and the Compare and Edit Record Sources panel are displayed, as shown in Figure 9 on page 24.
Total Relationship Instance Records When no relationship instance is selected in the left panel, all the participants defined in the selected relationship are displayed in the Total Relationship Instance Record panel. Click the button to view other participants and click the button to view the previous participant. The number next to the Total Relationship Instance Records title is the total number of the relationship instances. Each circle represents a participant. The circle filled in blue indicates that the corresponding participant is the anchor participant. The number in the circle is the number of the participant instances.
As shown in Figure 8, the selected identity relationship has 12 relationship instances. SAP_Customer is the anchor participant to represent the relationship and the number of the SAP_Customer participant instances in the relationship is 4.
Figure 8 Total Relationship Instance Records
Record Sources When a relationship instance is selected in the left panel, which is represented by an anchor participant instance, the participants in the selected relationship instance are displayed in the Record Sources panel. The number on each circle indicates the number of participant instances in the selected relationship instance and the blue circle indicates the corresponding participant is the anchor participant.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 24 | Chapter 4 Managing Identity Relationships
You can drag the participant circle to change the order of the participants. The detailed information of the first participant is displayed at the top of the Compare and Edit Record Sources panel.
Compare and Edit Record Sources The detailed information of participant instances is displayed in the Compare and Edit Record Sources panel, where you can add, edit, or delete a participant instance in or from the relationship instance. The order of the participants listed in the Compare and Edit Record Sources panel is in accordance with the order of the participant displayed in the Record Sources panel. To manage a relationship instance, click the relationship instance in the left panel and the detailed information is displayed in the right panel. For details about how to manage a relationship instance, see Editing an Identity Relationship Instance on page 29.
Figure 9 Editing an Identity Relationship Instance
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Creating an Identity Relationship Instance | 25
Creating an Identity Relationship Instance
An identity relationship defines the relationship of entities from different applications. See Identity Relationship on page 65 for more details. To create an identity relationship instance, complete the following tasks: • Task A, Create an Identity Relationship Instance, page 25 • Task B, Add Participant Instances, page 27
Task A Create an Identity Relationship Instance To create an identity relationship instance: 1. In the Identity Relationship Management page, click the Create button at the top of the left panel. The New Relationship Instance dialog is displayed, as shown in Figure 10.
Figure 10 New Relationship Instance Dialog
2. Select a way to create the relationship instance: — Create a new entry A new participant instance is used to create the relationship instance. See Creating a New Entry on page 26 for more details. — Choose from existing entries An existing participant instance is used to create the relationship instance. See Choosing From Existing Entries on page 26 for more details. 3. Click the Save button to create an identity relationship instance. The created relationship instance is selected and listed at the top of left panel.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 26 | Chapter 4 Managing Identity Relationships
Creating a New Entry By default, Create a new entry is selected. The defined fields are listed, as shown in Figure 11. The items displayed are the fields defined when building the ER Model in TIBCO Designer. Enter the value for each corresponding field in the text field.
If the field is followed by a red key word, it means that the field is the key field. Otherwise, the field is the non-key field. The following asterisk (*) indicates that the corresponding field is required. You must provide a value for it. The creation of an entry equals to the creation of an entity.
Figure 11 Creating a New Entry
Choosing From Existing Entries If Choose from existing entries is selected, a search panel is displayed, as shown in Figure 12.
Figure 12 Choosing From Existing Entries
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Creating an Identity Relationship Instance | 27
To select an existing entity instance as one of the participant instances of the relationship instance: 1. Enter the search criteria in the Narrow your search by panel to narrow your selections. This step is optional. 2. Click the Search button. The entity instances that match the criteria specified in Step 1 are displayed in the Then select a result panel. If no criteria are entered in the first step, all the existing entity instances are displayed. The first 20 entity instances are displayed in the right panel. You can slide the scrollbar to view more. 3. Select an entity instance in the Then select a result panel, and then click the Select button to create a relationship instance.
The entity instance that has been added to another identity relationship instance cannot be selected, which is grayed out.
Task B Add Participant Instances Once the identity relationship instance is created, it is automatically selected in the left panel, as shown in Figure 13.
Figure 13 Created Identity Relationship Instance
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 28 | Chapter 4 Managing Identity Relationships
To add participant instances to an identity relationship instance: 1. Click the button next to the corresponding participant in the Compare and Edit Record Sources panel. The New Participant Instance dialog is displayed. 2. See Adding a Participant Instance on page 40 for more details about how to add participant instances to a relationship instance.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Editing an Identity Relationship Instance | 29
Editing an Identity Relationship Instance
After selecting the identity relationship instance that you want to edit, the information of the selected relationship instance is listed in the right panel. The Compare and Edit Relationship Instance panel displays participant instances with detailed information. See Right Panel of the Identity Relationship Management Page on page 23 for more details. You can compare and edit the participant instances in the Compare and Edit Relationship Instance panel: • To add a new participant instance for the selected relationship instance, click the button next to the corresponding participant. For more details, see Adding a Participant Instance on page 40 for more details. • To delete a participant instance from the selected relationship instance, click the participant instance and click the button. Note: The anchor participant instance that represents the relationship instance cannot be deleted. The button is grayed out. The other instances of the anchor participant can be deleted. • To edit a participant instance, select a participant instance and click the button to edit it in the displayed Edit dialog.
The corresponding entity is updated accordingly when editing the participant instance.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 30 | Chapter 4 Managing Identity Relationships
Setting Up Favorite Relationships
In the Identity Relationship Management pages, the (Manage labels and favorites) button in the menu allows you to change the display name of relationships and set up your favorite relationships. Once clicking the button, the Manage labels and favorites dialog is displayed, as shown in Figure 14.
Figure 14 Manage Labels and Favorites Dialog
The relationships are displayed in alphabetical order. An alphabet bar is located on the left side where you can click the corresponding letter to look up the relationship that starts with the selected letter. Edit the identity relationships in the Manage labels and favorites dialog as follows: • To change the display name of a relationship, enter a new name in the text field. Note: Only the system administrator has the permission to change the relationship name. • To set one or more relationships as favorites, click the icon. Once a relationship is set as favorite, the icon is highlighted with yellow.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 31
Chapter 5 Managing Association Relationships
This chapter explains how to manage the association relationships.
Topics
• Association Relationship Management Page Overview, page 32 • Creating an Association Relationship Instance, page 34 • Editing an Association Relationship Instance, page 36 • Setting Up Favorite Relationships, page 37
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 32 | Chapter 5 Managing Association Relationships
Association Relationship Management Page Overview
After selecting an association relationship in the Association tab from the menu, you are brought to the Association Relationship Management page, as shown in Figure 15.
Figure 15 Association Relationship Management Page
Left Panel of the Association Relationship Management Page The left panel is used to manage the association relationship instances. See Left Panel Overview on page 16 for more details about information listed in the left panel. • To delete one or more association relationship instances, select the corresponding check boxes and click the Delete button at the top of the left panel.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Association Relationship Management Page Overview | 33
Note: The entity instances will not be deleted along with the deletion of the association relationship instance. • To create an association relationship instance, click the Create button at the top of the left panel. See Creating an Association Relationship Instance on page 34 for more details.
Right Panel of the Association Relationship Management Page Different from the identity relationship, the association relationship has only two participants. For more details, see Association Relationship on page 66. The right panel of the association relationship is different from that of the identity relationship. As shown in Association Relationship Management Page on page 32, the right panel of the association relationship is divided into the following two panels: • Information Panel The upper Information panel displays the detailed information of the selected anchor participant instance, allowing you to edit the select anchor participant. • Association Panel The lower Association panel displays the associated participant. All the participant instances are listed in this panel, allowing you to edit the associated participant.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 34 | Chapter 5 Managing Association Relationships
Creating an Association Relationship Instance
The association relationship must contain two participants and only two. To create an association relationship instance, you must create the two participants one by one. To create an association relationship instance: 1. In the Association Relationship Management page, click the Create button at the top of the left panel. The New Association Relationship Instance dialog is displayed, as shown in Figure 16.
Figure 16 New Association Relationship Instance Dialog
2. In the Pair this participant field, create a participant instance or select an existing participant instance as one participant instance to pair. See Adding a Participant Instance on page 40 for more details. 3. In the With this participant field, create a participant instance or select an existing participant instance as the participant instance to pair with. See Adding a Participant Instance on page 40 for more details. When the two participant instances are decided, the participant icons are highlighted with blue, as shown in Figure 17 on page 35. 4. Click the Done button to create an association relationship instance with the two participant instances, or click the Close button to exit.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Creating an Association Relationship Instance | 35
Figure 17 Two Participants of an Association Relationship
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 36 | Chapter 5 Managing Association Relationships
Editing an Association Relationship Instance
The detailed information of the selected association relationship instance is displayed in the right panel. You can create, edit, and delete a participant instance in the Association panel. The association relationship has only two participants. One participant is the anchor participant that is displayed in the left panel and the detailed information of the anchor participant is displayed in the upper Information panel; the other associated participant is displayed in the lower Association panel, as shown in Figure 18.
Figure 18 Association Panel
Manage an association relationship as follows: • To add a new participant instance for the associated participant, click the button. See Adding a Participant Instance on page 40 for more details. • To delete a participant instance from the selected relationship instance, select the participant instance and click the button. • To edit a participant instance, select a participant instance and click the button to edit it in the displayed Edit page. • To reverse the positions of two participants, click the button. Once you click this button, the participant displayed in the Association panel will be displayed in the left panel, the detailed information will be displayed in the Information panel, and the anchor participant in the left panel will be listed in the Association panel.
The reverse operation temporarily changes the anchor participant in the current page. But the anchor participant is not changed in server. If you refresh the current page, the anchor participant is still the original one. To change the anchor participant, see Changing the Display Field for Anchor Participant on page 44.
The corresponding entity is updated accordingly when editing the participant instance.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Setting Up Favorite Relationships | 37
Setting Up Favorite Relationships
In the Association Relationship Management pages, the (Manage labels and favorites) button in the menu allows you to change the display name of relationships and set up your favorite relationships. Once clicking the button, the Manage labels and favorites dialog is displayed, as shown in Figure 19.
Figure 19 Manage Labels and Favorites Dialog
The relationships are displayed in alphabetical order. An alphabet bar is located on the left side where you can click the corresponding letter to look up the relationship that starts with the selected letter. Edit the association relationships in the Manage labels and favorites dialog as follows: • To change the display name of a relationship, enter a new name in the text field. Note: Only the system administrator has the permission to change the relationship name. • To set one or more relationships as favorites, click the icon. Once a relationship is set as a favorite, the icon is highlighted with yellow.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 38 | Chapter 5 Managing Association Relationships
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 39
Chapter 6 Managing Participants
This chapter introduces how to manage the participants in an identity relationship or an association relationship.
Topics
• Adding a Participant Instance, page 40 • Changing Display Field and Setting Up Anchor Participant, page 43
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 40 | Chapter 6 Managing Participants
Adding a Participant Instance
When adding a new participant instance for an identity relationship instance or an association relationship instance, the operations done in the New Participant Instance dialog are the same as described in this section. After clicking the button in the right panel, the New Participant Instance dialog is displayed, as shown in Figure 20.
Figure 20 New Participant Instance Dialog
Two options are available to add a new participant instance: • Create a new entry Create a new entity instance to add to the relationship instance. See Creating a New Entry on page 41 for more details. • Choose from existing entries Select an existing entity instance to add to the relationship instance. See Choosing From Existing Entries on page 41 for more details
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Adding a Participant Instance | 41
Creating a New Entry If Creating a new entry is selected and the defined fields are listed, as shown in Figure 21.
Figure 21 Creating a New Entry
To create a participant instance: 1. Enter values in the corresponding text fields. The displayed items are the fields defined when building the ER Model. 2. Click the Save button to create a new participant instance.
If the field is followed by a word key in red, it means that the field is the key field. Otherwise, the field is the non-key field. Also, a field followed by an asterisk (*) means that the field is required. You must provide a value for it. The creation of an entry equals to the creation of an entity.
Choosing From Existing Entries If Choose from existing entries is selected, a search panel is displayed, as shown in Figure 22.
Figure 22 New Participant from Existing Entries
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 42 | Chapter 6 Managing Participants
To add an existing participant instance: 1. Enter the search criteria in the Narrow your search by panel to narrow your selections. This step is optional. 2. Click the Search button. All the existing entity instances are displayed in the Then select a result panel based on the given information if there is any. The first 20 entity instances are displayed in the right panel. You can slide the scrollbar to view more. 3. Click the entity instance in the list and click the Select button to create a relationship instance. Note: For identity relationships, the entity instances that have been added to another identity relationship instance cannot be selected and they are grayed out.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Changing Display Field and Setting Up Anchor Participant | 43
Changing Display Field and Setting Up Anchor Participant
In the Identity and Association Relationship Management pages, the (Manage Participants) button in the menu allows you to change the display name of participants, set anchor participants, and change the display field of the anchor participant.
Only the system administrator has the permission to edit the participants.
To edit the participants in the relationship: 1. Changing the Display Name and Setting the Anchor Participant, page 43 2. Changing the Display Field for Anchor Participant, page 44
Changing the Display Name and Setting the Anchor Participant To change the display name and set the anchor participant: 1. Click the button on the upper-right corner on the corresponding Relationship Management page. The Edit Participants dialog is displayed, as shown in Figure 23. See Table 2 about the information displayed in the Edit Participants dialog.
Figure 23 Editing Participants Dialog
2. Type the display name of the participant in the Display Name field. 3. Click Anchor to set the corresponding participant as the anchor participant. See Entity and Anchor Participant on page 64 for more details about anchor participants. 4. Click the Next button to continue.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 44 | Chapter 6 Managing Participants
5. Change the display field for the anchor participant. See Changing the Display Field for Anchor Participant on page 44 for details. 6. Click the Back button to go to the previous page or click the Save button to save your settings.
Table 2 Editing Participants Column Description System Name Displays the name of the participant defined when building the ER model.
Display Name Displays the name of the participant to use in the SmartMapper EPS Business UI.
Total Records Displays the number of participant instances.
Set Anchor Clicks to set the corresponding participant as the anchor participant.
Changing the Display Field for Anchor Participant In TIBCO Designer, an entity can be configured with one or more key fields and non-key fields. When the SmartMapper EPS Business UI server is started, the system randomly sets a pre-defined field as the display field. The first line displays the value of the display field and the value is bolded; the second line displays the values of all the defined key fields. The Change Display Field dialog is displayed after Changing the Display Name and Setting the Anchor Participant, as shown in Figure 24. The Available display fields panel shows the fields that can be set as display field and the Selected display fields panel shows the fields that have been selected as the display field.
If the entity only has only one key field defined, the field is selected as the display field by default and cannot be removed.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Changing Display Field and Setting Up Anchor Participant | 45
Figure 24 Changing Display Field for the Anchor Participant
To change the display field for the anchor participant: 1. Select one or more fields in the Available display fields panel, and then click the Add button. The selected field is added to the Selected display fields panel. 2. Use the Move Up and the Move Down buttons next to the Selected display fields panel to arrange the order of the display field. Similarly, select a field in the Selected display fields panel, and then click the Remove button to remove the selected field from the display field list.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 46 | Chapter 6 Managing Participants
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 47
Chapter 7 Managing Entities
This chapter explains how to manage entities.
Topics
• Entity Management Page Overview, page 48 • Creating an Entity Instance, page 49 • Changing Display Field, page 50 • Setting Up Favorite Entities, page 51
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 48 | Chapter 7 Managing Entities
Entity Management Page Overview
After selecting an entity under the Entity tab from the menu, you are brought to the Entity Management Page, as shown in Figure 25.
Figure 25 Entity Management Page
The Entity Management page is also divided into two panels: • Left Panel lists all the entity instances of the selected entity. Manage the entities as follows: — To delete one or more entity instances, select the corresponding check boxes and click the Delete button at the top of the left panel. You can also delete an entity instance by directly clicking the button in the right panel. Note: The entity instances that have been added in a relationship cannot be deleted. — To create an entity instance, click the Create button at the top of the left panel. See Creating an Entity Instance on page 49 for more details. • Right Panel displays the detailed information of the selected entity instance. By default, the first item in the left panel is selected.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Creating an Entity Instance | 49
Creating an Entity Instance
To create an entity instance: 1. In the Entity Management page, click the Create button at the top of the left panel. The New Entity Instance dialog is displayed. 2. In the New Entity Instance dialog, enter values for the defined fields.
Note: If the field is followed in a word key in red, it means that the field is the key field. Otherwise, the field is the non-key field. The following asterisk (*) indicates that the corresponding field is required. You must provide a value for it. 3. Click the Save button to create an entity instance.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 50 | Chapter 7 Managing Entities
Changing Display Field
In TIBCO Designer, an entity can be configured with one or more key fields and non-key fields. When the SmartMapper EPS Business UI server is started, the system randomly sets a pre-defined field as the display field. The first line displays the value of the display field and the value is bolded; the second line displays the values of all the defined key fields.
Only the system administrator has the permission to change the display field for the entity.
To change the display field for an entity: 1. In the Entity Management page, click the button in the upper-right corner of the menu. The Change Display Field dialog is displayed. 2. In the Change Display Field dialog, the left Available Display Fields panel displays available fields that can be set as display fields; the right Selected Display Fields panel displays the fields that have been selected as the display field. — To select one or more fields as a display field, select one or more fields in the left panel and click the Add button. — To remove a display field from the display field list, select a display field in the right panel and click the Remove button. You can arrange the order of display fields by clicking the Move Up and Move Down buttons next to the right Selected Display Fields panel. 3. Click the Save button to save your changes.
If the entity has only one key field defined, the field is selected as the display field by default and cannot be removed.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Setting Up Favorite Entities | 51
Setting Up Favorite Entities
In the Entity Management page, the (Manage labels and favorites) button in the menu allows users to change the display name of the entities and to set up favorite entities. When you click the button, the Manage labels and favorites dialog is displayed, as shown in Figure 26.
Figure 26 Manage Labels and Favorites Dialog
Different from identity relationships and association relationships, entities are grouped under applications. The entities are displayed in a tree structure: the first level is the application level; the second level is the entity level. The applications are displayed in alphabetical order. An alphabet bar is located on the left side where you can click the corresponding letter to find the application that starts with the selected letter. Edit the entities in the Manage labels and favorites dialog as follows: • To change the display name of an entity, enter a new name in the text field. Note: Only the system administrator has the permission to change the entity name. The application name cannot be changed.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 52 | Chapter 7 Managing Entities
• To set the application or the entity as favorites, click the icon. Once an application or an entity is set as favorite, the corresponding icon is highlighted with yellow. Note: If an application is set as the favorite application, all the entities in the application are automatically set as favorite entities.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 53
Chapter 8 Managing Users and Permissions
This chapter explains how to manage the user account and user permissions as the system administrator. A system administrator is a user whose username is admin and has full permissions with all the relationships and entities. The username and the user role of the system administrator cannot be changed, which are defined by the system.
Topics
• Profile Management, page 54 • User Management, page 56 • Permission Management, page 59
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 54 | Chapter 8 Managing Users and Permissions
Profile Management
Profile Management allows users to view and update the account information. To view or update the account information: 1. Click the username link at the upper-right corner of home page. A menu is displayed, as shown in Figure 27.
Figure 27 User Management Menu
2. Select the Profile option. The Profile dialog is displayed.. 3. Update the account information according to the information listed in Table 3. Note: The asterisk followed after each item indicates that field is required. 4. Click the Save button to save your changes or click the Close button to exit.
Table 3 Profile Information Profile Items Description Username Displays the name of the user. Note: For a system administrator, the username is set as admin by default. The username cannot be changed.
First Name Displays the first name of the user.
Last Name Displays the last name of the user.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Profile Management | 55
Table 3 Profile Information (Cont’d) Profile Items Description Email Displays the email of the user. The email address specified here is used to receive the email containing the password when you forget your password.
Users Role Displays the role of the user. A user role determines which entity or relationship a user has permissions for as well as what the permissions are. For more details, see Permission File on page 60. Note: Only the system administrator has the permission to change the user role for a user. The system administrator has the administrator role assigned by default with full permission, which cannot be changed.
Password Enters a new password if you want to change the password.
Note: Special symbols are allowed. The password must contain 8 characters at least and cannot exceed 16 characters.
Confirm Password Enters the new password again.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 56 | Chapter 8 Managing Users and Permissions
User Management
User Management allows a system administrator to manage users using the SmartMapper EPS Business UI.
The User Management option is available only when the login user is the system administrator.
To manage SmartMapper EPS Business UI users: 1. Click the admin link in the upper-right corner of home page. A menu is displayed. 2. Click the User Management option. The User Management dialog is displayed, as shown in Figure 28.
Figure 28 User Management Dialog
3. Do as follows to search, add, delete, and edit a user: — Enter the username of the user that you want to search in the search field and the user matching with entered username is displayed. — Click the button next to the search field to add a user. See Adding a User on page 57 for more details. — Click the button to edit the corresponding user. The username cannot be changed. — Select the check box before the username and the button is displayed. Click the button to delete the selected users. The admin user cannot be deleted. 4. Click the Close button to exit.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide User Management | 57
Adding a User The system administrator has the permission to add SmartMapper users. By assigning the user with the corresponding user role, the user only has designated permissions for specified entities and relationships. To add a user: 1. Click the button in the User Management dialog. The Add New User dialog is displayed. 2. Enter the user information listed in Table 4 in the corresponding text fields. 3. Click the Save button to add a user and click the Back button to go back to the User Management dialog.
Table 4 Adding a User User Information Description Username Enters the username of the user. See Guidelines for Defining Username on page 58 for the rules applied for the username.
First Name Enters the first name of the user.
Last Name Enters the last name of the user.
Email Enters the email of the user.
User Role Selects a role for the user from the role list. A user role determines which entity or relationship a user has permissions for as well as what the permissions are. All the user roles are defined in the permission file. For more details, see Permission Management on page 59. Note: Only the system administrator has the permission to change the user role for a user. The system administrator has the administrator role assigned by default with full permission, which cannot be changed.
Password Enters the password of the user.
Note: Special symbols are allowed. The password must contain 8 characters at least and cannot exceed 16 characters.
Confirm Password Enters the password again.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 58 | Chapter 8 Managing Users and Permissions
Guidelines for Defining Username The following rules must be applied for the username: • The username must begin with the alphanumeric character. • The username cannot contain any special symbols except for the underscore (_).
• The username must contain 3 characters at least and cannot exceed 15 characters.
• The username cannot be admin.
• The username is not case-sensitive. If a user with the name ABC already exists, you cannot add a user with the name abc.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Permission Management | 59
Permission Management
Permission Management allows a system administrator to upload a new permission file and export the permission file currently in use.
This option is available only when the login user is the system administrator.
A permission file contains the user roles to be assigned to the SmartMapper EPS Business UI users. See Permission File on page 60 for more details. To upload or export a permission file: 1. Click the admin link at the upper-right corner of the home page. A menu is displayed. 2. Click the Permission Management option. The Permission Management dialog is displayed, as shown in Figure 29.
Figure 29 Permission Management Dialog
3. Do as follows to upload and export a permission file: —Click the Choose File button to navigate to the location in which the permission file resides and click the Upload button to load the selected permission file. The uploaded file is stored in the SmartMapper_HOME\admin\config\system\permissions_upload_fol der directory. The SmartMapper EPS Business UI will be refreshed automatically after the permission file is uploaded. The permission of the system administrator will not be changed after loading the permission file. Note: The permission file to be loaded must be in XML format. The permission file cannot contain non-existing relationships, applications, and entities. Otherwise, the permission file cannot be loaded. —Click the Export button to export the permission file currently in use. 4. Click the Close button to exit.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 60 | Chapter 8 Managing Users and Permissions
Permission File
A permission file, role_permissions.xml, is automatically generated in the SmartMapper_HOME\admin\config\system directory, after starting the SmartMapper EPS Business UI server. The permission file is used to manage user roles. A user role is a collection of permissions defined for entities and relationships. A predefined user role can be assigned to the SmartMapper EPS Business UI users. In this way, the user only has the permissions defined in the assigned user role. A user role determines which relationship or entity the user has permissions for and what the permissions are.
A commonuser role is created by default, which has the write permission for all entities and relationships, as shown in Figure 30.
If the ER Model is synchronized after the SmartMapper EPS Business UI server is started, the newly added relationships and entities have no permission assigned by default. Also, for the common users, the newly added relationships and entities are invisible. The system administrator needs to change the permission for each added relationship and entity in the permission file, and then load the permission file.
Figure 30 Permission File
Adding a User Role To add a new user role:
1. Navigate to the SmartMapper_HOME\admin\config\system directory and locate the role_permissions.xml file.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Permission Management | 61
2. Open the role_permissions.xml file. 3. Add a user role node under the root node as follows. See Table 5 for descriptions of attributes.
Table 5 Attributes in the Permission File Attributes Description name The name of the user role, relationship, application, or entity.
Note: The name of the user role cannot be administrator. The administrator role is created by default, which is assigned to the system administrator.
description A brief description for the user role.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 62 | Chapter 8 Managing Users and Permissions
Table 5 Attributes in the Permission File (Cont’d) Attributes Description permission The permission assigned to each entity, application or relationship.
The valid values are: W, R, and N. The values are not case-sensitive.
• W represents the write permission. The element defined with this permission can be viewed, created, deleted, and updated by the user who is assigned this role.
• R represents the read permission. The element defined with this permission can be viewed by the user who is assigned this role.
• N represents no permission. The element defined with this permission will not be displayed for the user who is assigned this role. Note: If no value is entered, no permission is assigned by default.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 63
Appendix A Anchor Participants and Relationship Types
This chapter explains entity, anchor participant, and relationship types.
Topics
• Entity and Anchor Participant, page 64 • Relationship Types, page 65
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 64 | Appendix A Anchor Participants and Relationship Types
Entity and Anchor Participant
This section provides you with a brief introduction to the entity and anchor participant.
Entity An entity represents something that is being represented, such as a customer record. In most cases, an entity is a proxy for an object. It contains the necessary information to retrieve or identify the object. Entities are composed of one or more attributes. Entities are created and grouped logically in Application folders like SAP, Oracle, and Siebel. Once created, entities are placed in relationships to form participants. An entity represents a complete key to the object. This is the case whether the entity contains one or many attributes, and whether those attributes are keys or values.
Anchor Participant Because a relationship may have many participants, one of the participants must be set as anchored to represent this relationship. That is, an anchor participant represents a relationship and the instances of the anchor participant represent the relationship instances of this relationship. By default, the anchor participant is set by the system randomly. An anchor participant is listed in the left panel and the circle representing the anchor participant is filled in blue in the right panel. See Changing the Display Name and Setting the Anchor Participant on page 43 for more details about setting up an anchor participant. For example, an Order relationship has three participants. One is OAG_SalesOrder, one is SAP_Order, and one is Siebel_SalesOrder. The OAG_SalesOrder is set as the anchor participant, therefore, the OAG_SalesOrder participant is used to represent the Order relationship and the participant instances listed in the left panel represent the relationship instances in the Order relationship.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide Relationship Types | 65
Relationship Types
A relationship is a collection of entities that a user wants to bind together in a particular way. Once an entity participates in a relationship instance, it can be used for cross-referencing. Relationships can be divided into the following two types: • Identity Relationship models a relationship of entities across different applications. • Association Relationship models a relationship between two typically orthogonal entities or of the same entity. The association relationship is quite different from the identity relationship. An association relationship describes a relationship between participants that belong to two different kinds like customer and order; while an identity relationship describes a relationship of participants that belong to a same kind from different systems like the order ID in different systems.
Identity Relationship All participants are peers in this relationship. It is used to keep the corresponding keys of different applications. For example, after a company merger involving several applications, you are given the task to create a cross-reference of keys for three data file dumps, one for SAP, one for Siebel, and one for Oracle. A particular customer may be in one or more of the applications, as shown in Table 6. Table 6 Identity relationship: Customer Record
SAP_Customer Siebel_Account Oracle_Customer A 1 1243 J
B 2 1222 K
C 3 1433 L
D 4 4123 M
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 66 | Appendix A Anchor Participants and Relationship Types
Association Relationship This kind of relationship can have two and only two participants. They can be used to model a relationship of two typically orthogonal entities, like teacher and class as shown in Table 7; or a relationship of the same entity, like a part-subpart containment relationship.
Table 7 Association Relationship Teacher Class (grade, class number) Jody 2 1
Jody 2 2
Dover 2 1
Dover 1 1
McDonald 1 2
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide | 67 Index
A E alphabetical order 51 edit an association participant instance 36 anchor participant 64 edit an identity participant instance 29 set anchor participant 43 association relationship 66 association relationships edit an identity relationship instance 36 H asterisk 26 home page of the SmartMapper Business UI 12
B I blue circle 23 identity relationship 21, 65 identity relationships create an identity relationship instance 22, 25 C delete an identity relationship instance 22 edit an identity relationship instance 29 changing the display name of the participant 43 configuration file 4 email settings 4 JDBC database 4 L session timeout settings 4 create an identity participant instance 29 left panel overview 16 create an identity relationship instance log out 14 add participants 27 login choose from existing entries 25 forgot the password 8 create a new entry 25 remember me 7 login SmartMapper Business UI configuration file 4 start server 6 D stop server 10 delete an association participant instance 36 delete an identity participant instance 29 display field 17 changing display field 44, 50
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 68 | Index
M S
manage entities 47 setting up favorite relationships 45 creating an entity instance 49 start server 6 setting up favorite entities 51 stop server 10
N T
number 17, 23 total records 44
O U
order of the participant 24 user guide 13 user management 14, 56 add a user 57 delete a user 56 P edit a user 56 search a user 56 permission file 60 user profile 14 adding a user role 60 permission management 14, 59 export a permission file 59 permission file 60 upload a permission file 59 product information 13 profile management 54 users role 55
Q
quick tips 14
R
reverse the positions of two participant 36
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 69 | TIBCO Product Documentation and Support Services TIBCO Product Documentation and Support Services
For information about this product, you can read the documentation, contact TIBCO Support, and join the TIBCO Community.
How to Access TIBCO Documentation Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainly in HTML and PDF formats. The TIBCO Product Documentation website is updated frequently and is more current than any other documentation included with the product.
Product-Specific Documentation The following documentation for this product is available on the TIBCO ActiveMatrix BusinessWorks™ SmartMapper page. • TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Release Notes • TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Installation • TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server User’s Guide
Other TIBCO Product Documentation When working with TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server, you may find it useful to read the documentation of the following TIBCO products: •TIBCO Designer™ • TIBCO Administrator™ • TIBCO ActiveMatrix BusinessWork™ •TIBCO Rendezvous® • TIBCO Enterprise Message Service™ •TIBCO Hawk®
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 70 | TIBCO Product Documentation and Support Services
How to Contact TIBCO Support Get an overview of TIBCO Support. You can contact TIBCO Support in the following ways: • For accessing the Support Knowledge Base and getting personalized content about products you are interested in, visit the TIBCO Support website. • For creating a Support case, you must have a valid maintenance or support contract with TIBCO. You also need a user name and password to log in to TIBCO Support website. If you do not have a user name, you can request one by clicking Register on the website.
How to Join TIBCO Community TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matter experts to share and access their collective experience. TIBCO Community offers access to Q&A forums, product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, and tools that extend and enable customers to gain full value from TIBCO products. In addition, users can submit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, visit TIBCO Community.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide 71 | Legal and Third-Party Notices Legal and Third-Party Notices
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, the TIBCO logo, the TIBCO O logo, TIB, Information Bus, TIBCO ActiveMatrix BusinessWorks, TIBCO Designer, TIBCO Runtime Agent, TIBCO Administrator, TIBCO Rendezvous, TIBCO Hawk, and TIBCO Enterprise Message Service are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle Corporation and/or its affiliates. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. This software may be available on multiple operating systems. However, not all operating system platforms for a specific software version are released at the same time. See the readme file for the availability of this software version on a specific operating system platform. THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer to TIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details. Copyright © 1999-2021. TIBCO Software Inc. All Rights Reserved.
TIBCO ActiveMatrix BusinessWorks™ SmartMapper Enterprise Server Business UI User’s Guide