Versions Compared

Version Old Version 8 New Version Current
Changes made by

yuriy.biryukov

Viktoria Karakiko

Saved on

Key

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

Description

Integration of the onboarding crew list with the Adobe Learning Manager

Latest Version

2024.40.3.1

Release Date

Download Path

Download

Type

Replicator Plugin

...

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:

...

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

...

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:

Adobe_LMS_housekeeping_AUS_API_KEY.pngImage Removed

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 IntegrationAdminAdobe_LMS_housekeeping_generate_API_KEY.pngImage Added

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

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”.

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:

Adobe_LMS_housekeeping_AUS_API_KEY.pngImage Added

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.

ISSUEDBY

A user-defined value, XREF

The value is defined in APM > General Setup > Miscellaneous > Interfaces (e.g. Adobe LMS.

OAUTH

The code generated in Adobe Learning Manager as an IntegrationAdminADOBELMS). For more information, see Adobe LMS Data RetrievingInterface Setup.

REFRESH_TOKEN

The token generated in Adobe Learning Manager as an IntegrationAdmin. For more information, see Adobe LMS Data Retrieving.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 “learner”“Learner”.

SERVER_NAMETYPE

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.
Note: In case the parameter is not defined, the log file is not replaced.

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:

Adobe_LMS_housekeeping_numorg_id.pngImage Removed

XREF

The value is defined in APM > General Setup > Miscellaneous > Interfaces (e.g. ADOBELMS). For more information, see Adobe LMS Interface Setupuser 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.
Note: In case the parameter is not 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.

adobe_lms_VESSEL_XREF.png

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.

...