Contents

Housekeeping

System Architecture

The Adonis Personnel Portal consists of 3 applications:

• Administrator Portal

• Employee Portal

• Crew Portal

See this article explaining the differences between them:
Difference between the Administrator, Employee and Crew Portals

Server Components

The Adonis Personnel Portal consists of the following server components:

1. The Adonis Personnel Portal Web Service
   The Crew Portal Web Service (AdonisWebServices) contains the API used by the Personnel Portal.
   This component is Mandatory!

2. The Adonis Personnel Portal (Client Web Application)
   The Crew Portal is the actual web application or user interface used by the onboard crew members.
   It requires the Crew Portal Web Service

3. The Time Registration Service
   This service is mandatory when it is used by the Time Clock. The Time Clock uses the Time Registration Service to communicate with the database.
   It requires the Crew Portal Web Service

System Requirements

The Adonis Crew Portal requires: .Net Framework 4.7 or higher.

Please check that your server is supporting .net 4.7.

Besides the Minimum server hardware requirements given by Microsoft, we recommend using at least 8 GB of memory installed.

The Internet Information Services Manager (IIS)

APP Installation set will install or activate IIS and windows features.
The Installation set enables the following features:

-IIS-HttpCompressionDynamic
-IIS-ApplicationDevelopment
-IIS-ASPNET
-IIS-ISAPIExtensions
-IIS-ISAPIFilter
-NetFx4Extended-ASPNET45
-IIS-NetFxExtensibility45
-IIS-ASPNET45
-WCF-HTTP-Activation45
-IIS-WebServerRole
-IIS-WebServerManagementTools
-IIS-IIS6ManagementCompatibility
-IIS-Metabase
-IIS-WebServer
-IIS-ApplicationInit
-IIS-StaticContent
-IIS-NetFxExtensibility
-WAS-ProcessModel
-WAS-WindowsActivationService
-WAS-ConfigurationAPI

The Installation sets register the following IIS VirtualDirs:

• AdonisWebServices;

• APP (Adonis Personnel Portal);

• AdonisTimeRegSrv.

Installation/ Upgrade

Before you start

Before installing the Adonis Personnel Portal, you need to have installed Adonis Personnel Manager (version 4.20 or higher).

Database Modifications

When installing or upgrading the system, you need to upgrade the database.

To perform this upgrade, you should have AD_UPGRADE credentials. If they are unknown, please check with your database administrator

Installation Modes

The installation set offers you the following options:

Install Personnel Portal will be offered by default as your target server / PC doesn't have any instance of APP installed.

• Install - creates the application from scratch, installs & activates all necessary components.

• Repair - to re-install, clean up, and activate already installed components.

• Update - checks for the installed application & verifies its version against the offered one. If the installed version is lower, the system can be upgraded to contain the latest functionality & logic changes

New Installation

Step 1: System Setup

It is recommended to close all other applications before starting.

Run the file & wait until the necessary system components are turned on.
The Welcome screen below appears:

Click Next to continue.

Step 2: Installation Mode

In the opening window, you see the options that can be performed by the set:

To install the new application use Select Install Personnel Portal mode (creates the application from scratch, installs & activates all necessary components).

Click Next to proceed.

Step 3: Choosing Components to be Installed:

By default, the set offers all of the components:

Personnel Portal WebService - the service is responsible for numerous calculations & operations that are performed by the system.

Personnel Portal - creates a web interface that allows access & to various operations with application modules for onboard crew and office employees.
Time Registration Service - can be disabled if you do not plan to use Panel PC applications for daily registration of work & rest hours for your crew.
If you plan, please leave the list as it is (all checkboxes are set).

Click Next.

Step 4: Database Connection Setup

Please enter the Database server name & Database name that are used by Adonis Personnel Manager (APM).

You can find this information in APM, under Service Desk > About > System Information > Connection:

Click the Test DB Connection button and wait until the system confirms that input data are ok (message Test OK will appear).

Click Next to continue.

Step 5: General Settings

Customer Name - will be used to define the application URL. This can be site-specific or a generic name used on all sites.

Vessel/Office installation & ID - depending on the selected radio button offers you the drop-down list of Companies/Vessels from your organization structure defined in Adonis Personnel Manager. This is to define your current office to work with.
Installation Name - suffix to be used by installation set when creating virtual IIS directories.
If you have only one installed copy of the APP on the server, it is recommended to leave the Installation name field empty.
But if you would like to install a few copies of the APP on the same server, you need to specify the unique Installation name. It will be added to IIS virtual directories.

Step 6: SMTP/E-Mail Settings:

Please define details for SMTP-server & its connection credentials (if necessary) to be used by the system for mail generation when Sending Reports by Email or Sending out Notifications.

Click Next.

Step 7: IIS Settings

Please ensure that the Web Site is set to the Default Web Site value.

Click Next.

Step 8: Installation Settings

Browse the path on which you would like to install the APP too.

Click Install to begin the procedure.

You will be able to follow up on the installation process on your Progress screen:

Step 10: Run Database Scripts & Create ini-file

Once a certain set of components is unpacked & installed, necessary Windows features turned on, the Adonis Script Executor box appears to run the scripts pack for modification of your database structure:

Click Execute to run database scripts.

The progress log on the right will inform you of the progress:

Enter AD_Upgrade password.

Once the log informs you that the database upgrade is finished, click Exit.

Step 11: Completing the APP Setup Wizard

After executing the scripts, you are switched back to the Installation Wizard:

Click Next to continue.

Open Crew Portal/Administrator Portal options are optional.

Click Finish.

Once the application is installed, you will have 3 access shortcuts created on the desktop:

Upgrade Existing Installation

The same Installation set is used to perform the system upgrade.
It will recognize existing applications and use the settings stored in the Windows registry to perform the upgrade.

Step 1: Start

Run the file & wait until the necessary system components are turned on.
The Welcome screen below appears:

Click Next to continue.

Step 2: Select Update mode

Select Update option - checks for the installed application & verifies its version against the offered one.
If the installed version is lower, the system can be upgraded to contain the latest functionality & logic changes.

Click the Update button.

Step 3: Run Database Scripts

You will be able to follow up on the installation process on your Progress screen.
Once a certain set of components is unpacked & installed, necessary Windows features turned on, the Adonis Script Executor box appears to run the scripts pack for modification of your database structure:

Click Execute to run database scripts.

The progress log on the right will inform you of the progress:

Enter AD_Upgrade password.
Once the log informs you that the database upgrade is finished, click Exit.

Step 4: Completing the APP Setup Wizard

After executing the scripts, you are switched back to the Installation Wizard:

Click Next to finish.

Open Crew Portal/Administrator Portal options are optional.

Click Finish.

Accessing the Application

The Adonis Personnel Portal consists of the following main applications.

See below each of the accessible via dedicated URLs:

The Personal Portal Links

You could find all links on portals via the URL below:
URL: http://localhost/APP/

How Portal link is built:

Example: http://localhost/APP/CustomerName/employee

• localhost – host address

• APP – the name of the web application; you could find it in IIS

• CustomerName – the name of the company that was declared during APP installation; if you don't remember it you should use the link http://localhost/APP/

• employee (or crew/administrator) – link to one of the portals0

The Crew Portal

It is executed in the local network onboard and accessible by all onboard crew members who have current activity.
It is used to give crew members access to the various onboard modules.
To log in you need authentication by Pin and Passcode.
URL: http://localhost/APP/CustomerName/Crew

The Employee Portal

It is used to give employees access to using the internet for various modules when they are at home or traveling.
To log in you need an authentication Email address and Password.
URL: http://localhost/APP/CustomerName/employee

The Administrator Portal

This is the Portal to administrate both Applications. It includes the setup of the various modules, user access rights, etc.
URL: http://localhost/APP/CustomerName/Administrator
Default Credentials:
UID: admin@crewportal.cp
PWD: 1

The Time Clock

The Time Clock installation needs the following URL to access the APM database:
URL: http://localhost/AdonisTimeRegSrv/TimeRegWebService.asmx

Maintaining Reports

Reports are not included in the installation set but are maintained via the Administrator Portal > Reports > Maintain Reports.
In this module, the reports, required by the customer, are uploaded to the server and accessible for the various modules/user groups.

Here you can edit, add, delete and preview reports.
Reports Grid displays Modified Date, Report Name, Report Version, and Comments (if exist):

To add a new report, click New.

1. Use the Browse button to find the .frx or .axr file containing the report you want to upload and use the Upload button to copy the report to the database

2. Report Name, you can overwrite the report name and give it use an understandable name.
   This is the name that will be displayed in the report menu.

3. Select the user groups that will have access to the report.

4. Select the modules that will display the report in their report menu.

5. If the report can be sent by mail, you can select which modules will have the possibility to send this report by e-mail.

6. Comments for internal usage by the administrator.

7. Don't forget to click Save.
   

Click to back to the Administrative Tools.

Notification Service Task Scheduler

The Notification Service Task Scheduler is designed for creating notification processes/tasks that are run periodically.

After logging in to Adonis Administrator Portal, you can access it on the Main menu screen:

The list of already scheduled tasks will be displayed on the following example screen:

1. Scheduled Tasks Grid.
   
   It contains task given Name, Schedule, Next Time when a task will be run, Last Time when it was run, Last Status of performing a task (if it was run successfully if emails were generated if there was an error when running a task).
   Please use the standard command Delete/Edit in the first column of the grid for viewing/editing or deleting a task.
   The log is for reviewing task last-time run details (date, duration, status).

2. Click Add Task button to add a new notification task.
   See the How to Create a Task section below.

3. Click

   

   to back to the Administrative Tools.

Also, notification tasks can be modified and maintained in APM.

How to Create a Task

After you clicked the button, the Task Properties form will be opened with several parameters to fill in.
Let's review the main steps.

Step 1: Task Schedule tab

We define the task name and the date/time when the task will be performed on the Task Schedule tab:

1. You should fill in Task Name.

2. By default, the task is added as enabled (Disable task checkbox is cleared).
   But you can set it. In this case, the task will be displayed in the list but will never be picked up by the server (will not be executed).

3. Time settings can be set up to run the task in one single day.
   You can enter the time when the task will be run the first time.
   If you set repeat during the day every option, please mark the interval in which the task will be performed and the time after which the task will not be run.

4. Date settings: please choose the first day when a task will be performed.
   -By default, the current date is set.
   If you want the task to be performed periodically, please choose the value in the Repeat on dates field.
   -Default value is set to perform the task only within the selected date, but you can choose to run it daily, weekly, monthly, or yearly.

Step 2: Report and SQL tab

Adonis can offer you several reports that may be selected to be run with a task. Go to Report and SQL tab:

1. Please use the dropdown menu of Select report to be attached to the email field to choose a report.
   Only one report for a task may be selected.
   For reports to appear in the list, they need to be previously uploaded under Reports > Maintain Reports
   
   The report will be generated in .pdf format and attached to an email that will be sent by the task manager according to a defined schedule.
   Each report requires its parameters to be performed accordingly.
   
   You will find the parameters described in a separate section for each report:
   -For Non-conforming events work & rest report, see Report Parameters: Non-Conforming Work & Rest section;
   -For the Non-conforming events overtime report, see the Report Parameters: Non-Conforming Overtime section.
   
   Please input these parameters in the Report params field.
   -In our example, we selected the Non-Conforming Overtime report, checked the needed parameters, and input them.

2. Additional criteria may be checked before the report will be run & attached to the email.
   Please use SQL to filter your task according to your preferences & needs.
   Insert your script into the free input field below. You can use any tables related to your database, both Crew Portal & APM, when creating your query.
   
   -If your script returns any result, the task will not be performed. The result of the script will be placed into the field Last Status for this task;
   -If a script doesn't return any result, this task will be run as scheduled.

Step 3: Notification E-mails tab

Now you should define the e-mail addresses to which the report will be sent. This can be done on the Notification E-mails tab.
The system offers 2 options for the recipient's list:

1. a) Fixed email list
   You should just input all e-mails that will be used as recipients. This list will be static & will not change unless some addresses are added/removed manually.

   You can input several emails in one row separating them by comma or you can input each mail from the new row
   You can also define the Email subject and body and click Save.
   

2. b) Dynamic from database
   
   

   

   
   You can use SQL (up to 4000 symbols) so that all the crew members that fit certain conditions become recipients.
   
   You should use the # symbol for aliases of fields from database tables.
   -One of the aliases that exist in selection should be defined as the Field identifying email address (#Email).
   -All fields can then be used in the email body.
   

   This option lets you create mail merge documents that will be automatically sent to the recipients of your interest.
   Please wrap the field alias in brackets symbols [ ] like [#Pin] in the email body, then you will have them displayed as the real database values corresponding to each selected person.
   
   IMPORTANT:
   -Each field should be specified only once inside the query.
   -You should not define values like select pw001p01.pin as #PIN, and 1020 as #PIN.
   
   You can as well define the subject for the email & add some text that may contain necessary info/comments for the report/contact data of the administrator, etc.

Please click Save at the bottom of the dialogue window when you finish your task setup.

It will then appear in the task list.
The task will run the defined report at a given time. It will be performed within a defined period, sending a report performed with setup parameters.

No manual actions are required from an operator unless you want to change some parameters.

If you do not want to create a task, please click Cancel.

Report Parameters: Non-Conforming Work & Rest

The Non-Conforming Work & Rest report is designed for Task Scheduler for periodic automatic mailing to defined recipients.

Report Parameters
Please note that for efficient work, the following parameters need to be defined on the Report and SQL tab of the task:

NonConforming_Period_from (mandatory) is a value that describes how many days must be deducted (negative value) from today's date. This will be the beginning of the reported period.

NonConforming_Period_to (mandatory) is a value that describes how many days are deducted from today's date. This will be the end of the reported period.

E.g. if current date is July, 11 & NonConforming_Period_from = -10, NonConforming_Period_to = - 8.
Then the report will check the period from July, 1 (current date minus 10) to July, 3 (current date minus 8).

PositionNumorgId (mandatory) defines the position in the chain of approval. Only this position & positions that are situated below in the chain of approval will be processed by the report. The digital code that corresponds to a position may be found in Structured Query Language (SQL) Server Management Studio. Select the needed database and run a special script.

Look at the example:

VesselNumorgId (mandatory). You can find it under Organization Structure > Vessel Properties > Identification:

ServiceURL (mandatory).
Log in Adonis Administrator Portal > Configurations > General Settings > Personal Portal Service tab:

Report Parameters: Non-Conforming Overtime

The Non-Conforming Overtime report is designed for Task Scheduler for periodic automatic mailing to defined recipients.

Report Parameters
Please note that for efficient work the following parameters need to be defined on the Report and SQL tab of the task:

NonConforming_Period_from (mandatory) is a value that describes how many days must be deducted (negative value) from today's date. This will be the beginning of the reported period.

NonConforming_Period_to (mandatory) is a value that describes how many days must deduct (negative value) from today's date. This will be the end of the reported period.

E.g. if current date is July, 11 & NonConforming_Period_from = -10, NonConforming_Period_to = - 8.
Then the report will check the period from July, 1 (current date minus 10) to July, 3 (current date minus 8).

PositionNumorgId (mandatory) defines the position in the chain of approval. Only this position & positions that are situated below in the chain of approval will be processed by the report. The digital code that corresponds to a position may be found in Structured Query Language (SQL) Server Management Studio. Select the needed database and run the special script).

Look at the example:

VesselNumorgId (mandatory). You can find it under Organization Structure > Vessel Properties > Identification:

ServiceURL (mandatory)

Log in Adonis Administrator Portal > Configurations > General Settings > Personal Portal Service tab: