2 Deploying the Office 365 Connector

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

The following topics discuss these stages:

Note:

Some of the procedures described in this chapter must be performed on the target system. To perform these procedures, you must use an Office 365 account with administrator privileges.

2.1 Preinstallation

Preinstallation for the Office 365 connector involves registering a client application (that is, the Office 365 connector) with the target system so that the connector can access Office 365 Graph APIs. It also involves generating the client ID and client secret for authenticating to the target system and setting the permissions for the client application.

Preinstallation involves performing the following tasks on the target system:

Note:

The detailed instructions for performing these preinstallation tasks are available in the Office 365 product documentation at https://docs.microsoft.com/en-us/microsoft-365/.
  1. Register your client application with Microsoft Azure Active Directory to provide secure sign in and authorization for your services. You can register your client application by creating an application in the Microsoft Azure Management Portal.
  2. Generate the client ID and client secret values for your client application. Note down these values as they are required while configuring IT resource parameters.
  3. Specify the permissions that the client application requires to access the target system. To do so:
    1. Assign the Read and write domains and Read and write directory data application permissions that the client application requires on Windows Azure Active Directory.
    2. Assign the following delegated permissions that the client application requires on Windows Azure Active Directory:

      • Read and write directory data

      • Read and write all groups

      • Read all groups

      • Access the directory as the signed-in user

      • Read directory data

      • Read all user’s full profiles

      • Read all user’s basic profiles

      • Sign in and read user profile

    3. Add the client application to "Company Administrator" and “User Account Administrator” in the Office 365 administrative roles. Visit the following Microsoft support URL for detailed information: https://support.microsoft.com/en-in/kb/3004133

      This provides the necessary permissions for the client application to perform the Change Password and Delete user and group membership operations.

2.2 Installation

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

The following topics discuss installing the Office 365 connector:

2.2.1 Understanding Installation of the Office 365 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.

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.

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 Office365 Connector RELEASE_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 Office365 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. See Clearing Content Related to Connector Resource Bundles from the Server Cache for information about running the PurgeCache utility. There are no prerequisites for some predefined connectors.

    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 Table A-1.

2.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 Office365 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 Office365 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 2-1 describes each parameter.

    Table 2-1 Parameters of the Office 365 IT Resource

    Parameter Description

    Configuration Lookup

    Name of the lookup definition that stores configuration information used during reconciliation and provisioning operation.

    If you have configured your target system as a target resource, then enter Lookup.Office365.Configuration.

    If you have configured your target system as a trusted source, then enter Lookup.Office365.Configuration.Trusted.

    Default value: Lookup.Office365.Configuration

    Connector Server Name

    If you have deployed the Office 365 connector in the Connector Server, then enter the name of the IT resource for the Connector Server.

    proxyHost

    Name of the proxy host used to connect to an external target.

    Sample value: www.example.com.

    proxyPort

    Proxy port number.

    Sample value: 80

    proxyUser

    Proxy user name of the target system user account that Oracle Identity Manager uses to connect to the target system.

    proxyPassword

    Password of the proxy user ID of the target system user account that Oracle Identity Manager uses to connect to the target system.

    authenticationServerUrl

    Enter the URL of the authentication server that validates the client ID and client secret for your target system.

    Sample value: https://login.windows.net/ mydomain /oauth2/token?api-version=1.0

    authenticationType

    Type of authentication used by your target system. For this connector, the target system OAuth2.0 client credentials.

    Default value: client_credentials

    Do not modify the value of the parameter.

    clientId

    Enter the client identifier (a unique string) issued by the authorization server to your client application during the registration process. You obtained the client ID while performing the procedure described in Preinstallation.

    clientSecret

    Enter the secret key used to authenticate the identity of your client application. You obtained the secret key while performing the procedure described in Preinstallation.

    Host

    Enter the host name of the computer hosting your target system.

    Sample value: graph.windows.net

    Port

    Enter the port number at which the target system is listening.

    Sample value: 443

    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

    uriPlaceHolder

    Key-value pair for replacing place holders in the relURIs. The URI place holder consists of values which are repeated in every relative URL. Values must be comma separated.

    For example, tenant ID and API version values are a part of every request URL. Therefore, we replace it with a key-value pair.

    Sample value: "tenant_id;domain name","api_version;api-version=1.6"
  7. To save the values, click Update.

2.3 Postinstallation

Postinstallation steps are divided across the following sections:

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 entitlement and catalog synchronization jobs.

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

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 Office 365 connector that you want to associate the form with. In addition, select the Generate Entitlement Forms check box.

2.3.1.3 Creating an Application Instance

See Creating Application Instances in Oracle Fusion Middleware Administering Oracle Identity Manager.

2.3.1.4 Publishing a Sandbox

Before you publish a sandbox, perform the following procedure as a best practice to validate all sandbox changes made till this stage as it is hard to revert changes once a sandbox is published:
  1. In the System Administration console, deactivate the sandbox.
  2. Log out of the System Administration console.
  3. Log in to the Self Service console using the xelsysadm user credentials and then activate the sandbox that you deactivated in Step 1.
  4. In the Catalog, ensure that the Office 365 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

To harvest entitlements and sync catalog:
  1. Run the scheduled jobs for lookup field synchronization listed in Scheduled Jobs for Lookup Field Synchronization for Office 365 Connector.
  2. Run the Entitlement List scheduled job to populate Entitlement Assignment schema from child process form table. See Predefined Scheduled Tasks in Oracle Fusion Middleware Administering Oracle Identity Manager for more information about this scheduled job.
  3. Run the Catalog Synchronization Job scheduled job. See Predefined Scheduled Tasks in Oracle Fusion Middleware Administering Oracle Identity Manager for more information about this scheduled job.

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. 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 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 Office365 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_ USER_PRINCIPAL_NAME__c_description']}"><source>User Principal Name</source><target/></trans-unit><trans-unit id="sessiondef.oracle.iam.ui.runtime.form.model.RSAForm.entity.Office365FormEO.UD_USER_PRINCIPAL_NAME __c_LABEL"><source>First Name</source><target/></trans-unit>
    4. Open the resource file from the connector package, for example Office365_ja.properties, and get the value of the attribute from the file, for example, 
      global.udf.UD_GA_USR_ USER_PRINCIPAL_NAME =\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_GA_USR_ USER_PRINCIPAL_NAME __c_description']}"><source>Account Name</source> <target>u30A2\u30AB\u30A6\u30F3\u30C8\u540D</target></trans-unit> <trans-unitid="sessiondef.oracle.iam.ui.runtime.form.model.Office365.entity sEO.UD_GA_USR_ACCOUNT_NAME__c_LABEL"><source>Account Name</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 Manager for more information about exporting and importing metadata files

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

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 Office 365 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:

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_SEVER 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='Office365-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.OFFICE365" level="[LOG_LEVEL]" useParentHandlers="false">
        <handler name="Office365-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 2-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='Office365-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.OFFICE365" level="NOTIFICATION:1" useParentHandlers="false">
        <handler name="Office365-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 Office 365

Configure SSL to secure data communication between Oracle Identity Manager and Office 365.

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 Office 365.
  2. Copy the public key certificate of Office 365 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 -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 Manager is in sync with the validity date of the SSL certificate to avoid any errors during SSL communication.