Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

root@selfexpandCollapseAlltruestartDepth1

Getting Started

Here’s a simple getting started guide that walks you through a basic the setup of OnLink. Following these steps and seeing the app in action will familiarize you with the supported functionality.

Panel
bgColor#EAE6FF

Install link:

https://marketplace.atlassian.com/apps/1231655/onlink-hr-systems-integration-for-jira?hosting=cloud&tab=overview

Setting up OnLink is a two step process - configuring system connections and setting up Jira post function.

Configure Connections

Watch this 1 min video to see how a connection can be created.

https://www.loom.com/share/41603569175b4d9c802bd9145521d5bf

Setup Post Function

To execute OnLink, we need to configure a post function. Here’s a quick video that walks through the configuration steps:

.

Panel
bgColor#FFFFFF
  1. Click on Assets and click on the schema you want to import data into. Then click on Schema configuration -> Import -> Create Import and then select OnLink Importer. Give the Import a name and click on Create Import.

    image-20240218-044259.pngImage Added
  2. Click on the three dots and select Configure app, then set a name in the Configure mapping attributes popup. Click on Save configuration.

    image-20231229-185253.pngImage Added
  3. Now go to OnLink app, you should see a new configuration there. Select Edit in the drop down. Here you can select the Source system and rest of the configuration.

    image-20240218-044610.pngImage Added

Mapping Configuration

  1. Schema is pre-selected in OnLink and is set to the schema you selected in step 1. Set object type to the specific object you want to map to. Then map field level attributes (source data field is on the left side and the object attribute appears on the right side). Use “map” prefix for field mapping and “key” prefix for a unique identifier that will be used to identify objects for update purposes. Here are a couple of examples:

  2. Sample maps

    1. key:Worker_ID=WorkerID - sets Worker_ID (from source system) as the unique identifier, WorkerID (without the underscore) is the object attribute

    2. map:First_Name=Firstname - maps First_Name from source to Firstname object attribute

    3. map:DepartmentRef=Department|RefID=${DepartmentRef}- maps DepartmentRef (field in source data) to Department (an attribute in the schema that is of type Department object), the string following pipe specifies the AQL to lookup department. RefId is the key on the Department object. ${DepartmentRef} is the lookup value.

  3. To map references to other schema attributes, you can specify AQL after the pipe symbol as shown above for mapping DepartmentRef. DepartmentRefID is the value coming from Workday custom report. DepartmentRef is the attribute in schema pointing to Department object. RefID is the attribute on Department object. Here’s an example object definition - you can see support for User, Object and other types:

    image-20240218-045431.pngImage Added
  4. To map multiple values (cardinality > 1), use any of these options:

    1. If incoming Json field is of type string array, then add this line map:DeptSrc=Department|Name=${DeptSrc) - the assumption in this case is that "DeptSrc" is an array object in the incoming Json data.

    2. If incoming Json field is of type object array, then add this line map:OrgData=CostCenter|Name=${OrgData}|arrayElement=CostCenterName - the assumption in this case is that “OrgData” is an object array in the incoming Json data, with a child element “CostCenterName”

    3. map:incomingJsonValues=objAttr|arraySeparator=~ This tells OnLink that the json value has multiple values, each separated by a ~. You can also reference another object: two: map:DeptSrc=Department|Name=${DeptSrc)|arraySeparator=~

  5. Other mapping examples:

    1. map:Uptime=values.0_where_operatingSystem/name_eq_Uptime - where operatingSystem is an array object with name and values (array object) child elements. Gets first instance of values where name is Uptime.

    2. map:DiskText=sizeMegabytes_where_storage/device_eq_any - storage is an array object with device and sizeMegabytes as child elements. Gets first sizeMegabytes value.

  6. OnLink processes data in two steps - Get Data and Import Data. To manually test, you can click on Get Data first and then wait until you see “No more pending records. Data will be imported on next Import run.” message in Job Logs. Then, click on Import. Production runs are fully automated based on the schedule you choose.

image-20240318-045922.pngImage Added

Videos

OnLink helps synchronize HR and employee data. Here’s a quick demo that shows how OnLink can be used to synchronize Workday HR data with JSM Assets.

https://www.loom.com/share/c1ec1a2251f84afea996f1470129f36b

For your convenience, we have provided a mock Workday endpoint for you to test any of the Workday functions. Follow these steps to test a Workday function.

  1. Setup Workday Connection using below mock endpoint

    Code Block
    API Endpoint URL = https://27af8c7f-d27f-457a-9616-026b70d2717f.mock.pstmn.io/ccx/service/
    API version = v40.1
    Tenant name = hack13_wcpdev1
    Username = lmcneil
    Password = <contact us for the password support@onwardb.com>
  2. Create a post function for any of the supported Workday endpoints.

  3. Then create a task and transition the task to the status that will trigger the configured post function.

Page Tree
c6eca177260e41ceb7f98f848fa7925b

This is an update video showing how to map and test data imports.

https://www.loom.com/share/879dbfb4f5aa4f259e2c953e78810926

Table of Contents
stylenone