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 for the Box connector involves performing a series of tasks on the target system.
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 Box 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.
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, perform the following procedure:
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 Box Connector Installation Media.
An IT resource for your target system is created after you install the connector. You configure this IT resource to let the connector connect Oracle Identity Manager with your target system.
This section provides information about the following topics:
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.
Connection Parameters
Authentication Parameters
Table 2-1 lists connection parameters.
Table 2-1 Connection IT Resource Parameters
Parameter | Description |
---|---|
Host |
Host name or IP address of the computer hosting the target system. Sample value: |
Port |
Port number at which the target system is listening. Sample value: |
authenticationType |
Type of authentication used by your target system. The Box target system uses manual input of access token and refresh token for OAuth2.0 authentication. Default value: 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 would have obtained the client ID while configuring the newly registered application as a part of preinstallation. Sample value: |
clientSecret |
Enter the secret key used to authenticate the identity of your client application. You would have obtained the secret key while configuring the newly registered application as a part of preinstallation. Sample value: |
Configuration Lookup |
Name of the lookup definition that stores configuration information used during reconciliation and provisioning operations. Default value: |
Connector Server Name |
If you have deployed the Box connector in a Java Connector Server, then enter the name of the IT resource for the Connector Server. |
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: |
proxyHost |
Name of the proxy host used to connect to an external target system. Sample value: |
proxyPort |
Proxy port number. Sample value: |
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. |
Table 2-2 lists authentication parameters.
Table 2-2 Authentication IT Resource Parameters
Parameter | Description |
---|---|
clientId |
The client identifier issued to the client during the registration process. Sample value: |
clientSecret |
The client secret identifier issued to the client during the registration process. Sample value: |
customAuthHeaders |
Takes access token and refresh token values. Sample value 1: Sample value 2: |
The IT resource for the target system contains connection information about the target system. Oracle Identity Manager uses this information during provisioning and reconciliation.
The Box IT resource is automatically created when you run the Connector Installer. You must specify values for the parameters of the IT resource. To specify values:
Postinstallation for the Box 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:
You must create an 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.
These procedures are described in the following sections:
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.
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 Box connector that you want to associate the form with. In addition, select the Generate Entitlement Forms check box.
Perform the following steps to create an application instance:
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:
See Also:
Predefined Scheduled Tasks in Oracle Fusion Middleware Administering Oracle Identity Manager for a description of the Entitlement List and Catalog Synchronization Job scheduled jobs
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.
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.
Oracle Identity Manager uses Oracle Diagnostic Logging (ODL) logging service for recording all types of events pertaining to the connector.
The following topics provide detailed information about logging:
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.
Table 2-3 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 is located at the following path: DOMAIN_HOME/config/fmwconfig/servers/OIM_SERVER/logging.xml
Here, DOMAIN_HOME and OIM_SEVER are the domain and server names specified during the installation of Oracle Identity Manager.