Description | Integration of the onboarding crew list with the Adobe Learning Manager |
Latest Version | 2024.40.23.1 |
Release Date | 26 Nov |
Download Path | |
Type | Replicator Plugin |
Change Log:
| Expand | |
|---|---|
|
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).
...
| Info |
|---|
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:
...
| Info |
|---|
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
...
Type
...
The value defaults to user (Replicator parameter).
...
...
...
The email address of a crew member.
...
Date Of Birth
...
BIRTHDATE
...
Date Of Birth: 22/09/1978
Format: DD/MM/YYYY
...
Employment Type
...
The value defaults to Seafarer (Replicator parameter).
...
Current Vessel
...
VESSELNAME
...
The vessel name where a crew belongs to and has the Current activity.
...
Planned Vessel
...
VESSELNAME
...
The vessel name where a crew belongs to and has the Planned activity.
...
Manning Agency
...
NUMORGID
...
The company/agency above the vessel that is fetched from the Personal Details datagroup (the Organization/Company field).
...
Vessel Type
...
VESSELTYPE
...
The value is fetched from Activity Details > Vessel > Type of Vessel.
...
Location Status
...
CODE
...
Activity Code (e.g. ONB).
...
Seaman ID
...
PIN
...
APM identification number of a crew member.
...
Name
...
FIRSTNAME
LASTNAME
...
The name and surname of a crew member.
...
Profile
...
RANK
...
Rank Name.
...
Roles
...
The value defaults to Learner (Replicator parameter).
...
UserType
...
The value defaults to Internal (Replicator parameter).
...
UserUniqueId
...
PIN
...
The value equals Seaman ID.
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
...
Adobe LMS
...
The value is defined in the Replicator parameter and in APM.
...
ExternalPIN
...
data.relationships.learner.data.id
...
11359232
...
The value is fetched from XREF_PIN.
...
ExternalDocID
...
data.id
...
11359232_104844_CERTIFICATION_38773
...
The UUID of the course XREF.
...
ExternalDocType
...
data.relationships.model.data.id
...
certification:38773
...
The course UUID XREF added to competence codes.
...
ExternalDocCode
BADGE
...
The value is defined in the Replicator parameter and in APM.
...
DocumentNo
...
data.id
...
11359232_104844_CERTIFICATION_38773
...
DateFrom
...
data.attributes.dateAchieved
...
2023-07-21T17:53:55.000Z
...
The course is retrieved in case dateAchieved is not null.
...
DateTo
...
data.attributes.expiryDate
...
2025-07-21T17:53:55.000Z
...
ExpiryDate
...
data.attributes.expiryDate
...
2025-07-21T17:53:55.000Z
...
IssuedBy
...
CCS
...
The value is defined in the Replicator parameter.
Basket Datagroup
...
Adonis
...
Adobe LMS
...
Sample Value
...
Description/Comments
...
CreateTime
...
2024-11-20 08:52:18.287
...
Timestamp
...
Description
...
filename
...
13190870_Public HealthLevel 2_Skill.pdf
...
The value is the filename of the pdf file
...
SourceDoc
...
filename
...
13190870_Public HealthLevel 2_Skill.pdf
...
The value is the filename of the pdf file
...
DocType
...
BADGE
...
The value is defined in the Replicator parameter. (ExternalDocCode)
...
CreatedBy
...
ADOBELMS
...
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:
...
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:
API
API Name
Interface. Select it from the drop-down list. Make sure you have defined it in APM. For more information, see Adobe LMS Interface Setup.
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
...
| ||||||||
|
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).
...
| Info |
|---|
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:
...
| Info |
|---|
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). |
| |||||||
| 2 | Manager_Id | The value defaults to the Manager user_id (Replicator parameter). |
| |||||||
| 3 | The email address of a crew member. |
| ||||||||
| 4 | Date Of Birth | BIRTHDATE | Date Of Birth: 22/09/1978 Format: DD/MM/YYYY |
| ||||||
| 5 | Employment Type | The value defaults to Seafarer (Replicator parameter). |
| |||||||
| 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). |
| ||||||
| 9 | Vessel Type | VESSELTYPE | The value is fetched from Activity Details > Vessel > Type of Vessel. | |||||||
| 10 | Location Status | CODE | Activity Code (e.g. ONB). |
| ||||||
| 11 | Seaman ID | PIN | APM identification number of a crew member. |
| ||||||
| 12 | Name | FIRSTNAME LASTNAME | The name and surname of a crew member. |
| ||||||
| 13 | Profile | RANK | Rank Name. |
| ||||||
| 14 | Roles | The value defaults to Learner (Replicator parameter). |
| |||||||
| 15 | UserType | The value defaults to Internal (Replicator parameter). |
| |||||||
| 16 | UserUniqueId | PIN | The value equals Seaman ID. |
|
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:  | |
SERVICE_URL | The URL to the Adobe LMS service. | |
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. | |
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. | |
MANAGER_ID | The userID of the Training Manager | |
EXTERNALDOCCODE | Enter BADGE to mark a competence or a certificate is retrieved from Adobe LMS using API (Replicator plugin). The valueis defined in the APM > General Setup > Enclosed Document. For more information, see Associate Records with External System Records. | |
XREF | The value is defined in APM > General Setup > Miscellaneous > Interfaces (e.g. ADOBELMS). For more information, see Adobe LMS Interface Setup. | |
EMPLOYMENTTYPE | The employment type of a crew member while exporting to Adobe LMS. The value defaults to “Seafearer”. | |
ISSUEDBY | A user-defined value, e.g. “Adobe LMS” | |
ROLE | The role of a crew member while exporting to Adobe LMS. The value defaults to “seafearer”“Learner”. | EXTERNALDOCCODE | Enter BADGE to mark a competence or a certificate is retrieved from Adobe LMS using API (Replicator plugin). The valueis 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 serviceTYPE | 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”. | |
COMPETENCE_DESC | The description for the PDF files was retrieved from Adobe LMS, e.g. “Certificate from Adobe LMS“ | |
DATABASE | The APM database name is in use. | |
SERVER_NAME | The name of the server hosting the APM database. | |
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. | |
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. | |
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”. | |
VESSEL | Vessel ID number. To access it, navigate to Organization structure in APM and select the vessel being in use:  | |
XREF | The value is defined in APM > General Setup > Miscellaneous > Interfaces (e.g. ADOBELMS). For more information, see Adobe LMS Interface Setupnot defined, the log file is not replaced. | |
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. | |
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 |
...
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:
...
| Info |
|---|
Before getting started, make sure , the third-party interface is predefined in APM. For more information, see Adobe LMS Interface Setup. |
...