5 Performing the Postconfiguration Tasks for the Workday Connectors

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

5.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:

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

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

5.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 as Administrator and activate the sandbox 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.

5.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:

5.2 Configuring SSL

Configure SSL to secure data communication between Oracle Identity Governance and the Workday 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 Workday.
  2. Copy the public key certificate of Workday 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 are sample values for this command:

    • keytool -import -keystore <JAVA_HOME>/jre/lib/security/cacerts -file <Cert_Location>/GeoTrustTLSRSACAG1.crt -storepass changeit -alias GeoTrustTLSRSACAG1t_1

    • keytool -import -keystore <JAVA_HOME>/jre/lib/security/cacerts -file <Cert_Location>/DigiCertGlobalRootG2.crt -storepass changeit -alias DigiCertGlobalRootG2_1

    • keytool -import -keystore <WL_HOME>/server/lib/DemoTrust.jks -file <Cert_Location>/GeoTrustTLSRSACAG1.crt -storepass DemoTrustKeyStorePassPhrase -alias GeoTrustTLSRSACAG1t_1

    • keytool -import -keystore <WL_HOME>/server/lib/DemoTrust.jks -file <Cert_Location>/DigiCertGlobalRootG2.crt -storepass DemoTrustKeyStorePassPhrase -alias DigiCertGlobalRootG2_1

    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.

5.3 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, you must create an IT resource for the Connector Server as described in Creating IT Resource of Oracle Fusion Middleware Administering Oracle Identity Governance. While creating the IT resource, ensure to use to select Connector Server from the IT Resource Type list.
In addition, specify values for the parameters of the IT resource for the Connector Server listed in Table 5-1.

Table 5-1 Parameters of the IT Resource for the Connector Server

Parameter Description

Host

Enter the host name or IP address of the computer hosting the Connector Server.

Sample value: myhost.com

Key

Enter the key for the Connector Server.

Port

Enter the number of the port at which the Connector Server is listening.

By default, this value is blank. You must enter the port number that is displayed on the terminal when you start the Connector Server.

Sample value: 8759

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.

Recommended value: 0

A value of 0 means that the connection never times out.

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 Setting SSL for Connector Server and OIM in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance.

5.4 Managing Logging

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:

5.4.1 Understanding Log Levels

Oracle Identity Manager uses Oracle Java Diagnostic Logging (OJDL) for logging. OJDL 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 log levels are mapped to ODL message type and level combinations as shown in Table 5-2.

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

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

5.4.2 Enabling logging

Perform these steps 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='workday-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>
      </log_handlers>
      
      <logger name='ORG.IDENTITYCONNECTORS.WORKDAY' level='[LOG_LEVEL]' useParentHandlers='false'>
           <handler name='workday-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 5-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='workday-handler' level='TRACE:32' class='oracle.core.ojdl.logging.ODLHandlerFactory'>    
           <property name='logreader:' value='off'/>
           <property name='path' value='${<%OIM_DOMAIN%>}/servers/oim_server1/logs/workdaylogs.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>
      </log_handlers>
      
      <loggers>
         <logger name='ORG.IDENTITYCONNECTORS.WORKDAY' level='TRACE:32' useParentHandlers='false'>
           <handler name='workday-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 TRACE:32 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.

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

To localize field label that you add in 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 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 the Workday 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_Workday_Target_USER_NAME__c_description']}">
       <source>User Name</source>
       <target/>
      </trans-unit>
      <trans-unit id="sessiondef.oracle.iam.ui.runtime.form.model.WorkdayTargetForm1.entity.WorkdayTargetForm1EO.UD_Workday_Target_USER_NAME__c_LABEL">
      <source>User Name</source>
      <target/>
    4. Open the resource file (for example, Workday.properties) from the connector package, and get the value of the attribute from the file, for example, global.udf.UD_WD_USER_NAME=\u30E6\u30FC\u30B6\u30FC\u540D.

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

      <trans-unit id="${adfBundle['oracle.adf.businesseditor.model.util.BaseRuntimeResourceBundle']['persdef.sessiondef.oracle.iam.ui.runtime.form.model.user.entity.userEO.UD_Workday_Target_USER_NAME__c_description']}">
      <source>User Name</source>
      <target>\u30E6\u30FC\u30B6\u30FC\u540D</target>
      </trans-unit>
      <trans-unit id="sessiondef.oracle.iam.ui.runtime.form.model.WorkdayTargetForm1.entity.WorkdayTarget1EO.UD_Workday_Target_USER_NAME__c_LABEL">
       <source>User Name</source>
      <target>\u30E6\u30FC\u30B6\u30FC\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 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 Enterprise Manager.