The procedure to deploy the connector can be divided into the following 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 ServiceNow account with administrator privileges.Registering a client application with the target system so that the connector can access ServiceNow REST APIs. It also involves creating a user account, modifying ACL values and adding a specific role to a user.
Note:
The detailed instructions for performing these preinstallation tasks are available in the ServiceNow product documentation at https://docs.servicenow.com.Installing the connector requires you to run the connector installer and then configure the IT resource.
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.
Note:
In this guide, the term Connector Installer has been used to refer to the Connector Installer feature of Oracle Identity System Administration.To run the Connector Installer:
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 discusses 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.
Table 2-1 IT Resource Parameters
| Parameter | Description |
|---|---|
|
Configuration Lookup |
Name of the lookup definition that stores configuration information used during reconciliation and provisioning. Default value: |
|
Connector Server Name |
If you have deployed the ServiceNow connector in the Connector Server, then enter the name of the IT resource for the Connector Server. |
|
authenticationServerUrl |
Enter the URL of the authentication server that is used to authenticate the resource owner user name and password. Sample value: https://ven01622.service-now.com/ |
|
authenticationType |
Type of the authentication. Default value: Do not modify the value of the parameter. Note: The sample value implies OAuth 2.0 resource owner password. ServiceNow target instance supports only the OAuth 2.0 resource owner password type. |
|
clientId |
Client identifier issued to the client during the registration process. Sample value: |
|
clientSecret |
Enter the client secret used to authenticate the identity of the client application. Sample value: The clientSecret is obtained while performing the procedure described in Registering the Client Application. |
|
host |
Host name or IP address of the computer hosting the target system. Sample value: |
|
password |
Password used for the OAuth 2.0 resource owner password authentication. |
|
port |
Port number at which the target system is listening. Sample value: |
|
sslEnabled |
If the target system requires SSL connectivity, then set the value of this parameter to |
|
username |
Enter the user name for the OAuth 2.0 authentication. This user name is used during password authentication of the resource owner. Sample value: |
|
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. |
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 ServiceNow IT resource is automatically created when you run the Connector Installer. You must specify values for the parameters as follows:
This topic discusses the following postinstallation procedures:
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.
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 ServiceNow connector that you want to associate the form with. In addition, select the Generate Entitlement Forms check box.
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:
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.
To clear content related to connector resource bundles from the server cache you can either restart Oracle Identity Manager or run the PurgeCache utility. The following is the procedure to clear the server cache by running the PurgeCache utility:
You can set a log level based on Oracle Java Diagnostic Logging and enable logging in the Oracle WebLogic Server. The following topics contain detailed information:
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 logs to one of the following available levels:
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 2-2.
Table 2-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.
To enable logging in Oracle WebLogic Server:
Edit the logging.xml file as follows:
Add the following blocks in the file:
<log_handler name='Servicenow-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.SERVICENOW" level="[LOG_LEVEL]" useParentHandlers="false">
<handler name="servicenow-handler"/>
<handler name="console-handler"/>
</logger>
Replace both occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. .
Similarly, replace [FILE_NAME] with the full path and name of the log file in which you want log messages specific to connector operations to be recorded.
The following blocks show sample values for [LOG_LEVEL] and [FILE_NAME] :
<log_handler name='Servicenow-handler' level='NOTIFICATION:1' class='oracle.core.ojdl.logging.ODLHandlerFactory'> <property name='logreader:' value='off'/> <property name='path' value='/<%OIM_DOMAIN%>/servers/oim_server1/logs/serviceNowScriptLogs.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.SERVICENOW" level="NOTIFICATION:1" useParentHandlers="false"> <handler name="Servicenow-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.
Save and close the file.
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.
Restart the application server.