By default, the application runnables do not contain the files of the online help. You must add these files using the help enhancement. You specify the files by using the "artifact coordinates", that is the technical name and version of the file.
The basic structure of an enhance command for adding the help for most applications is
on <nodeName> enhance <instanceId> with help <helpArtifact> <version> type war where
<nodeName> is the logical name of the node, e.g. n1
<instanceId> is the instance ID of the runnable to which you want to add the help, e.g, "abs1"
<helpArtifact> is the technical name of the actual set of help files, e.g. com.aris.documentation.architect.
The technical name is different for the help of different runnables.
<version> is the version you are installing, e.g., “10.0.0”.
To find out the actual version of the runnables and help files on your DVD, check the
generated.apptypes.cfg file. It contains multiple "register app type" commands, which contain the versions of the runnables - the versions used here are also the versions of the help files. For example, if your DVD contains ARIS version 10.0.0.3, the generated.apptypes.cfg file looks like this:
For the business server runnable (ABS), some parts of the online help have been separated into dedicated files for different languages. The language can be specified with an additional option, the "classifier", in the enhance command. So for adding help to ABS, the structure of the enhance command is
on <nodeName> enhance <instanceId> with help <helpArtifact> <version>
classifier <lang> type war
The variables <nodeName>, <instanceId>, <helpArtifact>, and <version> have the same meaning as above.
<lang> is the language of the help artifact. Currently, there are ABS help files for five different languages:
en (English), de (German), fr (French), es (Spanish), ja (Japanese).
You can add all languages using several enhance commands, or you can pick only those languages that you need, depending on your user base. Adding the English language version (en) is mandatory.
The names and classifiers of the help artifacts of the different runnables are the following:
Runnable Help artifacts (since version) Languages
ABS
com.aris.documentation.architect de, en, fr, es, ja pt (since 9.8.2) ru, zh, nl (since 9.8.6) com.aris.documentation.architect-scripthelp (since 9.8.2) -
com.aris.documentation.architect-methodhelp (since 9.8.2) -13, de, en, fr, es, ja pt, ru, zh, nl (since 9.8.6) ADSAdmin com.aris.documentation.administration.ads -
UMCAdmin
Again assuming that you are following our example exactly, and assuming that you are using repository of version 10.0.0, the commands to add all available help files to your application runnables are the
following:
Help enhancements for the ABS runnables
on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier de type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier en type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier fr type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier es type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier ja type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier pt type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier ru type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier zh type war on n1 enhance abs1 with help com.aris.documentation.architect 10.0.0 classifier nl type war on n1 enhance abs1 with help com.aris.documentation.architect-scripthelp 10.0.0 type war on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier de type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier en type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier es type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier fr type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier ja type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier pt type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier ru type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier zh type war
on n1 enhance abs1 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier nl type war
13The methodhelp consists of a common part (an artifact without language classifier) and parts for the different languages. The common part should always be enhanced, while the language specific parts can be chosen depending on the languages required by
109
on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier de type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier en type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier fr type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier es type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier ja type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier pt type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier ru type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier zh type war on n2 enhance abs2 with help com.aris.documentation.architect 10.0.0 classifier nl type war on n2 enhance abs2 with help com.aris.documentation.architect-scripthelp 10.0.0 type war on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier de type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier en type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier es type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier fr type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier ja type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier pt type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier ru type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier zh type war
on n2 enhance abs2 with help com.aris.documentation.architect-methodhelp 10.0.0 classifier nl type war
Help enhancements for the UMCAdmin runnables
on n1 enhance umc1 with help com.aris.documentation.administration.administration 10.0.0 type war on n1 enhance umc1 with help com.aris.documentation.administration.tm 10.0.0 type war
on n3 enhance umc2 with help com.aris.documentation.administration.administration 10.0.0 type war on n3 enhance umc2 with help com.aris.documentation.administration.tm 10.0.0 type war
Help enhancements for the Copernicus runnables
on n1 enhance cop1 with help com.aris.documentation.connect 10.0.0 type war on n2 enhance cop2 with help com.aris.documentation.connect 10.0.0 type war
Help enhancements for the ADSAdmin runnables
on n1 enhance ads1 with help com.aris.documentation.administration.ads 10.0.0 type war on n3 enhance ads2 with help com.aris.documentation.administration.ads 10.0.0 type war
Help enhancements for the APG runnables
on n2 enhance apg1 with help com.aris.documentation.processboardhelp 10.0.0 type war on n3 enhance apg2 with help com.aris.documentation.processboardhelp 10.0.0 type war
9 Highly available client access to a distributed installation
9.1 The roles of the ARIS load balancer (ARIS LB)
In our chapter about the distribution of micro-service applications, we already briefly explained the role of the load balancer both as a single point of access for all kinds of clients and its role in the preferred routing mechanism that we use to improve performance. However, we did not explain the rationale behind routing all clients’ requests through the load balancer. In particular, in a single-node installation without redundant applications, it might seem that because there is no load distribution to be done among different instances of the same application type, we could do entirely without a load balancer. However, there is an important restriction that makes it necessary to use a load balancer also in this case.