Description
...
To update a program on the sites, you need to:
- Create an update package of an application.
- Upload (publish) the update package into Replicator.
- Specify the sites which the update must be delivered to and set the installation time.
Create APM Update Package
To create the APM update package, follow the steps below:
- Run the APM setup wizard. In the Install mode dialog, select the Generate update package option:
Click Next to continue. - In the Choose Adonis Personnel Manager Location dialog, define the directory for saving the update package:
Click Generate to generate the package. - Wait until the package is generated:
When completed generating, click Next to contimue.
And then need to define the place where ADPW.ini file is located.
Subitem: for APP.
To run installation set in silent mode use parameter /S. To specify instance for update use parameter /I=”Instance name” (parameter “/I” is only used in silent mode)
To create CAB file for replicator run installation set with parameter /CAB. It will create .CAB file in the same folder where .exe file is. (it must have write access to this folder)
Examples:
Run installation in silent mode
AdonisPortalInstall_v2020.20.0.19.exe /S /I=”Test_Installtion”
Create CAB file for update by replicator
...
- continue.
- When done, the following dialog appears:
Click Finish to close the wizard dialog.
Create APP Update Package
To create the APP update package, follow the steps below:
- Open a command line application and enter the following commands:
start /D <path_to_the_folder_with_the_installation_set> <path_to_APP_installer.exe> /CABstart /D H:\Adonis\Replicator\APP_distribute_via_Replicator AdonisPortalInstall_v2021.10.0.102.exe /CAB - Press Enter.
As a result, the CAB update package will be generated and available in the defined folder: AdonisPortalInstall_v2021.10.0.102.cab
In replicator task setup it need specify update parameter INSTANCE_NAME with name of APP instance you want to update. It needs in case if more then one instance installed on server. If this parameter is not specified then it will update [DEFAULT] instance.
Once done, Replicator will proceed to the next steps:
- Deliver the update package to the selected sites.
- Install the update at the scheduled time.
Plugin and program installation procedures are different. Below you will find the description of each installation procedures.
Update Program/Plugin
A program update package contains an executable file that performs installation, a configuration file (Update.ini) and other files needed to install the update. Replicator starts the installer at the scheduled time using the command line parameters specified in Update.ini. When the installation process is completed, Replicator gets the exit code and stores the installation log in a certain database table. In case the update installation is successful, Replicator saves the version number of the installed program to that database table (the version number is specified in Update.ini). Based on this information, you can observe the program update installation on each site.
A plugin update package contains a plugin executable file (console application), Update.ini and other files used by the plugin when it runs. There must be one or more so-called plugin tasks specified in Update.ini. Each task is defined by the command line parameters to be used when starting the plugin application. A task has also its own name and a schedule. The installation of the plugin update consists in extracting files from an update package to a certain disk folder from where the plugin will start. After the successful installation, Replicator stores the plugin version number of the plugin to the database (same as after program installation) so that you can see the plugin update status on all sites.
To update a program or a plugin, proceed with the following instructions:
- Create an update package of the program. For more information, see 2639102768.
- Publish the update package in Replicator Manager and set the time for updating the program/plugin. For more information, see 2639102768.
- Specify parameters for the site(s). For more information, see 2639102768.
Anchor Create Update Package Create Update Package
Create Update Package
Create Update Package | |
Create Update Package |
An update package is a CAB archive that includes:
- An Update.ini file is an executable file that will start and update the program (installer).
- Other files required to update the program.
Info |
---|
You can create an update package on your own or with the help of the PackageBuilder utility. |
Anchor Publish Update Package Publish Update Package
Publish Update Package
Publish Update Package | |
Publish Update Package |
To publish the update package in Replicator Manager, follow the steps below carefully:
- On the left-hand side pane, select the service which you got connected to and navigate to Updatable programs:
- Within the Updatable programs workspace, click the Publish update button. The Open dialog then appears on the screen:
- Select the CAB file of the program you want to update. Click Open to load the file to Replicator Manager. Once clicked the package publishing is started. If the package is successfully published, you are notified respectively:
Select the sites which the update package is to be delivered to:
Info Based on whether you want to deliver an update package to a single site or a multiple of them, you can select a single row or a multiple of them, accordingly.
- Selecting the site(s) enables the Set Install Time button. Click the button to open the Set Update Install Time dialog:
Within the dialog, specify the update install time by setting one of the options:
- Do not install update automatically. Select the option to deliver the update package without auto-update.
- Install update as soon as it is delivered to site. Select the option to allow updating once it is delivered to the sites.
- Install at specified date and time. Select the option and specify the date and time values for the update to be installed on the sites.
- Once done, click Ok to apply the changes.
As a result, the update package will be delivered to the selected site(s) and update will start at the specified time or as soon as the update package is delivered to the site(s). Besides, you must set the connection parameters to the affected site(s) have been correctly set. For more information, see 2639102768.
Anchor | ||||
---|---|---|---|---|
|
After the plugin/program is installed, it is necessary to specify parameters for the Site(s).
To specify the parameters, follow the steps below:
- On the left-hand side pane, select the service which you got connected to and navigate to Updatable programs.
- In the Updatable programs node, select the plugin/program to be affected. Right under the selected program/plugin, select Update parameters/Plugin parameters, accordingly.
- 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:
- On entering, click OK to proceed.
Below, you will find the description of parameters required for each program/plugin.
For the RESCO Interface plugin, the following parameters are required:
Name | Value |
---|---|
DATABASE | Enter the database name to be used. |
DAYSGAP | Define the number of days after the current day during which crew members will be available in RESCO. |
SERVER_NAME | Specify the server name to which to connect. |
SERVICE_PSW | Enter the password to the service. |
SERVICE_URL | Enter the service URL. |
SERVICE_USER | Enter the service user name. |
XREF | Define the name of the Xref interface added in the APM. |
For APM, the following parameters are required:
Name | Value |
---|---|
APM_FOLDER | Specify the application installation path. |
SERVER_NAME | Enter the server name. |
DATABASE_NAME | Enter the database name to be used. |
USER_NAME | Enter the APM username. |
Password | Define the database password. |
Note |
---|
Before updating APM, make sure the following conditions are met:
|
Info |
---|
If APM is running and Replicator makes an attempt to perform an auto-upgrade, a warning message prompting you to save any changes will be displayed on the screen and APM will be terminated: |
For APP, only one parameter is required:
Name | Value |
---|---|
INSTANCE_NAME | Specify the APP instance name to be updated. |
Info |
---|
Passwords for user AD_UPGRADE must match. Otherwise, the APP site will be upgraded but the database will remain unchanged. |
Remove Program/Plugin
You can remove a program or a plugin from the list of programs that may be updated. To do this, follow the steps below:
On the left-hand side pane, select the service which you got connected to and navigate to Updatable programs:
- In the Updatable programs workspace, select the program/plugin you want to remove and click the Delete program button. Clicking the command displays the Confirm dialog where you can confirm the deletion:
- Click Yes to confirm the deletion.
When successfully completed, the corresponding message then appears.
Info |
---|
If an affected program/plugin is running at the moment, it will be removed after all the tasks are finished. |
Note |
---|
All the information related to the program/plugin will be removed from your database (status info, update parameters, task schedules) as well. Besides, the corresponding folder(s) will be removed from the disk. |