Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

iTrent / Data Conversion

Operation Information

Executes an MHR iTrent Data Conversion.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type iTrent.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose iTrent in the Type pick list;
  • Give the iTrent KeySafe key a Title (this is the name / identifier for the iTrent account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Username string Authentication Username
Password string Authentication Password

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked iTrent account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
API Endpoint endpoint string Make the API calls against the test or live iTrent web services endpoint Yes TEST, LIVE
Conversion Type conv_type string iTrent conversion type code. See MHR web services documentation for more information Yes None provided
Conversion File conv_file array Contents of data conversion file to load including headings Yes None provided
People Identifier people_id string People Identifier – (NI=Social Security Number, PERREF=Personal Reference, PAYREF=Payroll Reference, OCCREF=Position Occupancy Reference, APPLICANT_REF_NO=Applicant Reference Number) Yes Applicant Reference Number, Payroll Reference, Personal Reference, Position Occupancy Reference, Social Security Number
Field Separator fs string Field Separator – defaults to comma Yes None provided
Organization Name org_name string Organization Name of organization into which data is to be loaded Yes None provided

Output Parameters

Display Name ID Type Description
Status status string The status of the iTrent API call (ok/fail)
Error error string Any errors returned from the iTrent API call
In This Document