APP Housekeeping
Contents
System Architecture
Adonis Personnel Portal consists of three applications:
Administrator Portal
Employee Portal
Crew Portal
See the article explaining the difference between them:
https://adonishr.atlassian.net/wiki/spaces/KB/pages/3223782827
Server Components
The Adonis Personnel Portal consists of the following server components:
The Adonis Personnel Portal Web Service
The Crew Portal Web Service (AdonisWebServices) contains the API used by the Personnel Portal.
This component is Mandatory!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 ServiceThe Time Registration Service
This service is mandatory when it is used by Time Clock. Time Clock uses the Time Registration Service to communicate with the database.
It requires the Crew Portal Web Service
System Requirements
The following description shows the minimum and recommended hardware and software requirements:
Adonis Crew Portal requires: .Net Framework 4.7 or higher
The server must support .net 4.7.
Minimum CPU is 8 GB
Minimum server hardware requirements given by Microsoft
Internet Information Services Manager (IIS)
The APP installation set will install or activate the following IIS and Windows 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
Remote installation / update is not applicable if IIS is running on Windows 10. For more information on the remote update, see Remote Installation / Update.
Installation / Upgrade
The sections below contain step-by-step instructions on how to install and update Adonis Personal Portal.
Getting Started
Before installing Adonis Personnel Portal, make sure you have Adonis Personnel Manager (version 4.20 or higher) installed on your workstation.
Database Modifications
When installing or upgrading the system, you need to upgrade the database.
To perform this upgrade, you are required to provide AD_UPGRADE credentials. If they are unknown, please contact your database administrator.
Installation Modes
The installation set offers you the following options:
Install Personnel Portal creates the application from scratch, installs and activates all the necessary components. The option is set by default as your target server or workstation does not have any APP instance installed
Repair is used to re-install, clean up, and activate already installed components
Update checks for the installed application and verifies its version against the offered one. If the installed version is lower, the system will be upgraded to the latest one
In the Install, Repair or Update modes, the installation set enables the Windows features. For more information, see the Internet Information Services Manager (IIS) section.
New Installation
Step 1
To start the installation, go to the download area of our website or your FTP area and download the latest version of Adonis Personnel Portal.
Once the download is complete, go to the downloaded path and double-click the installation file to launch the setup wizard.
It is recommended to close all other applications before starting the installation.
Step 2
When the Welcome dialog appears, click Next to continue.
Step 3
Specify whether the installation is to be performed locally or on the Azure platform:
Select Local Installation and click Next to proceed.
Step 4
In the dialog, select Install/Update Personnel Manager and click Next to proceed:
Step 5
In the Choose Components dialog, select the components to be installed:
By default, the set offers all of the components:
Personnel Portal WebService is responsible for numerous calculations and operations being performed by the system.
Personnel Portal creates a web interface that provides onboard crew and office employees with an access to various operations within application modules.
Gateway API Web Service allows different applications/services to communicate with each other and exchange data on and off the network.
Integration Web Service ensures communication to third-party applications.
Click Next to proceed.
Step 6
Define the connection details such as server and database names as well as provide the database credentials.
On entering the details, click Test DB connection to make sure the connection is successful. When done, click Next to continue.
Step 7
In the General settings dialog, select whether you want to perform the vessel or office installation:
On selecting, in the Office ID/Vessel ID drop-down list, select the ID to be affected.
Step 8
Define details for the SMTP server as well as its connection credentials (if necessary). It is required for mail generation when sending reports by email or sending out notifications.
Click Next.
Step 9
In the Personnel Portal IIS settings dialog, ensure that the Web Site is set to Default Web Site.
Click Next.
Step 10
With the dialog displayed, choose the folder where you want to install the Adonis Personnel Portal application.
To do this, click Browse… and indicate the path to the destination folder.
Click Next to continue.
You can see the APP installation in progress:
Step 11
Enter the database AD_UPGRADE password:
Click OK to confirm.
Step 12
The Adonis Personnel Portal application has been successfully installed on your PC.
Click Next to finish the installation.
On the dialog that opens, select the applications to be lauched after closing the wizard:
Click Finish to close the setup wizard.
Application Update
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
To start the update, go to the download area of our website or your FTP area and download the latest version of Adonis Personnel Portal.
Once the download is complete, go to the downloaded path and double-click the installation file to launch the setup wizard.
Step 2
When the Welcome dialog appears, click Next to continue.
Step 3
Specify whether the installation is to be performed locally or on the Azure platform:
Select Local Installation and click Next to proceed.
Step 4
In the Install/Update DB dialog, select Install/Update Personnel Manager:
Once done, click Next to proceed.
Step 5
In the Install/Update dialog that appears, select the Update Personnel Portal to version option:
Selecting the option enables the drop-down list where you can select the application instance to be updated. The default application instance is set to [DEFAULT].
When completed, click Update.
Step 6
You can see the APP update in progress:
Step 7
Enter the database AD_UPGRADE password:
Click OK to confirm.
Step 8
The Adonis Personnel Portal application has been successfully updated on your PC.
Click Next to finish the installation.
On the dialog that opens, select the applications to be lauched after closing the wizard:
Click Finish to close the setup wizard.
Remote Installation / Update
The remote installation or update of Adonis Personnel Portal assumes installing or updating it from the office workstation to the vessel one or vice versa. It is only possible to perform the remote installation / update in the Silent mode using the parameters described in Command-line Parameters.
Command-line Parameters
The table below lists the parameters to be used to perform a remote installation/update of Adonis Personnel Portal.
/S | Executes installation set in the Silent mode. |
---|---|
/DBO | Updates only a database in the Silent mode. |
/I | Stands for an instance to be updated. |
/CAB | Creats the CAB file to perform an update by Replicator. |
Parameters Description
The /S command-line parameter enables executing installation in the Silent mode. To initiate the installation, type:
AdonisPortalInstall_vXXXX.XX.X.XX.exe /S
The /DBO command-line parameter allows updating only a database. To update a database, type:
AdonisPortalInstall_vXXXX.XX.X.XX.exe /S /DBO
The /I command-line parameter allows specifying the application instance to be updated. If /I parameter is not defined, the installation set updates the [DEFAULT] instance of Adonis Personnel Portal. To update a specific instance, type:
AdonisPortalInstall_vXXXX.XX.X.XX.exe /S /I=Instance_Name
The /CAB parameter is used to create a CAB file to perform an update in Adonis Replicator. An output CAB file will contain an encoded application instance as well as the the CAB file name will include the instance name. For example: AdonisPortalInstall_appInstanceName_v{PRODUCT_VERSION}.cab. In case an instance name is not defined, a CAB file will be created for the [DEFAULT] instance.
To create a CAB file with a specific instance name, type:
Replicator Setup
This section describes the parameters to be passed in Adonis Replicator to perform a remote update/installation of Adonis Personnel Portal. To get started, run Adonis Replicator:
To specify the parameters, 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 Adonis Personnel Portal. Right under the selected application, select Update 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:
REMOTE_SERVER – name or IP address of server where to update APP
REMOTE_SERVER_LOGIN – windows login with admin access rights for \\server\Admin$ resource
REMOTE_SERVER_PASSWORD – password of REMOTE_SERVER_LOGIN user
On entering, click OK to proceed.
The installation of Adonis Personnel Portal on a remote workstation is performed with the help of the PsExec utility that requires the following prerequisites:
File and Printer sharing are enabled on the remote computer
The REMOTE_SERVER_LOGIN / REMOTE_SERVER_PASSWORD credential has an access right to the \\REMOTE_SERVER\Admin$ resource. To make sure the remote server is accessible, execute the follwoing
where REMOTE_SERVER is localhost in case the Replicator Service and APP are on the same server.
Azure Installation
You have the possibility to install the APP web application on the Azure platform. For this, proceed with the steps that follow.
Step 1
In the Setup manager, select Azure Installation:
Click Next to proceed.
Step 2
Selecting the Azure Installation option opens the Microsoft Azure sign-in page. Enter your credentials to sign in to the Azure account:
On successful authentication, opens the Azure Subscription dialog.
Step 3
On the Azure Subscription dialog, select whether you want to update the existing installation or proceed to a new installation:
New Installation
Update
When done, from the Subscription drop-down list, select the Azure subscription to be used.
Click Next to proceed.
Step 4
The appearing dialog allows setting the APP web application name by filling in the fields below:
Region. From the drop-down list, set the region where the web application to be installed.
Customer Short Name. Enter the company name to be used as an installation name.
Web App Name Prefix. Enter the prefix to appear before the installation name.
On filling in the fields, click Check Web App Name to make sure the web installation name is unique. In case the verification is successful, the following message appears:
Click OK. This enables the Next button in the Setup manager. Click it to proceed with the installation.
Step 5
On the dialog, set the following:
Database server. From the drop-down list, select the SQL server where the wen installation is to be performed.
Database name. From the drop-down list, select the database name to be used for the web application
Click Install to launch the installation.
Step 6
The installation is in progress:
Once completed, click Next to complete the installation.
Step 7
The web application is successfully installed:
Click Finish to close the Setup manager.
The complete web application URL is : https://appbestcustomerappne.azurewebsites.net/APP_BestCustomer/administrator
As a result of installation, the following components are created in Azure:
Resource Group
App Service Plan
Web App
Accessing Applications
Adonis Personnel Portal consists of the following main applications:
Adonis Crew Portal
Adonis Employee Portal
Adonis Administrator Portal
Adonis Time Clock
See below each of the accessible via dedicated URLs.
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
Adonis 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
Adonis 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
Adonis 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
Adonis Time Clock
The Time Clock installation needs the following URL to access the APM database:
URL: http://localhost/AdonisTimeRegSrv/TimeRegWebService.asmx