Milestone 3: Installing Topaz for Enterprise Data Client


Task 3.1 Install Enterprise Data Option on Topaz Workbench

Topaz Enterprise Data is a feature pack of Topaz Workbench. See Topaz Workbench Installation Guide for information about installing the Topaz Workbench feature packs.

Task 3.2 Install File-AID Rules Engine (FARE) for Topaz Enterprise Data

This section applies only if the optional File-AID Services server is installed. The version of the FARE being installed must match the version of File-AID Services intended to be used from Topaz.

  1. From the Topaz Enterprise Data media or RFN download, select the File-AID Rules Engine tab and then select Install File-AID Rules Engine for Windows.
  2. On the Introduction page, click Next
  3. Choose the default File-AID/EX installation folder or a separate folder and click Next.
    • The default option installs FARE in the directory <Topaz installation directory>\Enterprise Data\FARE.
    • If a separate folder is selected for FARE installation, an environment variable FARE_HOME can be manually defined and set to the FARE installation folder. In this scenario, multiple installations of Topaz can share the same installation of FARE.
  4. Click Install on the Pre-Installation Summary. 
  5. When installation is complete, click Done on the Install Complete screen.

Task 3.3 Set the Location for File-AID Services Server

This section applies only if the optional File-AID Services server is installed.

File-AID Services need to be defined in two places:

  • In Workbench Preferences, to define File Services server to be connected to from the client
  • In Local execution server preferences, to define which File-AID Services server to be connected when File-AID/EX specifications are executed on the local (embedded) execution server

To define File-AID Services to be used by Topaz Workbench 

  1. From the Window menu, select Preferences, expand Compuware, and select File-AID Services.
  2. Type the URL for your File-AID Services. An example URL is https://cwsserver.dnsname:3081.
  3. Click Test Connection.
  4. If you get a Connection Successful message, click Apply, click OK, and click OK again to return to Topaz Workbench.

To define File-AID Services to be used by Local Execution Server

  1. From the Compuware menu, select File-AID/EX to switch to the File-AID/EX perspective.
  2. From the Tools view’s Administration pane, select Homebase
  3. In Homebase, click dataPrivacyTemplate.jpg or, from the Tools menu, select Dynamic Data Privacy. The Dynamic Data Privacy dialog box appears.
  4. From the execution server drop-down list, select the execution server for which to set values. The drop-down list shows all available execution servers for the chosen repository. Initially, the only available execution server in this list is “LOCAL”. Make sure it’s selected from the drop-down list.
  5. In the File-AID Services field, enter or modify the value to indicate the server name or IP address of the File-AID Services server.
  6. In the File-AID Services Port field, enter or modify the value to indicate either https or http port number of the File-AID Services server. The default https value is 3081 and the http is 4180 and valid values are between 1 through 65535, as configured on the File-AID Services.
  7. Optionally, click Test to test the connection. A message indicates success or failure of the connection.
  8. Click Save. The values are saved in the DataPrivacy.properties file, which is located at <workspace>\.com.compuware.fileaid.ex\cfg.

Task 3.4 Enable Db2 JDBC Repository and Database Access Support 

Db2 JDBC support is not enabled by default, and JDBC drivers are not provided with the product.

  1. If <db2_installation_directory>\IBM\SQLLIB\ java directory is present, copy the db2jcc.jar file from the <db2_installation_directory>\IBM\SQLLIB\java to the <Topaz installation directory>\drivers folder.
  2. Copy the Db2 license file (db2jcc_license_cu.jar or db2jcc_license_cisuz.jar depending on platform) to the same directory where the driver was copied. 

    Important

    This must be done anytime the Db2 version is upgraded.

  3. Edit the repositoryJDBC.properties file (located at <workspace>\.com compuware.fileaid.ex\cfg) and uncomment the Db2 driver registration entry COM.ibm.db2.jdbc.app.DB2Driver.
  4. Stop the currently running local communication manager and local execution server. For details, see Shutting-Down-or-Restarting-Local-Execution-Server-and-Local-Communication-Manager. Db2 support should now be enabled.

Task 3.5 Check Out an Enterprise Data License

  1. From the Topaz Workbench Help menu, select 

    Topaz Workbench

     Licensing.

  2. If the Topaz Enterprise Data feature pack is listed, select it and click Check Out. If the license check out succeeds, the Lease Begin and Lease End dates are updated.

Task 3.6 Configure Data Privacy Feature

This step is needed only for clients that are going to use Data Studio’s Data Privacy feature.

Data Studio’s Data Privacy can be accessed from Topaz Workbench, which is Eclipse-based, allowing you to access data on the mainframe and database management systems (DBMS) from your PC or workstation.

Before you can work with the Data Privacy application you must perform some basic setup. To use translate tables, they must be created and appropriate credentials assigned. To use dynamic privacy rules with BMC Compuware's File-AID products, you must create a project with its associated data elements and project rules.

Task 3.6.1 Perform Basic Setup

The basic setup steps only need to be performed when you first install the Topaz Workbench or if your working environment changes.

  1. Start Topaz Workbench.
  2. From the Topaz Workbench Welcome window, click the Data Privacy icon, or from the Topaz Workbench menu, select Compuware > File-AID Data Privacy. This opens the Data Privacy Explorer view and shows the available repositories. If your Data Privacy Explorer pane is empty, click the Refresh icon to list your available repositories.
  3. Your Data Privacy Administrator must assign you a user role. The first time you start data privacy, if your role has not yet been assigned, you will receive a "No Roles" error message. Without a role assignment, you will be unable to perform any data privacy tasks. For a description of the default security roles, see “Manage Security” in the Data Privacy online help.
  4. If you wish to use a repository other than the default Derby repository that comes with File-AID Services, you must first create it. For instructions on how to do this, see “Manage Data Privacy Repositories” in the Data Privacy online help. To create a new repository, you need to be assigned the Compuware Data Privacy Global Resource Admin role or the Compuware Data Privacy Admin role. Other roles are not permitted to create new repositories.
  5. Before you can use data privacy for mainframe data, you must define a mainframe host in Topaz Workbench. For complete details for defining a host, see the Host Explorer online help. In general, to configure a new host, you must:
    1. Open the Host Explorer view.
    2. Right-click on Hosts and select Configure > Host Connections on File-AID Services from the list. The File-AID Services Connections dialog box appears.
    3. To configure a mainframe host, select the HCI tab, and click Add. The File-AID Services Administration dialog box appears.
    4. Enter the User ID and Password. Initially, the user ID is cwadmin and the password is the same, cwadmin. If you are the Administrator, the password should be changed by providing the new password of your choice.
    5. Click OK. The Host Connections dialog box appears.
    6. On the General tab, enter the Host, Port, and an optional Description.
    7. (optional) Select the Secure connection check box to enable an encrypted secure HCI connection. Then choose the encrypted protocol your mainframe is configured to use. Selecting Auto will cause Host Explorer to check to see what version of TLS or SSL you have.
    8. (optional) Select the Credentials tab which enables you to manage any credentials that you have saved for this host during Login.
    9. (optional) Select the Advanced tab to reveal additional parameters:
      • Read/write timeout (seconds) determines the amount of time Host Explorer will wait for a response from the HCI before timing out.
      • I/O trace level should be changed from the default of None only when directed by BMC Support.

    10. Click OK. You will return to the File-AID Services Connections dialog box. Your new mainframe host will now appear in the list of hosts.
    11. To add a new database connection, click the JDBC tab and click Add. The Database Connection dialog box appears.
    12. On the General tab, select the database type (IBM Db2 for Linux, Unix, and Windows; IBM Db2 for z/OS; Oracle; SQL Server; Sybase) from the list. Enter the database host, port number, location/SID, and an optional description if desired.
      • For Oracle you may also select a Connection Type (SID or Service name).
      • Optionally, you may select the Properties tab to define and manage any additional properties.
      • The Credentials tab is provided to enable you to manage any login credentials that you have saved for this database during Login.
    13. Click OK. You will return to the File-AID Services Connections dialog box. Your database connection will now appears in the database list.
    14. Click OK. You will return to Topaz Workbench.
    15. When you try to access a mainframe host or a database connection in the Host Explorer view, a login dialog box appears. Enter your login credentials. For the mainframe, enter your mainframe user ID and password. For a database, enter your database ID and password. You can now access only the information that you are authorized to access. For example, you will only be able to access those files that you can access if you were logged on to the mainframe or your database.
  6. A repository must be opened before you can create or select a Data Privacy project. To open a repository, double-click it or right-click and select Open Repository. This provides a list of projects within that repository that you can work with.

    Important

    If the repository you expected to see does not appear in the list, click Refresh. If you click Refresh, any open projects will be closed and any changes you have made during this session since the project was last saved will not be saved. A message box appears giving you the option to continue and lose changes or cancel.

  7. To create a new project (or your first project), see “Create a New Data Privacy Project” in the Data Privacy online help for complete details.

    Important

    Perspectives and views can be opened and closed as desired and windows can be repositioned within the display. When you exit Topaz Workbench, your current perspectives are saved. The next time you start Topaz Workbench, the same perspectives that were open when you exited will reopen.

Task 3.6.2 Create Credentials and Translate Tables

  1. Follow the procedure in the Create New Credentials topic in the Data Privacy online help for information on how to create new credentials. Credentials are required at disguise execution time to allow the disguise job to access the values stored in translate tables. FTranslate table definitions require credentials. The credentials can be created before defining the translate table or they can be added from within Manage Translate Tables. Credentials are created through Resource Administration, and you must be a Data Privacy Administrator or a Data Privacy Global Resource Administrator to create, delete, or modify credentials.
  2. Follow the procedure in the Manage Translate Tables topic in the Data Privacy online help for information on how to create translate tables. Translate tables allow you to use a table of replacement values for data that you want to disguise. Translate tables are created through Resource Administration, and you must be a Data Privacy Administrator or a Data Privacy Global Resource Administrator to create new translate tables.
  3. To return to the Welcome window, select Help > Welcome.

This section provides information about the following topics:

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*