2.7 Creating the Driver Object

To create the Epic EMP driver the driver packages must first be installed in the Designer project’s Package Catalog. When creating the driver object, these packages must be added to the driver object and configured for the target environment.

2.7.1 Importing the Current Driver Packages

To import the driver packages into Designer please use the following steps:

  1. Open Designer.

  2. In the Outline view, right-click the Package Catalog.

  3. Click Import Package.

  4. Browse to the location where the Epic EMP Driver, Epic EMP Driver Default, and Epic EMP Driver Entitlements packages were downloaded.

  5. Select all packages for the Epic EMP Driver.

  6. Click Select All to import all of the packages displayed in the screen.

  7. Click OK to import the selected packages, then click OK in the successfully imported packages message.

  8. After the packages are imported the driver object may be created and configured for the target environment.

2.7.2 Activating the Driver

The Epic EMP driver is activated by loading the Epic EMP Driver Micro Focus license key.

Note that the driver must be activated within 90 days of installation, else the driver stops working and an activation error will be displayed in the driver trace file.

Additionally, the driver must also be registered with Epic for use in the customer's Epic environments. This is done in 1 of 3 manners:

  • The customer's App Orchard Point Person (AOPP) contacts their Epic App Orchard TS and provides the application name of "Micro Focus IDM Driver for User Management".

  • The customer registers the driver with Epic by submitting the App Orchard App Request Process document located on Epic's Galaxy documentation portal.

  • The customer contacts their Micro Focus Account Executive who could have the driver registered on the customer's behalf.

2.7.3 Authentication

Parameter

Description

Authentication ID

The authentication ID for the driver. The format is EMP:<ID>

Set Password

The password for the driver

2.7.4 Driver Parameters

The following driver parameters are set for the Epic EMP driver

Driver Options

Parameter

Description

Epic Version

The version of the Epic implementation. Select 2017 if the implementation is running Epic 2017 or newer

Epic Environment

Select Production or Non-Production

ID Types

A list of custom ID types (Item 20700/20701) to set. This is very implementation specific. When an ID type is added here it will show in the Schema as IDType-<value>. The value listed here comes from the ID type descriptor under Names in Other Systems in the ID type definition in Epic.

NOTE:In the ID Type definition under the ID Rules tab in Epic the Method must be either user entered or system generated.

Trust All Certs

If enabled, tells the driver to trust all certs when establishing the https connection to the Epic SOAP endpoint (there are security risks associated with utilizing this functionality as it can potentially open the system to MIM attacks)

Subscriber Options

Parameter

Description

URL of SOAP Endpoint

The WSDL location for the Epic SOAP endpoint. This can be of either, file or URI format (that is, https://server/path/epic.wsdl or file:/var/opt/epic/epic.wsdl)

Enable Data Courier Log File

Yes or No as to enable the data courier log file

Path for data courier log files

The location to store log files if enabled

Force Contact on all Updates

Yes or No as to force contact on updates in Epic. If set to yes, the Epic will create a new contact record on every update from the driver.

Audit User

The audit user in Epic that will be identified as the creator of a new User record

Audit User Password

The audit user’s password

Path to template CSV file

The full file path to the location of the template CSV file provided by Epic for linkable templates and sub-templates

2.7.5 Global Configuration Values

Global configuration values (GCVs) are values that can be used by the driver to control functionality. GCVs are defined on the driver or on the driver set. Driver set GCVs can be used by all drivers in the driver set. Driver GCVs can be used only by the driver on which they are defined.

Configuration

The following driver parameters are set for the Epic EMP Driver Default package.

Parameter

Description

Use Epic ID for Create

  • If true selected, then the value of the user's configured Epic ID attribute will be used when creating the EMP record. Note that if there is:

    • no Epic ID value set on the user, then the create will be vetoed.

    • If false is selected, then Epic ID will arbitrarily assign the ID on create of EMP record.

Epic ID Attribute

Attribute in IDV containing Epic ID value to use during EMP record creation.

Entitlements

The following driver parameters are set for the Epic EMP Driver Entitlements package.

Parameter

Description

Use User Account Entitlement

When the driver is enabled for entitlements, accounts are only created and removed/disabled when the account entitlement is granted to or revoked from users.

Entitlements are granted and revoked only by entitlement agents. Three entitlement agents ship with Identity Manager:

  • Role-Based Entitlements (RBE): RBE is ideal for simple automation. For example, when a user is added to the HR system, the user is automatically granted accounts in other systems

  • Workflow: Workflow is ideal for approvals. For example, when a user is added to the HR system, the manager must approve the accounts for the user.

  • Roles Based Provisioning Module (RBPM): RBPM is ideal for true and full-featured roles based provisioning. For example, when a user is added to the Accounting role, the user automatically receives all accounts associated with the Accounting role.

If True is selected, one of these entitlement agents must be installed and configured for the driver to create and delete accounts. For more information, see the Identity Manager Entitlements Guide.

Enable Login Disabled attribute sync

Select whether the changes made to the Login Disabled attribute in Identity Vault should be synced even if the User Account entitlement (UserAccount) is enabled.

When account entitlement revoked

Choose what action is taken in Epic when a User Account Entitlement is revoked; Disable Account or Block Account.

Block Comment

A freetext comment to send with the event, about why the User is blocked. The maximum length is 100 characters.

Enable External Identifier Entitlement

Select Yes to enable the management of External Identifiers via driver entitlements.

Enable Standard Template Entitlements

Select Yes to enable the standard management of Templates via driver Available Template, Default Template, and Applied Template entitlements.