Waiting Room APM plugin

Owned by yuriy.biryukov
Last updated: Feb 26, 2024 by Viktoria Karakiko
4 min read

Description

Waiting Room plugin to store records from Crew Inspector

Latest Version

2023.10.1.1

Release Date

Dec 27, 2023

Download Path

Download

Type

APM Plugin

Introduction

The Waiting Room plugin stores records which have not been imported from the APM plugins that use the AIWS and AUS APIs due to errors. The plugin is designed to easily identify the issue and find its solution.

Functionality

The section will teach you how to operate the plugin.

To get started, first, open the plugin. For this, switch to the Tools ribbon tab and click the Import button. From the drop-down list, select Waiting Room:

waiting_room_import_menu.png

The plugin main page then appears:

waiting_room_start_screen.png

Reveal Errors

On accessing the plugin, you can view the list of records that failed to be imported to APM. To view the description of the error(s), select a record and expand it:

  • The Error/Text column specifies the error code and its description. For more information, see Interfaces Errors/Text and Solutions.

  • The Solution column contains the instructions to be followed to resolve the issue. For more information, see Fixing Errors.

In case the error text refers to the XREF missing or incorrect data, please read Associate Records with XREF for possible solutions.

To view the initial set of data being imported to APM, click the View link:

 

Fix Errors

Based on the error description and the provided solution, you can resolve the issue manually (for more information, see Associate Records with XREF) or contact the Administrator and proceed with the data import. For this, make sure to carefully follow the provided instructions:

Once completed, click IMPORT TO ADONIS on the plugin toolbar to run the import process.

 

Associate Records with XREF

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.

 

Log into the Adonis Personnel Manager. Once logged in, navigate to the Setup ribbon tab > General Codes > Miscellaneous > Interfaces and proceed with the following steps:

  1. On the ribbon, click New to make the dialog appear:

     

  2. Enter a Code (mandatory field), a unique alpha-numeric APM code.

  3. In the Text field, indicate the name of an interface and its alternative name, if needed, in the Alternative field.

  4. In the Sort field, define the order number of a record (where 0 means the first record in the list).

  5. In the Is Passive field, specify whether the code is to be active or passive. Passive codes appear as disabled. Setting a code to Passive is recommended if it is no longer in use.

  6. In the APP Modules field, select the Adonis Personal Portal module(s) where you want to use the code.

  7. Click OK to proceed.

 

Log into the Adonis Personnel Manager. Once logged in, navigate to the Setup ribbon tab > General Codes and proceed with the following steps:

  1. Select the category code to be affected (e.g. Medical Codes, Personal Detail Ranks, etc.)and click Open on the toolbar.

  2. 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. If the interface is unavailable, you need to define the interface by following the instructions in How to add an xref interface above.

    • Xref Code. Enter a cross-reference value of the 3rd party system.

    • Comment. Enter any comment you want to add.

       

  3. When completed, click OK to apply the changes.

 

Housekeeping

The section will guide you through the plugin installation and configuration procedures.

Download and Installation

To install the plugin, navigate to Install APM Plugin and follow the step-by-step instructions carefully.

The latest plug-in version is available here: Waiting Room.

Connection Settings Configuration

To view the records, you need to establish a connection with AdonisIntegrationWebService.

For this, follow the steps below:

  1. In the Waiting Room plugin, navigate to Settings:

  2. In the Settings dialog, fill in the following fields:

    • In the AIWS Url field, enter the webservice URL.

    • In the API Password field, enter the password to the webservice.

  3. Click Test Connection to make sure the connection is successfully established and click OK to proceed:

  4. Click Save for the changes to take effect.