Description | Integration of the onboarding crew list with the Adobe Learning Manager |
Latest Version | 2024.40.3.1 |
Release Date |
|
Download Path | |
Type | Replicator Plugin |
Change Log:
Version | Date | Description |
|---|---|---|
2024.40.3.1 | APMPI-1452 - The PDF certificate in the Overview datagroup (Basket) is no longer retrieved once distributed to the Competence datagroup.
APMPI-1453 - Implemented the possibility of defining several vessels in the Main Site. We added the VESSEL_XREF parameter to the Plugin Setup. Make sure to populate the defined parameter value for specific vessels in APM Organization Structure. Crew members who have current or planned activities on those vessels are sent to Adobe LMS. 
APMPI-1463 - The document descriptions in OLEDOCS got changed to 'Certificate'. The file name is stored in SOURCEDOC. From now on, long document names will not cause errors.
APMPI-1464 - The Manning agency name is fetched to Adobe LMS from the Personal Details datagroup (the Organization/Company field): 
APMPI-1465 - Added the non-mandatory COMPETENCE_DESC parameter. The description defines the PDF file from the Adobe LMS.
APMPI-1468 - Added the MANAGER_ID parameter to the plugin’s parameters list.
APMPI-1471 - On processing Adobe LMS data:
|
Description
Adobe LMS
Adobe Learning Manager is a cloud-based learning management system (LMS) that offers a comprehensive solution for organizations to create, manage, and deliver engaging educational content.
This versatile platform enables companies to efficiently train employees, customers, and partners while providing tailored learning journeys and valuable insights into program performance.
Workflow
The Adonis Adobe LMS plugin is designed to ensure seamless integration of the onboarding crew list with the Adobe Learning Manager. The system workflow is as described below:
exporting crew members' data with the Planned and Current activities to take learning courses
importing crew members' data after successful completion of the course(s)
storing crew members' PDF certificates in the Overview datagroup (Basket tab).
In case a certificate gets removed from the Basket, either deliberately or accidentally, it will re-uploaded upon next run of the Adobe LMS plugin.
Adding Certificate to Competence
On uploading certificates, you can now attach them to the crew members' actual competences. For this, in APM, navigate to the Overview datagroup > the Basket tab where the PDF certificates are stored:
Now, proceed as described below:
Select the certificate to be affected.
In the Distribute section, fill in the fields:
Datagroup. In the drop-down list, select Competence.
View. In the drop-down list, select the Competence datagroup view where you want to view the attached certificate. The list fetches the competence views predefined in General Codes > Competence > Competence View.
Code. In the drop-down list, select a competence code which you want to associate with the selected certificate. The list fetches the competence views predefined in General Codes > Competence > Competence Code.
Click the Link scan to existing button and confirm the association:
As a result, the certificate is now attached to the selected competence in the Competence datagroup:
Once distributed to the Competence datagroup, the PDF certificate in the Overview datagroup (Basket) is no longer retrieved.
Field Mapping
APM → Adobe LMS
Adobe LMS | Adonis Mapping | Description/Comments | Mandatory | |
|---|---|---|---|---|
| 1 | Type | The value defaults to user (Replicator parameter). | Y | |
| 2 | Manager_Id | The value defaults to the Manager user_id (Replicator parameter). | Y | |
| 3 | The email address of a crew member. | Y | ||
| 4 | Date Of Birth | BIRTHDATE | Date Of Birth: 22/09/1978 Format: DD/MM/YYYY | Y |
| 5 | Employment Type | The value defaults to Seafarer (Replicator parameter). | Y | |
| 6 | Current Vessel | VESSELNAME | The vessel name where a crew belongs to and has the Current activity. | |
| 7 | Planned Vessel | VESSELNAME | The vessel name where a crew belongs to and has the Planned activity. | |
| 8 | Manning Agency | NUMORGID | The company/agency above the vessel that is fetched from the Personal Details datagroup (the Organization/Company field). | Y |
| 9 | Vessel Type | VESSELTYPE | The value is fetched from Activity Details > Vessel > Type of Vessel. | |
| 10 | Location Status | CODE | Activity Code (e.g. ONB). | Y |
| 11 | Seaman ID | PIN | APM identification number of a crew member. | Y |
| 12 | Name | FIRSTNAME LASTNAME | The name and surname of a crew member. | Y |
| 13 | Profile | RANK | Rank Name. | Y |
| 14 | Roles | The value defaults to Learner (Replicator parameter). | Y | |
| 15 | UserType | The value defaults to Internal (Replicator parameter). | Y | |
| 16 | UserUniqueId | PIN | The value equals Seaman ID. | Y |
Adobe LMS → APM
Competence Datagroup
The plugin picks up only the completed course of the crew member.
Adonis | Adobe LMS | Sample Value | Description/Comments |
|---|---|---|---|
Interface |
| The value is defined in the Replicator parameter and in APM. | |
ExternalPIN | data.relationships.learner.data.id |
| The value is fetched from XREF_PIN. |
ExternalDocID | data.id |
| The UUID of the course XREF. |
ExternalDocType | data.relationships.model.data.id |
| The course UUID XREF added to competence codes. |
ExternalDocCode |
| The value is defined in the Replicator parameter and in APM. | |
DocumentNo | data.id |
| |
DateFrom | data.attributes.dateAchieved |
| The course is retrieved in case dateAchieved is not null. |
DateTo | data.attributes.expiryDate |
| |
ExpiryDate | data.attributes.expiryDate |
| |
IssuedBy |
| The value is defined in the Replicator parameter. |
Basket Datagroup
Adonis | Adobe LMS | Sample Value | Description/Comments |
|---|---|---|---|
CreateTime |
| Timestamp | |
Description | filename |
| The value is the filename of the pdf file |
SourceDoc | filename |
| The value is the filename of the pdf file |
DocType |
| The value is defined in the Replicator parameter. (ExternalDocCode) | |
CreatedBy |
| The value is defined in the Replicator parameter. (XREF) |
Housekeeping
The section covers the download, installation, and configuration procedures of the Adobe LMS plugin.
http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Replicator/ADB
Installing Plugin
Once the download is complete, follow the link below to get the instructions on how to install the plugin:
Installing and distributing the Replicator plug-in
Replicator Setup
Setting Parameters
After the plugin is installed, it is necessary to specify parameters for the Site(s). To do this, follow the steps below:
On the left-hand side pane, select the service to which you got connected and navigate to Updatable programs.
In the Updatable programs node, select the plugin to be affected. Right under the selected plugin, select Plugin parameters.
In the Update parameters workspace, select the Site for which you want to add parameters and click the Add button. Clicking the command displays the Add new command dialog where you can enter the parameters one by one:
On entering, click OK to proceed.
Below, you will find the description of the parameters required for the Adobe LMS plugin:
Blue Highlight: Can be setup in the Adobe Learning Manager by the Integration Admin.
Green Highlight: Can be setup in the APP Administrator > General > Web Services
Orange Highlight: Can be setup in the APM General Setup
Purple Highlight: Can be setup in the Organization Structure
Gray Highlight: All default value, can be set by the Adobe LMS Training Manager / Author
Name | Value |
|---|---|
AUS_API_KEY | The API authorization key is generated in the APP Administration Portal. To generate it, log in to the APP Administration Portal and navigate to Configurations > General Settings > WEB SERVICES. Now, scroll down to the Generate API Key section:  Fill in the following fields:
When done, click GENERATE API KEY. |
AUS_URL | Base URL of AUS API. Retrieve the URL in the APP Administration Portal. For this, log in to the APP Administrator Portal and navigate to Configurations > General Settings > WEB SERVICES:  |
CLIENT_ID | LMS Identification number provided by Adobe LMS. For more information, see Adobe LMS Data Retrieving. |
CLIENT_SECRET | The key generated in Adobe Learning Manager as an IntegrationAdmin. For more information, see Adobe LMS Data Retrieving. |
DATABASE | The APM database name in use. |
DAYSGAP | Interval in days from today's date or day in the past in which the system will detect planned and current sea service activities. |
DEBUGDAYS | The request/response files are stored only for the specified number of days and then will be deleted. Note: If the DEBUGDAYS parameter is not defined, files will be stored within the current day only. |
DEBUGLOG | 0 - for the debug information in Replicator only. 7 - for the extended log; adds debug information into the log and stores request/response in the debug folder. |
EMPLOYMENTTYPE | The employment type of a crew member while exporting to Adobe LMS. The value defaults to “Seafearer”. |
EXTERNALDOCCODE | Enter BADGE to mark a competence or a certificate is retrieved from Adobe LMS using API (Replicator plugin). The value is defined in the APM > General Setup > Enclosed Document. For more information, see Associate Records with External System Records. |
ISSUEDBY | A user-defined value, e.g. Adobe LMS. |
OAUTH | The code generated in Adobe Learning Manager as an IntegrationAdmin. For more information, see Adobe LMS Data Retrieving. |
REFRESH_TOKEN | The token generated in Adobe Learning Manager as an IntegrationAdmin. For more information, see Adobe LMS Data Retrieving. |
ROLE | The role of a crew member while exporting to Adobe LMS. The value defaults to “Learner”. |
SERVER_NAME | The name of the server hosting the APM database. |
SERVICE_URL | The URL to the Adobe LMS service. |
TRUNCDAYS | Enter the number of days after which the .log file will be replaced with a new one. |
TYPE | The user type of a crew member while exporting to Adobe LMS. The value defaults to “user”. |
USERTYPE | The usertype of a crew member while exporting to Adobe LMS. The value defaults to “Internal”. |
XREF | The value is defined in APM > General Setup > Miscellaneous > Interfaces (e.g. ADOBELMS). For more information, see Adobe LMS Interface Setup. |
VESSEL_XREF | Allows defining several vessels in the Main Site. Make sure to populate the defined parameter value for specific vessels in APM Organization Structure.  For more information, see Associate Records with External System Records > Associate Vessel. |
COMPETENCE_DESC | The description for the PDF files retrieved from Adobe LMS. |
MANAGER_ID | The userID of the Training Manager |
Scheduler Setup
Once the plugin is successfully installed, select ADB.Adobe LMS Interface in the Scheduler node on the left-hand pane, and set the desired scheduler options on the workspace:
On setting the scheduler, select ADB.Adobe LMS Interface in the Status node on the left-hand pane to see the export/import results:
While importing data to Adonis Personnel Manager, a user might encounter errors or inconsistencies. To resolve them, please be advised to use Waiting Room plugin revealing the errors as well as suggesting possible solutions:
APM Setup
This section will walk you through the setup required in the Adonis Personnel Manager.
Adobe LMS Interface Setup
On learning courses completion, Adobe LMS exports PDF certificates to APM. This data is processed with the help of cross-references defined in the system and further linked to the Adobe LMS interface.
To configure the Adobe LMS interface, go to the Setup ribbon tab > General Codes > Miscellaneous > Interfaces and proceed with the following steps:
On the ribbon, click New to make the dialog appear:
Enter a Code (mandatory field), a unique alpha-numeric APM code.
In the Text field, indicate the name of an interface and its alternative name, if needed, in the Alternative field.
In the Sort field, define the order number of a record (where 0 means the first record in the list).
In the Is Passive field, specify whether the code is to be active or passive. Passive codes appear as disabled. It is recommended to set a code to Passive if it will no longer be in use.
Click OK to proceed.
As a result, a new record appears in the grid of Interfaces:
Associate Records with External System Records
The XREF functionality in Adonis is designed to associate records in the Adonis lookup tables, such as General Codes and Organization Structure, with their corresponding codes used in external systems.
Before getting started, make sure, the third-party interface is predefined in APM. For more information, see Adobe LMS Interface Setup.
To associate certificates exported to APM, first, log into the Adonis Personnel Manager. Once logged in, navigate to the Setup ribbon tab > General Codes and proceed with the following steps:
On the left-hand pane, navigate to Enclosed Documents > Enclosed Documents Codes category code.
In the list of enclosed documents codes, select a code and click Open on the toolbar:
Switch to the XREF tab and click the Append button. Clicking the command enables the fields to be filled out:
Interface. Select the interface from the drop-down list.
Xref Code. Enter a cross-reference value of the 3rd party system.
Comment. Enter any comment you want to add.
When completed, click OK to apply the changes.
To associate learning courses with the competences in APM, first, log into the Adonis Personnel Manager. Once logged in, navigate to the Setup ribbon tab > General Codes and proceed with the following steps:
On the left-hand pane, navigate to Competence > Competence Codes category code.
In the list of competences codes, select a code and click Open on the toolbar:
Switch to the XREF tab and click the Append button. Clicking the command enables the fields to be filled out:
Interface. Select the interface from the drop-down list.
Xref Code. Enter a cross-reference value of the 3rd party system.
Comment. Enter any comment you want to add.
When completed, click OK to apply the changes
On the Options tab, make sure to set the document type to Certificate.
Navigate to the Setup ribbon tab and click the Organization structure button.
In the Organization tree-view structure, select the vessel which you want to link.
Select Properties > XRef on the left-hand pane:
Click the Append button at the bottom of the page. Clicking the button enables the fields to be filled out:
Interface is a plugin name. Select it from the drop-down list.
Xref Code is the 3 party system name usually provided by the system itself.
Comment is any comment you want to add.
Click Save on the toolbar.
Adobe LMS Data Retrieving
As an IntegrationAdmin, you can access and retrieve sensitive information in the Adobe LMS application. Please follow the steps below to access the required data:
Log in to the Adonis LMS application as IntegrationAdmin. For this, click the profile picture and select IntegrationAdmin from the drop-down menu:
On the left-hand side pane, select Applications. On the workspace, select the tile with the required internal application:
This opens the selected external application details:
Retrieve the data as described below:
Application ID equals Client ID
Application Secret equals Client Secret
To generate an authentication code (Oauth), navigate Developer Resources > Access Tokens for Testing and Development:
Enter the Client ID value and retrieve the Oauth code value.