Chapter 3   Managing Data


This chapter describes how to use the Management Console and the Repository Browser to manage and view your data.

This chapter contains information about the following topics:

• The Management Console

• The Repository Browser

The Management Console

---

Each connector has an interactive Management Console Tool. The Management Console is typically used by the data source administrator and consists of two groups of functions:

• Tasks that are used to process data and functions from Enterprise System metadata:
  • data mining

  • creating and editing new data sources

• User management that establishes relationships between the web and back-end users.

To Start the Management Console from Windows NT

• Select Start>Programs>iPlanet Application Server 6.0>PEOPLESOFT Connector 6.0- Management Console.

To Start the Management Console from Solaris

1. Enter the following directory:

   cd <iPlanet>/ias/APPS/bin

2. Enter the following command:

   psftconsole.sh

Figure 3-1    PeopleSoft Management Console

Management Console Functions

The Tasks tab is used to perform the following tasks:

• Data Mining

• Create New Data Source

• Edit Data Source

The PeopleSoft User Mapping Management tab is used to perform the following task:

• Mapping User Privileges

The Mapping User Privileges function enables you to group users by mapping web-users to PeopleSoft users.

The Data Mining Tool

The Data Mining Tool uses a common cross-platform format, eXtensible Markup Language (XML), to populate the repository by taking back-end information and converting it to XML. The XML is then stored in the UIF Repository in a specific structure. See Figure 3-2.

Figure 3-2    Mining Tool

The Data Mining Tool enables you to examine or analyze data and extract functions and parameters from the back-end system. The iPlanet Application Server user can then utilize (call) these functions. The elements of the Data Mining Tool are shown in Figure 3-2.

Figure 3-3    Data Mining Elements

The Data Mining Tool uses a search criteria to query the PeopleSoft system. You then select a function or multiple functions to be mined. Based on your search criteria, data is extracted from the PeopleSoft system, converted to XML file(s), and loaded into the data repository.

Data Mining Processes

The following lists the processes that are part of the Data Mining Tool:

• Choosing the Data Source

• Choosing and Converting the PeopleSoft Message Definition

Accessing the Data Mining Tool

The Data Mining Tool in the iPlanet Application Server Enterprise Connector for PeopleSoft is accessed through the Management Console.

To Start the Data Mining Tool

1. Enter the PeopleSoft Management Console as described in The Management Console.

2. In the Tasks tab, select the Data Mining icon. Figure 3-4 is displayed.

Figure 3-4    Choose Data Source Window

Choosing the Data Source

The data source contains all the information needed to connect to the PeopleSoft system, and stores all the function objects.

To Choose the Data Source

1. Select the data source from the list.

   For information about the data source that the Data Mining Tool accesses, click Details.

2. If you do not want to view the data source details, continue to Editing a Data Source.

DataSource Details
The DataSource Details window contains a description of the data source as seen in Figure 3-5.

Figure 3-5   

DataSource Details Window

The DataSource Details window contains information in read only view.

Table 3-1 lists and defines fields in the DataSource Details window.

Table 3-1    DataSource Details Window

Parameter	Definition
Database Login Name	Login name for the database.
Database SID	Database special identity number.
Database Host	Name of the computer where the database host is located.
Database Port	Database port that is listening.
PeopleSoft User Name	User name assigned by the PeopleSoft administrator for the PeopleSoft system.
PeopleSoft Host Address (name:port)	The name of the computer where PeopleSoft system resides, and the port number.

The Query Results window appears as in Figure 3-6.

Choosing and Converting the PeopleSoft Message Definition

The Query Results window lists the activity name and the input name of the PeopleSoft Message Definition as seen in Figure 3-6.

The following procedure converts the PeopleSoft Message Definition to an XML file and loads it into the repository.

Figure 3-6    Query Results Window

To Choose and Convert the PeopleSoft Message Definition to an XML File and Load it to the Repository

1. From the Query Results window highlight an Activity Name or Input Name (multiples allowed).

2. Click Convert.

   The following activities occur:

   • the selected names are loaded into the repository

   • an XML file is created

Creating a New Data Source

The data source contains all the information needed to connect to the PeopleSoft system, and stores all the function objects. In addition, the data source determines which system to mine, and where to place the function objects.

To Create a New Data Source

1. On the PeopleSoft Management Console, click the Create New Data source icon to display the Create New Data Source details window as seen in Figure 3-7.

Figure 3-7    Create New Data Source dialog box

The Create New Data Source dialog box contains data source details parameters, see Table 3-1, that can be edited. For a description of the parameters see DataSource Details.

2. Change the values as necessary and click OK.

   A new data source is created and a message displays informing you that must restart the Management Console to use the newly created data source. See Figure 3-8.

Figure 3-8    New Data Source Information Message

3. Click OK, and manually restart the Management Console.

Editing a Data Source

This option is used to edit an existing data source.

To Edit a Data Source

1. Click the Edit Source. Figure 3-9 is displayed.

Figure 3-9    Choose Data Source

2. Select the Data source and click OK. The Data Source Details window is displayed as shown in Figure 3-10.

Figure 3-10    Edit Data Source Window.

3. Type changes in the text boxes and click OK.

   The changes are made in the repository.

4. Restart the Management Console.

Mapping User Privileges

The PeopleSoft User Management function enables the administrator to assign access privileges to the back-end system. There are two separate user identity domains: Web users and Enterprise System users. An incoming request has a specific web user identity associated with it. The web identity needs to be mapped to a PeopleSoft user identity specific to the data source.

The mapped web identity is passed between client and server, which the connector then uses for interaction with PeopleSoft.

The user mapping service maintains user mapping tables. There are two distinct tables:

• Enterprise System user identities

• Web to Enterprise System mappings

The mapping service provides the connector with methods to determine the Enterprise System identity, given a web-identity, as per the mapping tables opened using the Management Console. The Enterprise System user table is populated using the Data Mining Tool in the Management Console. The data source administrator can populate the user mapping table interactively, through the Management Console.

To Perform User Mapping

1. From the PeopleSoft Management Console window, click the User Mapping Management tab. See Figure 3-11.

Figure 3-11    PeopleSoft User Mapping Management window.

2. Click on the User Mapping node. Figure 3-12 is displayed.

Figure 3-12    PeopleSoft User Mapping Management Tab

The tree view represents the general topics available. The browser view displays the details of the node selected. The Choose Data Source Window is displayed.

3. Select a data source.

   The Web and Entity Information appear for the selected data source.

Using the Web User Information area you can:

• Add a new user

• Change a user

• Delete a user

Using the Entity Information area you can:

• Add a new entity

• Change an entity

• Delete an entity

To save your changes, click Save.

---

Note	The Save feature saves the information to the repository for both tabbed panes.

---

Web User Information

The Web User Information area is used to map a web user identity to a back-end user identity. The administrator assigns an entity name for the web users. The Web ID is used by the server to enable users to move freely across multiple systems. The administrator assigns Entity Information prior to the Web User Information, since the web user must be mapped to an entity.

Table 3-2 lists and defines fields in the Web User Information area. See Figure 3-13.

Table 3-2    Web User Information Parameters

Parameter Name	Definition
Web ID	ID assigned to users on the system.
Entity Name	Name of the assigned back-end user. The naming convention is dependent upon the database type used.

To Add a Web User

1. Click New User.

   The Web User Information window is displayed. See Figure 3-13

Figure 3-13    Web User Information Window

2. Type in the Web ID.

3. Select an Entity Name from the available names.

4. Click OK when finished to return to the main window.

To Change a Web User

1. Click Change User.

   The Web User Information window appears. See Figure 3-13.

2. Edit the desired field.

3. Click OK when finished to return to the main window.

To Delete a Web User

1. Select the web user.

2. Click Delete.

   The web user is deleted and you are returned to the main window.

Entity Information

The Entity Information area is used to list the following data about backend entities assigned to the web users:

Table 3-3    Entity Information

Parameter	Definition
Backend User Name	Name of the backend user.
Backend Password	Backend password, assigned by the user.
Entity Name	Backend entity name, assigned by the system administrator.

To Add an Entity

1. To add a new backend entity, click New Entity.

   The Entity Information window appears. See Figure 3-14.

Figure 3-14   

Entity Information Window

2. Enter the entity information.

3. Click OK.

   The Entity Information appears. See Figure 3-15.

Figure 3-15    Entity Information/Connection Pools Information Window

4. Enter the Connection Pools information.

   Table 3-4 lists and describes the fields in the Connection Pools area.
   

   Table 3-4    Connection Pools 
   
   

   Parameter	Definition
   Entity	Name of the entity regarding this pool.
   Debug Level	(Optional) Determines type of message logging, as described by the following choices: 0: Logging turned off. 1: Logs only callback messages. 2: Logs all messages.
   Max Pool Size	Maximum number of connections in the pool.
   Max Wait	Maximum interval time set that the connection pool waits in between connections.
   Monitor Interval	Time period set between monitoring the connection pool.
   Steady Pool Size	The desired number of connectors available at any one time.
   Unused Max Life	Time interval set for an unused connection. When the set time has elapsed, the connection is closed.

5. Click OK to return to the main window.

6. Enter the Entity information and click OK.

   The new entity information appears in the Entity Information area.

To Change Entity Information

1. Click Change Entity.

2. Edit the desired field(s).

3. Click OK.

   The edited entity is displayed in the Entity Information area of the window.

To Delete an Entity

1. Select the entity.

2. Click Delete.
   

   ---

   Note	You cannot delete an entity that has associated web users. Change or delete the web users before trying to delete an entity.

   ---

   
   

When you have completed all actions in the Entity Information window, click Save. All your additions and changes are saved to the system.

Connection Pools

The PSFT Connection Pools option in the PeopleSoft User Management function allows the administrator to change the pooling configuration for entities. See Figure 3-16.

Figure 3-16    PeopleSoft Management Console Connection Pools Information

Table 3-5 lists and describes the Connection Pool Parameters:   

Table 3-5     Connection Pool Parameters

Parameter	Description
Entity	Name of entity for whom these parameters apply.
Max Pool Size	Maximum number of connections in the pool.
Max Wait	Interval time set that the connection pool waits in between connections.
Monitor Interval	Time period set between monitoring the connection pool.
Steady Pool Size	The desired number of connectors available at any one time.
Unused Max Life	Time interval set for an unused connection. When the set time is elapsed, the connection is closed.
Debug Level	Determines type of message logging, as described by the following choices: 0: Logging turned off 1: Logs only callback messages. 2: Logs all messages.

 

See Chapter 4 for more information about pooling.

To Change Pool Parameters

1. On User Mapping Management Tab, click on the PSFT Connection Pools node.

2. Click on any cell; the row is automatically selected, or click Change Pool.

   The Entity Information/Connection Pools Information is displayed as in Figure 3-15.

3. Edit the parameter(s) and click OK to return to the PSFT Connection Pools window in the PeopleSoft Management Console as seen in Figure 3-16.

4. Click Save in the Management Console window.

The Repository Browser

---

All the definitions for the connector using the Management Console are saved in a repository. The Repository Browser is the Graphical User Interface to the repository and is used only for viewing information about the connector. Most management tasks are done using the Management Console.

The Repository Browser contains the following:

• information representing the connection to the back-end system

• all the function objects that you mine from the back-end system

• user mapping information

• connection pools

All of these components are part of a data source.

Although the repository service does not impose any specific organization (schematics) on the repository contents, the UIF runtime requires the contents of the repository to be organized in a specific and well defined way. This organization is the UIF repository schematics. The UIF runtime expects specific information in specific places in the repository hierarchy. Therefore, repository contents are not supposed to be arbitrarily modified by the user. Contents are modified as part of the specific administration activities controlled by the Management Console, which allows the administrator to use the import and export functions appropriately. In addition, the UIF runtime service runs a consistency check on repository contents at startup.

Repository Browser Functions

The following functions are available in the Repository Browser:

• Import — allows you import XML files into the repository

• Export — allows you export XML files from the repository

• Delete — deletes nodes from the data structure in the repository

• Refresh — refreshes the Repository Browser display

• Import Root — imports an XML file and creates the root node

Loading Data Into the Repository Browser

There are two ways to load data into the Repository Browser. You can either load the data automatically into the Repository Browser via the Management Console, or you can manually load the XML file using the Import function.

To Access the UIF Repository Browser from Windows NT

• Select Start > Programs> iPlanet Application Server > iAS UIF 6.0 Repository Browser

  The Repository Browser is displayed. See Figure 3-17.

To Access the UIF Repository Browser from Solaris

1. Enter the following command line:

   cd iplanet/ias6/ias/APPS/bin

2. Enter the following:

   ./bspbrowser.sh

   The Repository Browser is displayed. See Figure 3-17.

Figure 3-17    Repository Browser

The Repository Browser is divided into two panes. When you open the browser the left pane displays nodes containing the adapter (connector) types and data sources. These nodes are hierarchical and can be expanded to show details of the data structure and function objects. The right pane displays the properties of the node selected in the left pane.

For a more detailed description of the node contents, refer to the iPlanet Application Server Enterprise Connector for PeopleSoft Developer's Guide.

The Repository Data Structure

The Repository Browser contains the following nodes that are installed automatically when you install the UIF:

• adapterTypes

• dataSources

adapterTypes

The adapterTypes node contains a default data structure for each type of connector that is installed. The adapterTypes section contains one subtree entry per adapter. The entry contains common definitions, which form the basis for defining data sources on the connector.

dataSources

The dataSources node contains a default dataSource structure that is set when you install a connector. You can define several data sources for each adapterType. The dataSource section contains subtree entries, each of which is a logical UIF data source. A data source corresponds to a specific back-end Enterprise System and is supported by the corresponding adapterType.

The data source definition activity is tightly controlled by the Management Console. There are two distinct user roles: the data source administrator and the application developer. The data source administrator is responsible for creating and administering data source entries, while the application developer develops applications that access these data sources.

A data source definition is usually heavily pre configured by the data source administrator. The application developer usually uses pre configured function objects, much like EJBs would be used with the deployment descriptor already set. This substantially isolates the application developer from the back-end specific interaction issues. See the iAS Enterprise Connector for PeopleSoft Developer's Guide for more information about programming applications.

To Import XML Files

1. Select Import.

Figure 3-18 is displayed.

Figure 3-18    Import Database Window

2. Enter the XML filename that you want to import and click OK.

To Export XML Files

1. Select Export.

   Figure 3-19 is displayed.

Figure 3-19    Export DataBase Window

2. Enter the XML filename that you want to export and click OK.

To Delete Nodes

1. Select Delete.

2. Select the Node you want to delete.

   A warning message is displayed.

Figure 3-20    Delete Node

3. Click Yes or No.

   A status message appears as shown in Figure 3-21.

Figure 3-21    Repository Browser - Delete Status

The display in the Repository Browser is updated with current data.

To Refresh the Display of Repository Contents

• Click Refresh.

To Import the Root Node into the Repository Contents

1. Click Import Root.

   The Import Database window is displayed as shown in Figure 3-22.

2. Enter the XML filename to import and click OK.

   The root node and its contents are imported into the repository.

Figure 3-22    Import Root Window