Oracle

Audience: Administrators

 

Overview

Oracle is a comprehensive, cloud-based HCM management software. OrgChart can connect directly to Oracle. The following is a list of frequently asked questions pertaining to Oracle's compatibility with OrgChart.

FAQ

Q: How do I set up my connection to Oracle?

Reference the Oracle Connector Setup section below.

Q: Can I pull photos from Oracle into my org charts?

A: Yes. Reference the Oracle Photo Configuration section for more information.

Q: Can I embed org charts (generated from my Oracle) data?

A: Yes.

Oracle Configuratoin

In order to configure Oracle to integrate with OrgChart, please work with your Oracle Representative to create an API Service user.

Ensure the API service user has access to view:

• The resource containing the reporting structure for your organization

• Any additional child resources that you would like to include

Once you've properly configured your API service user, reference the Oracle Connector Setup section below to set up your Oracle Connector in OrgChart.

Oracle Connector Setup

OrgChart can import data directly from Oracle. The following article provides step-by-step instructions for setting up an Oracle connector in OrgChart.

In order to complete setup, you will need the following information:

• REST Server URL - The URL of your Oracle Cloud service containing the endpoint for querying worker relationships. For example, https://servername.fa.us2.oraclecloud.com/hcmRestApi/resources/11.13.18.05/workers

Important

Generally, the Oracle resource workers (endpoint shown above) will have the worker relationship information necessary for creating the reporting hierarchy in OrgChart.

• User Name and Password - User name and Password of the API service user with permissions to access the resources you're querying

Note

Contact your Oracle System Administrator if you have questions regarding the required information above.

1.Click on the Settings button in the bottom right corner, and then select the Chart Settings option from the list.

2. Click on the connector icon under the Main Data Source heading. The list of Main Data Source connectors is displayed.

3. Click on the Oracle icon

2. Enter the Subdomain API, Username, Password in the corresponding text boxes.

3. Enter a comma delineated list of the Child Resources that contain the reporting structure (work relationships) for your organization in the Child Resources text box (under the Configuration heading).

Note

Reference the Oracle Employee Information documentation for more more information regarding reporting structure.

4. Optionally, enter a pre-defined Finder (e.g. 'findByPersonId) in the Finder text box. Finders are constructed with the help of your Oracle System Administrator, and allow OrgChart to retrieve only records that match the Finder criteria.

5. Optionally, enter a query parameter in the Parameter text box. OrgChart will only retrieve records matching the query parameter. Reference the Common Queries section below for queries associated with common use cases.

Note

If you would like to one of the following query parameters, please check the Specify Full Query checkbox to the left of the Parameters text box, and then enter the full query:

• fields

• onlyData

• limit

• offset

• totalResults

• orderBy

• links

• include

• includeChildren

• showAnnotations

• metadataMode

• resources

6. Click Save, and then Refresh. The data nested in the Child Resources queried is pulled into OrgChart. To supplement the data that has been pulled in, reference the following section on Oracle Merge Data . 

Common Queries
OrgChart allows you to specify which employee records are pulled into OrgChart. If you specify a query, OrgChart will only return records matching the specified parameter(s). The following is a non-exhaustive list of commonly used queries, and associated use cases.

Query	Use Case
workRelationships.TerminationDate is null	Import all employees who have not been terminated.
workRelationshoips.TerminationDate > today	Import all employees who have a future termination date

 

Note

Query may vary slightly depending upon the parent resource and employee data structure. Bolded elements of the queries above are specific to OrgChart, and will not change.

Compound Queries

You can enter multiple queries into the Query text box. The following format must be used when querying Oracle data with multiple parameters:

(Query1) comparison value(Query2)

The following is an example of a compound query that will pull employees who have not been terminated, or employees with a termination date set in the future:

(workRelationships.TerminationDate is null) or (workRelationships.TerminationDate > today)

Oracle Merge Data

After your initial data pull from your Oracle workers resource, you may want to import additional employee data from a different Oracle resource. In order to import data that's located outside of the workers resource used for the Main Data Source, you must set up an Oracle Merge Data Connector.

The following section provides step-by-step instructions for configuring Oracle as a Merge Data Connector.

Configuring an Oracle Merge Data Connector

1. Click on the Settings button in the bottom right corner, and then select the Chart Settings option from the list.

2. Under the Merge data sources heading, click on Add data source and then select Oracle

3. Enter the Subdomain , Username and Password for the API Service User in the corresponding text boxes.

4.Click on the Load field mapping button (under the Configuration section) to pre-load the fields in the Merge Data source.

5. Click on the Record Field dropdown menu (under the Mapping heading), and then select the field from the Main Data Source that you would like to use to update employee records. For example, if you select LocationID, OrgChart will update records with the information in the Merge Data Source according to their LocationID.

6. Click on the Merge Field dropdown menu, and then select the field from the Merge Data Source that corresponds with the Record Field. For example, if you select LocationID, the Merge Data source values for LocationID should match the Record Field field values.

7. Click on Save, and then Refresh.

Oracle Photo Configuration

OrgChart can pull photos directly from your Oracle instance for display in chart boxes, employee profiles, and search results.

The following article provides step-by-step instructions for configuring your Oracle photo import in OrgChart.

Importing Oracle Photos

1. Click on the Settings button in the bottom right corner, and then select the Chart Settings option from the list.

2.In the Data sources panel, scroll down to the bottom of the page and there will be a heading called Additional photo configuration

3. Click on the option Click here to select data source and then select Oracle

4. Enter the following credentials in the corresponding text boxes:

• Subdomain - Oracle REST server URL

• Username - Username associated with your Oracle API service user

• Password - Password associated with the Oracl API service user

5. Click on Validate to ensure that your credentials are correct.

6. Click on Save, and then Refresh.

7. Follow the steps in the Creating a Photo Formula section to finish configuring your Oracle photos.

Creating a Photo Formula

In order to display your photos from Oracle in OrgChart, you'll need to create an Oracle photo formula.

1. Click on the Settings button in the bottom right corner, and then select the Chart Settings option from the list

2. Navigate to the Fields & Formulas tab and then click on Create Formula button and select Static formula

3. Enter a name for the formula (i.e. Photo).

4. Click on the + icon to add an operation and then select the Concatenate option

5. Enter the following information into the text box: oraclecloud

6. Click on + Add new value button

7. Click on the Type dropdown menu, and then select the Field Lookup option.

8. Click on the Value dropdown menu, and then select EmployeeId.

9. Click on Save, and then Refresh the Master Chart.