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 and browse data and functions from Enterprise System metadata:
  • data mining

  • browsing archived XML files

  • creating new data sources

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

To Enter the Management Console from Windows NT

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

To Enter the Management Console from Solaris

1. Enter the following directory:

   cd <iPlanet>/ias/APPS/bin

2. Enter the following command:

   R3console.sh

Figure 3-1    R/3 Management Console

Management Console Functions

The Tasks tab is used to perform the following tasks:

• Data Mining

• Browse Archived XMLs

• Create New Data Source

• Edit Data Source

The R/3 User 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 R/3 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 that can be browsed when necessary. 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-3.

Figure 3-3    Data Mining Elements

The Data Mining Tool uses a search criteria to query the R/3 system. You then select a function or multiple functions to be mined. Based on your search criteria, data is extracted from the R/3 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

• Inputting Search Criteria

• Choosing R/3 Functions

Accessing the Data Mining Tool

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

To Enter the Data Mining Tool

1. Enter the R/3 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 R/3 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 Inputting Search Criteria.

Data Source Details
The Data Source 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 about the following:

• Back-end Character Set

• Default User Information

• Connection Parameters

• Pooling Parameters

The Back-end Character Set field is used to specify the character set the R/3 back-end server is using. The Back-end Character Set's default value is ISO_8859-1 (US-ASCII).

If you are running the iPlanet Application Server in International Mode and the back-end server's character set is not ISO_8859-1, set this parameter accordingly, otherwise use the default setting. When editing or creating a new data source, select the appropriate character set from the drop down list provided.

The following tables list and define fields in the DataSource Details Window:

The Default User Information area is used by the Management Console to connect to the R/3 system.

Table 3-1 Default User Information

Variable	Definition
Client	Client number.
User Name	R/3 user name.
Language	Language used by the Management Console. EN is English, DE is German. For other languages, consult the R/3 Guides.

The Connection Parameters area contains information needed to connect to the R/3 system. The system may be set up for Load Balancing (accessing different R/3 Servers) based on load or non-load balancing.

The parameters required for Load Balancing are indicated as such.

Table 3-2 Connection Parameters 

Variable	Definition
Host Name	R/3 Application Server Host Name.
System No	System number of the R/3 application server. Zero (0) is the default.
Gateway Host	The Host Name where the gateway services are running.
Gateway Service	The gateway service used by the host.
Msg Server	Host name of the R/3 Message Server as it is known by the iPlanet Application Server Enterprise Connector for R/3, or the R/3 router. (Used for Load Balancing.)
System Name	Name of the primary R/3 system that the iPlanet Application Server Enterprise Connector for R/3 communicates with. The name consists of three alphanumeric characters. (Used for Load Balancing.)
Group Name	Name of thelogon group which consists of a set of R/3 Application Servers for Load Balancing.
Load Balancing	To enable this parameter, click in the check box.
R/3 Trace	The R/3 Trace parameter is a diagnostic (debugging) tool in the R/3 software. Enabling this parameter influences software reaction intervals and generates a log file (dev_frc.trc). This log file aids in the debugging task. To enable this parameter, click in the check box.

The Pooling Parameters area describe the configuration of the R/3 connection pool. The parameters are set by the system administrator.

Table 3-3 Pooling Parameters

Variable	Definition
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 connections 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.
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.

Inputting Search Criteria

The Input window is used to enter in search criteria for choosing function names. You can enter function names with asterisks to be used as wildcards, for example BAPI* as seen in Figure 3-6.

To Input Search Criteria

• In the Input window, type in the search criteria and click OK.

Figure 3-6    Input Window

The Choose R/3 Function window displays. See Figure 3-7. The search criteria begins when you click OK.

Choosing R/3 Functions

The functions list contains all the function objects.

To Choose the R/3 Functions

Select the R/3 function or multiple functions to be activated from the list generated, as seen in Figure 3-7.

You can perform the following Data Mining tasks after you choose the R/3 function:

• Load into Repository (default)

• Save XML

• Archive XML

Figure 3-7    Choose R/3 Function

---

Note	When you load a selection(s) into a repository, you must select the Save XML check box to save the generated XML. The operation is finished when the progress indicator disappears. You can select one or multiple check boxes.

---

Load into Repository (default)
The Load into Repository option is used to load a function or multiple functions into the repository. An XML file is created and erased in the process. This option is the system default setting.

Save XML
This option is used to store a selected function, or multiple functions, in an XML file. The file can then be loaded into the repository.

Archive XML
This option is used to store a selected function, or multiple functions, as an XML file in zip format. The file can be loaded into the repository. The name of the default zip file is <data source name>.zip and is located under the following path: <root>/apps/archives.

To Archive the Functions

• Type in a file name or click Open to accept the default directory. See Figure 3-8.

Figure 3-8    Add Window

Several progress screens appear until the process terminates.

Browsing Archived XMLs

This option is used to view XML files that have been archived (zipped).

To Browse Archived XMLs

1. Click the Browse Archived XMLs icon to display a list of archived functions in zip format. See Figure 3-9.

Figure 3-9    Load Archived Functions Window

2. Select the required archive.

3. Click Open.

   The Choose Archive window is displayed.

Figure 3-10    Choose Archive Window

The Choose Archive window lists the name of the archived XML file and its path.

To load a function, highlight it and click Load. The function is then loaded into the repository.

Archiving Details

The Archive Details option enables you to view the XML file in a simple viewer.

To View an XML File for a Given Function

1. Select the function.

   The name of the XML file is the same as the name of the function.

2. Click Archive Details. The XML file is displayed as shown in Figure 3-11.

Figure 3-11    Typical XML File

Creating a New Data Source

The data source contains all the information needed to connect to the R/3 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 R/3 Management Console, click the Create New Data source icon to display the Create New Data Source details window, see Figure 3-12.

Figure 3-12    Create New Data Source Window

The Create New Data Source window contains fields for entering information about Creating the Data Source, Default User Information, Connection Parameters, and Pooling Parameters. For a description of these parameters see Data Source Details.

2. Enter new values are necessary and click OK.

   The 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-13.

Figure 3-13    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 Data Source icon to display the Choose Data Source window. See Figure 3-14.

Figure 3-14    Choose Data Source Window

2. Select the data source and click OK to display the Edit Data Source window, see Figure 3-15.

Figure 3-15    Edit Data Source Window

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

   The changes are made in the repository.

4. Restart the Management Console.

Mapping User Privileges

The R/3 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 an R/3 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 R/3.

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 R/3 Management Console window, click the R/3 User Management tab.

2. Click on the R/3 User Mapping node. Figure 3-17 is displayed.

Figure 3-16    R/3 User 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.

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-4 lists and defines fields in the Web User Information area:

Table 3-4 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-17.

Figure 3-17    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.

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 data about back-end entities assigned to the web users, as follows:

Table 3-5 Entity Information Parameters

Back-end User Name	Name of the back-end user.
Back-end Password	The Back-end Password, assigned by the user.
Entity	Back-end entity name, assigned by the system administrator.

To Add an Entity

1. To add a new back-end entity, click New Entity.

   The Entity Information window is displayed. See Figure 3-18.

Figure 3-18    Entity Information Window

2. Enter the Entity information.

3. Click OK.

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

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.

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 Repository Browser from NT

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

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

To Access the 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-19.

Figure 3-19    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 R/3 Developer's Guide.

The Repository Data Structure

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

• root node

• 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 iPlanet Application Server Enterprise Connector for R/3 Developer's Guide for more information about programming applications.

To Import XML Files

1. Select Import.

   Figure 3-20 is displayed.

Figure 3-20    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-21 is displayed.

Figure 3-21    Export DataBase Window

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

To Delete Nodes

1. Select Delete.

2. Select the Node you want to delete

   A warning message is displayed.

3. Click OK.

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

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

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