Академический Документы
Профессиональный Документы
Культура Документы
Version: 12.00
Date: 01.11.2017
Stable releases
Swiss-AS provides 3 times a year a new version of AMOS so called “Stable Release”. The roadmap and “End of Life
Cycles” of the stable releases is published on the web in the customer area http://www.swiss-as.com/amos/roadmap
/#releasePlan .
Stable releases are recommended to be installed in productive environments since they are tested and reliable.
SWISS-AS.COM
4/52
Potential bugs can easily be fixed by means of patches (single version or cumulative patches) within short time
notice. Functionality and the database schema are not changed by patches; only program errors and security issues
on server or client side are corrected. Patches for one particular stable release version are provided frequently
(weekly) for more than one year. Swiss-AS publishes “Security Alert / Patch Withdraw” and inform the customers to
install the patch. This guarantees a stable AMOS environment with a very high availability for a predictable period of
time.
The release change to a stable release is not reversible!
Recommendations:
Please make sure that you migrated to the next higher supported version until your current version is running
out of support.
The release change to a stable release needs to be tested in detail. All business critical processes and
interfaces needs to be tested via UAT.
Preview Releases
Previews are intended to be used in test environments exclusively as they reflect the latest status of development
and might therefore show incomplete functionality. They can be installed to allow customers to stay up to date with
program changes and to be able to give feedback about new developments.
Every installation of a Preview Release requires a change of the database schema which makes them more or less
time-consuming to install (dependent on the size of your database and the power of the server hardware). Naturally,
Preview Releases always tend to have more errors and cannot be patched like Stable Releases. The release
change to a preview release can only be initiated from a preceding stable release.
For Preview Releases no patches will be published. Bugs might be fixed in the next preview release.
Preview releases must not be used in production!
Release Numbering
Both types of releases differ in numbering as explained in the following examples:
SWISS-AS.COM
5/52
10. 30 - 07
Upgrade Notes
Please take the following notes into account when upgrading or patching an existing AMOS server:
when upgrading from a Stable Release to a higher Stable Release, up to 2 version can be missed out
when patching a Stable Release only use patch files and not a Stable Release file.
upgrading from a Preview Release is not recommended as data inconsistencies introduced by incomplete
functionality might cause errors during the release change process.
from AMOS v10.30 on patches can be uninstalled
SWISS-AS.COM
6/52
Overview
Any release change of a production environment needs to be tested thoroughly in a test environment using the
same data and the same AMOS version as in production. Please make sure that key users and administrators are
aware of the following preconditions in order to allow an efficient upgrade test:
in order to get comparable results for the required downtime, the test environment should have a similar
setup as the production servers in terms of hardware resources
both keys users and system/database administrators will be heavily involved in the various tasks required to
perform one test cycle
system/database administrators need to be familiar with the procedures and scripts used to refresh the test
environment with up-to-date production data and the current application server version
experience shows that performing multiple cycles of the upgrade tests (including system preparation and data
correction) until no errors remain takes between several weeks and 6 months
Swiss-AS assists customers regarding the preparation of the test environment, the execution of the release
upgrade and during data correction in case of complex conditions
Every upgrade test cycle consists of the following steps that have to be repeated until both the release change log
and the forecast comparison show no errors. To monitor the progress of the data correction and collect useful
details that might be relevant for the production upgrade, every cycle needs to be documented using the history of
update log files and an Upgrade Instruction Manual.
SWISS-AS.COM
7/52
Process Description
Required steps to perform one release change test cycle to AMOS 10.x are described in the table below (major
steps highlighted in yellow). Note that the post work phase is only applicable after a successful release change in a
production or acceptance environment.
SWISS-AS.COM
8/52
Adjust database DB
parameters according
recommendation.
See latest Hardware
Requirements, Sybase
Standards and AMOS
Installation Guide
Follow progress of OS
upgrade using the release
change URL (described
below) or in the update log
SWISS-AS.COM
9/52
Maintain Update
Instruction Manual
The error and warning codes
require special actions to be
executed before, during or
even after the upgrade.
Therefore it is highly
recommended to maintain an
Update Instruction Manual
that describes how to correct
the data and which activities
have to be executed in which
order. These instructions will
be completed in subsequent
test cycles and will be used
during the production
upgrade.
SWISS-AS.COM
10/52
Re-enable automatic OS
database backups
Install the latest version of
backup and recovery scripts.
Note that AMOS 9.80 scripts
can no longer be used for
AMOS 10.x.
SWISS-AS.COM
11/52
Various log files exist on the server that provide additional information about the release change: full_sync_error log,
full_sync_monitoring log, full sync log (per release), incremental-release-change log.
Release change from pre-10.70 to post-10.70 versions
Purpose
This document descibes how to perform a release change from a pre-10.70 AMOS (minimum AMOS 9.80) to any
post-10.70 version. With this procedure it is possible to upgrade to AMOS 10.80 and higher versions without
stopover at jumping release AMOS 10.70.
Preconditions
SWISS-AS.COM
12/52
Process
The release change process works as follows:
Description
1. The AMOS administrator has to download the latest AMOS 10.70 release file from the swiss-as.com website.
2. The AMOS administrator starts the release change by opening the pre-10.70 AMOS client, open program
Configure Server (APN:10), then switch to the Maintenance tab. Either click new release to install the release
immediately or schedule the release change. Please choose the AMOS 10.70 release file downloaded in step 1 in
the file dialog.
3. The pre-release checks will then be executed automatically on the server. AMOS recognizes that 10.70 will not
be the final version but the version specified in the release_change.cfg file instead. The pre-release check verifies
that all required versions are downloaded in the release-folder.
4. The release change to AMOS 10.70 starts automatically. The output is written to a log file in the parent directory
of the pre-10.70 AMOS server. The log file name is update<newVersion>AMOS_stable_<oldVersion>.log. At the
beginning of the log file there is again some output mentioning the target version and listing the available release
files.
5. After the release change to AMOS 10.70 finished, the release change to the subsequent versions is started
automatically. The log file of this operation can be found in a subdirectory of the release-folder called incrementalR
eleaseChange. The progress can also be followed in the browser using the AMOS server's URL
6. After the release change has been finished successfully, the final version of the AMOS server wil be started
automatically.
SWISS-AS.COM
13/52
Environment Usage
In order to avoid inadvertent use of an AMOS environment, the intended usage of each environment - prior and after
the go-live - needs to be known to every AMOS user and the infrastructure team. During the implementation project
of AMOS, every member of the project team needs know which AMOS instances are available and what they are
used for. The commonly used environments and the data flow between them is documented here.
Environment Overview
AMOS production
Version: only Stable Releases Always on the same version as the migration environment.
Usage: production environment
Access: all users
AMOS migration
Version: only Stable Releases. Always on the same version as the production environment.
Usage: this environment is used to load data from the migration files. It is configured for improved performance.
Access: only users involved in the data migration process.
AMOS acceptance
Version: usually the latest available Stable Release
Usage: this environment is used to regularly validate changes in AMOS coming with a patch or a new release before
this update is applied to production. Prior to the update of production environment, a copy of the production
database is loaded into the acceptance environment so that keys users can verify bug fixes and new features.
Access: key users
AMOS playground
Version: usually the same version as the production environment
Usage: this environment is used to allow users to try out AMOS features using live data. The data is overwritten
regularly with a fresh copy of production data
Access: all users
AMOS test
Version: Preview Releases or Stable Releases
Usage: this environment is used to test the update/patch procedure or a disaster recovery scenario.
Access: administrators only
Data Flow
The following pictures illustrate the data flow during the implementation project (data migration) and in production.
All movement of data, except the manual migration of data from the transfer files, is performed by scripts that can
either be executed by the system administrator or scheduled to run automatically.
SWISS-AS.COM
14/52
Migration Details
The following topics have to be taken into account when recovering an AMOS database from backup during the
replication of the production environment.
SWISS-AS.COM
15/52
database. This tool provides jobs to the remove data of particular modules from the database in a consistent way.
Use the following procedure to configure necessary clean-up jobs.
1. Identify fast-growing tables by using the "Table-Size" button in the Database Monitoring tabsheet in program
AMOS Control Center (APN 2167).
2. Find the appropriate clean-up job in the list of tables affected by each job in the selection dialog in program
Data Clean-up.
3. Set up the clean-up job to run regularly (daily) based on a specific criterion (usually "number of days").
Note: when initially cleaning up huge tables you have to make sure that the database transaction log doesn't fill up
because too many rows are affected by the given criterion. In this case, initially use a higher retention time and
move it down slowly to the target time within the next couple of days. Use program Database Explorer (APN 11) to
determine the amount of rows affected by a specific criterion. In general, the amount of data affected by the data
clean-up has an impact on the database's transaction log space and the size of incremental backups.
Log Files
SWISS-AS.COM
16/52
In AMOS APN 10 Configure Server, the AMOS server allows to define backends where the output of the application
server can be stored. In most cases, these backends use log files in the application server's logs directory. To limit
the amount of data that is written to these logs, the administrator can define filters for each backend. Note that if a
particular filter rule is applied, following rules will be ignored.
Scheduled Tasks
The schedule of background tasks in AMOS needs to be defined by the administrator. Due to increased resource
usage, some tasks should not run simultaneously e.g. all tasks related to the forecast calculation. Always follow the
instructions given in the description of each task regarding parameters, the order in which tasks need to be executed
and the recommended period. Please refer to the www.swiss-as.com or the AMOS installation guide regarding the
mandatory scheduler tasks. Mandatory tasks are also called 'system' tasks.
Condition Description
Webdrive location on remote host While the webdrive can be located on a remote file
server using a UNC path,
the index directory should always be stored locally for
performance reasons.
Shared webdrive directory amongst multiple AMOS In test environments, multiple AMOS instances often
instances share a common webdrive
in order to safe disk space. As each AMOS instance
locks access to the index
files upon start, other instances will not be able to use
the index for text
searches if the default location is unchanged. To avoid
this each AMOS
instance needs to have its own index directory.
Separation of index data from visible data Using the default index location, the index directory will
be visible on the
webdrive although this data is of no use for users.
Single Sign-On
With AMOS it is now possible to authenticate against a running Kerberos service to login at the AMOS server
instead of typing in the username and password in the login dialog. This feature has to be enabled on server side
SWISS-AS.COM
17/52
before it is available on the client side at all. To enable SSO via Kerberos, the integer value of parameter 1000 has
to be set to 1 (this parameter is also used for IMAP and LDAP configuration). Doing this allows a client on the next
login to select a checkbox to login e.g. via Windows credentials as shown in the image below:
The AMOS client will look for cached session credentials of the operating system and tries to login with these.
Please ensure that all necessary configuration to use SSO was already done before activating this feature,
otherwise the SSO login will not be available independent on the parameter 1000 setting. To see what else have to
be done, have a look into the online help or ask for further support.
SWISS-AS.COM
18/52
Program Configure Server (APN 10) allows administrators to define the size of each pool and a timeout a process
waits when requesting a connection from the pool before throwing an error. The pool configuration will be stored in a
server configuration file called database_pool_configuration.cfg.
SWISS-AS.COM
19/52
Monitoring Limits
In program Configure Server (APN 10) on tabsheet Statistics, limits can be configured to monitor critical events.
Once a particular limit is reached, the event will be tracked in the application server's monitoring log file and will be
visible in the System Performance tabsheet in the AMOS Control Center (APN 2167).
Warning: in order to limit the amount of monitoring data stored in the database please take the following
recommendations into account:
set up clean-up job MonitoringEventsLogCleanupJob in program Data Clean-up
initially, use high monitoring limits to only catch the most critical events and adjust the limits after having
eliminated them.
Workflow Configuration
In program Workflow Configuration (APN 612) the administrator can set up workflows to monitor events caused by:
User actions
Scheduler tasks
AIM interfaces
System events
Some of these events require the administrator's intervention so the workflow can be configured to send a
notification message.
Swiss-AS strongly recommends that, starting from the patches mentioned above, every customer have the
"Maintenance Key Check" Deferred Job enabled and scheduled in their productive environments.
SWISS-AS.COM
20/52
Make sure that the "Enabled" check box is marked and verify the "Scheduling" tab:
The default schedule is to run this job daily at 1am but it can be changed according to your needs, please make sure
that the job is scheduled to run at a time when the AMOS server is certainly online. Swiss-AS recommends that this
job runs at least once a week.
What happens when the Maintenance key or one of the certificates is about to expire?
For each execution of this Deferred Job, the "Log" tab will contain execution details and a list of soon-to-be-expired
key and certificates:
Maintenance Key
License key certificate
Root certificate
SSL server certificate
SWISS-AS.COM
21/52
In case the Maintenance Key or one of the certificates is about to expire, the same information will be send sent via
email with subject "Maintenance Key Warning!" to all users of the ADMIN group or to the email address given to the
ADMIN group. For AOS customers, the AOS team will receive the same email. Example email text:
The installed maintenance key has expired, please request a new one for not having any restrictions in
your AMOS environment!
Currently installed maintenance key:
Serial Number: 77421392805575325
Valid Until: 19.February.2015
SWISS-AS.COM
22/52
Fill out the certificate data. Choose a "Valid until date" (this is the date when the next License Key Certificate will
have to be created). Leave the "Certificate Chain" option unticked.
SWISS-AS.COM
23/52
Fill in all information about your environment (remember to select the "Productive" option if you are doing this for
your Productive environment) and click on "Send Web Request". A new Maintenance Key will be requested and the
"Import Maintenance Key" screen will be shown:
The program AMOS Control Center (APN 2167) provides tools to verify the correct operation of your AMOS server.
It is the central monitoring application within AMOS that gives a quick overview of the AMOS environment and also
detailed information about database and application server processes. Currently, the following components are
monitored by the AMOS Control Center:
database space, table growth, table statistics and database parameters
file system space
AMOS scheduler tasks
AMOS server Java usage
A dashboard displays all critical events based on the given monitoring settings, notifies users based on the
notification settings and provides links to recommended actions. Note that these features require several Deferred
Jobs to be running in order to collect the required data and actively handle critical events.
SWISS-AS.COM
24/52
SWISS-AS.COM
25/52
Introduction
Swiss-AS provides powershell and linux bash scripts for the backup and recovery of Sybase databases used by
AMOS. The script's configuration need to be adapted to the customer's AMOS environment so that they can be
used either manually or scheduled via the task scheduler and cron. All scripts make use of a configuration file that
stores all required parameters and a so called toolboxes which are files that define particular functions. Usually, only
the configuration files need to be changed by the customer in order to get the script running.
This document describes the script's usage and the configuration.
General Notes
Predefined Configuration files : each script requires a specific set of parameters stored in a configuration file.
A template of each of the three configuration files (backup.cfg.ps1/backup.cfg, recovery.cfg.ps1/recovery.cfg
and logship.cfg.ps1/logship.cfg) is provided together with the backup, recovery and logshipping scripts and
the toolbox files.
General Toolbox : the toolbox file toolbox.ps1/toolbox.sh defines generic functions used in the backup and
recovery scripts. By default the toolbox file is located in the same directory as the corresponding script.
Sybase Toolbox : the toolbox file sybase_toolbox.ps1/sybase.toolbox.sh defines Sybase specific functions
used in the backup and recovery scripts. By default the toolbox file is located in the same directory as the
corresponding script.
Powershell execution policy : to be able to run powershell scripts on a host, the execution policy needs to be
adjusted (see Set-ExecutionPolicy command). It is possible the change the policy to the whole server or only
for one script execution (see ByPass execution policy)
Introduction
General Notes
Backup scripts
Function
Usage
Configuration Parameters
System Requirements
Recovery scripts
Function
Usage
Configuration Parameters
System Requirements
Logshipping script
Function
Usage
Configuration Parameters
System Requirements
SWISS-AS.COM
26/52
Backup scripts
The scripts to create database backups are called syb_backup.sh and syb_dump_trans.sh :
syb_backup.sh : creates a set of backup files of one or more user databases and all system databases of a
given Sybase instance.
syb_dump_trans.sh : creates an incremental backup file of one or more user database and truncates the
transaction log of all system databases of a given Sybase instance. The backup file is added to the current
backup set
A configuration file (by default etc/backup.cfg) and the toolbox files toolbox.sh and sybase_toolbox.sh are
required by those scripts.
Function
the backup file is added to the current backup set and is identified by a sequence number and a process ID
by default all databases that are part of the full backup (see syb_backup.ps1) are included, but particular
databases can be omitted
truncates the transaction log of all system databases instead of an incremental backup
the script prevents multiple simultaneous executions
performs check of the configuration parameters before creating backup sets
creates entries in AMOS table in order to monitor the backup via AMOS control center (from 10.30 on)
creates and archives a log file for each run
Usage
Without the option –f the script uses the configuration file etc/backup.cfg.
Options:
-c : let the script check the configuration only. No backup set is created.
-h : shows the usage
-f file : the script uses file as configuration file. Without this option the file etc/backup.cfg is used by default.
-i : overwrites the standby database, logshipping needs to be configured to use this parameter.
SWISS-AS.COM
27/52
The required toolbox files need to be located in the same directory as the script itself.
Configuration Parameters
The script requires the following configuration parameters that need to be defined in the script's configuration file. By
default the configuration file is etc/backup.cfg or it can be provided using option –ConfigFile for Windows powershell
and option -f for Linux bash respectively.
Parameter Description
SWISS-AS.COM
28/52
SWISS-AS.COM
29/52
System Requirements
The Linux user that runs the backup script needs to have the correct permissions on the required files and
directories.
SWISS-AS.COM
30/52
Recovery scripts
The script to recover a database from a full backup is called syb_recover.sh. It loads a set of full database backup
files into a user database of a given Sybase instance. Additionally it remaps AMOS users to Sybase logins and
restarts the corresponding AMOS server to enforce the reactivation of the AMOS maintenance key. This requires a
password-less SSH login to the host of the AMOS server. A configuration file (by default etc/recovery.cfg) and the
toolbox files toolbox.sh and sybase_toolbox.sh are required by this script.
Function
Usage
Without the option –f the script uses the configuration file etc/recovery.cfg.
Options:
-c : let the script check the configuration only. No backup is loaded.
-h : shows the usage
-f file : the script uses file as configuration file. Without this option the file etc/recovery.cfg is used by default.
The required toolbox files need to be located in the same directory as the script itself.
Configuration Parameters
Parameter Description
SWISS-AS.COM
31/52
SWISS-AS.COM
32/52
System Requirements
The Linux user that runs the recovery script needs to have the correct permissions on the required files and
directories. Additionally, a password-less SSH login is required between the user running the recovery script and the
user running the target AMOS server (see ssh-keygen for details). The AMOS maintenance key on the target
AMOS instance has to be backed up previously in order to allow automatic maintenance key recovery.
SWISS-AS.COM
33/52
Logshipping script
The scripts used for log shipping are called logship_full.sh and logship_inc.sh. They are usually called
automatically by the full and incremental backup scripts but can also be used manually. They copy a set of backup
files to a remote server and load them into the target database. A configuration file (by default etc/logship.cfg) and
the toolbox files toolbox.sh and sybase_toolbox.sh are required by these scripts.
Function
Usage
Without the option –f the script uses the configuration file etc/logship.cfg.
Options:
-c : let the script check the configuration only. No file is transferred.
-h : shows the usage
-f file : the script uses file as configuration file. Without this option the file etc/logship.cfg is used by default.
The required toolbox files need to be located in the same directory as the script itself.
Configuration Parameters
Parameter Description
SWISS-AS.COM
34/52
System Requirements
The Linux user that runs the recovery script needs to have the correct permissions on the required files and
directories. Additionally, a password-less SSH login is required between the user running the logship scripts and the
user running the target AMOS and DB servers (see ssh-keygen for details).
SWISS-AS.COM
35/52
SWISS-AS.COM
36/52
Introduction
Swiss-AS provides powershell and linux bash scripts for the backup and recovery of Sybase databases used by
AMOS. The script's configuration need to be adapted to the customer's AMOS environment so that they can be
used either manually or scheduled via the task scheduler and cron. All scripts make use of a configuration file that
stores all required parameters and a so called toolboxes which are files that define particular functions. Usually, only
the configuration files need to be changed by the customer in order to get the script running.
This document describes the script's usage and the configuration.
General Notes
Predefined Configuration files : each script requires a specific set of parameters stored in a configuration file.
A template of each of the three configuration files (backup.cfg.ps1/backup.cfg, recovery.cfg.ps1/recovery.cfg
and logship.cfg.ps1/logship.cfg) is provided together with the backup, recovery and logshipping scripts and
the toolbox files.
General Toolbox : the toolbox file toolbox.ps1/toolbox.sh defines generic functions used in the backup and
recovery scripts. By default the toolbox file is located in the same directory as the corresponding script.
Sybase Toolbox : the toolbox file sybase_toolbox.ps1/sybase.toolbox.sh defines Sybase specific functions
used in the backup and recovery scripts. By default the toolbox file is located in the same directory as the
corresponding script.
Powershell execution policy : to be able to run powershell scripts on a host, the execution policy needs to be
adjusted (see Set-ExecutionPolicy command). It is possible the change the policy to the whole server or only
for one script execution (see ByPass execution policy)
Introduction
General Notes
Backup scripts
Function
Usage
Configuration Parameters
System Requirements
Recovery scripts
Function
Usage
Configuration Parameters
System Requirements
Logshipping script
Function
Usage
Configuration Parameters
System Requirements
Backup scripts
The scripts to create database backups are called syb_backup.ps1 and syb_dump_trans.ps1 :
syb_backup.ps1 : creates a set of backup files of one or more user databases and all system databases of a
given Sybase instance.
syb_dump_trans.ps1 : creates an incremental backup file of one or more user database and truncates the
transaction log of all system databases of a given Sybase instance. The backup file is added to the current
backup set
A configuration file (by default etc/backup.cfg.ps1) and the toolbox files toolbox.ps1 and sybase_toolbox.ps1 are
SWISS-AS.COM
37/52
Function
the backup file is added to the current backup set and is identified by a sequence number and a process ID
by default all databases that are part of the full backup (see syb_backup.ps1) are included, but particular
databases can be omitted
truncates the transaction log of all system databases instead of an incremental backup
the script prevents multiple simultaneous executions
performs check of the configuration parameters before creating backup sets
creates entries in AMOS table in order to monitor the backup via AMOS control center (from 10.30 on)
creates and archives a log file for each run
Usage
Without the option –ConfigFile the script uses the configuration file etc/backup.cfg.ps1.
Options:
-CheckConfig : let the script check the configuration only. No backup set is created.
-Help : shows the usage
-ConfigFile file : the script uses file as configuration file. Without this option the file etc/backup.cfg.ps1 is used
by default.
-LogshipInit : overwrites the standby database, logshipping needs to be configured to use this parameter.
The required toolbox files need to be located in the same directory as the script itself.
Configuration Parameters
The script requires the following configuration parameters that need to be defined in the script's configuration file. By
SWISS-AS.COM
38/52
default the configuration file is etc/backup.cfg or it can be provided using option –ConfigFile for Windows powershell
and option -f for Linux bash respectively.
Parameter Description
SWISS-AS.COM
39/52
SWISS-AS.COM
40/52
System Requirements
The Windows user that runs the backup script needs to have the correct permissions on the required files and
directories.
SWISS-AS.COM
41/52
Recovery scripts
The script to recover a database from a full backup is called syb_recover.ps1. It loads a set of full database backup
files into a user database of a given Sybase instance. Additionally it remaps AMOS users to Sybase logins and
restarts the corresponding AMOS server to enforce the reactivation of the AMOS maintenance key. A configuration
file (by default etc/recovery.cfg.ps1) and the toolbox files toolbox.ps1 and sybase_toolbox.ps1 are required by
this script.
Function
Usage
Without the option –ConfigFile the script uses the configuration file etc/backup.cfg.ps1.
Options:
-CheckConfig : let the script check the configuration only. No backup set is created.
-Help : shows the usage
-ConfigFile file : the script uses file as configuration file. Without this option the file etc/backup.cfg.ps1 is used
by default.
The required toolbox files need to be located in the same directory as the script itself.
Configuration Parameters
Parameter Description
SWISS-AS.COM
42/52
SWISS-AS.COM
43/52
System Requirements
The Windows user that runs the recovery script needs to have the correct permissions on the required files
and directories (including remote ones).
The AMOS maintenance key on the target AMOS instance has to be backed up previously in order to allow
automatic maintenance key recovery.
AMOS Config server tool is remotely executed on the target AMOS host, so make sure WinRM is well
configured regarding Java Memory consumption.
SWISS-AS.COM
44/52
Logshipping script
The scripts used for log shipping are called logship_full.ps1 and logship_inc.ps1. They are usually called
automatically by the full and incremental backup scripts but can also be used manually. They copy a set of backup
files to a remote server and load them into the target database. A configuration file (by default etc/logship.cfg.ps1)
and the toolbox files toolbox.ps1 and sybase_toolbox.ps1 are required by these scripts.
Function
Usage
Without the option –ConfigFile the script uses the configuration file etc/logship.cfg.ps1.
Options:
-CheckConfig : let the script check the configuration only. No file is transferred.
-Help : shows the usage
-ConfigFile file : the script uses file as configuration file. Without this option the file etc/logship.cfg is used by
default.
The required toolbox files need to be located in the same directory as the script itself.
Configuration Parameters
Parameter Description
SWISS-AS.COM
45/52
System Requirements
The Windows user that runs the recovery script needs to have the correct permissions on the required files and
directories (including remote ones).
SWISS-AS.COM
46/52
Database Maintenance
Core maintenance by the database administrator includes the following tasks:
full and incremental database backups following the customer's backup policies
update index and table statistics, defragmentation
database server error log monitoring
monitor database and table growth
monitor resource consumption
clean-up unused data/tables
increase database size (see AMOS Installation Guide for details)
Several tools within the AMOS application support DBAs and AMOS administrators to perform these tasks. Please
find an overview below.
Monitor database and table growth AMOS Control Center APN 2137 Tabsheet Database
Monitoring/Table Evolution
Monitor resource consumption Statistic Analyzer APN 156 Activation of statistics module
required (APN 10)
Data clean-up (data only) Data Clean-Up APN 2167 Removes dispensable and outdated
data
Data clean-up (unused tables) Protected customer objects APN Remove tables formerly used by
2254 AMOS
There is always one value per line. If the line begins with a #, the line is treated as a comment and not evaluated.
Parameter names and values are case sensitive.
server.cfg
SWISS-AS.COM
47/52
This file contains all the settings that are required to reach the server and some general settings. Most of the
settings are already applied during the client installation, they can be changed with the corresponding AMOS
program. You can create multiple server.cfg files if you need to connect a client to multiple servers. The servers
have to be sequentially numbered, e.g
server.cfg, server2.cfg, etc
This way you can create multiple profiles, for example, one for the test server, one with a proxy and a direct one.
Please note that the first file (server.cfg) is the master file. This file will always be used by the automatic client
update procedure to refresh the client. Only when you reach the login dialog you will be able to select one of the
stored profiles. The AMOS client programs always record their settings in the master file, irrespective of the profile
that you selected at log in.
The following parameter are allowed in the server.cfg:
Runtime
Version of the Java runtime environment. This is entered automatically by the updater, and is used to check whether
the Java runtime environment used by the AMOS client is current up to date , or if there is a newer version available
on the server. The version is stored as a number. e.g.
Runtime = 170040
build.revision
SupportEmail
The email address of the automatically generated support emails which are registered here. This value is always set
automatically each time a user logs in using the value of AMOS parameter 1232. Manual changes to this parameter
will be overwritten.
System
This is an internal field which is used by the client updater. Should the the update logic change, the server can
determine by using this number if the client is still using the old update logic or if the client understands the new
logic. This is necessary in order to smoothly and continuously upgrade old clients to the new update logic. This
value should never be changed manually.
Server
Here the name or the IP address of the AMOS server is stored to which the client connects to, e.g.
SWISS-AS.COM
48/52
Server = amosserver.swiss-as.com
Port
The port of the AMOS server is specified with this value. As default the AMOS server runs on port 5080.
ProxyHost
If the internet is only accessible through a proxy server, you can configure the name or IP address of the HTTP
proxy server for here, e.g.
ProxyHost = proxy.swiss-as.com
ProxyPort
This value allows you to specify the proxy port. Often this is port 8080, e.g.
ProxyPort = 8080
ProxyIgnoreList
This value can be used to determine a list of addresses that should be accessed directly and not through the proxy.
You can use the * to specify an address group and you can separate multiple entries with a comma; e.g.
ProxyIgnoreList = *.swiss-as.com, amosng.crossair.ch, test.*.local
ProxyUser
If the HTTP proxy requires authentication you can enter the user here, e.g.
Proxy = proxy user
ProxyPassword
If a password is required for the proxy, you can store the password here. Note that the stored password is encrypted
and cannot be changed manually. You can change it if you access the AMOS Client login dialog or if you run the
ProxySelector tool.
UseProxyForAmos
If the AMOS server cannot be accessed directly, but only through the Internet, you can determine if the AMOS client
should connect to the AMOS server through a proxy with this field. This requires a proxy configuration (see above).
The proxy server must be configured that it allows TUNNEL to the AMOS server (HTTP Connect). Acceptable
values are true and false, e.g.
UseProxyForAmos = true
AllowProxyChange
This parameter can be used to control whether the proxy settings may be changed in the AMOS login dialog. If this
field is set to true, then an additional button will be visible with which you can call up the Proxy Settings dialog, e.g.
SWISS-AS.COM
49/52
AllowProxyChange = true
LastLogin
If the AMOS client is configured to display the last used login, this parameter stores the name of the user that loged
in successfully. The next time a user starts the client the login name will be prefilled with the value of this parameter.
See also AMOS parameter 1219.
Remote
This flag can be set to true to prevent multiple animations and background images to be displayed which would take
a long time to process during a screen refresh. These images would unnecessarily extend this action and would
make a screen refresh very long tedious action. This mode is especially interesting when the AMOS client is used
via Remote Desktop, VNC, Tarantella or Citrix.
AllowClientConfigureSettings
With this flag you can hide some menu configuration options concerning graphic acceleration, re-download client
and DDE handler settings in the AMOS client. If you set this flag to false, these corresponding menu options are not
displayed in the client.
EnvironmentName
This parameter allows you to create an alias for the server name (or IP) and port that will be displayed in the login
dialog.
AllowCancel
If this parameter is set to true then a timer is started to monitor the scroll lock key. If this key is pressed a program
will be launched that allows you to cancel the current running AMOS transaction. This should be only used for
training or presentation purpose to unblock AMOS if one action takes to long. This is not an end user feature.
UseUpdater
If this parameter is set to true then the automatic update process will be used to install new versions of the client. If
you want to roll out all patches on your own you can set this property to false to deactivate the updater completely.
UseSsl
To activate SSL for the client-server communication, the this parameter has to be set to true and the correct port
number has to be specified in the port property. Additionally the client should be rolled out already with the correct
certificates of the AMOS server.
launch.cfg
This file contains some settings that influence the AMOS client launcher. The launcher has some predefined default
settings that can be overritten by creating or editing this file. The following properties can be used:
vm
Set this property to use another Java VM or to use java.exe instead of javaw.exe.
SWISS-AS.COM
50/52
vmargs
Set this parameter to specify additional arguments to the Java VM. This parameter can be used to increase the
client's memory to more than the default of 512 MB, e.g.
vmargs = -Xmx1024m -XX:MaxPermSize=128m
will allow the client to use up to 1024 MB memory. Note that this also requires to increase Java's permanent
generation (PermGen) memory as shown above.
stayAlive
Set this flag to true to make the launcher stay alive. The launcher will then no longer terminate itself but will wait for
the client to terminate before it terminates itself. It will catch all console output from the client and dump it to the
standard console output (system out). Use this if you need to monitor the console of the AMOS client. This
parameter is deactivated per default.
mainClass
This parameter defines the main class that is started by the launcher. The default is amos.client.Client. Note that the
class that you define here needs to have a main method.
updaterClass
Using this parameter an updater class can be specified that is executed before the main class is launched in a
separate VM. The updater is launched in the same VM as the launcher. Per default the launcher tries to start the
class amos.client.Updater. If the class is not found this is ignored. Note that the class that is specified needs to
implement the Runnable interface.
cleanup.cfg
The last time a cleanup of the Client was executed is recorded in this file. From time to time a cleanup job is run to
delete deprecated classes and icons. This file is created automatically after that job has finished.
This file contain the version number of the client and the time when the cleanup job has been executed for the last
time.
directDraw.cfg
In this file, the settings that you will find in the client configuration regarding Graphics Accelleration are saved. These
are internal Java settings and are forwarded directly to the Java runtime system. The values true or false are
allowed for all settings.
FontCache
OnScreen
Enables or disables direct draw onscreen rendering. If disabled, no direct draw will be used. This can help with faulty
graphics card drivers.
OffScreen
Enables or disables direct draw offscreen rendering. If disabled, no direct draw will be used. This can help with faulty
graphics card drivers.
SWISS-AS.COM
51/52
FastDialogs
This disables some native MS Windows options and resolves issues with file dialogs on certain computers.
Version
This field is only for internal use, should all settings from the server for all the clients be overwritten. The server can
check the version number to ensure if this has already been done for a particular client. This is only required if you
want to reset the default behavior for all clients.
edoc.cfg
In this file, all settings that are of interest to the integration for the eDoc are stored here. This file is automatically
generated when an eDoc link is created or opened for the first time. The file automatically searches for the eDoc
client and if found, the path is stored in this file.
ClientPath
EDocUser
The user name and password that is used for authentication in to the eDoc client is stored in this parameter. If this
value is not set the current AMOS login sign will be used. With these settings you can, for example login as another
user and also use another user's eDoc settings. User name and password can be both specified separated by a
pipe (|), e.g.
EDocUser = username|password
registered.cfg
This file is actually not a configuration file but a MS Windows registry script.This script is used to register the AMOS
client as a DDE server and as a DDE handler for the protocol amos :/ /. This can be done in the client's configuration
menu.
sim_colors.cfg
Color, buttons, images and all other settings which are used in the Simulator Terminal application are defined here.
By changing these value, the GUI of the application can be completely changed. When you use the Simulator
Terminal application for the first time the default value is stored in this file. The settings are to exhaustive to list them
all here.
simulator.cfg
All settings for the Simulator Terminal application are stored here. All options can be set in AMOS client in the
Terminal Configuration application. The individual settings are not described in detail here
AMOS Server Configuration
Java Memory Configuration
Adjusting Java memory of the AMOS Server and the amos_config_server command line tool
Use the Configuration option in the amos_config_server command line tool to increase the memory of the
application server and the amos_config_server command line tool respectively. Note that you need to restart the
application and the command line tool in order to make the new memory values effective.
System Monitoring
SWISS-AS.COM
52/52
The monitoring & troubleshooting of the AMOS environment should include the following tasks:
disk space of the application server and database server partitions, usually /applic, /data, /log, /backup and
/webdrive. In MS Windows, the corresponding partitions might be located on different drives.
memory consumption of java processes and the dataserver processes. In MS Windows, this is the AMOS
service and sqlsrver.exe.
CPU usage of Java processes and the dataserver processes. In MS Windows, this is the AMOS service and
sqlsrver.exe.
creation of incremental and full backup files. Usually, these files are stored in /backup or on a backup drive in
MS Windows.
prepare tools to create Java heap and thread dumps in order to identify performance problems
Document Information Administration Guide
Swiss AviationSoftware Ltd.
BSLSAS/CS
P.O.Box, CH-4002 Basel, Switzerland
Tel.: +41 61 582 72 94
Fax: +41 61 582 70 17
SWISS-AS.COM