JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Getting Started With Oracle Java CAPS Master Patient Index     Java CAPS Documentation
search filter icon
search icon

Document Information

Getting Started With Oracle Java CAPS Master Patient Index

Related Topics

About the Default Projects

The Server Project

The Object Structure

Query Configuration

Standardization and Matching Configuration

Person Names

Parsing Addresses

The Match String

Threshold Configuration

Enterprise Data Manager Configuration

The Collaboration Client Project

The Business Process Client Project

Implementing the Default Projects

Install the Required Software

To Install Java CAPS Master Index (Repository) and Java CAPS Master Patient Index

Customize the Application

Regenerate the Application

To Regenerate the Application

To Update the Collaboration

Create the Database Tables

To Define Systems for the Sample Files

To Define User Codes for the Sample Files

To Create the Database Tables

Configure the Connectivity Maps

To Configure the Client Connectivity Maps

Define the Environment

To Define the Environment

Deploy the Projects

To Deploy the Server Project

To Deploy the Collaboration Client Project

To Deploy the Business Process Client Project

Define EDM Security

To Define EDM User Accounts

Running the Java CAPS Master Patient Index Projects

Run the Sample Files

To Access and Process the Sample Files

Work With the EDM

To Log in to the EDM

To View the New Records

Implementing the Default Projects

Before continuing, make sure you have access to an Oracle or SQL Server database. The database can be installed on the same computer as Java CAPS Master Patient Index or on any computer that can be accessed over your network.

Sample input files are provided with the Java CAPS Master Patient Index documentation and can be accessed from the Java CAPS sample projects web site (this is described in Running the Java CAPS Master Patient Index Projects).

Getting started with Java CAPS Master Patient Index includes the following tasks:

Install the Required Software

In order to work with the Java CAPS Master Patient Index projects, you must have the following applications installed.

Java CAPS Master Index (Repository) and Java CAPS Master Patient Index are not installed when you install Java CAPS.

To Install Java CAPS Master Index (Repository) and Java CAPS Master Patient Index

  1. Make sure the Java CAPS Repository is started.
  2. Upload eview.sar and eindex.sar to the Repository using the Java CAPS Uploader, as described in To Install Java CAPS Components Using the Java CAPS Uploader in Using the Oracle Java CAPS 6.3 Installation GUI.
  3. Launch NetBeans and connect to the Java CAPS Repository.
  4. Install Master Index in NetBeans, as described in To Install Components Using the NetBeans IDE Update Center in Using the Oracle Java CAPS 6.3 Installation GUI. Follow these guidelines:
    • On the Settings page of the NetBeans Plugins tool, only select CAPS Repository Update Center.

    • If a validation error appears while installing Master Index, click continue on the dialog box to ignore the warning.

    • After the installation is complete, restart the IDE and then reconnect to the Repository. The Java CAPS Master Patient Index projects appear in the Projects window once the IDE starts again.

  5. Once all required software is installed, continue to Customize the Application.

Customize the Application

The Java CAPS Master Patient Index projects work in their default configuration, but you can customize several attributes of the master index, such as the appearance of the EDM, the queries used by the application, the matching parameters, and so on. In order for the default client projects and sample input files to work with the application, however, you cannot modify the object structure.

One recommended change is to enable audit logging in the Enterprise Data Manager file so you can work with the Audit Log feature. To do this, change the value of the allow-insert element at the end of the file to “true”. If this is not enabled, you will not be able to view the audit log on the EDM.

After you modify any of the configuration files, continue to Regenerate the Application.

Regenerate the Application

Before you can work with the application files, you must regenerate the application and then import the regenerated JAR files into the eIndexClient project Collaboration.


Note - When you regenerate, the database scripts are updated to reflect object structure changes with the exception of the Create User Indexes script, which is not an automatically generated file. You can modify the file manually if needed (but this is not required for this tutorial).


To Regenerate the Application

Before You Begin

Make sure you have completes the steps under Install the Required Software and Customize the Application.

  1. In the Projects window, expand the eIndex project.
  2. Right-click eView Application - Person.
  3. On the context menu, click Generate.
  4. On the confirmation dialog box, click Yes.
  5. Update the Collaboration as described below.

To Update the Collaboration

  1. In the Projects window, expand the eIndexClient project.
  2. Check out and open the ProcessPerson Collaboration.
  3. In the toolbar, click Import JAR File.

    The Add/Remove Jar Files dialog box appears.

  4. For each Java CAPS Master Patient Index JAR file in the list, highlight the filename and then click Remove.
  5. For each Java CAPS Master Patient Index JAR file to re-import, do the following:
    1. Click Add.
    2. Double-click the eIndex project name in the list that appears.
    3. Select the name of the JAR file to import.
    4. Click Import.
  6. Save the Collaboration.
  7. Continue to Create the Database Tables.

Create the Database Tables

To create the database tables, you must have a standard Oracle or SQL Server database installed and running either on your computer or on a network computer accessible to your machine. To run the sample files, modifications are required for the Systems script and the Create User Code Data script. These changes are described below. Do not delete or change any of the existing processing codes or systems.

Before you begin these procedures, complete the steps under Regenerate the Application.

To Define Systems for the Sample Files

  1. In the Projects window, expand the eIndex project, expand eView Application - Person, and then expand Database Script.
  2. Under Database Script, check out and open the Systems file.
  3. Add the following SQL statements after the existing insert statement and before the end statement.

    insert into sbyn_systems (systemcode, description, status, id_length, format, input_mask, value_mask, create_date, create_userid) values (’CBMC’, ’CB MED CENTER’, ’A’, 9, ’[0-9]{9}’, ’DDD-DDD-DDD’, ’DDD^DDD^DDD’, TO_DATE(v_date, ’MM/DD/YYYY’), v_user);

    insert into sbyn_systems (systemcode, description, status, id_length, format, input_mask, value_mask, create_date, create_userid) values (’WHC’, ’WAYFIELD HOME CARE’, ’A’, 7, ’[0-9]{7}’, ’DD-DDD-DD’, ’DD^DDD^DD’, TO_DATE(v_date, ’MM/DD/YYYY’), v_user);

  4. Save and close the file.
  5. Define user codes as described below.

To Define User Codes for the Sample Files

  1. In the Projects window, expand the eIndex project, expand eView Application - Person, and then expand Database Script.
  2. Under Database Script, check out and open the Create User Code Data file.
  3. Add the following SQL statements to the end of the file.

    insert into sbyn_user_code (code_list, code, descr, format, input_mask, value_mask) values (’AUXIDDEF’, ’ACCT’, ’ACCOUNT NUMBER’, ’[0-9]{8}’, ’D-DDD-DDDD’, ’D^DDD^DDDD’); commit;

  4. Save and close the file.
  5. Create the database tables as described below.

To Create the Database Tables

  1. If you have not done so already, create a standard database using Oracle or SQL Server database tools.
  2. Use SQL*Plus to create a user for the database. Use the following script as a sample, entering the user name and password of the Java CAPS Master Patient Index user who will create the database files and provide the connection from the EDM and Adapters.

    create user username identified by password;

    grant connect, resource to <username>;

    commit;

  3. In the Projects window, expand the eIndex project, expand eView Application - Person, and then expand the Database Script folder.
  4. Right-click Database Script, and then select Properties.
  5. On the Properties window, do the following.
    1. For Oracle: In the Database Server field, change <hostname> to the name of the computer on which the database resides, change the port number if you are not using the default, and change <SID> to the SID name of the Java CAPS Master Patient Index database. You can enter “localhost” for the hostname if the database is on your local computer.
    2. For SQL Server: In the Database Server field, delete the default value and replace it with jdbc:sqlserver://server:port;databaseName=database, where server is the name of the computer on which the database resides, port is the port number the database is listening on, and database is the name of the database.
    3. In the User field, enter the user ID for the user you created in step 2 above.
    4. In the Password field, enter the password for the user you created in step 2 above.
    5. Close the dialog box.
  6. Under Database Script, right-click Create Person Database, click Run, and then click OK on the Information dialog box.
  7. Run Create User Indexes as above.
  8. Run Systems as above.
  9. Run Code List as above.
  10. Run Create User Code Data as above.
  11. Continue to Configure the Connectivity Maps.

Configure the Connectivity Maps

The Connectivity Maps for all three Java CAPS Master Patient Index projects are predefined. You only need to configure the Adapter connections for the Collaboration client and Business Process client projects. The database Adapter is already configured for connectivity in the server project.

To Configure the Client Connectivity Maps

Before You Begin

Complete the steps under Create the Database Tables.

  1. In the eIndexClient project, check out the Connectivity Map (CMap1), and then open it in the Connectivity Map Editor.
  2. Double-click the icon between the inbound Adapter and the Service.
  3. On the Properties dialog box, change the value of the Input File Name property to inputcollab*.txt and press Enter.
  4. Click OK.
  5. Double-click the icon between the Service and the outbound Adapter.
  6. On the Properties dialog box, change the value of the Output File Name property to outputcollab%d.dat.
  7. Click OK.
  8. Save and close the Collaboration client Connectivity Map.
  9. Repeat the above steps for the Connectivity Map in the eIndexBPClient project, verifying that the input file name is inputbp*.txt and the output file name is outputbp%d.dat.
  10. Continue to Define the Environment.

Define the Environment

In order to deploy the projects to the application server, you need to create an Environment that maps the project components in the Connectivity Map to the physical components on the domain.

To Define the Environment

Before You Begin

Complete the steps under Configure the Connectivity Maps.

  1. In the Services window, right-click CAPS Environments, and then select New Environment.
  2. Rename the Environment to eIndexEnvironment.
  3. Right-click eIndexEnvironment, point to New, and then select Logical Host.
  4. Rename the Logical Host eIndexLH.
  5. Right-click eIndexLH, point to New, and then select Sun Java System Application Server.
  6. Rename the server to eIndexAS.
  7. Right-click eIndexAS, select Properties, and then define the application server password (this is the Administrator password). Verify the URL, and then click OK to close the Properties window.
  8. Right-click eIndexEnvironment, point to New, and then select File External System.
  9. Enter FileSystem for the name.
  10. Right-click FileSystem, select Properties, and then configure the File Adapters as follows.
    1. For the inbound File Adapter, expand Inbound File Adapter, select Parameter Settings, and then specify the directory in which you will place the sample data files.
    2. For the outbound File Adapter, expand Outbound File Adapter, select Parameter Settings, and then specify the directory to which you want the Adapter to write the outbound files.
  11. Right-click eIndexEnvironment, point to New, and then select Oracle External System or Sqlserver External System, depending on which database you are using. Enter DatabaseSystem for the name.
  12. Configure DatabaseSystem as follows.
    1. Right-click DatabaseSystem, and then click Properties.
    2. For Oracle, expand Outbound Oracle Adapter; for SQL Server, expand Outbound SQLServer XA Adapter.
    3. Select JDBC Connector Settings.
    4. Define the properties listed in the table below.
    5. Click OK to close the Properties window.
      Property
      Description
      ServerName
      The name of the database server (you can enter “localhost” if the database is on the same computer as the application server).
      PortNumber
      The port number on which the database is listening. For Oracle, the default is 1521; for SQL Server, the default is 1433.
      DatabaseName
      The SID name of the database.
      User
      The login ID of the administrator user you created when you created the database (under Create the Database Tables).
      Password
      The database password for the administrator user.

      See Configuring Environment Components for Oracle Java CAPS Database Adapters for more information about configuring the database external system.

  13. Continue to Deploy the Projects.

Deploy the Projects

For each sample project, you must create a Deployment Profile and build and deploy the project. Be sure to build the server project before creating the client projects’ Deployment Profiles. Building the server project creates the Java CAPS Master Patient Index application, which is required in order to deploy the client projects.


Note - Before you begin these steps, make sure the application server is running and you have completed the steps under Define the Environment.


To Deploy the Server Project

This task links the components of the Java CAPS Master Patient Index server Connectivity Map with the physical components defined for the Environment.

  1. In the Projects window, right-click the eIndex project.
  2. Point to New, and then click Deployment Profile.
  3. Name the profile eIndexDep.
  4. Select eIndexEnvironment for the Environment.
  5. Select only ServerConnectivityMap for the Connectivity Map.
  6. Click OK.

    The Deployment Editor appears.

  7. In the Deployment Editor window, click the Automap icon.

    The project components are automatically mapped to the Environment containers.

  8. On the Automap Results dialog box, click Close.
  9. In the Deployment Editor toolbar, click Build. When the build is complete, click OK.

    The application EAR file is generated and placed in JavaCAPS_Home\.netbeans\caps\builds\eIndexeIndexDep\eIndexLH\eIndexIS.

  10. After the project builds successfully, click Deploy in the Deployment Editor toolbar, and then click Yes on the Deploy dialog box.
  11. Save and close the Deployment Profile.

To Deploy the Collaboration Client Project

This task links the components of the Collaboration client Connectivity Map with the physical components defined for the Environment.

  1. In the Projects window, right-click the eIndexClient project.
  2. Point to New, and then click Deployment Profile.
  3. Name the profile CollabDep.
  4. Select eIndexEnvironment for the Environment.
  5. Select only CMAP1 as the Connectivity Map to use.
  6. Click OK.

    The Deployment Editor appears.

  7. In the Deployment Editor window, click the Automap icon.

    The project components are automatically mapped to the Environment containers.

  8. On the Automap Results dialog box, click Close.
  9. In the Deployment Editor toolbar, click Build. When the build is complete, click OK.

    The application EAR file is generated and placed in JavaCAPS_Home\.netbeans\caps\builds\eIndexClientCollabDep\eIndexLH\eIndexIS.

  10. After the project builds successfully, click Deploy in the Deployment Editor toolbar, and then click Yes on the Deploy dialog box.
  11. Save and close the Deployment Profile.

To Deploy the Business Process Client Project

This task links the components of the Business Process client Connectivity Map with the physical components defined for the Environment.

  1. In the Projects window, right-click the eIndexBPClient project.
  2. Point to New, and then click Deployment Profile.
  3. Name the profile eInsightDep.
  4. Select eIndexEnvironment for the Environment.
  5. Select only CMAP1 as the Connectivity Map to use.
  6. Click OK.

    The Deployment Editor appears.

  7. In the Deployment Editor window, click the Automap icon.

    The project components are automatically mapped to the Environment containers.

  8. On the Automap Results dialog box, click Close.
  9. In the Deployment Editor toolbar, click Build. When the build is complete, click OK.

    The application EAR file is generated and placed in JavaCAPS_Home\.netbeans\caps\builds\eIndexBPClienteInsightDep\eIndexLH\eIndexIS.

  10. After the project builds successfully, click Deploy in the Deployment Editor toolbar. Click Yes on the Deploy dialog box.
  11. Save and close the Deployment Profile.
  12. Continue to Define EDM Security.

Define EDM Security

To access the Enterprise Data Manager (EDM), you need to create a user for logging on to the EDM and assign security permissions. Security is defined in the application server.

To Define EDM User Accounts

Before You Begin

Complete the steps under Deploy the Projects.

  1. Access the GlassFish Admin Console (on the Services window in NetBeans, expand Servers, right-click the application server, and then select View Admin Console).
  2. In the left panel of the Admin Console, expand Configuration, Security, and then Realms.
  3. Under Realms, click file.
  4. On the Edit Realm page, click Manage Users.
  5. On the File Users page, click New.
  6. On the New File Realm User page, enter the following information:
    • In the User ID field, enter a unique login ID for the user.

    • In the Group List field, enter eView.Admin.


      Note - You can enter different user groups to see the affect each has on permissions. Each user must be assigned to either eView.Admin or eView.User. Master Index User Roles (Repository) in Maintaining Oracle Java CAPS Master Indexes (Repository) lists and describes each Java CAPS Master Patient Index user group.


    • In the New Password and Confirm New Password fields, enter a password for the user.

  7. Click OK.
  8. Enter data into the master index application as described in Running the Java CAPS Master Patient Index Projects.