To set up synchronization with an Epic health care system, a server must be available with the following software installed on it
All One Identity Manager Service actions are run against the target system environment on the synchronization server. Data entries required for synchronization and administration with the One Identity Manager database are processed by the synchronization server. The synchronization server must be declared as a Job server in One Identity Manager.
NOTE: If several target system environments of the same type are synchronized under the same synchronization server, it is useful to set up a Job server for each target system on performance grounds. This avoids unnecessary swapping of connections to target systems because a Job server only has to process tasks of the same type (re-use of existing connections).
Use the Server Installer to install the One Identity Manager Service. The program runs the following steps:
- Setting up a Job server.
- Specifying machine roles and server function for the Job server.
- Remote installation of One Identity Manager Service components corresponding to the machine roles.
- Configuration of One Identity Manager Service.
- Starts the One Identity Manager Service.
NOTE: The program runs remote installation of the One Identity Manager Service. Local installation of the service is not possible with this program. Remote installation is only supported within a domain or a trusted domain.
For remote installation of One Identity Manager Service, you require an administrative workstation on which the One Identity Manager components are installed. For detailed information about installing a workstation, see the One Identity Manager Installation Guide.
To install and configure One Identity Manager Service remotely on a server
- Start the program Server Installer on your administrative workstation.
- Enter the valid connection credentials for the One Identity Manager database on the Database connection page.
- Specify the server on which you want to install One Identity Manager Service on the Server properties page.
Select a Job server from the Server menu.
- OR -
To create a new Job server, click Add.
Enter the following data for the Job server.
Table 2: Job Server Properties
| Property |
Description |
| Server |
Job server name. |
| Queue |
Name of the queue to handle the process steps.
Each One Identity Manager Service within the network must have a unique queue identifier. The process steps are requested by the job queue using exactly this queue name. The queue identifier is entered in the One Identity Manager Service configuration file. |
| Full server name |
Full server name in accordance with DNS syntax.
Example: <Name of servers>.<Fully qualified domain name> |
NOTE: You can use the Extended option to make changes to other properties for the Job server. You can also edit the properties later with Designer.
- Select Epic on the Machine roles page.
- Select Epic connector on the Server functions page.
- Check the One Identity Manager Service configuration on the Service settings page.
NOTE:The initial service configuration is predefined already. If further changes need to be made to the configuration, you can do this later with the Designer. For more information about configuring the service, see the One Identity Manager Configuration Guide.
-
To configure remote installations, click Next.
-
Confirm the security prompt with Yes.
-
Select the directory with the install files on Select installation source.
-
Select the file with the private key on the page Select private key file.
NOTE: This page is only displayed when the database is encrypted.
-
Enter the service's installation data on the Service access page.
Table 3: Installation Data
| Data |
Description |
| Computer |
Server on which to install and start the service from.
To select a server
Enter a name for the server.
- OR -
Select a entry from the list. |
| Service Account |
User account data for the One Identity Manager Service.
To enter a user account for the One Identity Manager Service
Set the option Local system account. This starts the One Identity Manager Service under the NT AUTHORITY\SYSTEM account.
- OR -
Enter user account, password and password confirmation. |
| Installation account |
Data for the administrative user account to install the service.
To enter an administrative user account for installation
Enable Advanced. l Enable Current user. This uses the user account of the current user.
- OR -
Enter user account, password and password confirmation. |
- Click Next to start installing the service.
Installation of the service occurs automatically and may take some time.
- Click Finish on the last page of Server Installer.
NOTE: The service is entered with the name One Identity Manager Service in the server service management.
Use Synchronization Editor to configure synchronization between the One Identity Manager database and Epic health care system. The following describes the steps for initial configuration of a synchronization project. For more information about setting up synchronization, see the One Identity Manager Target System Synchronization Reference Guide.
After the initial configuration, you can customize and configure workflows within the synchronization project. Use the workflow wizard in the Synchronization Editor for this. The Synchronization Editor also provides different configuration options for a synchronization project.
The following information is required for setting up a synchronization project.
Table 4: Information Required for Setting up a Synchronization Project
| Data |
Explanation |
| Client Name |
Client name who is using Epic |
| Environment Name |
Epic instance’s environment being connected to. Example: TEST, PROD |
| Connection display |
Provide a display name for the Epic connection |
| Client ID |
Valid Epic Client ID for authenticating against the Epic web services. For more information, see Epic health care system prerequisites for using One Identity Client ID.
NOTE: Production Client ID must be used to connect to Epic’s Production environment and Non-Production Client ID must be used to connect to Epic’s Non-Production environments |
| Username |
User that has access to the Epic web services
- If the username is an EMP user account, then prefix the username with emp:
Example: If username is webServiceAccount, then enter the username as emp:webServiceAccount
- If the username is an Active directory user account then prefix the username with windows:
Example: If username is webServiceAccount, then enter the username as windows:webServiceAccount |
| Password |
Password of the user who has access to the Epic web services |
| Audit user id |
Epic EMP user id that should be used for auditing the web service calls being made. The user needs to be active.
IMPORTANT:The EMP user id supplied should be the External ID of the user.
NOTE:It is highly recommended that an exclusive Epic EMP service account is created and used as the Audit user id |
| Audit user password |
Audit user password needs to be supplied only on Epic versions prior to Epic 2018 |
| Personnel Management Webservice URL |
Epic’s Personnel management web services URL.
NOTE: Only one connection is allowed to a particular Epic environment. So the Personnel Management Webservice URL needs to be unique across synchronization projects. |
| Demographic (User) Webservice URL |
Epic’s demographics (User) web services URL
NOTE: Only one connection is allowed to a particular Epic environment. So the Demographics (User) Webservice URL needs to be unique across synchronization projects. |
| CSV import directory |
The directory from which the Epic EMP User, EMPTemplate and SubTemplate CSV reports should be fetched. This directory can be local folder or a network share.
IMPORTANT: Important If local folder is used, make sure to set up the local folder on the synchronization server and One Identity Manager workstation. If network shared path is used provide the UNC path to the network share. |
| CSV import directory Credential |
If the CSV import directory is a network share click this check box to optionally enter the credentials.
NOTE: Not applicable for a local folder. |
| UserName |
If the CSV import directory is a network share optionally enter the username to access the network share. Enter the username in the following format Domain Name\Username. |
| Password |
If the CSV import directory is a network share optionally enter the password to access the network share. |
| IsNativeEpicAuthentication |
Click this checkbox if the Epic environment is configured to use native Epic authentication. This value determines whether the Epic EMP user account password changes are propagated to the target system or not. Password updates to Epic EMP user accounts take place only if native Epic authentication is configured. |
| Use Custom PowerShell Script for User Import |
If the Epic EMP user report generated out of Epic needs to be customized even further before it is used by the Epic connector check this check box. Copy the EpicUserReportFilterScript.ps1 from the One Identity Manager installer’s dvd/Addon folder to the CSV import directory. Customize the PowerShell script according to the requirements. Now, the Epic connector would use the data returned by the PowerShell script rather than the EMP user report CSV file.
IMPORTANT: If local folder is used, make sure to copy the PowerShell script to the job server’s local folder and One Identity Manager workstation’s local folder. If the PowerShell script execution policy on job server or One Identity Manager workstation is set to AllSigned, then the PowerShell script has to be signed after modification or change the script execution policy on the server to be less restrictive for the script to run. |
| Synchronization server for Epic health care system |
All One Identity Manager Service actions are run against the target system environment on the synchronization server. Data entries required for synchronization and administration with the One Identity Manager database are processed by the synchronization server.
The One Identity Manager Service with the Epic connector must be installed on the synchronization server. The synchronization server must be declared as a Job server in One Identity Manager. Use the following properties when you set up the Job server.
Property Value
Server function Epic connector Machine role Server | Job server |
Additional properties for the Job server. For more information, see Setting up the synchronization server. |
| One Identity Manager database connection data |
Database server
- Database
- SQL Server Login and password
Specifies whether integrated Windows authentication is used. This type of authentication is not recommended. If you decide to use it anyway, ensure that your environment supports Windows authentication. |
| Remote connection server |
To configure synchronization with a target system, One Identity Manager must load the data from the target system. One Identity Manager communicates directly with target system to do this. Sometimes direct access from the workstation on which the Synchronization Editor is installed is not possible, because of the firewall configuration, for example, or because the workstation does not fulfill the necessary hardware and software requirements. If direct access to the workstation is not possible, you can set up a remote connection. The remote connection server and the workstation must be in the same Active Directory domain.
Remote connection server configuration
- One Identity Manager Service is started
- RemoteConnectPlugin is installed
- Epic connector is installed
The remote connection server must be declared as a Job server in One Identity Manager. The Job server name is required.
NOTE: The remote connection server requires the same configuration as the synchronization server (with regard to the installed software and entitlements). Use the synchronization as remote connection server at the same time, by simply installing the RemoteConnectPlugin as well. For more information about setting up a remote connection, see the One Identity Manager Target System Synchronization Reference Guide. |
NOTE: The following sequence describes how you configure a synchronization project if Synchronization Editor is both
- Run in default mode, and
- Started from the launchpad
If you run the project wizard in expert mode or directly from Synchronization Editor, additional configuration settings can be made. Follow the project wizard instructions through these steps.
To set up an initial synchronization project for Epic health care system
- Start the Launchpad and log on to the One Identity Manager database.
NOTE: If synchronization is run by an application server, connect the
database through the application server.
- Select Target system type Epic and click Start.
This starts the Synchronization Editor's project wizard.
- Specify how One Identity Manager can access the target system on the System access page.
- If access is possible from the workstation on which you started Synchronization Editor, you do not need to make any settings.
- If access is not possible from the workstation on which you started Synchronization Editor, you can set up a remote connection.
Enable the Connect using remote connection server option and select the server to be used for the connection under Job server.
-
Enter the system connection details for your client.
- Enter the advance settings details if the option has been chosen.
- On the One Identity Manager Connection tab, test the data for connecting to the One Identity Manager database. The data is loaded from the connected database. Reenter the password.
NOTE: If you use an unencrypted One Identity Manager database and have not yet saved any synchronization projects to the database, you need to enter all connection data again. This page is not shown if a synchronization project already exists.
- The wizard loads the target system schema. This may take a few minutes depending on the type of target system access and the size of the target system.
- On the Restrict target system access page, you specify how system access should work. You have the following options
Table 5: Specify target system access
| Option |
Meaning |
| Read-only access to target system |
Specifies whether a synchronization workflow is only to be set up for the initial loading of the target system into the One Identity Manager database.
The synchronization workflow has the following characteristics
- Synchronization is in the direction of One Identity Manager.
- Processing methods in the synchronization steps are only defined for synchronization in the direction of One Identity Manager.
|
| Read/write access to target system. Provisioning available. |
Specifies whether a provisioning workflow is to be set up in addition to the synchronization workflow for the initial loading of the target system.
The provisioning workflow displays the following characteristics
- Synchronization is in the direction of the Target system.
- Processing methods are only defined in the synchronization steps for synchronization in the direction of the Target system.
- Synchronization steps are only created for such schema classes whose schema types have write access.
|
- Select the synchronization server to run synchronization on the Synchronization server page.
If the synchronization server is not declared as a Job server in the One Identity Manager database yet, you can add a new Job server.
- Click to add a new Job server.
-
Enter a name for the Job server and the full server name conforming to DNS syntax.
-
Click OK.
The synchronization server is declared as Job server for the target system in the One Identity Manager database.
NOTE: After you save the synchronization project, ensure that this server is set up as a synchronization server.
-
To close the project wizard, click Finish.
This creates and allocates a default schedule for regular synchronization. Enable the schedule for regular synchronization.
The synchronization project is created, saved and enabled immediately.
NOTE:
- If you do not want the synchronization project to be activated immediately, disable the Activate and save the new synchronization project automatically option. In this case, save the synchronization project manually before closing the Synchronization Editor.
- The connection data for the target system is saved in a variable set and can be modified under Configuration | Variables in Synchronization Editor.
Configure the created initial synchronization project for Epic health care system
Configure the following variables of the synchronization project
- Locale: The locale that is used in Epic. Date time values are formatted based on the locale. Contact your Epic administrator to get the locale. Default locale is en-US.
-
EpicVersion: Epic deployment version should be entered in "Month Year" format. For example, to indicate Epic version May 2020, enter as May 2020. This variable would be used for futuristic version specific implementation for any API upgrades.
-
LinkedProviderIDType: Epic EMP-SER Link Provider ID Type that the customer would like to use. Once synchronization has been run after configuring the ID Type it should not be changed to avoid data inconsistency or potential data loss.
Configure the following fields under the Mappings section of the synchronization project
- User Mappings
- vrtDateFormat: Configure the date format that you want to use based on the locale. If the locale is en-US, the configuration is already done and you need not to do anything more.
- UserHasEMPTemplate Mappings
- vrtDateFormat: Configure the date format that you want to use based on the locale. If the locale is en-US, the configuration is already done and you need not to do anything more.
To configure the content of the synchronization log
- Open the synchronization project in the Synchronization Editor.
- To configure the synchronization log for target system connection, select the category Configuration | Target system.
- To configure the synchronization log for the database connection, select Configuration | One Identity Manager connection.
- Select the General view and click Setup.
- Select the Synchronization log view and set Create synchronization log.
- Enable the data to be logged.
NOTE: Some content generates a particularly large volume of log data. The synchronization log should only contain data required for troubleshooting and other analyses.
- Click OK.
To synchronize on a regular basis
- Open the synchronization project in the Synchronization Editor.
- Select the category Configuration | Start up configurations.
- Select a start up configuration in the document view and click Edit schedule.
- Edit the schedule properties.
- To enable the schedule, click Activate.
- Click OK.
To start initial synchronization manually
1. Open the synchronization project in the Synchronization Editor.
2. Select the category Configuration | Start up configurations.
3. Select a start up configuration in the document view and click Execute.
4. Confirm the security prompt with Yes.
NOTE: Following a synchronization, employees are automatically created for the user accounts in the default installation. If an account definition for the client is not yet known at the time of synchronization, user accounts are linked with employees. However, account definitions are not assigned. The user accounts are therefore in a Linked state.
To manage the user accounts using account definitions, assign an account definition and a manage level to these user accounts.
To select user accounts through account definitions
- Create an account definition.
- Assign an account definition to the client.
- Assign the account definition and manage level to user accounts in linked status.
- In One Identity Manager, select Epic Healthcare | User accounts | Linked but not configured | <Client>.
- Select Assign account definition to linked accounts.
Related Topics
Synchronization results are summarized in the synchronization log. You can specify the extent of the synchronization log for each system connection individually. One Identity Manager provides several reports in which the synchronization results are organized under different criteria.
To display a synchronization log
- Open the synchronization project in the Synchronization Editor.
- Select Logs.
- Click in the navigation view toolbar.
Logs for all completed synchronization runs are displayed in the navigation view.
-
Select a log by double-clicking on it.
An analysis of the synchronization is shown as a report. You can save the report.
To display a provisioning log
- Open the synchronization project in the Synchronization Editor.
- Select Logs.
- Click in the navigation view toolbar.
Logs for all completed provisioning processes are displayed in the navigation view.
- Select a log by double-clicking on it. An analysis of the provisioning is show as a report. You can save the report.
- The log is marked in color in the navigation view.
This mark shows you the execution status of the synchronization/provisioning.
- Synchronization logs are stored for a fixed length of time.
To modify the retention period for synchronization logs
- In Designer, enable the DPR | Journal | LifeTime configuration parameter and
enter the maximum retention period.
You have used the Synchronization Editor to set up a synchronization project for synchronization of an Epic health care system. If you manage user accounts and their authorizations with One Identity Manager, changes are provisioned in the Epic health care system. You can customize the synchronization as required by updating the synchronization project’s workflow, mappings, variables and start up configurations
IMPORTANT: As long as synchronization is running, you must not start another synchronization for the same target system. This applies especially, if the same synchronization objects would be processed.
- If another synchronization is started with the same start up configuration, this process is stopped and is assigned the Frozen execution status. An error message is written to the One Identity Manager Service log file.
- If another synchronization is started with another start up configuration, that addresses same target system, it may lead to synchronization error or loss of data. Specify One Identity Manager behavior in this case, in the start up configuration. Group start up configurations with the same start up behavior.
For detailed information about configuring synchronization, see the One Identity Manager Target System Synchronization Reference Guide.
