                    =========================================
                    |  How to install AristaFlow BPM Suite  |
                    =========================================

1. Use the installer to install the desired products on your Windows system.
1a. If you want to run AristaFlow on a Linux system, simply unzip the
    corresponding products.
2a. Add the Jar-file containing your AristaFlow licence to the 'lib'-directory
    of the server or
    copy 'conf/ADEPT2.properties.dist' to 'conf/ADEPT2.properties' and add the
    configuration entry with the licence information to the new configuration
    file.
2b. Add Jar-file containing your AristaFlow licence to the 'dropins'-directory
    of the TestClient, if previously installed or
    create an empty file 'conf/ADEPT2.properties' and add the configuration
    entry with the licence information to the new configuration file.

                    ========================================
                    |  How to set up an AristaFlow server  |
                    ========================================

1. Unzip the file 'aristaflow-server.zip'
1a. Add the Jar-file containing your AristaFlow licence to the 'lib'-directory
    of the server or
    copy 'conf/ADEPT2.properties.dist' to 'conf/ADEPT2.properties' and add the
    configuration entry with the licence information to the new configuration
    file.
2. If you need a special network configuration copy the file
   'conf/ADEPT2.properties.dist' to 'conf/ADEPT2.properties' if not done yet.
2a. Optionally change the 'Port' [netty.Port], the server should use
    (default value is 47999).
2b. Optionally change 'Host' [netty.Host] to the network interface (host name or
    IP address) if the server uses 127.0.0.1 (printed on console) when started
    and the server should be accessed from remote clients.
2c. If this network interface is reachable via a different host name or IP
    addresses, set [netty.ExternalHost] to the one that should be used.
3. By default the server does neither know any process template.
3a. Some example templates are  delivered with the server that could be added to
    the server via the 'Process Template Editor'. The could be found in the
    'examples'-folder of the server.


                    =========================================
                    |  How to set up the AristaFlow clients |
                    =========================================

1. Unzip the file 'aristaflow-ui-bundle-<os-platform>.7z'. This contains the
   following products:
1a. 'aristaflow-activityrepositoryeditor': The editor for creating activity
    templates.
1b. aristaflow-client': The client for instantiating and executing the process
    templates that were previously created. This client is the 'normal' workflow
    client that shows the items for one user in a worklist.
1c. 'aristaflow-monitor': The monitor for monitoring process instances/process
    execution.
1d. 'aristaflow-orgmodeleditor': The editor for changing the organisational
    model that should be used for the processes.
1e. 'aristaflow-processtemplateeditor': The editor for creating and changing
    process templates.
1f. 'aristaflow-testclient': A client containing a complete server with a small
    organisational model allowing to test execute the processes.
2. Unzip the file 'aristaflow-automaticclient.zip' if you need a client, that
   operates activities that need no user interaction.
3. If your server does not run on 127.0.0.1 copy the file
   'conf/ADEPT2.properties.dist' to 'conf/ADEPT2.properties'.
3a. Adapt the URI of the global registry to the actual server settings
    ([serverIP] and [serverPort]):
    GlobalRegistry.ServiceURI=${arflow:confVar.MainCommunicationService}://[serverIP]:[serverPort]/GlobalRegistry/GlobalRegistry
    (The default values are [serverIP]=127.0.0.1, [serverPort]=47999).
4. If you have a multiuser environment like a terminal server, you will have to
   use different workspaces for every user explicitly. This can be done by
   providing a (user-specific) workspace directory with the
   "-data <workspace-directory>" parameter in the ini-file of the client
   product.
5. Start the client product. Note, that the initial login is "supervisor" and
   "password", per default.


                    =========================================
                    |     How to set up error handling      |
                    =========================================

1. Start the ProcessTemplateEditor.
2. Copy/import the error handling samples to a new or existing project. The
   samples were shipped with the server and reside in the folder
   '<server-install-dir>/examples/templates/errorhandling'.
3. The 'DefaultErrorHandling' and 'DefaultResetErrorHandling' samples could be
   used directly, but they could also be customised to your own needs. The
   'DefaultResetErrorHandling' sample, e.g. asks the supervisor, whether to
   reset a failed activity or to abort the whole process instance.
4. Deploy the error handling process to the process manager.
5. Adapt the template status, set the starter rule to 'Agent(username='system')'.
6. Start the Monitor.
7. Use 'Server Configuration/Configure error handling process...' to select the
   desired error handling process and confirm that with 'OK'. The error handling
   is now set and an instance of it will be started for every failed activity.


                    =========================================
                    |      AristaFlow support process       |
                    =========================================

If any problems occur while using the AristaFlow BPM Suite, please feel free to
contact the AristaFlow Support via the corresponding process:

                       https://support.aristaflow.com
