4 Installing the Connector in CI Mode

The procedure to deploy the connector is divided across three stages namely preinstallation, installation, and postinstallation.

• Preinstallation

• Installation

• Postinstallation

4.1 Preinstallation

As a part of preinstallation, ensure all Eloqua users have an Eloqua account with required administrator user access and permissions.

4.2 Installation

You must install the Eloqua connector in Oracle Identity Manager and if required, place the connector code bundle in the Connector Server.

The following topics discuss installing the Eloqua connector:

• Understanding Installation of the Eloqua Connector

• Running the Connector Installer

• Configuring the IT Resource for the Target System

4.2.1 Understanding Installation of the Eloqua Connector

You can run the connector code either locally in Oracle Identity Manager or remotely in a Connector Server.

Depending on where you want to run the connector code (bundle), the connector provides the following installation options:

• Run the connector code locally in Oracle Identity Manager. In this scenario, you deploy the connector in Oracle Identity Manager. Deploying the connector in Oracle Identity Manager involves performing the procedures described in Running the Connector Installer and Configuring the IT Resource for the Target System.

• Run the connector code remotely in a Connector Server. In this scenario, you deploy the connector in Oracle Identity Manager, and then, deploy the connector bundle in a Connector Server. See Using an Identity Connector Server in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager for information about installing, configuring, and running the Connector Server, and then installing the connector in a Connector Server.

4.2.2 Running the Connector Installer

When you run the Connector Installer, it automatically copies the connector files to directories in Oracle Identity Manager, imports connector XML files, and compiles adapters used for provisioning.

Note:

In this guide, the term Connector Installer has been used to refer to the Install Connectors feature of Oracle Identity Manager Administrative and User Console.

To run the Connector Installer:

1. Copy the contents of the connector installation media into the following directory: OIM_HOME/server/ConnectorDefaultDirectory.

   Note:

   If you are doing it for the first time place the bundle in connector server bundle directory, in that case you need to unzip the bundle before starting the installation.
2. Log in to Oracle Identity System Administration.
3. From the left pane, expand the Provisioning Configuration tab and click Manage Connector.
4. In the Manage Connector page, click Install.
5. From the Connector List, select Eloqua ConnectorRELEASE_NUMBER.
   This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory in Step 1.

   If you have copied the installation files into a different directory, then:

   1. In the Alternative Directory field, enter the full path and name of that directory.

   2. To repopulate the list of connectors in the Connector List list, click Refresh.

   3. From the Connector List list, select Eloqua Connector RELEASE_NUMBER.

6. Click Load.
7. To start the installation process, click Continue.
   The following tasks are performed in sequence:

   1. Configuration of connector libraries

   2. Import of the connector XML files (by using the Deployment Manager)

   3. Compilation of adapters

   On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure are displayed. If a task fails, then make the required correction and perform one of the following steps:

   1. Retry the installation by clicking Retry.

   2. Cancel the installation and begin again from Step 3.

8. Click Exit to finish the installation procedure.
   If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:

   1. Ensuring that the prerequisites for using the connector are addressed.

      Note:

      At this stage, run the PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites.

   2. Configuring the IT resource for the connector.

      Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.

   3. Configuring the scheduled tasks that are created when you installed the connector. Record the names of the scheduled tasks displayed on this page. The procedure to configure these scheduled tasks is described later in this guide. When you run the Connector Installer, it copies the connector files and external code files to destination directories on the Oracle Identity Manager host computer. These files are listed in Files and Directories in the Eloqua Connector Installation Package.

4.2.3 Configuring the IT Resource for the Target System

The IT resource for the target system is created during connector installation. This IT resource contains connection information about the target system. Oracle Identity Manager uses this information during reconciliation and provisioning.

The Eloqua IT resource is automatically created when you run the Connector Installer. To specify values for the parameters of the IT resource:

1. Log in to Oracle Identity System Administration.
2. In the left pane, under Configuration, click IT Resource.
3. In the IT Resource Name field on the Manage IT Resource page, enter Eloqua and then click Search.
4. Click the Edit icon for the IT resource.
5. From the list at the top of the page, select Details and Parameters.
6. Specify values for the parameters of the IT resource. Table 4-1 describes each parameter.

   Table 4-1 Parameters of the Eloqua IT Resource

   Parameter	Description
   authenticationType	Enter the type of authentication used by your target system. Sample value: basic
   username	Enter the user name of the target system that you create for performing connector operations. Sample value: IDMsysE10OD01\johnsmith
   password	Enter the password of the target system user account that you create for connector operations. Sample value: password
   host	Enter the host name of the machine hosting your target system. This is a mandatory attribute while creating an application. Sample value: www.example.com
   port	Enter the port number at which the target system is listening. Sample value: 443
   proxyHost	Enter the name of the proxy host used to connect to an external target. Sample value: www.example.com
   proxyPassword	Enter the password of the proxy user ID of the target system user account that Oracle Identity Governance uses to connect to the target system.
   proxyPort	Enter the proxy port number. Sample value: 80
   proxyUser	Enter the proxy user name of the target system user account that Oracle Identity Governance uses to connect to the target system.
   sslEnabled	If the target system requires SSL connectivity, then set the value of this parameter to true. Otherwise set the value to false. Default value: true

7. To save the values, click Update.

4.3 Postinstallation

These are the tasks that you can perform after creating an application in Oracle Identity Governance.

• Configuring Oracle Identity Governance

• Harvesting Entitlements and Sync Catalog

• Managing Logging for the Connector

• Configuring the IT Resource for the Connector Server

• Localizing Field Labels in UI Forms

• Configuring SSL

4.3.1 Configuring Oracle Identity Governance

During application creation, if you did not choose to create a default form, then you must create a UI form for the application that you created by using the connector.

Note:

Perform the procedures described in this section only if you did not choose to create the default form during creating the application.

The following topics describe the procedures to configure Oracle Identity Governance:

• Creating and Activating a Sandbox

• Creating a New UI Form

• Publishing a Sandbox

• Updating an Existing Application Instance with a New Form

4.3.1.1 Creating and Activating a Sandbox

You must create and activate a sandbox to begin using the customization and form management features. You can then publish the sandbox to make the customizations available to other users.

See Creating a Sandbox and Activating a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance.

4.3.1.2 Creating a New UI Form

You can use Form Designer in Oracle Identity System Administration to create and manage application instance forms.

See Creating Forms By Using the Form Designer in Oracle Fusion Middleware Administering Oracle Identity Governance.

While creating the UI form, ensure that you select the resource object corresponding to the newly created application that you want to associate the form with. In addition, select the Generate Entitlement Forms check box.

4.3.1.3 Publishing a Sandbox

Before publishing a sandbox, perform this procedure as a best practice to validate all sandbox changes made till this stage as it is difficult to revert the changes after a sandbox is published.

1. In Identity System Administration, deactivate the sandbox.

2. Log out of Identity System Administration.

3. Log in to Identity Self Service using the xelsysadm user credentials and then activate the sandbox that you deactivated in Step 1.

4. In the Catalog, ensure that the application instance form for your resource appears with correct fields.

5. Publish the sandbox. See Publishing a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance.

4.3.1.4 Updating an Existing Application Instance with a New Form

For any changes that you do in the schema of your application in Identity Self Service, you must create a new UI form and update the changes in an application instance.

To update an existing application instance with a new form:

1. Create and activate a sandbox.

2. Create a new UI form for the resource.

3. Open the existing application instance.

4. In the Form field, select the new UI form that you created.

5. Save the application instance.

6. Publish the sandbox.

See Also:

• Creating a Sandbox and Activating a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance

• Creating Forms By Using the Form Designer in Oracle Fusion Middleware Administering Oracle Identity Governance

• Publishing a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance

4.3.2 Harvesting Entitlements and Sync Catalog

You can populate Entitlement schema from child process form table, and harvest roles, application instances, and entitlements into catalog. You can also load catalog metadata.

To harvest entitlements and sync catalog:

1. Run the scheduled jobs for lookup field synchronization listed in Reconciliation Jobs.
2. Run the Entitlement List scheduled job to populate Entitlement Assignment schema from child process form table.
3. Run the Catalog Synchronization Job scheduled job.

See Also:

Predefined Scheduled Tasks in Oracle Fusion Middleware Administering Oracle Identity Governance for a description of the Entitlement List and Catalog Synchronization Job scheduled jobs

4.3.3 Managing Logging for the Connector

Oracle Identity Governance uses the Oracle Diagnostic Logging (ODL) logging service for recording all types of events pertaining to the connector.

The following topics provide detailed information about logging:

• Understanding Log Levels

• Enabling Logging

4.3.3.1 Understanding Log Levels

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. ODL is the principle logging service used by Oracle Identity Manager and is based on java.util.Logger. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

• SEVERE.intValue()+100

  This level enables logging of information about fatal errors.

• SEVERE

  This level enables logging of information about errors that might allow Oracle Identity Manager to continue running.

• WARNING

  This level enables logging of information about potentially harmful situations.

• INFO

  This level enables logging of messages that highlight the progress of the application.

• CONFIG

  This level enables logging of information about fine-grained events that are useful for debugging.

• FINE, FINER, FINEST

  These levels enable logging of information about fine-grained events, where FINEST logs information about all events.

These message types are mapped to ODL message type and level combinations as shown in Table 4-2.

Table 4-2 Log Levels and ODL Message Type:Level Combinations

Java Level	ODL Message Type:Level
SEVERE.intValue()+100	INCIDENT_ERROR:1
SEVERE	ERROR:1
WARNING	WARNING:1
INFO	NOTIFICATION:1
CONFIG	NOTIFICATION:16
FINE	TRACE:1
FINER	TRACE:16
FINEST	TRACE:32

The configuration file for OJDL is logging.xml, which is located at the following path: DOMAIN_HOME/config/fmwconfig/servers/OIM_SERVER/logging.xml

Here, DOMAIN_HOME and OIM_SEVER are the domain name and server name specified during the installation of Oracle Identity Manager.

4.3.3.2 Enabling Logging

Perform this procedure to enable logging in Oracle WebLogic Server.

To enable logging in Oracle WebLogic Server:

1. Edit the logging.xml file as follows:

   1. Add the following blocks in the file:

      <log_handler name='Eloqua-handler' level='[LOG_LEVEL]'class='oracle.core.ojdl.logging.ODLHandlerFactory'> 
      	<property name='logreader:' value='off'/>	
      	<property name='path' value='[FILE_NAME]'/> 	
      	<property name='format' value='ODL-Text'/>	
      	<property name='useThreadName' value='true'/> 
      	<property name='locale' value='en'/> 
      	<property name='maxFileSize' value='5242880'/> 
      	<property name='maxLogSize' value='52428800'/>
      	<property name='encoding' value='UTF-8'/>
      </log_handler> 
      

      <logger name="ORG.IDENTITYCONNECTORS.GENERICREST" level="[LOG_LEVEL]" useParentHandlers="false">
      	<handler name="Eloqua-handler"/>
      	<handler name="console-handler"/>
      </logger>

      <logger name="ORG.IDENTITYCONNECTORS.RESTCOMMON" level="[LOG_LEVEL]" useParentHandlers="false">
      	<handler name="Eloqua-handler"/>
      	<handler name="console-handler"/>
      </logger>

   2. Replace both occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. Table 4-2 lists the supported message type and level combinations. Similarly, replace [FILE_NAME] with the full path and name of the log file in which you want log messages to be recorded. The following blocks show sample values for [LOG_LEVEL] and [FILE_NAME]:

      <log_handler name='Eloqua-handler' level='NOTIFICATION:1'class='oracle.core.ojdl.logging.ODLHandlerFactory'> 
      	<property name='logreader:' value='off'/>	
      	<property name='path' value='F:\MyMachine\middleware\user_projects\domains\base_domain1\servers\oim_server1\logs\oim_server1-diagnostic-1.log'/>
      	<property name='format' value='ODL-Text'/> 	
      	<property name='useThreadName' value='true'/> 
      	<property name='locale' value='en'/> 
      	<property name='maxFileSize' value='5242880'/> 
      	<property name='maxLogSize' value='52428800'/> 
      	<property name='encoding' value='UTF-8'/>
      </log_handler>
      
      <logger name="ORG.IDENTITYCONNECTORS.GENERICREST" level="NOTIFICATION:1" useParentHandlers="false">
      	<handler name="Eloqua-handler"/> 
      	<handler name="console-handler"/>
      </logger>
      
      <logger name="ORG.IDENTITYCONNECTORS.RESTCOMMON" level="NOTIFICATION:1" useParentHandlers="false">
      	<handler name="Eloqua-handler"/> 
      	<handler name="console-handler"/>
      </logger>

   With these sample values, when you use Oracle Identity Governance, all messages generated for this connector that are of a log level equal to or higher than the NOTIFICATION:1 level are recorded in the specified file.

2. Save and close the file.
3. Set the following environment variable to redirect the server logs to a file:

   • For Microsoft Windows: set WLS_REDIRECT_LOG=FILENAME

   • For UNIX: export WLS_REDIRECT_LOG=FILENAME

   Replace FILENAME with the location and name of the file to which you want to redirect the output.

4. Restart the application server.

4.3.4 Configuring the IT Resource for the Connector Server

If you have used the Connector Server, then you must configure values for the parameters of the Connector Server IT resource.

After you create the application for your target system, the connector creates a default IT resource for the Connector Server. The name of this default IT resource is Eloqua Connector Server.

In Oracle Identity System Administration, search for and edit the Eloqua Connector Server IT resource to specify values for the parameters of IT resource for the Connector Server listed in Table 4-2. For more information about searching for IT resources and updating its parameters, see Managing IT Resources in Oracle Fusion Middleware Administering Oracle Identity Governance.

Table 4-3 Parameters of the IT Resource for the Eloqua Connector Server

Parameter	Description
Host	Enter the host name or IP address of the computer hosting the Connector Server. Sample value: HostName
Key	Enter the key for the Connector Server.
Port	Enter the number of the port at which the Connector Server is listening. Sample value: 8763
Timeout	Enter an integer value which specifies the number of milliseconds after which the connection between the Connector Server and Oracle Identity Governance times out. If the value is zero or if no value is specified, the timeout is unlimited. Sample value: 0 (recommended value)
UseSSL	Enter true to specify that you will configure SSL between Oracle Identity Governance and the Connector Server. Otherwise, enter false. Default value: false Note: It is recommended that you configure SSL to secure communication with the connector server. To configure SSL, see Configuring SSL for Java Connector Server in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance.

4.3.5 Localizing Field Labels in UI Forms

You can localize UI form field labels by using the resource bundle corresponding to the language you want to use. Resource bundles are available in the connector installation media.

To localize field labels that is added to the UI forms:

1. Log in to Oracle Enterprise Manager.
2. In the left pane, expand Application Deployments and then select oracle.iam.console.identity.sysadmin.ear.
3. In the right pane, from the Application Deployment list, select MDS Configuration.
4. On the MDS Configuration page, click Export and save the archive (oracle.iam.console.identity.sysadmin.ear_V2.0_metadata.zip) to the local computer.
5. Extract the contents of the archive, and open the following file in a text editor:

   SAVED_LOCATION\xliffBundles\oracle\iam\ui\runtime\BizEditorBundle.xlf

   Note:

   You will not be able to view the BizEditorBundle.xlf file unless you complete creating the application for your target system or perform any customization such as creating a UDF.
6. Edit the BizEditorBundle.xlf file in the following manner:

   1. Search for the following text:

      <file source-language="en" original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf" datatype="x-oracle-adf">

   2. Replace with the following text:

      <file source-language="en" target-language="LANG_CODE" original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf" datatype="x-oracle-adf">

      In this text, replace LANG_CODE with the code of the language that you want to localize the form field labels. The following is a sample value for localizing the form field labels in Japanese:

      <file source-language="en" target-language="ja" original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf" datatype="x-oracle-adf">

   3. Search for the application instance code. This procedure shows a sample edit for Eloqua Application instance. The original code is:

      <trans-unit id="${adfBundle['oracle.adf.businesseditor.model.util.BaseRuntimeResourceBundle']['persdef.sessiondef.oracle.iam.ui.runtime.form.model.user.entity.userEO.UD_Name_c_description']}">
      <source>Name</source><target/>
      </trans-unit>
      id="sessiondef.oracle.iam.ui.runtime.form.model.RSAForm.entity.EloquaFormEO.UD_NAME __c_LABEL"><source>Name</source><target/>"
      </trans-unit>

   4. Open the resource file from the connector package, for example Eloqua_ja.properties, and get the value of the attribute from the file, for example,

      global.udf.UD_USR_EQ_LOGIN =\u30A2\u30AB\u30A6\u30F3 \u30C8\u540D.

   5. Replace the original code shown in Step 6.c with the following:

      <trans-unit id="${adfBundle['oracle.adf.businesseditor.model.util.BaseRuntimeResourceBu ndle']['persdef.sessiondef.oracle.iam.ui.runtime.form.model.user.entity.use rEO.global.udf.UD_USR_EQ_LOGIN __c_description']}">
      <source>Login</source> <target>u30A2\u30AB\u30A6\u30F3\u30C8\u540D</target>
      </trans-unit> <trans-unitid="sessiondef.oracle.iam.ui.runtime.form.model.Eloqua.entity sEO.global.udf.UD_USR_EQ_LOGIN__c_LABEL">
      <source>Login</source> <target>\u30A2\u30AB\u30A6\u30F3\u30C8\u540D</target> 
      </trans-unit>

   6. Repeat Steps 6.a through 6.d for all attributes of the process form.

   7. Save the file as BizEditorBundle_LANG_CODE.xlf. In this file name, replace LANG_CODE with the code of the language to which you are localizing. Sample file name: BizEditorBundle_ja.xlf.

7. Repackage the ZIP file and import it into MDS.

   See Also:

   Deploying and Undeploying Customizations in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance for more information about exporting and importing metadata files

8. Log out of and log in to Oracle Identity Governance.

4.3.6 Configuring SSL

Configure SSL to secure data communication between Oracle Identity Governance and the Eloqua target system.

Note:

If you are using this connector along with a Connector Server, then there is no need to configure SSL. You can skip this section.

To configure SSL:

1. Obtain the SSL public key certificate of Eloqua.
2. Copy the public key certificate of Eloqua to the computer hosting Oracle Identity Governance.
3. Run the following keytool command to import the public key certificate into the identity key store in Oracle Identity Governance:
   keytool -import -alias ALIAS -trustcacerts -file CERT_FILE_NAME -keystore KEYSTORE_NAME -storepass PASSWORD

   In this command:

   • ALIAS is the public key certificate alias.

   • CERT_FILE_NAME is the full path and name of the certificate store (the default is cacerts).

   • KEYSTORE_NAME is the name of the keystore.

   • PASSWORD is the password of the keystore.

   The following is a sample value for this command:

   keytool -import -alias serverwl -trustcacerts -file supportcert.pem -keystore client_store.jks -storepass weblogic1

   Note:

   • Change the parameter values passed to the keytool command according to your requirements. Ensure that there is no line break in the keytool arguments

   • Ensure that the system date for Oracle Identity Governance is in sync with the validity date of the SSL certificate to avoid any errors during SSL communication.