EMC ® Documentum ®
Connector for EPIC
Version 1.6B250714_update
Installation Guide
EMC Corporation
Corporate Headquarters
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Legal Notice
Copyright © 2013-2015 EMC Corporation. All Rights Reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS
OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF
Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks
used herein are the property of their respective owners.
Documentation Feedback
Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback
about how we can make our documentation better or easier to use, please send us your feedback directly at
[email protected]
Table of Contents
Preface
Chapter 1
Chapter 2
Chapter 3
Chapter 4
................................................................................................................................
5
...................................................................................................
9
What is C4E? ....................................................................................................
HIP Epic ROI Module ...................................................................................
9
9
How does C4E Work? .......................................................................................
10
Functions of C4E ..............................................................................................
Viewing Documents Stored in Documentum ..................................................
File Types Supported by Documentum Viewer ...........................................
Scanning Documents to Documentum ...........................................................
Batch Scanning Documents to Documentum ..................................................
Importing Documents to Documentum ..........................................................
Batch Importing Documents to Documentum .................................................
Publishing ROI Packages...............................................................................
11
11
11
11
12
12
12
12
About C4E
Security Configuration
................................................................................ 13
Access Control Settings .....................................................................................
User Authentication......................................................................................
Default Accounts ......................................................................................
Authentication Configuration ....................................................................
User Authorization .......................................................................................
Component Access Control ...........................................................................
13
13
13
13
14
14
Log Settings .....................................................................................................
Log Description ............................................................................................
14
14
Communication Security Settings ......................................................................
Port Usage ...................................................................................................
Network Encryption .....................................................................................
14
14
15
Secure Deployment and Usage Settings..............................................................
Secure Deployment Settings ..........................................................................
15
16
C4E Installation and Configuration ..............................................................
Prerequisites ....................................................................................................
17
17
Installing C4E ...................................................................................................
18
Configuring C4E...............................................................................................
18
Deploying Object Types ....................................................................................
28
Importing Document Types ...............................................................................
Installing the HIP Epic ROI Module ...................................................................
30
31
Configuring the HIP Epic ROI Module ...............................................................
31
Configuring Epic Hyperspace............................................................................
36
.................................................................. 37
FDI Record Settings .......................................................................................... 37
C4E Configuration for Scanning
3
Table of Contents
Appendix A
4
LWP Record Settings.........................................................................................
38
SDF Settings .....................................................................................................
39
EAF/HSD Settings ............................................................................................
39
.........................................................................
C4E AppSettings.xml ........................................................................................
C4E DCTMSettings.xml ....................................................................................
C4E MimeTypes.xml .........................................................................................
C4E ScanSettings.xml........................................................................................
ROI Module AppSettings.xml............................................................................
ROI Module DCTMSettings.xml ........................................................................
41
Sample Configuration Files
41
41
42
43
43
43
Preface
Purpose
This document describes the procedure to install and configure EMC Documentum Connector for
EPIC (C4E) and the related modules of C4E.
Audience
This guide is intended for technical support team who is responsible for installing EMC Documentum
C4E. This document assumes that the person who performs installation has technical knowledge and
experience in network topologies, Oracle, Documentum, Epic Hyperspace, and storage technologies
and is familiar with Microsoft Windows, Linux, and VMware.
Revision History
Revision Date
Description
June 2015
Updated the description of document levels attribute in the Section
Importing Document Types.
July 2014
• Updated the version number to 1.6B250714_update.
• Updated the following file names:
— HIP-DCTM-1.6.0.dar to HIP-DCTM- 1.6B250714
_update.dar
— EMC Documentum Epic Integration.msi to EMC
Documentum Epic Integration-1.6B250714_update
.msi
• Removed all references to XDS Registration.
• Removed the steps to configure Registry attributes from
Configuring the DCTM server details:, page 20.
• Removed the sample content of XdsRegSettings.xml file from
Appendix A, Sample Configuration Files.
• Added information on unavailability of deleted mime types in
Configuring the mimetype details:, page 22
• Updated the values of FDI Record settings in FDI Record
Settings, page 37.
5
Preface
Revision Date
Description
• Updated the values of LWP Record settings in LWP Record
Settings, page 38.
6
Preface
Revision Date
Description
June 2014
Initial publication.
7
Preface
8
Chapter 1
About C4E
This chapter contains the following topics:
• What is C4E?, page 9
• How does C4E Work?, page 10
• Functions of C4E, page 11
What is C4E?
The C4E package enables Healthcare providers using Epic EMR to store and retrieve patient records
from a Documentum Repository. The C4E package contains the C4E and the HIP Epic EMR Release
of Information (ROI) module.
Epic is a client-server electronic medical record application. The client part is called Epic Hyperspace
and is typically installed on a PC. The Hyperspace client connects back to a cache database running
on servers in the datacenter.
The C4E enables your Epic Hyperspace client application to:
• Scan and store Healthcare documents in a Documentum repository
• Upload Healthcare documents to a Documentum repository
• View Healthcare documents stored in a Documentum repository
HIP Epic ROI Module
The HIP Epic ROI module enables you to retrieve patient content stored in Documentum and then
package and output that content as part of an Epic Release of Information package. The module
converts all PDF documents to images before sending the content to the Epic viewer. The module
converts each page of a multi-page PDF to a TIFF image. This module supports only PDF and TIFF
file formats.
9
About C4E
How does C4E Work?
For all Desktop Scan, View, and Upload scenarios, the action is initiated through the Epic workstation.
Epic calls the C4E when scanning, viewing, or uploading. C4E uses DFS Web Services to access the
EMC Documentum Repository when sending or retrieving content.
The following figure illustrates the C4E workflow:
For batch scan and upload scenarios, high-volume scanners scan and upload documents to the
EMC Documentum Repository. The Repository Server uses HL7 messages to inform Epic of the
new content.
The following figure illustrates the batch scanning workflow:
10
About C4E
Functions of C4E
C4E supports the following functions:
• Viewing Documents Stored in Documentum, page 11
• Scanning Documents to Documentum, page 11
• Batch Scanning Documents to Documentum, page 12
• Importing Documents to Documentum, page 12
• Batch Importing Documents to Documentum, page 12
• Publishing ROI Packages, page 12
Viewing Documents Stored in Documentum
You must open the Media tab under the appropriate patient context and click the document link.
The C4E retrieves the document from Documentum, and displays it to you through the integrated
Documentum viewer. If the viewer does not support the file type, Windows attempts to open the
content with the default application for the file type.
File Types Supported by Documentum Viewer
• TIFF
• GIF
• JPG
• JPEG
• JPE
• PDF
• DOC
• PNG
• BMP
• txt
Besides the above mentioned file types, the Documentum Viewer supports other valid file types
that you add.
Scanning Documents to Documentum
You can scan the documents through an Epic Hyperspace client that presents a scanning interface
with a Scan button in the Media tab of the interface. From the scanning interface, users can select the
11
About C4E
document type and click Scan. The C4E ensures that the application saves the scanned document
in the Documentum repository. Documentum returns a unique object ID to Epic, enabling Epic to
provide a link to the document on the Media tab.
Batch Scanning Documents to Documentum
You can schedule batch scans through a scan capture server that scan and upload documents to a
Documentum repository. The Repository Server generates an HL7 MDM message containing the
Documentum unique ID for each document uploaded to Documentum. It sends this message to Epic,
enabling Epic to display the document ID with the corresponding patient ID on the media tab.
Importing Documents to Documentum
You can import documents through the Epic scanning interface. You must define the document
type and then select the file to import. The C4E ensures the application saves the document in the
Documentum repository. Documentum returns a unique object ID to Epic, enabling Epic to provide a
link to the document on the Media tab.
Batch Importing Documents to Documentum
You can schedule batch upload to a Document repository through a high volume server. The
Repository Server generates an HL7 MDM message containing the Documentum unique ID for each
document uploaded to Documentum. It sends this message to Epic, enabling Epic to display the
document ID with the corresponding patient ID on the media tab.
Publishing ROI Packages
The HIP Epic ROI module receives a document ID from Epic that corresponds to the object ID of a
document in Documentum. The module then retrieves the document and transforms it (if required)
from PDF to an image format and sends the resulting image back to the Epic Module. If the HIP Epic
ROI module encounters a multiple page PDF file, each page of the PDF file is converted to a TIFF
image and sent back to Epic.
12
Chapter 2
Security Configuration
This chapter provides the security configuration settings required to ensure secure operation of C4E.
This chapter contains the following topics:
• Access Control Settings, page 13
• Log Settings, page 14
• Communication Security Settings, page 14
• Secure Deployment and Usage Settings, page 15
Access Control Settings
Access control settings enable the protection of resources against unauthorized access.
User Authentication
The C4E uses a single Documentum account for all operations. Login prompt is not provided to users
because this single account is configured in the configuration tool and shared by all users.
Default Accounts
There are no specific default accounts. The customer’s Documentum Administrator must determine
and configure the account to be used for all C4E client installations.
Authentication Configuration
The C4E contains a configuration utility to configure the authentication information. You must
specify the repository name, the user name, and the password in the utility (this information is
encrypted in the configuration files). This account can be any type of Documentum account as long as
the authentication information required above can be provided.
13
Security Configuration
User Authorization
All content created by the C4E is configured with an Access Control List (ACL). The ACL can be
configured in the configuration tool. The default ACL is hip_repository_acl. If the configuration
is left blank, it indicates that the DCTM runtime ACL is generated.
Component Access Control
You can use the Epic Hyperspace to access C4E. All access to the C4E is controlled by the Epic
Hyperspace application administrator.
Log Settings
The log file generated by the C4E logs information from levels NONE (no logging) to DEBUG (all
messages logged) and this is configured in the configuration tool.
Log Description
The C4E generates the log file in the C4E installation folder.
The name of the log file generated is DCTM_EpicIntegratorCommon - <Epic User
name>.log.
The logs for Media handler viewer is generated in DCTM_EpicIntegratorCommon.log.
Communication Security Settings
The communication security settings enable the establishment of secure communication channels
between the product components as well as between product components and external systems
or components.
Port Usage
Component
Service
Protocol
Port
Description
C4E Viewer
/Scanner
NA
http
80
NA
C4E ROI
NA
http
80
NA
14
Security Configuration
Component
Service
Protocol
Port
Description
C4E Viewer
/Scanner
NA
http
9080
ACS
C4E ROI
NA
http
9080
NA
Network Encryption
You can use SSL if configured on the web services application server. In the configuration URL you
can designate the protocol https in the URL string.
Secure Deployment and Usage Settings
The following figure illustrates the C4E layers:
15
Security Configuration
Secure Deployment Settings
The security settings for deployment of the web services layer are described in the DFS web services
documentation.
16
Chapter 3
C4E Installation and Configuration
This chapter contains the following topics:
• Prerequisites, page 17
• Installing C4E, page 18
• Configuring C4E, page 18
• Deploying Object Types, page 28
• Importing Document Types, page 30
• Installing the HIP Epic ROI Module, page 31
• Configuring the HIP Epic ROI Module, page 31
• Configuring Epic Hyperspace, page 36
Prerequisites
Ensure that the following criteria are met before you start the installation of C4E:
• Content Server is installed and functioning properly.
• The following files are downloaded from the EMC Download Center:
— HIP-DCTM-1.6B250714_update.dar
— HIP-XDS-1.6.0.dar
— EMC Documentum Epic Integration-1.6B250714_update.msi
• The dardeployer.exe file located in the folder
C:\Documentum\product\6.7\install\composer\ComposerHeadless is deployed.
The HIP dar files contain the data models that are required to perform operations using C4E.
• Desktop Experience is enabled on Windows Server machines
• HIP Repository Server is installed and tested.
• The HL7.properties file is deployed and configured. This is required for batch scanning
integration with Epic.
• Epic Hyperspace Client is installed on all required workstations.
• Epic Print Server (EPS) is installed and tested.
17
C4E Installation and Configuration
• Scanner is attached to your network and functioning properly.
• If Citrix is used, the Epic Hyperspace is published via Citrix to the Epic Workstation machine,
where the scanner is connected and the respective scanner driver is installed.
• Microsoft Visual C++ 2008 redistributable installer is present in the Prerequisites folder of C4E
package.
• AX Viewer 7.0 present in the Prerequisites folder of C4E package is installed.
• Microsoft .NET Framework 4.0 redistributable installer is present in the Prerequisites folder of
C4E package and HIP Epic ROI module package.
• Datalogics PDF2Image redistributable installer is present in the Prerequisites folder in the HIP
Epic ROI module package.
• Documentum User Account is created for the use of Epic Integration solution components.
Do not share this account with other administrative functions.
• Documentum Foundation Services (DFS) Web service is functioning properly
EMC Documentum Connector for EPIC 1.6B250714_update Release Notes provides a complete list of
system requirements.
Installing C4E
1.
Uninstall the current version.
2.
Delete the config files, the temp files and the temp folders from the installation directory.
3.
Run the EMC Documentum Epic Integration-1.6B250714_update.msi file.
4.
Click Next.
5.
Click Install to start the installation process. The InstallShield wizard successfully completes
the installation.
6.
Click Finish.
Note: If you do not uninstall the current version and remove the config files from the installation
directory, you will get an XML error and the config tool will crash when it tries to load one of the
previous XML files.
Configuring C4E
1.
Go to the C4E installation directory.
For example, C:\Program Files (x86)\EMC\EMC Documentum Epic Integration.
2.
Double-click DCTM_EpicIntegratorConfig.exe.
3.
Type the configuration details in the following four tabs of theDCTM Epic Integrator
Configuration utility.
• Login: Contains basic information about your Documentum repository.
18
C4E Installation and Configuration
Configuring the login details:, page 19
• DCTM Server: Contains the Documentum Foundation Services (DFS) URL and the format of
the DOCUID.
Configuring the DCTM server details:, page 20
• Mime Types: Defines the media types in your repository that C4E can handle.
For each Mime Type, you can decide whether the integrated Documentum viewer or another
application allows viewing of the file. When the viewer encounters an unsupported media
format, the application uses the default Windows viewer for the file type.
Configuring the mimetype details:, page 22
• Scanning: Contains setting for your scanning operations.
Configuring the scanning details:, page 25
4.
Click Save.
You must click Save after you type the configuration details in each tab.
5.
Click Exit to close the utility.
Configuring the login details:
1.
Click Login.
2.
Type/select appropriate values in the fields, as mentioned in the following table:
Field
Description
Default DCTM Repository Name
Type the name of the Documentum repository
to which C4E is connected.
DCTM Repository User Name
Type the Documentum user name that the
C4E will use for all Documentum operations.
This user account must be exclusive to the
Epic EMR Integration solution.
DCTM Repository Password
Type the password for the Documentum user
name.
Admin User Name
Type the name of the Admin User.
By default, the Admin User Name is
EpicAdmin.
Epic must pass this user account to C4E to
enable the Admin user interface.
19
C4E Installation and Configuration
Field
Description
Log Output
Select the type of information required in the
C4E log file.
For example:
• Debug (All) – All messages, errors, and
warnings are written to the log file.
• Warnings & Errors – All errors and
warnings are written to the log file.
• Errors Only – Critical errors are written to
the log file.
• None – Disables logging.
3.
Click Save.
Configuring the DCTM server details:
1.
Click DCTM Server.
2.
Type /select appropriate values in the fields as mentioned in the following table:
Field
Description
DCTM Base URL
Type the Documentum Web Services Server
URL.
For example:
http://<server_name>:<port>/emc-dfs
The server name indicates the hostname of the
machine on which the AppServer is installed.
Check URL
Click this button to validate the URL.
An error message appears if the URL is not
valid.
Document ID (DOCUID) Format Mask
Displays the syntax C4E uses when it
creates the Epic Document Unique Identifier
(DOCUID).
You can create the syntax using Document ID
(DOCUID) Format Mask Builder.
Builder
Click to define the syntax C4E uses when it
creates the Epic DOCUID.
The Document ID (DOCUID) Format Mask Builder allows you to define the format that C4E
will use to generate document identifiers.
The following figure shows a sample.
20
C4E Installation and Configuration
3.
Create a Document ID Format using Document ID (DOCUID) Format Mask Builder as follows:
a.
Type /select appropriate values in the fields as mentioned in the following table:
Field
Description
Document ID (DOCUID)
Delimiter
Type a delimiter to separate the values in the
DOCUID.
For example, /.
You cannot use characters such as %, [], *, and " as
delimiters because they are reserved characters.
Fields/Formulas
Contains the following data fields and variables that
you can use to construct the DOCUID syntax.
• DCTM_objectId – A variable that supplies the
value of the object ID from the Documentum
Repository.
• DCTM_Repository – A variable that supplies the
name of the default Documentum Repository.
You defined this name on the Login tab.
• %DATETIME% – The current date and timestamp
in the format: YYYYMMDDHHMMSSA
• %DATE% – The current date in the format:
YYYYMMDD
• %TIME% – The current time in the format:
HHMMSSA
21
C4E Installation and Configuration
b. From Fields/Formulas, select DCTM_objectId and click
to the Display Order list.
to add the field/formula
Note: DCTM_objectId is mandatory to create a Document ID Format Mask.
c.
Select the other required Fields/Formulas and click
Display Order list.
to add the field/formula to the
To add a Literal Value to the Document ID Format Mask:
i.
Select Literal Value from the Type options.
ii. Type the value in the Value field and click
Order list.
to add the field/formula to the Display
To delete a Field/Formula from the Display Order list:
a.
Select the Field/Formula you want to delete.
b. Click
.
d. Click OK.
4.
Select View PDF Renditions (when available) if you want to view the scanned documents in
the PDF format.
During the view operation, C4E shows the documents in the PDF format only if PDF Rendition
exists for the selected document in Content Server and if you have selected the View PDF
Renditions option.
If you are importing and rendering a JPEG file to PDF, you can view the PDF file only if you have
selected the Viewer Support option in the Mime Types tab. The procedure Configuring the
mimetype details:, page 22 provides more details on Mime Type settings.
5.
Select View the CURRENT version of a document if you want to view the latest version of a
document.
6.
Click Save.
Configuring the mimetype details:
1.
Click Mime Types.
2.
Type /select appropriate values in the fields, as mentioned in the following table:
Field
Description
Mime Type
Type the Mime Type.
Extension
Type the file extension of the Mime type.
DCTM Format Name
Type the Documentum format name of the Mime.
If you want to enter a new format name which is not
currently supported by DCTM, the Administrator
must first create an entry for the new format name in
Documentum as a Documentum format.
22
C4E Installation and Configuration
Field
Description
Viewer Support
Select this option if you want to open the Mime type in
the C4E Documentum viewer.
All Mime types are not supported by the Documentum
viewer. Epic interface allows Windows to select the
default application to open the Mime types that are not
supported by the Documentum viewer.
You must select this option to view the JPEG files
rendered in PDF.
TIFF Support
Select the TIFF Support option to enable C4E to
convert images to TIFF format. When using your Epic
workstation to upload multiple images for one patient
record, this option enables C4E to convert the multiple
images into a single, multi-page TIFF image.
For example, if TIFF Support is enabled for the JPEG
Mime Type, and if you upload three JPEG files, C4E
converts the three images into a single multi-page TIFF
image.
If TIFF Support is enabled for both the BMP and JPEG
Mime types, and if you upload a Bitmap image and a
JPEG image, C4E will convert both the images to a single
multi-page TIFF image.
If one of the files cannot be converted (for example, an
audio file) or if it is not enabled for TIFF Support, C4E
will upload both files in their existing format.
When you import multiple image files, you receive
only one Object ID in response. However, when you
import/scan multiple documents, each document and
page will be added as separate objects in the docbase.
Note: You can enable TIFF Support ONLY for image files.
23
C4E Installation and Configuration
The following figure shows a sample of the configuration information:
3.
Click
.
The defined Mime Type appears in the list as a tilde (~) separated expression as follows:
Mime Type ~ File Extension ~ Documentum Format Name ~
Viewer Support (True/False), TIFF support (True/False)
Note: You cannot add more than one Mime type with the same values for Mime Type, Extension
and DCTM Format Name. The Mime Types created with the same values for Mime Type,
Extension and DCTM Format Name, but with different values for Viewer Support and TIFF
Support are considered as duplicate entries. The utility shows an error message if you attempt to
create a Mime type with the same values for Mime Type, Extension and DCTM Format Name.
4.
To delete a Mime Type:
a.
Select the Mime Type to be deleted from the list.
b. Click
.
A message “Are you sure you wish to remove the selected Mime Type” appears.
c.
Click Yes.
The mime types that you delete from the configuration utility will not be available to you later
for importing.
5.
To edit a Mime Type:
a.
24
Select the Mime Type to be edited from the list.
C4E Installation and Configuration
b. Edit the required fields.
c.
Click
.
A message “Are you sure you wish to edit the selected Mime Type” appears.
d. Click Yes.
6.
Click Save.
Configuring the scanning details:
1.
Click Scanning.
2.
Type /select appropriate values in the fields, as mentioned in the following table:
Field
Description
Default Paper Size
Select the default page size for scanned
images.
By default, the page size is US Legal.
You can change this setting during scanning.
The available values are:
• A4
• A5
• A6
• A7
• ISO B5
• ISO B6
• Business Card
• US Letter
• US Legal
Default Mode
Select the default scanning mode.
The available values are:
• Bitonal (B/W)
• Greyscale (256 color)
• Color (24-bit)
25
C4E Installation and Configuration
Field
Description
Default DPI
Select the default Dots Per Inch (DPI) setting
for scanning.
The available values are:
• 75
• 100
• 150
• 200
• 300
• 600
RootCabinet
Type the Documentum cabinet where the C4E
stores all the scanned and imported content.
The cabinet name must be preceded by a /.
The cabinet must already exist in the
Documentum.
GroupContextName
Type the Epic context parameter name. C4E
groups the documents based on this context
parameter name.
ACL Name
Type the Access Control List (ACL) name that
C4E will apply to the scanned and imported
documents. This name must already exist in
Documentum.
Max. Import Size (MB)
The maximum size of a file that C4E can
import. C4E does not permit importing a file,
if the file size is greater than the configured
size.
Working Folder
Click
and select the folder where
C4E stores the scanned documents or the
documents selected for viewing. You must
have full control permissions to this folder.
Also, ensure that the working folder path ends
with a ’\’.
This setting does not accept environment
variables. By default, the utility uses the C4E
installation location.
The working folder is accessible by both Epic
Hyperspace and Workstation machines, even
if they are on different machines.
26
C4E Installation and Configuration
Field
Description
3rd party application always on top
Select this option if you want the 3rd party
application window to appear on top of other
windows. For example, if you select this
option, the PDF Viewer appears on top of
other windows.
On top Timeout (sec)
Type the value taken by the 3rd party
application for loading the window. The value
is in seconds.
The default value is 10 seconds.
Note: The size of the documents that can be scanned depends on the Java heap size of the
application server. Therefore, when you scan the documents that occupy large memory size, for
example, documents with high DPI, or documents with large number of pages or documents
that need to be color scanned, you must ensure that the document size does not exceed the size
permitted by the web services of the application server.
A document that is successfully imported gets stored in the Documentum server. When the
imported document is added to the Documentum, a folder dmh_patient_folder is created and
the name of the patient is stored in the folder with the patient_name attribute.
When adding a document to the repository, the Connector stores the following meta-data to
indicate if the document was scanned or imported:
• source_id = c4e_import
• source_id = c4e_scan
When the import/scan operation is completed, you receive a message prompting to confirm if
the scanned/imported document must be uploaded to the repository. When the documents are
processed, the scanning interface shows a message indicating if the operation was a success or
a failure.
If the scan/import operation is performed on a tiff file, the status of the c4e _scan or
c4e_import input flag depends on the operation (scan/import) that is performed first. That is,
if you perform a scan first, the input flag is c4e_scan and if you perform an import first, the
input flag status is c4e_import.
3.
Click Save.
Chapter 4, C4E Configuration for Scanning provides more details on C4E configuration for
integration with a third-party scanning product.
The configuration settings in each tab in the configuration utility are saved to the following XML files:
• AppSettings.xml — Stores the settings you defined in the Login tab.
The schema for this file is:
<installation_dir>/AppSettingsSchema.xsd
• MimeTypes.xml — Stores the settings you defined in the Mime Types tab. Because there are
multiple configuration options for a single mime type, each grouping is contained within a
separate MimeType node.
The schema for this file is:
27
C4E Installation and Configuration
<installation_dir>/MimeTypeSchema.xsd
• DCTMSettings.xml — Stores the settings you defined in the DCTM Server tab.
The schema for this file is:
<installation_dir>/DCTMSettingsSchema.xsd
• ScanSettings.xml — Stores the settings you defined in the Scanning tab.
The schema for this file is:
<installation_dir>/ScanSettingsSchema.xsd
You can copy and deploy these files to other locations that require the same settings. The chapter
Appendix A, Sample Configuration Files provides a sample of these files.
Deploying Object Types
C4E requires the HIP dar files to be deployed before you can perform any operation such as import,
scan, and so on.
The following dar files contain the data models that are required to complete the operations:
• HIP-DCTM-1.6B250714_update.dar — stores the HIP Healthcare Information Model object
types
• HIP-XDS-1.6.0.dar — stores the HIP object types
Deploy both the DAR files using either the Composer D7 DAR Installer (dardeployer.exe) or
Documentum Headless Composer.
Deploying HIP dar files using dar deployer:
1.
28
Double-click dardeployer.exe located at <DCTM_install_dir>\product\7.1\install
\composer\ComposerHeadless\
C4E Installation and Configuration
2.
Define the following settings in the DAR Details and Docbroker Details sections:
• DAR — Browse and select the DAR file.
• Docbroker Host — Select your Docbroker host.
• Docbroker Port — Define the port number for your Docbroker host.
3.
Click Connect.
29
C4E Installation and Configuration
4.
Define the following settings in the Repository Details section:
• Repository — Select your Documentum Repository from the list.
• User Name — Supply the Documentum Content Server User Name.
• Password — Supply the password for the Documentum Content Server user name.
5.
Click Install. The DAR Installer informs you when the DAR files are successfully installed.
Deploy both the dar files as mentioned above.
Importing Document Types
To import your document types to the Documentum Server, use the DocTypes Import Utility and
import a configuration file that describes your document types. Your configuration file should
describe your document types with the following format:
<document_type>,<description>,<document_levels>,<enabled>
• document type: The document type value to be imported. For example, ABR.
• description: A description of the document type value. For example, ABR REPORT
• document levels: The applicable document level for the document type.
The acceptable values are single character values P, E, and O where P indicates Patient level, E
indicates Encounter level and O indicates Order level. The document type value must be unique
and can have only one value for the document level. If a document type is available at multiple
levels, the document type value must be different for each level.
• enabled: Defines if the imported document type is enabled for use or not. Set to 1 to enable it for
use. Set to 0 to disable the document type.
Sample document type descriptions:
ABR,ABR REPORT,P,1
AMBR,AMBULANCE RECORD,E,1
To import your document types:
1.
Go to the C4E installation directory.
For example, C:\Epic\EMC\EMC Documentum Epic Integration-1.6B250714_update.
2.
Double-click DctmConnectorDocTypeImportApp.exe.
3.
Type/select appropriate values in the fields as mentioned in the following table:
30
Field
Description
Server Url
Type the URL of the Documentum Web Services Server.
This is the same URL you provided for DCTM Base URL
in Configuring C4E, page 18.
Repository
Type the name of the primary Documentum Repository.
This is the same repository name you provided for Default
DCTM Repository Name in Configuring C4E, page 18.
C4E Installation and Configuration
Field
Description
UserName
Type the Documentum user name that the utility will use to
log in to Documentum.
Password
Type the password for the Documentum user name.
Select file
4.
and select the configuration file that contains your
Click
document types.
Click Import.
Installing the HIP Epic ROI Module
1.
Extract the DCTM_EPS_Painter_Plug-in.zip to a temporary location on your Epic
Hyperspace workstation or network drive.
2.
Double-click setup.exe.
3.
Click Next.
4.
Click Browse and select the installation folder for HIP Epic ROI module.
For example, C:\EPIC\sdk\8.1\Epic Print Service\bin\plug-ins\painters
Do not use the default installation location.
To enable logging and temporary file storage, users need Full Control permission for this folder.
5.
For Install Documentum EPS Plug-in for yourself, or anyone who uses this computer, select
the option appropriately.
Select Just me if you want to restrict access to the current user else select Everyone to enable
access to all users on the local system.
6.
Click Next.
7.
Click Next to start the installation.
You can click Back if you want to review your settings.
8.
Click Close when the installation is completed.
Configuring the HIP Epic ROI Module
1.
Go to the HIP Epic ROI installation directory.
2.
Double-click DCTM Epic Print Service Painter Config.exe.
3.
Type the configuration details in the following tabs as given in the following steps:
• DCTM Settings: Contains connection settings for your Documentum repository.
• General: Contains settings that control the general operation of the HIP Epic ROI module.
• Epic DOCUID: Defines the syntax that the HIP Epic ROI module uses when creating an the
Epic Document Unique Identifier (DOCUID).
4.
Configuring the DCTM Settings.
31
C4E Installation and Configuration
a.
Click the DCTM Settings tab.
b. Type /select appropriate values in the fields, as mentioned in the following table:
Field
Description
DCTM Base URL
Type the URL of the Documentum Web
Services Server. When using Tomcat, you
must include the webapp name in the URL:
For tomcat:
http://<server_name>:<port>/emc
-dfs/
For JBoss:
http://<server_name>:<port>
/services
Click to ensure that the URL is valid.
c.
5.
DCTM Default Repository
Type the name of the Documentum
repository to which C4E is connected.
DCTM User Name
Type the Documentum user name that the
HIP Epic ROI module will use to access
Documentum. This user account must
be exclusive to the Epic EMR Integration
solution.
DCTM password
Type the password for the Documentum
user name.
Click Save.
Configuring the General details.
a.
Click the General tab.
b. Type /select appropriate values in the fields as mentioned in the following table:
Field
Description
Working Folder
and select the folder where the
Click
HIP Epic ROI module places the temporary
files when Epic requests documents.
The user must have full control permissions
to this folder.
This setting will not accept environment
variables. By default, the utility uses the
installation location of the HIP Epic ROI
module.
32
C4E Installation and Configuration
Field
Description
Working Folder Purge
Type a value to define the duration after
which the HIP Epic ROI module will delete
temporary files from the working folder.
The module deletes temporary files when
the files are older than the value specified
here.
Values are defined in minutes. To disable
this feature, set the value to 0.
Log Output
Select the type of information required in
the C4E log file.
For example:
• Debug (All) – All messages, errors, and
warnings are written to the log file.
• Warnings & Errors – All errors and
warnings are written to the log file.
• Errors Only – Critical errors are written
to the log file.
• None – Logging is disabled.
Log Location
Select the location of the HIP Epic ROI
module log file.
Select one of the following values:
• Default – The installation directory of the
HIP Epic ROI module.
• Application Data – The Windows
Application Data folder.
• Desktop – The Windows Desktop folder.
• Documents – The Windows Documents
folder.
• Temp – The Windows Temp folder.
c.
6.
Click Save.
Configuring the Epic DOCUID details.
a.
Click the Epic DOCUID tab.
b. Type /select appropriate values in the fields as mentioned in the following table:
33
C4E Installation and Configuration
Field
Description
Document ID (DOCUID) Delimiter
Displays the delimiter to separate the values
in the DOCUID.
The value that you specified using Builder
appears here.
Document ID (DOCUID) Format Mask
Displays the syntax C4E uses when it
creates the Epic Document Unique Identifier
(DOCUID).
The format that you define using Builder
appears here.
Builder
Click to define the syntax C4E uses when
it creates a DOCUID.
The Document ID (DOCUID) Format Mask
Builder dialog box shown in the following
figure allows you to define the DOCUID
Format.
c.
To create a Document ID Format of Field/ Formula type using Document ID (DOCUID)
Format Mask Builder:
i.
From the Type options, select Field/Formula.
ii. Type /select appropriate values in the fields, as mentioned in the following table:
34
C4E Installation and Configuration
Field
Description
Document ID (DOCUID) Delimiter
Type a delimiter to separate the values in
the DOCUID.
For example, /.
You cannot use the characters such as %,
[], *, and " as delimiters because they are
reserved characters.
Fields/Formulas
Contains data fields and variables that you
can use to construct the DOCUID syntax.
The available Fields and Formulas are:
• DCTM_objectId – A variable that
supplies the value of the object ID from
the Documentum Repository.
• DCTM_Repository – A variable that
supplies the name of the default
Documentum Repository. You defined
this name on the Login tab.
• %DATETIME% – The current date and
timestamp in the following format:
YYYYMMDDHHMMSSA
• %DATE% – The current date in the
following format:
YYYYMMDD
• %TIME% – The current time in the
following format:
HHMMSSA
iii. From Fields/Formulas, select DCTM_objectId and click
to the Display Order list.
to add the field/formula
Note: DCTM_objectId is mandatory to create a Document ID Format Mask.
iv. Select the other required Fields/Formulas and click
the Display Order list.
to add the field/formula to
Note: To add a Literal Value to the Document ID Format Mask:
a.
Select Literal Value from the Type options.
b. Type the value in the Value field and click
Display Order list.
to add the field/formula to the
35
C4E Installation and Configuration
If you want to delete a Field/Formula from the Display Order list, select the
Field/Formula you want to delete and click
.
v. Click OK.
d. Click Save.
7.
Click Exit to close the utility.
The configuration settings in each tab in the configuration utility are saved to the following XML
files in the HIP Epic ROI installation directory:
• AppSettings.xml – This file stores the settings you defined on the General tab. The schema for
this file is:
<installation_dir>/AppSettingsSchema.xsd
• DCTMSettings.xml – This file stores the settings you defined on the DCTM Settings tab. The
schema for this file is:
<installation_dir>/DCTMSettingsSchema.xsd
You can copy and deploy these files to other location that require the same settings. The chapter
Appendix A, Sample Configuration Files provides a sample of these files.
Configuring Epic Hyperspace
You must configure Epic Hyperspace to use the C4E components.
1.
Log in to Epic Hyperspace.
2.
View the Workstation Settings and open a Workstation Profile.
3.
In the Sections list, select Media Handlers.
4.
Select the Scan attribute and type the following value: DCTM_EpicIntegratorViewer
.Viewer.
5.
From the sections list, select Scans.
6.
Select the ProgID of Scan Acquisition Server attribute and type the following value:
DCTM_EpicIntegration.EpicScan.
7.
Select the ProgID of Scan Viewer attribute and type the following value: DCTM
_EpicIntegratorViewer.Viewer.
8.
Accept the changes and restart Epic Hyperspace.
36
Chapter 4
C4E Configuration for Scanning
This chapter describes the specific C4E configuration settings to be built in Epic for integration
with a third-party scanning product.
This chapter contains the following topics:
• FDI Record Settings, page 37
• LWP Record Settings, page 38
• SDF Settings, page 39
• EAF/HSD Settings, page 39
FDI Record Settings
Attribute
Value
MEDIAHANDLER_PROGID
EACCMEDIAHANDLER81
.ACCUSTOMSCANHANDLER
SCANACQ_PROGID
DCTM_EpicIntegration.EpicScan
NEEDS_AUTHENTICATION
0
GENERIC_USERID
EpicAdmin
GENERIC_PASSWORD
EpicAdmin
SCANACQ_INITPARAMS
NA
SCANVIEWER_PROGID
DCTM_EpicIntegratorViewer.Viewer
SCANVIEWER_LIC_KEY
NA
IMAGE_PLUGIN_NAME
dctmimg
IMAGE_PLUGIN_XML_PP
NA
EXTAPP_STRING
NA
WEB_ACQ_URL_PROGPT
NA
WEB_VIEW_URL_PROGPT
NA
WEB_ACQ_PROGID
NA
SCANACQ_ADDL_CTX
NA
37
C4E Configuration for Scanning
Attribute
Value
SCANACQ_ADDL_INFO
NA
SCANACQ_ADDL_STATIC
NA
DEFICIENCY_URL_PROG
NA
EPICWEB_MEDIAHANDLER
NA
EPICWEB_VIEWERURL
NA
EPICWEB_VIEWERURL
NA
LWP Record Settings
Attribute
Value
File Format
NA
LWP1
Path
NA
LWP2
ProgID of Scan Acquisition Server
DCTM_EpicIntegration.EpicScan
LWP3
ProgID of Scan Viewer
No value. (To be left blank)
LWP4
Use BlobServer
No
LWP5
Use Scan Acquisition System
Yes
LWP6
Default workstation settings > Media Handlers
> Scan
38
EACCMEDIAHANDLER81
.ACCUSTOMSCANHANDLER
C4E Configuration for Scanning
SDF Settings
Attribute
Value
ProgID of Scan Analyst Module
NA
SDF1
ProgID of Scan Provider Signature Module
NA
SDF2
EAF/HSD Settings
Attribute
Value
Application Path
NA
EAF 1
Display Title
NA
EAF 2
Payment Posting
NA
HSD 1
Denial/Correspondence Follow-up
NA
HSD 2
39
C4E Configuration for Scanning
40
Appendix A
Sample Configuration Files
This appendix contains the following sample files associated with C4E:
• C4E AppSettings.xml, page 41
• C4E DCTMSettings.xml, page 41
• C4E MimeTypes.xml, page 42
• C4E ScanSettings.xml, page 43
• ROI Module AppSettings.xml, page 43
• ROI Module DCTMSettings.xml, page 43
C4E AppSettings.xml
<?xml version="1.0" standalone="yes"?>
<AppSettingsSchema xmlns="http://tempuri.org/AppSettingsSchema.xsd">
<Global>
<DefaultRepository>Healthcare</DefaultRepository>
<UserName>njkA2n+hLHAGo8A7u1pBJA==</UserName>
<Password>SH9N2tOaKencWkYkdC9iBA==</Password>
<Logging>2</Logging>
</Global>
</AppSettingsSchema>
C4E DCTMSettings.xml
<?xml version="1.0" standalone="yes"?>
<DCTMSettingsSchema xmlns="http://tempuri.org/DCTMSettingsSchema.xsd">
<DCTM>
<DCTMBase_URL>http://localhost:8080/emc-dfs/</DCTMBase_URL>
<DOCUIDMask>[DCTM_Repository]/[DCTM_objectId]/%DATETIME%</DOCUIDMask>
<DOCUIDDelimiter>/</DOCUIDDelimiter>
</DCTM>
</DCTMSettingsSchema>
41
Sample Configuration Files
C4E MimeTypes.xml
<?xml version="1.0" standalone="yes"?>
<MimeTypeSchema xmlns="http://tempuri.org/MimeTypeSchema.xsd">
<MimeType>
<Type>application/msword</Type>
<Extension>doc</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>false</TiffSupport>
<DCTMFormatName>doc</DCTMFormatName>
</MimeType>
<MimeType>
<Type>application/pdf</Type>
<Extension>pdf</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>false</TiffSupport>
<DCTMFormatName>pdf</DCTMFormatName>
</MimeType>
<MimeType>
<Type>image/jpeg</Type>
<Extension>jpg</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>true</TiffSupport>
<DCTMFormatName>jpeg</DCTMFormatName>
</MimeType>
<MimeType>
<Type>image/jpeg</Type>
<Extension>jpeg</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>true</TiffSupport>
<DCTMFormatName>jpeg</DCTMFormatName>
</MimeType>
<MimeType>
<Type>image/jpeg</Type>
<Extension>jpe</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>true</TiffSupport>
<DCTMFormatName>jpeg</DCTMFormatName>
</MimeType>
<MimeType>
<Type>image/tiff</Type>
<Extension>tiff</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>true</TiffSupport>
<DCTMFormatName>tiff</DCTMFormatName>
</MimeType>
<MimeType>
<Type>image/tiff</Type>
<Extension>tif</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>true</TiffSupport>
<DCTMFormatName>tiff</DCTMFormatName>
</MimeType>
<MimeType>
<Type>text/plain</Type>
<Extension>txt</Extension>
<ViewerSupport>true</ViewerSupport>
<TiffSupport>false</TiffSupport>
<DCTMFormatName>text</DCTMFormatName>
</MimeType>
<MimeType>
<Type>video/avi</Type>
<Extension>avi</Extension>
42
Sample Configuration Files
<ViewerSupport>false</ViewerSupport>
<TiffSupport>false</TiffSupport>
<DCTMFormatName>avi</DCTMFormatName>
</MimeType>
</MimeTypeSchema>
C4E ScanSettings.xml
<?xml version="1.0" standalone="yes"?>
<ScanSettingsSchema xmlns="http://tempuri.org/ScanSettingsSchema.xsd">
<ScanSettings>
<PaperSizeIndex>1</PaperSizeIndex>
<DPI>200</DPI>
<ModeIndex>0</ModeIndex>
<WorkingFolder>C:\Program Files (x86)\EMC\Documentum Epic Integrator\Temp
</WorkingFolder>
<ACLName />
<GroupContextName />
<RootCabinet />
</ScanSettings>
</ScanSettingsSchema>
ROI Module AppSettings.xml
<?xml version="1.0" standalone="yes"?>
<AppSettingsSchema xmlns="http://tempuri.org/AppSettingsSchema.xsd">
<Global>
<WorkingFolder>C:\Program Files (x86)\EMC\Documentum EPS Painter Plug-in\
</WorkingFolder>
<PurgeFolder>5</PurgeFolder>
<Logging>2</Logging>
<LogFolder>Default</LogFolder>
</Global>
</AppSettingsSchema>
ROI Module DCTMSettings.xml
<?xml version="1.0" standalone="yes"?>
<DCTMSettingsSchema xmlns="http://tempuri.org/DCTMSettingsSchema.xsd">
<DCTM>
<DCTMBase_URL>http://localhost:8080/emc-dfs</DCTMBase_URL>
<DefautlDCTMRepository>Healthcare</DefautlDCTMRepository>
<UserName>njkA2n+hLHAGo8A7u1pBJA==</UserName>
<Password>SH9N2tOaKencWkYkdC9iBA==</Password>
<DOCUIDMask>[DCTM_Repository]/[DCTM_objectId]/%DATETIME%</DOCUIDMask>
<DOCUIDDelimiter>/</DOCUIDDelimiter>
</DCTM>
43
Sample Configuration Files
</DCTMSettingsSchema>
44
Index
A
E
access control settings, 13
ACL name, 25
authentication configuration, 13
EAF/HSD record settings, 39
Epic ROI module, 9
B
batch importing documents with C4E, 12
batch scanning documents with C4E, 12
C
F
FDI record settings, 37
functions of C4E, 11
I
importing document types, 30
importing documents with C4E, 12
installing C4E, 18
installing HIP Epic ROI module, 31
C4E installation
configuration, 17
C4E scanning configuration, 37
communication security settings
port usage, 14
configuring C4E, 18
configuring DCTM server details
DCTM base URL, 20
configuring Epic Hyperspace, 36
configuring HIP Epic ROI module, 31
configuring login details, 19
configuring mimetype details
mime type, 22
configuring scanning details
root cabinet, 25
Connector for Epic
functions of Epic, 9
log description, 14
log output
log location, 32
log settings, 14
LWP record settings, 38
D
prerequisites for C4E installation, 17
Program ID of scan acquisition server, 36
Program ID of scan viewer, 36
publishing ROI packages, 12
DCTM base URL
DCTM default repository, 32
DCTM format name, 22
DCTM user name
DCTM password, 32
deploying object types, 28
DOCUID delimiter, 35
L
O
on top timeout (sec), 25
P
S
sample configuration files, 41
scanning documents with C4E, 11
SDF record settings, 39
secure deployment and usage settings
C4E layers, 15
45
Index
46
security configuration, 13
V
T
TIFF Support, 22
viewer support, 22
viewing documents with C4E
file types supported by C4E, 11
U
W
user authentication, 13
user authorization, 14
working folder
working folder purge, 32
working of C4E, 10