...
Contents
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
General Settings
The general settings allow you to control some of the most basic configuration settings for the APP application.
To access the settings, use one of the tips below:
On the workspace, navigate to Configurations > General Settings.
On the main menu, select Configurations > General Settings.
Before getting started, make sure you have selected the organization unit for which you want to define the settings. To do this, select an organization unit on the left-hand side pane of the General settings window by:
Using a scroll bar to search through the list.
Entering a text in the search field to filter records.
Email Server
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
...
Contents
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
General Settings
The general settings allow you to control some of the most basic configuration settings for the APP application.
To access the settings, use one of the tips below:
On the workspace, navigate to Configurations > General Settings.
On the main menu, select Configurations > General Settings.
Before getting started, make sure you have selected the organization unit for which you want to define the settings. To do this, select an organization unit on the left-hand side pane of the General settings window by:
Using a scroll bar to search through the list.
Entering a text in the search field to filter records.
Email Server
You can configure an SMTP server that will take care of the email's delivery. To do this, first switch to the Email Server tab in the General Settings window:
...
Fill in the fields as described below:
SMTP Server. Enter the server address used to send emails. If maintained by Adonis, enter the Adonis server address.
Port. Enter a port number that specifies a way of transmitting an email between two mail servers. The default port number of an outgoing SMTP server is 25.
Sender address. Enter an email address you would like to be used for sending emails to users.
Sender name. Enter a name you would like to be used for sending emails to users.
Connection security. In the drop-down list, select a certificate to enable an encrypted connection.
Allow untrusted certificate. Select the option to accept untrusted certificates.
Use credentials. Turn on the SMTP authentication and enter your account's SMTP Username and set SMTP Password.
APP URL in the email. Enter the APP URL to be provided in the email.
Send email to confirm changes in the Personal Details → Telecommunication. Select the option if you want to get notified once any Telecommunication data changes.
| Info |
|---|
Yellow-highlighted fields are mandatory. |
On completing, click SAVE to confirm the changes.
SQL Server
You can specify the SQL server as well as the database you are working on. To do this, switch to the SQL Server tab in the General Settings window:
...
Fill in the fields as described below:
SMTP Server. Enter the server address used to send emails. If maintained by Adonis, enter the Adonis server address.
Port. Enter a port number that specifies a way of transmitting an email between two mail servers. The default port number of an outgoing SMTP server is 25.
Sender address. Enter an email address you would like to be used for sending emails to users.
Sender name. Enter a name you would like to be used for sending emails to users.
Connection security. In the drop-down list, select a certificate to enable an encrypted connection.
Allow untrusted certificate. Select the option to accept untrusted certificates.
Use credentials. Turn on the SMTP authentication and enter your account's SMTP Username and set SMTP Password.
APP URL in the email. Enter the APP URL to be provided in the email.
Send email to confirm changes in the Personal Details → Telecommunication. Select the option if you want to get notified once any Telecommunication data changes.
| Info |
|---|
Yellow-highlighted fields are mandatory. |
On completing, click SAVE to confirm the changes.
SQL Server
You can specify the SQL server as well as the database you are working on. To do this, switch to the SQL Server tab in the General Settings window:
...
Fill in the fields as described below:
Server. Enter a server name you want to get connected to.
Database. Enter a database name located on the specified server.
Database user. Enter a database username.
Connection timeout. Specify seconds after which a connection request times out and a connection is thrown.
| Info |
|---|
Yellow-highlighted fields are mandatory |
On completing, click TEST to verify whether the connection is successful. If the connection is successfully established, click SAVE to confirm the changes. Once you click the button, you will see a confirmation dialog informing you that the settings have been updated but will take effect only after restarting the portal:
...
Click YES if you want to immediately restart the portal or NO if you want to restart it later.
Web Services
The Adonis architecture assumes the installation of two applications: web service and APP. Web service stores data and send it to APP by request.
Let us now cover the principles for name formations. On installing the application, the APP name consists of the following parts:
| Info |
|---|
InstanceName may be optionally defined while installing the application. |
The web service name then acquires the following parts:
hostname/WebServices_InstanceName/CrewPortalWebService.svc
The WEB SERVICES tab is designed to set up a connection between the APP application and the web service:
...
a server name you want to get connected to.
Database. Enter a database name located on the specified server.
Database user. Enter a database username.
Connection Timeout. Specify seconds after which a connection request times out and a connection is thrown.
| Info |
|---|
Yellow-highlighted fields are mandatory |
On completing, click TEST to verify whether the connection is successful. If the connection is successfully established, click SAVE to confirm the changes. Once you click the button, you will see a confirmation dialog informing you that the settings have been updated but will take effect only after restarting the portal:
...
Click YES if you want to immediately restart the portal or NO if you want to restart it later.
Web Services
The Adonis architecture assumes the installation of two applications: web service and APP. Web service stores data and send it to APP by request.
Let us now cover the principles for name formations. On installing the application, the APP name consists of the following parts:
| Info |
|---|
InstanceName may be optionally defined while installing the application. |
The web service name then acquires the following parts:
hostname/WebServices_InstanceName/CrewPortalWebService.svc
The WEB SERVICES tab is designed to set up a connection between the APP application and the web service:
...
To get started, in the Client-side requests section, define the web service URL for sending data requests:
Relative URL. Select the checkbox if you want to send requests to the web service located on the same host as the APP application. The unselected option assumes using the absolute URL where both protocol and hostname must be indicated.
In the Server-side requests section, define the web service address where the security token is to be generated:
Use the same URL for the server-side. Select the option to use the URL specified in the Client-side requests section.
Relative URL. Select the checkbox if you want to send requests to generate the security token on the web service located on the same host as the APP application. The unselected option assumes using the absolute URL where both protocol and hostname must be indicated.
In the Server-side requests section, define the web service address where the security token is to be generated:
Use the same URL for the server-side. Select the option to use the URL specified in the Client-side requests section.
Relative URL. Select the checkbox if you want to generate the security token on the web service located on the same host as the APP application. The unselected option assumes using the absolute URL where both protocol and hostname must be indicated (preferred option).
| Info |
|---|
The Electronic Service URL is read-only and depends on a Web Service URL setup. It will be updated accordingly in case any changes are applied to the Web Service URL. The Adonis_Esign_API password is stored in the WEB_CP_API_LOGIN and used to generate the authentication token for the Electronic Signature API methods. |
Besides, you can define URLs to other web services:
Adonis Integration Web Service (AIWS). Set the absolute URL to the web service.
Gateway.API Routing Service. Set the absolute URL to the web service.
POS (Point-Of-Sale) Gratuities Web Service. Set the absolute URL to the web service.
SMS Gateway Web Service. Set the absolute URL to the web service and enter Login and Password.
Generate API Key
be indicated (preferred option).
| Info |
|---|
The Electronic Service URL is read-only and depends on a Web Service URL setup. It will be updated accordingly in case any changes are applied to the Web Service URL. The Adonis_Esign_API password is stored in the WEB_CP_API_LOGIN and used to generate the authentication token for the Electronic Signature API methods. |
Besides, you can define URLs to other web services:
Adonis Integration Web Service (AIWS). Set the absolute URL to the web service.
Gateway.API Routing Service. Set the absolute URL to the web service.
POS (Point-Of-Sale) Gratuities Web Service. Set the absolute URL to the web service.
SMS Gateway Web Service. Set the absolute URL to the web service and enter Login and Password.
Adonis Upload Service (AUS). Generate the API key to access the selected methods in Adonis Upload Service (AUS). For more information, seeGenerate API.
| Anchor | ||||
|---|---|---|---|---|
|
Third-party customers can generate their own API Key to access Adonis Upload Service (AUS). The key is required for security purposes as well as for managing the usage of the endpoints:
CREATE
UPDATE
READ
To generate an API key, in Adonis Administrator Portal, navigate to Configurations > the WEB SERVICES tab and scroll down to the bottom of the page. In the Generate API Key section, fill in the fields:
API. From the drop-down list, select PersonDataImport.
API Name. Enter your API name.
Interface. From the drop-down list, select an interface to be used.
| Info |
|---|
The list of interfaces is fetched from the one defined in APM. To access it, navigate to the Setup ribbon tab > General Codes > Miscellaneous > Interfaces. |
In the Choose Scopes table, select the API methods and their end points to be used.
Once done, click GENERATE API KEY.
The API Key is displayed once it is generated and stored as a hashed value in the database:
...
| Info |
|---|
Make sure to store the generated API key since it is unrecoverable. Only a hash of the key is stored in the database. |
Adonis Learning Management System
...
Adonis LMS URL. Enter the link to the Adonis Digital Learning platform.
Adonis LMS API Token. Enter a unique identifier used to authenticate an application to access the API.
Adonis LMS Enroll API token.
When done, click SAVE to proceed.
...
You can view the log events that provide useful information and error messages intended primarily to help troubleshoot your solution. To do this, switch to the LOG tab in the General settings window:
...
You can filter data by the events listed in the grid. To do this, from the LogEvent drop-down menu, select one of the following :
...
| Anchor | ||||
|---|---|---|---|---|
|
The License Server LICENSE SERVER tab allows you to configure access to License Service via Adonis Administrator Portal:
...
Select the Enable privacy policy checkbox to enable the functionality.
Click the SELECT POLICY button and pick a PDF document containing the privacy policy to be populated.
Click SAVE.
| Info |
|---|
The privacy policy file size is limited to 5 MB. |
All users will be prompted to accept the privacy policy when logging into APP for the first time.
Multifactor Authentication
To enable the multifactor authentication to Adonis Personnel Portal and Adonis Crew Portal, switch to the MULTIFACTOR AUTHENTICATION tab:
...
Now, follow the steps below:
Select the Enable MFA checkbox. This opens the dialog:
Click OK and relog in for the changes to take effect.
You are then redirected to the login page:
...
General
The GENERAL tab provides you with the following options:
Set max file size for upload (mb). In the spin box, click up or down controls to set a size limit for files upload.
Onshore Crew Portal. Select the checkbox to enable Onshore Crew Portal.
Once completed, click SAVE to apply the changes.
...
containing the privacy policy to be populated.
Click SAVE.
| Info |
|---|
The privacy policy file size is limited to 5 MB. |
All users will be prompted to accept the privacy policy when logging into APP for the first time.
Multifactor Authentication
To enable the multifactor authentication to Adonis Personnel Portal and Adonis Crew Portal, switch to the MULTIFACTOR AUTHENTICATION tab:
...
Now, follow the steps below:
Select the Enable MFA checkbox. This opens the dialog:
Click OK and relog in for the changes to take effect.
You are then redirected to the login page:
...
General
The GENERAL tab provides you with the following options:
Set max file size for upload (mb). In the spin box, click up or down controls to set a size limit for files upload.
Onshore Crew Portal. Select the checkbox to enable Onshore Crew Portal.
Once completed, click SAVE to apply the changes.
...
Gangway Control
To enable the possibility for crew to change the activity from Planned to Current on the sign-on date directly on the panel, nagivate to the GANGWAY CONTROL tab and click the ACTIVATE GANGWAY ACTIONS button:
...
Once activated, the system informs you about successful activation.
| Info |
|---|
The ACTIVATE GANGWAY ACTIONS button is active if there are no gangway actions for the selected Organization unit. Once the actions are created, the button becomes inactive. |
Onshore Login
On the ONSHORE LOGIN tab, select the organization units (vessels) you want to be considered along with the current vessel when accessing Adonis Crew Portal.
...
This functionality allows a single login for all crew members who have an active sea service-activity and assigned to different organization units (vessels) selected on the ONSHORE LOGIN tab. The organization unit name is stated in the Vessel Name column:
...
| Info |
|---|
The Access Control > Users page displays only crew members currently onboard (those who have the Current activity). |
Time Zone Settings
When sailing around the world, a vessel crosses several time zones which an administrator must take care of beforehand. This setup is necessary to correctly process time registrations. To access the setup, use one of the following tips:
...
Set allowance rates for transportation, meals, lodging, and others. See Define Rates.
Define different reasons for traveling. See Set Travel Reason.
Define accommodation types that may be used when traveling. See Define Accommodation.
Set any additional expenses which a traveler may incur when traveling. See Set Outlay Various Types.
Change the preset summary titles. See Define Settlement Types.
Create outbound and inbound travels for non-onboard activities. See Define Travel Activities.
Add currency records. See Define Currencies.
Define the module options. See Set Module Options.
...
| Info |
|---|
Accommodation types being in use cannot be removed from the grid. |
| Anchor | ||||
|---|---|---|---|---|
|
...
Various
You can define any additional expenses a traveler may incur when traveling. To access the accommodation types, use one of the tips below:
On the toolbar, click Outlay Types Various.
On the main menu, select Travel Expense & WDA > Outlay Types. Various
...
Within the appeared Outlay types Various grid, you can see a list of predefined expenses that may be edited or removed. You can also update the grid with new outlay various types.
To add a new outlay various type, click New and fill in the fields:
Code is a unique alpha-numeric APP code.
The description is a name of an outlay a various type.
Type allows specifying whether the created outlay various type is an addition or a deduction. Select Advance to deduct an outlay a various amount from the allowance. Select Various to add an outlay a various amount to the allowance.
The deduction allows defining a deductible outlay various type. The option automatically applies if the Type is set to Advance.
Is Passive, if selected, makes the record unavailable. It is recommended to select the option if you consider the outlay various type will no longer be in use.
Is Scan Mandatory, if selected, makes the document scan mandatory to be attached.
Allow for user groups. From the drop-down list, select the user groups for which specific reasons will be accessible.
Allow for reasons. From the drop-down list, select the reason(s) you want to be available for the selected user groups.
Payroll Category 1/Payroll Category 2 is a unique alpha-numeric code that serves as a binding component between the APP entries and Entry Codes in APM.
...
On completing, click Save. As a result, a new outlay various type will appear in the grid.
To introduce any modifications to the existing outlay various types, in the Outlay types Various grid, click Edit next to the selected type:
...
When preparing a travel expense report, a traveler can view the summary of all the incurred expenses and the provided allowance rate. Below is an example of a summary:
As an administrator, you can rename the preset summary titles as well as define the order number for each of them.
To access the outlay settlement types, use one of the tips below:
...
Use Daily Approval workflow, if selected, indicates that only approved documents may be sent to a manager.
Display registered Rest (use it for Debug purposes only), if selected, display displays the registered rest time in a timesheet/timecard. By default, the rest time appears as a space.
Approver/coordinator must annotate reason to modify time registration (for TimeClock), if selected, obliges an approver/coordinator to leave comments after modifying a time registration.
Allow registering time till the end of today, if selected, allows registering time till the end of today (+15 minutes).
The subordinate should approve the corrections, if selected, makes a subordinate approve the corrections made by a coordinator.
...