General Information

After the installation is completed, the following files are stored in the ..\ APM directory:



The BACKUP folder contains the file backups to be able to restore the previous version of the application.
The PLUGINS folder contains software components that add specific features to the application.
The adFastReport2.dll library is required for providing compatibility with reports created in FastReport version 42.
The adpw.ini file contains the database connection strings.
The apmg.exe file is an executable used to run the Adonis Control Centre and Adonis Personnel Manager applications
The .lng files are localization files required to maintain different languages in the Adonis Control Centre and Adonis Personnel Manager applications.
The pw.dat file is a license file containing your company's license information for APM modules and datagroups.
The uninst.exe file is an executable used when uninstalling the application.
The sqlncli.exe installation file of Microsoft SQL Native Client is used to provide application compatibility with lower versions of SQL Server.
The libeay32.dll and ssleay32.dll libraries contain a set of procedures and driver functions that may be applied by Windows.
Cleaning up the directory structure

The upgrade is not removing the old directory structure of APM as there can be stored information that is critical for your operation.

We advise cleaning up this structure and removing the directory structure as it is not relevant for executing APM.

Requirements

To run the application effectively, make sure the following applications are installed on your workstation:

SQL Server (version 13 or higher) or SQL Native Client (version 11 or higher).

ODBC Driver.

Also see https://adonishr.atlassian.net/wiki/spaces/KB/pages/3647307769

Installation Modes

Adonis Personnel Manager offers you several installation modes intended for different purposes. The Install mode dialog, where you can access the installation modes, appears right after the Welcome screen:



Install Personnel Manager. Select the option to create a new installation of Adonis Personnel Manager. Besides, you can use this option if you need to create a test or development environment, or you want to move the current installation to a different server. For more information on how to install the application, see Installation Process.

The Create Database checkbox:

If selected, allows installing the application together with database tables, triggers, logins, etc.

If cleared, allow installing the application without any database. It is useful if you want to install APM on a new site by using a database backup of a different site.
Upgrade Personnel Manager. Select the option to upgrade the existing installation to a higher version that contains bug fixes and improvements. For more information on how to upgrade the application, see Upgrade Process.
Execute Upgrade script. Select the option to upgrade the database without updating the application. The option is particularly useful If:

your attempt to upgrade the application was not successful. To resolve the issue, run the executable file and select the Execute Upgrade script mode which will add missing upgrade scripts.

you want to upgrade the databases being used by several users. The Execute Upgrade Script option will allow selecting the database to be upgraded.

For more information, see Execute Upgrade Script.
Create Database Logins/Users. Select the option to connect to the database and create database logins: ADPW, AD_UPGRADE, and REPL.

When installing APM on a new server, first, restore the backup, then install APM without a database. During this installation, link APM to the restored database and create database logins/users. For more information, see Create Database Logins/Users.
Copy Files. Select the option to downgrade the program without updating the database. It is a time-saving procedure mainly intended for testing purposes in test/development environments.

Assume that you need to downgrade the current version of APM for testing/investigation purposes. To do this, run the executable file and select the Copy Files mode. For more information, see Copy Files.
Generate Update Package. Select the option to generate a .cab file with the APM installation set designed for the Replicator to automatically run the upgrade patches. For more information, see Generate Update Package.

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 Manager.
Once the download is complete, go to the downloaded path and double-click the installation file to launch a setup wizard.

Step 2
When the Welcome dialog appears, click Next to continue.


Step 3
In the Install mode dialog, select Install Personnel Manager and click Next to proceed.
Along with the installation, you can choose to create a database by selecting the Create Database checkbox.


 In case the Create Database checkbox remains unselected, the setup will skip the installation steps associated with the procedures required for creating a database.

Step 4
With the dialog displayed, choose the folder where you want to install the Adonis Personnel Manager application.
To do this, click Browse… and indicate the path to the destination folder. Click Next to continue.


Step 5
Indicate the path to the PW.dat license file which has been sent to you after buying the copy of APM. Click Next to continue.


 If you do not find the license file, please contact the Adonis Support Help desk.

Step 6
The setup cleans up the destination folder before the installation. Indicate the path to the folder where you want to store the files being removed. To proceed, click Next.


Step 7
You can see the APM installation in progress and the language resources being unpacked:


Step 8
With the dialog displayed, fill in the following fields:

Main SiteNo. Enter a numeric value for the main site.

SiteNo. Enter a numeric value for a vessel site.

Site Name. Specify the name of a vessel site.

Site Short Name. Define a short name for a vessel site.

Concern. Enter the name of your company.

On completing, click Next.

 If you install on the main site, it is recommended to define the same value in the Main SiteNo and SiteNo fields.
The values must be different for several sites to be replicated and the current installation is to be performed on a vessel site.

Step 9
At this stage, you can create the replication channels for data exchange between your sites. The setup is only intended for users with several sites.
To add vessel site, click the New button. This enables the grid fields to be filled in:

Id is a numeric value of a vessel site.

Name is a name of a vessel site.

Short name of a vessel site.

Once all the vessel sites are added, click Save to update the grid with new records and Next to continue.

 If the installation is intended for the main site only, skip the stage by clicking Next.

Step 10
Define the connection details such as server and database names as well as the database SA user password. On entering the details, click the Test connection button to verify whether the credentials are valid. When the system informs you that the connection is successful, it enables the Next button. Click it to proceed.


Step 11
Define passwords for AD_UPGRADE, APM and REPL database users.

Specify the password for the AD_UPGRADE database user. During the upgrade process, the password is used to modify the database. To proceed, click Next.

Open

Create the APM database user by specifying a user name and setting a password. The credentials are required for APP/APM to access the database. To proceed, click Next.

Setting the Use same password for all logins checkbox allows defining the same password for all database users.

 An Administrator can delete the APM database user and create a different user instead.

Specify the password for the REPL database user. The password is required for the Replicator to access the database. To proceed, click Next.

In addition, the system automatically creates the AD_LOGIN database user required for accessing the tables which contain the actual user login information. During the login process, the system verifies whether a user is an actual Adonis user. If the verification is successful, the system continues accessing the database using the credentials of the APM database user.

Step 12
Define the credentials for your system administrator (superuser) by setting Login, Name, and Password. The password will be stored in pwsecurity_users. Click Finish to continue with the installation process.


Step 13
You can see the Adonis Personnel Manager application installation in progress.


The Adonis Personnel Manager application has been successfully installed on your PC. Click Next to finish the installation.


Step 14
Click Finish to close the setup wizard.

Upgrade

After publishing a new APM official release version containing useful system implementations and bug fixes, you are offered to upgrade the.
Information regarding the new release, you get in Newsletters sent after it's officially published.
Please, pay attention: upgrade should be done on all sites and the same version.
So, you need to have all vessels online, with a good connection.

Before Upgrade

Ask users to log off APM for the period needed for upgrade;

When the scheduled time for the upgrade came, check login sessions and close them:

Log in APM, go to Setup > Login Sessions:

Open

Filter Logout Time column setting (Blanks) option:

The system leaves only current sessions.
Select all of them, except yours (in bold) > click Close Session (mention reason) > and Close button.

Log off APM.

Save AdonisRepl v. x.x..exe. file to the same Replicator folder where Replicator is installed.

The following steps need to be done in the same sequence to avoid possible issues:

Step 1: Disable Scheduler on the main site
Go to Replicator Manager >- Scheduler tab, clear the check-box for Use built-in scheduler option:

Click Save button.

Step 2: On the main site - Run replication (all 4 phases), check if no errors exist (if any – contact support@adonis.no):

FTP: Receive Files;

Import;

Export;

FTP: Send Files

Step 3: Go to every site (vessel) one by one and perform the next on each one:

Disable Scheduler;

Run replication (all 4 phases):

FTP: Receive Files;

Import;

Export;

FTP: Send Files

Be sure that no errors exist (if any – contact support@adonis.no).

Step 4: After you've finished needed actions on every vessel (per Step 3), return to the main site:
On the main site:

Run replication – only 2 phases:

FTP: Receive Files;

Import

Clear check-boxes for Export and FTP: Send Files.

Step 5: Check FTP, be sure that no pending files exist for every site.
Step 6: Perform upgrade on every site (see Upgrade Process section below).

Upgrade Process

Step 1. Run the executable file
Go to the download area of our website or your FTP area to download the latest patch with the name apm2017.4.0.XXX

where XXX is a build number.

Start the executable. Welcome screen appears:

Link to On-line User Instructions.

Click Next.

Step 2. Start the upgrade process

Starting from v.2015.1, APM Installation & Upgrade sets are distributed as the same executable. So, at the first step, you should select the correct option - Upgrade Personnel Manager.
It 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 Next.

Step 3. Browse the destination folder for installation & backup

The system will ask you to identify the target folder where you have your APM application installed.
Please browse the correct path in your system & click Next.

All information that is moved inside the database during an upgrade is also packed into the BACKUP folder.
Please define the path to the folder to store the backup files & click Next.

If you have several databases installed on the same server (the same executable), you will be offered to choose the proper one for upgrade:

Select needed DB and click the Next button.
You can as well tag several databases to upgrade - 'Multi-Upgrade' mode

If you want to upgrade the DB which is not defined in adpw ini. file, you can use Add new database option:



As a result, it will be upgraded and added to adpw.ini file. Details for the new database that should be added:

Note: Defined value in Alias field of Upgrade Set will be stored as CON_NAME value in ADPW.ini file.
Indicate Server name, Database name, and Password of AD_UPGRADE database user. 
Click test Connection and then Upgrade button.

Step 4. Define server connection details

The system will ask you to input database connection details together with the password of the AD_UPGRADE database user.
Click Test Connection to verify credentials that will enable the Next button (if given credentials are correct).
Upgrade will only be possible if the correct credentials are input above. 

Click the Upgrade button.

Step 5. Upgrade progress

The progress log will appear displaying the current processes running during the upgrade.
The script is divided into several sub-scripts. As each sub-script finishes, it will give a message containing the name of the script and 'Script execution finished'.
You may also receive information about changes that will have to be done in other parts of the system (e.g. modify access rights to data fields in the system).

After the upgrade has finished, read carefully all the shown information or copy and save it to be able to revert to it later.

When the process is completed, you can right-click & copy the entire log to an external text file. This can be used in case you issue any problems during the upgrade procedure.

Click Next.

Step 6. Finish and check System Information

Click Finish.

After Upgrade

For customers using replication

Step 1: Enable Scheduler on all vessel sites:
Go to Replicator Manager >- Scheduler tab, set the check-box for Use built-in scheduler option:

Click Save

Step 2: Enable Scheduler on the main site.
Step 3: Run replication on all sites – vessels and main site (all 4 phases – FTP: Receive Files, Import, Export, FTP: Send Files).
Check if no errors exist, if any – contact support@adonis.no

Execute Upgrade Script

Step 1. Run the executable file
Go to the download area of our website or your FTP area to download the latest patch with the name like apm2017.4.0.XXX

where XXX is a build number.

Start the executable. The welcoming screen appears:

Link to On-line User Instructions.

Click Next.

Step 2. Select mode

At this step, you should select the correct option - Execute Upgrade Script - to upgrade the database without program updating.
For details see the Install Modes section.

Click Next.

Step 3. Browse the destination folder

The system will ask you to identify the target folder where you have your APM application will be installed. Please browse the correct path in your system.

Required/available space data.

Click Next.

Step 4. Browse the destination for the backup folder

The installation set will perform the cleanup of the target installation directory. Any files that can appear under it will be moved to the backup folder.
Please browse the path for the backup directory to be created.

Click Next.

Select needed DB and click Next.
You can as well tag several databases (use ctrl + mouse-click) to upgrade.

Step 5. Define server connection details

The system will ask you to input database connection details (server and database names) and the database AD_UPGRADE user password.

Click Test Connection to verify credentials that will enable the Run scripts button if the given credentials are correct. Click OK.

The next step will only be possible if the correct credentials are input above.
Click the Run scripts button.

Step 6. Complete upgrade
A status window will display the upgrade progress & the actions being performed:

Click Next to finish.

Step 7. Finish

Click Finish.

Create Database Logins/Users

Please pay attention: Install / Upgrade Personnel Manager is the standard, commonly used mode.

The Create Database Logins/Users mode is an additional option used by the Adonis Development team for some special/uncommon situations.

*Step 1. Run the executable file:*
Go to the download area of our website or your FTP area to download the latest patch with the name apm2017.4.0.XXX

where XXX is a build number

Start the executable. The Welcome screen appears:

Link to On-line Help/User Instructions.

Click Next.

Step 2. Select mode

At this step, you should select the correct option – Create Database Logins/Users.
For details see the Install Modes section.

Click Next.

Step 3. Define server connection details

The system will ask you to input login, database connection details (server and database names), and the database SA user password.

Click Test Connection to verify credentials that will enable Create Logins button (if given credentials are correct). Click OK.

The next step will only be possible if the correct credentials are input above.
Click Create Logins button.

Step 4. Define passwords for database users ADPW, AD_UPGRADE and REPL

Please input & confirm the password for ADPW, AD_UPGRADE and REPL database users.
Three separate input screens will appear for each of mentioned users:

From ver. 2018.1, we added the possibility to use "use same password" for all database logins.

If it's set - the next 2 screens will be skipped.

Click Next when the password for a user is defined.


Step 5. Process completing
A status window will display the progress & the actions being performed:

Logins are successfully created.

Click Next to finish.

Step 6. Finish

Click Finish.

Copy Files

Please pay attention: Install / Upgrade Personnel Manager is the standard, commonly used mode.
The Copy Files mode is an additional option used by the Adonis Development team for some special/uncommon situations.

Step 1. Run the executable file
Go to the download area of our website or your FTP area to download the latest patch with the name apm2017.4.0.XXX

where XXX is a build number

Start the executable. The welcoming screen appears:

Link to On-line User Instructions.

Click Next.

Step 2. Start the process, select mode

At this step, you should select the correct option – Copy Files (to upgrade the program without database updating). 
See Install Modes section for details. 

We do not recommend using this mode. It's implemented purely for use by the Adonis Test and Development teams.

Click Next.

Step 3. Browse the destination folder

The system will ask you to identify the target folder where you have your APM application installed. Please browse the correct path in your system.

Required/available space data.

Click Next.

Step 4. Browse the destination for the backup folder

The installation set will perform the cleanup of the target installation directory. Any files that can appear under it, will be moved to the backup folder.
Please browse the path for the backup directory to be created.

Click Next.

Step 5. Completing phase
A status window will display the progress & the actions being performed:

Click Next to finish.

Step 6. Finish

Click Finish.

Generate Update Package

The newest replicator version provides the possibility to distribute & run upgrade patches automatically.
As upgrade requires passing a certain set of parameters, from APM ver. 2018.1. - we should provide the possibility to use this command for this purpose - to generate CAB of an installation set to install APM by Replicator.
This file should be then published in Replicator Manager (see separate The Adonis Replicator manual).

Step 1. Run the executable file
Go to the download area of our website or your FTP area to download the latest patch with the name like apm2018.1.0.XXX

where XXX is a build number

Start the executable. The welcoming screen appears:

1. Link to On-line User Instructions.

2. Click Next.

Step 2. Start the process, select mode

1. Select Generate Update Package option.

2. Click Next.

Step 3. Browse the destination folder

1. The system will ask you to identify the target folder where you have your APM application installed.
   Please browse the correct path in your system.

2. Click Generate button.
   The system generates a CAB file of the installation set. It will be saved in the 'APM SETUP' folder of the APM root folder. This file should be published by the Replicator manager (see separate The Adonis Replicator manual).

Step 4. Generating process

Click Next and Finish.

How to publish and schedule APM upgrade date & time via The Adonis Replicator Manager - see The Adonis Replicator manual.