ECL Service Sample Profile Overview

External Code List (ECL) Service is an XEServer service that provides a thread-safe mechanism to work with ECL using ECL or XE components. The service is used in situations when ECL has to be updated from an external data source while the profile with the ECL Lookup and the XEngine components are running. ECL Service provides a safe and convenient way to update and read data from ECL and also allows several profiles to concurrently access and use the same code list at a time. This sample profile serves as an example of the practical use of the ECL Service.

Profile Location

Edifecs Library / Best Practices / Common Tasks / ECL Service Sample

Requirements

  • Edifecs XEngine 9.1 hotfix 2 or later
  • Edifecs XEServer 9.1 or later
  • Edifecs Application Manager (EAM) 9.1 or later
  • HIPAA Standards Release 8.8.14 or later

Prerequisites

  • XE and ECL components communicate with the ECL Service through a port. So, one service can be used by multiple XEServer profiles and routes each using a different port number.
  • Ensure that the profile’s ECL Service (Services/XEngine/) uses the port number 6717.
  • XE components must use the XERegistry parameter Xengine.Settings.ECLService.Port. Ensure that the profile’s XEngine Service (Services/XEngine/) has the property XEngine.Settings.ECLService.Port=6717 defined.
  • ECL components have a setting to enable access to ECL through the service. For all ECL components, ensure that the option Connect to ECL Service with port is enabled and the port number is set to 6717.
  • Ensure that the folder ${ECRootPath}/Common/UserECLDB/jECL does not contain the file WestCoastUSStates h2.db. Delete the file if it is present.

A successful profile's workflow requires a sequential run through of all the steps from the profile workflow section.

Copy the sample file ECL-WestCoastUSStates.xml from the folder ${XESProfileConfig}/samples/01 Create and Register ECL to the folder ${XESWorkspace}/test-data/inbound/1_Create-and-Register-ECL.

Expected Results

  • The ECL WestCoastUSStates has been created and registered. The folder ${ECRootPath}/Common/UserECLDB/jECL contains the file WestCoastUSStates_usr00.h2.db.

Copy the sample file ECL-WestCoastUSStates.xml from the folder ${XESProfileConfig}/samples/01 Create and Register ECL to the folder ${XESWorkspace}/test-data/inbound/1_Create-and-Register-ECL.

Expected Results

  • The codes "WA", "CA", and "OR" are not available. The folder ${XESWorkspace}/test-data/outbound/02_06_10_Code-Lookup/Code-Not-Exists contains three messages with the related property files. In each property file, the value of the property "EclResult_EclResultCount" is 0 that indicates the absence of the codes in the ECL WestCoastUSStates.

Copy the sample files 5010_834_x220_A1-WA.txt, 5010_834_x220_A1-CA.txt, and 5010_834_x220_A1-OR.txt from ${XESProfileConfig}/samples/03_07_11 Validate to ${XESWorkspace}/test-data/inbound/03_07_11_Validate.

Expected Results

  • The transaction validation fails. The folder ${XESWorkspace}/test-data/outbound/03_07_11_Validate contains three invalid transactions and the related properties files in the subfolder Bad. The related LDNS and Error reports including the related properties files are stored in the subfolder Reports.

Copy the sample file WA.xml from ${XESProfileConfig}/samples/04 Insert Code XES Exchange to ${XESWorkspace}/test-data/inbound/04_Insert-Code-XES-Exchange.

Expected Results

  • The code "WA" is inserted into the ECL WestCoastUSStates.

Copy the sample files insert_DFF-code-list.csv and insert_DFF-code-list.csv.properties from the folder ${XESProfileConfig}/samples/05 Insert Code DFF File to ${XESWorkspace}/test-data/inbound/05_Insert-Code-DFF-File.

Expected Results

  • The code "WA" and "OR" are inserted into the ECL WestCoastUSStates.

Copy the sample files WA.xml, CA.xml, and OR.xml from the folder ${XESProfileConfig}/samples/02_06_10 Code Lookup to ${XESWorkspace}/test-data/inbound/02_06_10_Code-Lookup.

Expected Results

  • The codes "WA", "CA", and "OR" are available in ECL. The folder ${XESWorkspace}/test-data/outbound/02_06_10_Code-Lookup/Code-Exists contains three messages with the related property files. In each property file, the value of the property "EclResult_EclResultCount" is 1 which indicates the presence of the codes "WA", "CA", and "OR" in the ECL "WestCoastUSStates."

Expected Results

  • The transaction validation succeeds. The folder ${XESWorkspace}/test-data/outbound/03_07_11_Validate contains three valid transactions and the related properties files in the subfolder Good. The related LDNS and Error reports including the related properties files are stored in the subfolder Reports.

Copy the sample file CA.xml from ${XESProfileConfig}/samples/08 Delete Code XES Exchange to ${XESWorkspace}/test-data/inbound/08_Delete-Code-XES-Exchange.

Expected Results

  • The code "CA" is removed from the ECL WestCoastUSStates.

Copy the sample files delete_DFF-code-list.csv and delete_DFF-code-list.csv.properties from ${XESProfileConfig}/samples/09 Delete Code DFF File to ${XESWorkspace}/test-data/inbound/09_Delete-Code-DFF-File.

Expected Results

  • The code "WA" and "OR" are removed from the ECL WestCoastUSStates.

Repeat Step 2 and ensure that the expected results are the same.

Repeat Step 3 and ensure that the expected result is the same.

Copy the sample file ECL-WestCoastUSStates.xml from ${XESProfileConfig}/samples/12 Unregister and Delete ECL to ${XESWorkspace}/test-data/inbound/12_Unregister-and-Delete-ECL.

Expected Results

  • The ECL WestCoastUSStates has been unregistered and is not available for the current profile anymore, even if the file physically is still available in the folder ${ECRootPath}/Common/UserECLDB/jECL.