Oracle® Healthcare Master Person Index Relationship Management User's Guide Release 4.0 E71323-02 |
|
|
PDF · Mobi · ePub |
This chapter provides information and procedure for creating, configuring, and deploying a relationship management application project. The relationship management application project contains three applications: the relationship management service application, the relationship management data manager, and the relationship management MPI agent.
Information on implementing the custom plug-ins and configuring the advanced settings is covered in the subsequent chapters.
If you plan to implement the relationship management solution for the OHMPI applications, the prerequisite is to create and configure the OHMPI applications. Then, to create the relationship management project, perform the following steps:
On the NetBeans toolbar, click New Project.
The New Project wizard appears, and opens on the Choose Project window.
Under Categories, select OHMPI.
Under Projects, select Relationship Management Application and then click Next.
The Name and Location window appears with the default project name and directory paths.
Enter the NetBeans project name and the path where you want to store the project files, or accept the defaults.
Select the application server you are using from the drop-down list.
If no application servers appear in the list, click Manage.
The Servers window appears.
Click Add Server.
The Add Servers Instance window appears.
Select the Oracle WebLogic Server, and click Next.
Under Server Location, accept the defaults and click Finish.
You are returned to the Servers window with the application server you selected listed under Servers in the left pane.
Click Close.
The Name and Location window reappears.
Select the Set as Main Project check box to set the Relationship Management application as the main project.
Click Next.
On the Define Deployment Environment window, enter the following information in the Service section:
Date and Time Formats: The date and time formats for the OHMPI Relationship Management. This defines how date and time are stored.
Date Format: This is the default or application level format used by OHMPI Relationship Management backend for the date data type.
Timestamp Format: This is the default or application level format used by OHMPI Relationship Management backend for the timestamp data type.
Maximum File Size: Set the maximum size of object, rules, and groovy script files in terms of KB.
Maximum Rows Fetched: Set the maximum number of rows that can be fetched from the database. Enter the value in terms of K (1000). For example, if you set the value as 10, a maximum of 10,000 (10K) rows can be fetched.
Audit Enabled: Select true from the drop-down list to enable the relationship management audit.
Text Index: Select true from the drop-down list to enable search by Oracle text index.
On the Define Deployment Environment window, enter the following information in the UI section:
Date and Time Formats: The date and time formats for the OHMPI Relationship Management UI. This defines how date and time are displayed in UI.
Date Format: This is the default or application level format used by OHMPI Relationship Management UI for the date data type.
Timestamp Format: This is the default or application level format used by OHMPI Relationship Management UI for the timestamp data type.
Click Finish.
The wizard automatically creates two projects in the NetBeans Project window. The relationship management project includes the application artifacts and configuration or descriptor files of the relationship management service application, the relationship management data manager application, and the relationship management MPI agent. The relationship management custom task project provides a skeleton of the project which helps you to write the custom groovy task.
After you create the OHMPI RM project, several nodes that represent the RM configuration and descriptor files are placed in the project for the RM applications. These configuration and descriptor files contain the advanced settings and parameters. If you do not plan to make any customization, skip this section and continue with Section 2.3, "Building the Relationship Management Applications". Otherwise, make sure that the configuration files are customized correctly for your implementation.
The configuration and descriptor files of the Relationship Management server application are located in the RM project Configuration\service folder and include the following:
ohmpi_rm.properties: The properties configuration file of the relationship management service application.
persistence.xml: The JPA persistence descriptor file of Oracle TopLink 12c.
web.xml: The web deployment descriptor file of the relationship management service application.
weblogic.xml: The WebLogic-specific deployment descriptor file of the relationship management service application.
To modify the configuration file:
Open the file, that you want to modify, in the Configuration\service folder.
You can modify the following files:
ohmpi_rm.properties
persistence.xml
To configure the amount of information that gets logged, open the persistence.xml file and change the value in the following parameter:
<!-- The log level: OFF/SEVERE/WARNING/INFO/CONFIG/FINE/FINER/FINEST/ALL --> <property name="eclipselink.logging.level.sql" value="WARNING"/>
web.xml
weblogic.xml
Edit the file, as required.
Save the file.
For more information about persistence.xml, see Oracle TopLink 12c User's Guide. For more information about web.xml and weblogic.xml, see Fusion Middleware Developing Web Applications, Servlets, and JSPs for Oracle WebLogic Server 12c.
The configuration and descriptor files of the Relationship Management data manager are located in the RM project Configuration\ui folder and include the following:
uiConfig.js: The properties file of the relationship management data manager.
web.xml: The web deployment descriptor file of the relationship management data manager.
weblogic.xml: The WebLogic-specific deployment descriptor file of the relationship management data manager.
To modify the configuration file:
Open the file, that you want to modify, in the Configuration\ui folder.
You can modify the following files:
uiConfig.js
web.xml
weblogic.xml
Edit the file, as required.
Save the file.
For more information about web.xml and weblogic.xml, see Fusion Middleware Developing Web Applications, Servlets, and JSPs for Oracle WebLogic Server 12c.
Table 2-1 lists the properties in uiConfig.js.
Table 2-1 Properties in uiConfig.js
Property Name | Description |
---|---|
serviceBaseURL |
Base URL for the backend REST API Services. The host name must be fully qualified name (localhost will not work). |
graphPageMaxNodeCount |
Maximum periphery node count per graph page. |
entityTypes |
These options define the node shape and color in the relationship graph view and entity summary in graph or table view. Also, list of fields that need to be masked in properties panel. For example, entityTypes: { OrgProvider: {shape: 'plus', color: 'red', summaryFieldCount: 1 , sensitive_fields :[] } } |
relationshipTypes |
These options define the link color in the relationship graph view. List of fields that must be masked in the properties panel. relationshipTypes: { 'primary-care-physician-of': {color: '#3385b7', sensitive_fields :[]} } |
dateFormat |
For information, see Section 2.1, "Creating the Relationship Management Project". |
timestampFormat |
For information, see Section 2.1, "Creating the Relationship Management Project". |
uiDateFormat |
For information, see Section 2.1, "Creating the Relationship Management Project". |
uiTimestampFormat |
For information, see Section 2.1, "Creating the Relationship Management Project". |
If you plan to integrate the relationship management service with the OHMPI service through the MPI agent, see Section 3.2, "Integrating with Relationship Management Master Person Index Agent" for creating, configuring, and deploying the MPI agent.
For information, see Section 6.3.2.2, "Configuring the Relationship Management MPI Agent".
Right-click on the RM project and select Build.
Note:
If you have already build the project previously and made the changes to the configuration, right-click on the RM project and select Clean and Build. This will make sure that the previous build components are cleaned up.The following WAR files are created in the dist folder:
ohmpi-rm-service-1.0.0.war
ohmpi-rm-ui-1.0.0.war
If you plan to integrate the relationship management service with the OHMPI service through the MPI agent, see Section 3.2, "Integrating with Relationship Management Master Person Index Agent" for creating, configuring, and deploying the MPI agent. Otherwise, you need only the ohmpi-rm-service-1.0.0.war and ohmpi-rm-ui-1.0.0.war applications.
Oracle recommends that you create a separate dedicated database user for Relationship Management to handle the database tables and other database-related task.
Create a user.
CREATE USER <database_username> IDENTIFIED BY <password>;
Grant the following privileges to the user:
GRANT RESOURCE, CONNECT TO <database_username>; GRANT CREATE TABLESPACE TO <database_username>; GRANT DROP TABLESPACE TO <database_username>;
If you want to enable text-index search, grant the following additional privileges:
GRANT RESOURCE, CONNECT, CTXAPP TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_CLS TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_DDL TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_DOC TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_OUTPUT TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_QUERY TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_REPORT TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_THES TO <database_username>; GRANT EXECUTE ON CTXSYS.CTX_ULEXER TO <database_username>;
In the NetBeans editor, open the following scripts from the <Project_Name>/Database Script directory:
create-ohmpi-rm.sql
create-ohmpi-rm-audit.sql
If you have enabled the text-index search, open the following script:
create-ohmpi-rm-text-index.sql
Copy the entire text from create-ohmpi-rm.sql and paste into the SQL editor.
Execute the script against the database.
Repeat steps 2 and 3 for create-ohmpi-rm-audit.sql and create-ohmpi-rm-text-index.sql (if required).
Start the Oracle WebLogic Server. For instructions, see Oracle Fusion Middleware Online Documentation 12c Release 1 (12.1.3).
Log on to the WebLogic Server Administration Console.
On the left panel, under Domain Structure, select Deployments.
The Summary of Deployments panel appears.
On the right side of the panel under Deployments, click Install.
Select jax-rs-2.0.war from the <weblogic_server_home>\wlserver\common\deployable-libraries directory and click Next.
The Install Application Assistant panel appears.
Select the Install this deployment as Library option.
Click Next.
Select the server location for deployment and click Next.
Click Finish.
Start the Oracle WebLogic Server. For instructions, see Oracle Fusion Middleware Online Documentation 12c Release 1 (12.1.3).
Log on to the WebLogic Server Administration Console.
On the left panel, under Domain Structure, select Deployments.
On the right side of the Summary of Deployments panel, under Deployments, click Install.
Browse and locate the folder which contains the WAR file you want to install.
Select the ohmpi-rm-service-1.0.0.war option and click Next.
The Install Application Assistant panel appears.
Select the Install this deployment as an application option and click Next.
Select the server location for deployment and click Next.
Click Finish.
Start the Oracle WebLogic Server. For instructions, see Oracle Fusion Middleware Online Documentation 12c Release 1 (12.1.3).
Log on to the WebLogic Server Administration Console.
On the left panel, under Domain Structure, select Deployments.
On the right side of the Summary of Deployments panel, under Deployments, click Install.
Browse and locate the folder which contains the WAR file you want to install.
Select the ohmpi-rm-ui-1.0.0.war option and click Next.
The Install Application Assistant panel appears.
Select the Install this deployment as an application option and click Next.
Select the server location for deployment and click Next.
Click Finish.
Open an application server browser.
Enter the following URL:
http://<Server>:<Port>/ohmpi-rm-ui/1.0.0/
Enter the user name and password provided by your system administrator.
Click Sign In.
This section describes the REST API support by Relationship Management. For information on REST APIs, their signatures, and API message body, see Oracle Healthcare Master Person Index Relationship Management REST APIs Reference Guide.
OHMPI RM REST API is comprehensive uniform interface for managing generic relationships and entities. The RM REST APIs are used to create, modify, and search resources.
The resources managed by the OHMPI RM application are categorized as follows:
Metadata Resources: Manages entity types and relationship types
Management Resources: Manages domains, tasks and rulesets
Entity Resources: Manages entities
Relationship Resources: Manages relationships
MPI Integration Resources: Manages MPI integration between RM and MPIs
Stats Resources: Views count of entity types, relationship types, entities, relationships, domains, tasks, and rulesets
All the REST APIs have security enabled using HTTP Basic Authentication. For information on security details, see Chapter 8, "Relationship Management Security".
For each REST API to complete successfully, username:password must be passed in the request header in base64 encoded format. For example, Authorization: Basic d2VibG9naWM6d2VsY29tZTE=. Where, d2VibG9naWM6d2VsY29tZTE= is the base64 encoded format for weblogic:welcome1.
The response type of each REST API is application/json.
For POST and PUT APIs, you must set the header Content-Type to application/json.
Metadata Resources APIs are used to:
Create an entity type
Update, activate, or deactivate an entity type
Search for a specific entity type
Search for all entity types in the system
Create a relationship type
Update, activate, or deactivate a relationship type
Search for a specific relationship type
Search for all relationship types in the system
Management Resources APIs are used to:
Create a domain
Upload the object.xml file for the domain
Update, activate, or deactivate a domain
Search for a specific domain
Search for all domains in the system
Create a ruleset
Upload an xml file for the ruleset defining the ruleset
Update, activate, or deactivate a ruleset
Search for a specific ruleset
Search for all rulesets in the system
Create a task
Upload a groovy script file for the task
Update, activate, or deactivate a task
Search for a specific task
Search for all tasks in the system
Entity Resources APIs are used to:
Create an entity
Update, activate, or deactivate an entity
Search for a specific entity using its entity ID
Search for all the entities in the system based on the entity type and entity attributes
Search for all the entities in the system based on date attribute range and other entity attributes
Relationship Resources APIs are used to:
Create a relationship using source and target entities (without rules)
Create a relationship using single entity (using preconfigured rules)
Create a relationship using source and target entities (using preconfigured rules)
Update, activate, or deactivate a relationship
Search for a specific relationship using its relationship ID
Search for all the relationships in the system based on date attribute range and other relationship attributes
Search for all the relationships from source and target entities, and other entity attributes
Search for all the relationships from source or target entity ID
Search for all relationship from source or target ID, and relationship type
Synchronize relationships with MPI based on event type
Stats Resources APIs are used to:
Get information on active and inactive entity types, relationship types, domains, rulesets, and tasks
Get information on the:
Number of audit events (create, update, activate, and deactivate) in last 30 days
Active and inactive entities
Active, inactive, potential, and resolved relationships