2 Deploying the Concur Connector

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

The following topics provide details on these stages:

• Preinstallation

• Installation

• Postinstallation

2.1 Preinstallation

Preinstallation involves setting up a developer sandbox and obtaining the consumer key value. It also involves registering your partner application with Concur for accessing user management APIs.

To obtain these values, perform the following tasks on the target system:

1. Set up the Concur developer sandbox, and obtain the consumer key for your Concur Developer Sandbox account.
   You provide the consumer key value for the customAuthHeaders parameter while configuring the IT resource.
2. Register your partner application (that is the Concur connector) with Concur.

The detailed instructions for performing these preinstallation tasks are available in the Concur product documentation. For more information, visit the Concur website at https://developer.concur.com/.

2.2 Installation

You must install the connector in Oracle Identity Manager. If necessary, you can also deploy the connector in a Connector Server.

The following topics provide details on installing the Concur connector:

• Understanding Installation of the Concur Connector

• Running the Connector Installer

• Configuring the IT Resource for the Target System

2.2.1 Understanding Installation of the Concur 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. For information about installing, configuring, and running the Connector Server, and then installing the connector in a Connector Server, see Using an Identity Connector Server in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager.

2.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.

To run the Connector Installer:

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

   Note:

   If this is the first time you are running the Connector Installer for deploying the connector bundle in a Connector Server, then place the bundle in the connector server bundle directory.
2. Log in to Oracle Identity System Administration.
3. In the left pane, under System Management, click Manage Connector.
4. In the Manage Connector page, click Install.
5. From the Connector List list, select Concur Connector RELEASE_NUMBER. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory: OIM_HOME/server/ConnectorDefaultDirectory

   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 Concur 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 appears 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. To retry the installation, click Retry.

   2. To cancel the installation and restart the installation process, click Cancel, and then repeat Step 3 through Step 8.

8. If all three tasks of the connector installation process are successful, then a message indicating successful installation appears.
   In addition, a list of the steps that you must perform after the installation appears. These steps are as follows:

   1. Configuring the IT resource for the connector. The procedure to configure the IT resource is described later in this guide.

   2. Configuring the scheduled tasks that are created when you installed the connector. 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 on the Concur Connector Installation Media.

2.2.3 Configuring the IT Resource for the Target System

An IT resource for your target system is created after you install the connector. You configure this IT resource to enable the connector to connect Oracle Identity Manager with your target system.

This section contains the following topics:

• IT Resource Parameters
• Specifying Values for IT Resource Parameters

2.2.3.1 IT Resource Parameters

An IT resource is composed of parameters that store connection and other generic information about a target system. Oracle Identity Manager uses this information to connect to a specific installation or instance of your target system.

Table 2-1 displays each parameter of the Concur IT resource in an alphabetical order.

Table 2-1 IT Resource Parameters

Parameter	Description
authenticationServerUrl	Enter the URL of the authentication server that validates the consumer key for your target system. Sample value: https://www.concursolutions.com/net2/oauth2/accesstoken.ashx
authenticationType	Type of authentication that is used by your target system. This connector supports the OAuth 2.0 custom authentication type. Default value: custom Do not modify the value of the parameter.
customAuthHeaders	Enter the consumer key in the following format: “X-ConsumerKey=CONSUMER_KEY” In this format, replace CONSUMER_KEY with the consumer key that is assigned to you after you register for the Concur developer sandbox. Sample value: “X-ConsumerKey=abc12345ABc12345AbcXYZ” See Preinstallation for more information on obtaining the consumer key.
Configuration Lookup	Name of the lookup definition that stores configuration information used during the reconciliation and provisioning operations. Default value: Lookup.Concur.Configuration
Connector Server Name	If you have deployed the Concur connector in the Connector Server, then enter the name of the IT resource for the Connector Server.
host	Enter the host name of the computer hosting your target system. Sample value: www.concursolutions.com
password	Enter the password for connecting to the Connector platform. This is the password that you specified while registering for the Concur developer sandbox.
port	Enter the port number at which the target system is listening.
proxyHost	Enter the name of the proxy host that is used to connect to an external target. Sample value: www.example.com
proxyPort	Enter the proxy port number.
proxyUser	Enter the proxy user name of the target system user account that Oracle Identity Manager uses to connect to the target system.
proxyPassword	Enter the password of the proxy user ID of the target system user account that Oracle Identity Manager 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
username	Enter the user name for connecting to the Concur platform. This is the email address that you specified while registering for the Concur developer sandbox.

2.2.3.2 Specifying Values for IT Resource Parameters

The IT resource for the target system contains connection information about the target system. Oracle Identity Governance uses this information during provisioning and reconciliation. The Concur IT resource is automatically created when you run the Connector Installer, and you must specify values for the parameters of the IT resource.

To specify values for the parameters of the IT resource:

1. Log in to Identity System Administration.
2. Create and activate a sandbox. See Creating a Sandbox and Activating and Deactivating a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager.
3. In the left pane, under Configuration, click IT Resource.
4. In the IT Resource Name field on the Manage IT Resource page, enter Concur and then click Search.
5. Click the Edit icon for the IT resource.
6. From the list at the top of the page, select Details and Parameters.
7. Specify values for the parameters of the IT resource. IT Resource Parameters describes each parameter.
8. To save the values, click Update.

2.3 Postinstallation

Postinstallation for the connector involves configuring Oracle Identity Manager, enabling logging to track information about all connector events, and configuring SSL. It also involves performing some optional configurations such as localizing the user interface.

The postinstallation steps are divided across the following sections:

• Configuring Oracle Identity Manager

• Localizing Field Labels in UI Forms

• Clearing Content Related to Connector Resource Bundles from the Server Cache

• Managing Logging for the Concur Connector

• Configuring SSL for the Concur Connector

2.3.1 Configuring Oracle Identity Manager

You must create a UI form and an application instance for the resource against which you want to perform reconciliation and provisioning operations. In addition, you must run the entitlement and catalog synchronization jobs.

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

• Creating and Activating a Sandbox

• Creating a New UI Form

• Associating the Form with the Application Instance

• Publishing a Sandbox

• Harvesting Entitlements and Sync Catalog

• Updating an Existing Application Instance with a New Form

2.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 and Deactivating a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager.

2.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 Manager.

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

2.3.1.3 Associating the Form with the Application Instance

By default, an application instance named Concur Application Instance is automatically created after you install the connector. You must associate this application instance with the form created in Creating a New UI Form. See Modifying Application Instances in Oracle Fusion Middleware Administering Oracle Identity Manager.

After updating the application instance, you must publish it to an organization to make the application instance available for requesting and subsequent provisioning to users.

As a best practice, perform the following procedure before publishing the application instance:

1. In Identity System Administration, deactivate the sandbox.
2. Log out of Identity System Administration.
3. Log in to Oracle Identity Self Service and activate the sandbox that you deactivated in Step 1.
4. In the Catalog, check for the Application Instance UI (form fields) and ensure that it appears correctly.
5. Publish the application instance only if everything appears correctly. Otherwise, fix the issues and then publish the application instance.

   For instructions on publishing an application instance to an organization, see Managing Organizations Associated With Application Instances in Oracle Fusion Middleware Administering Oracle Identity Manager.

2.3.1.4 Publishing a Sandbox

Before publishing a sandbox, perform the following 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 Concur application instance form appears with correct fields.
5. Publish the sandbox. See Publishing a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager.

2.3.1.5 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 Entitlement List scheduled job to populate Entitlement Assignment schema from child process form table.
2. 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.

2.3.1.6 Updating an Existing Application Instance with a New Form

For any changes you do in the Form Designer, 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. See Creating a Sandbox and Activating and Deactivating a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager.
2. Create a new UI form for the resource. See Creating Forms By Using the Form Designer in Oracle Fusion Middleware Administering Oracle Identity Manager.
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 Publishing a Sandbox in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager.

2.3.2 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. The resource bundles are available in the connector installation media.

To localize a field label that is added to 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 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_en.xlf"

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 the Concur 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_ LOGINID__c_description']}">
      <source>Login ID</source>
      <target/>
      </trans-unit>
      <trans-unit 
      id="sessiondef.oracle.iam.ui.runtime.form.model.ConcurForm.entity.ConcurFormEO.UD_LOGINID __c_LABEL">
      <source>Login ID</source>
      <target/>
      </trans-unit>

      In this text, ConcurForm is the current form instance name associated with the Concur application instance.

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

      global.UD_CONCUR_LOGINID =\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.UD_CONCUR_LOGINID__c_description']}">
      <source>LoginID</source>
      <target>u30A2\u30AB\u30A6\u30F3\u30C8\u540D</target>
      </trans-unit> 
      <trans-unit
      id="sessiondef.oracle.iam.ui.runtime.form.model.Concur.entity sEO.UD_CONCUR___c_LABEL">
      <source>First Name</source> 
      <target>\u30A2\u3FIRSTNAME0AB\u30A6\u30F3\u30C8\u540D</target> 
      </trans-unit>

   6. Repeat Step 6 a through Step 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.

2.3.3 Clearing Content Related to Connector Resource Bundles from the Server Cache

When you deploy the connector, the resource bundles are copied from the resources directory on the installation media into the Oracle Identity Manager database. Whenever you add a new resource bundle to the connectorResources directory or make a change in an existing resource bundle, you must clear content related to connector resource bundles from the server cache.

To clear content related to connector resource bundles from the server cache:

1. In a command window, switch to the OIM_HOME/server/bin directory.
2. Enter one of the following commands:

   • On Microsoft Windows: PurgeCache.bat All

   • On UNIX: PurgeCache.sh All

   Note:

   You can use the PurgeCache utility to purge the cache for any content category. Run PurgeCache.bat CATEGORY_NAME on Microsoft Windows or PurgeCache.sh CATEGORY_NAME on UNIX. The CATEGORY_NAME argument represents the name of the content category that must be purged.

   For example, the following commands purge Metadata entries from the server cache:

   • PurgeCache.bat MetaData

   • PurgeCache.sh MetaData

   Before running the PurgeCache utility, ensure the WL_HOME and JAVA_HOME environment variables are set.

   When prompted, enter the user name and password of an account belonging to the SYSTEM ADMINISTRATORS group. In addition, you are prompted to enter the service URL in the following format:

   t3://OIM_HOST_NAME:OIM_PORT_NUMBER

   In this format:

   • Replace OIM_HOST_NAME with the host name or IP address of the Oracle Identity Manager host computer.

   • Replace OIM_PORT_NUMBER with the port on which Oracle Identity Manager is listening.

2.3.4 Managing Logging for the Concur Connector

Oracle Identity Manager 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

2.3.4.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 2-2.

Table 2-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	TRACE16
FINEST	TRACE32

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_SERVER are the domain name and server name specified during the installation of Oracle Identity Manager.

2.3.4.2 Enabling Logging

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='Concur-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.CONCUR" level="[LOG_LEVEL]" useParentHandlers="false">
              <handler name="Concur-handler"/>
              <handler name="console-handler"/>
      </logger>

   2. Replace both occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. Understanding Log Levels 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='Concur-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.CONCUR" level="NOTIFICATION:1" useParentHandlers="false">
              <handler name="Concur-handler"/> 
              <handler name="console-handler"/>
      </logger>

   With these sample values, when you use Oracle Identity Manager, 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.

2.3.5 Configuring SSL for the Concur Connector

You configure SSL to secure data communication between Oracle Identity Manager and the target system.

To configure SSL:

1. Obtain the SSL certificate by obtaining the public key certificate of the target system.
2. Copy the public key certificate of the target system to the computer hosting Oracle Identity Manager.
3. Run the following keytool command to import the public key certificate into the identity key store in Oracle Identity Manager:
   keytool -import -keystore WEBLOGIC_HOME/server/lib/DemoTrust.jks -file CERT_FILE_NAME -storepass PASSWORD

   In this command:

   • CERT_FILE_NAME is the full path and name of the certificate file

   • PASSWORD is the password of the keystore.

   The following is a sample value for this command:

   keytool -import -keystore WEBLOGIC_HOME/server/lib/DemoTrust.jks -file /home/target.cert -storepass DemoTrustKeyStorePassPhrase

   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.