How to Install

Step-by-step Installation Guide

The procedure assumes that you have already installed ARCHIBUS Web Central and an active project is declared inside the WEB-INF/config/afm-projects.xml file.

Copy the files

Extract the files from the provided GWE Kit in a separate folder and copy them to your ARCHIBUS folder. Do not replace any files of your ARCHIBUS OOB installation yet. We will deal with those later.

Add the GWE Beans

There are two configuration files which must be updated. The first modification will add the GWE Beans to the Spring Context and the second one will enable GWE to process incoming REST API calls.

First, open the applications.xml file found here:

          • applications.xml

In this file add the following import just before the closing </beans> tag at the end of the file and save:

applications.xml
<!-- GWE beans -->
<import resource="classpath*:com/archibus/gwe/appContext-services.xml"/>

Now open the rest-servlet.xml file found here:

    • rest-servlet.xml

Add the following bean declaration just before the closing </beans> tag at the end of the file and save:

rest-servlet.xml
<!-- GWE -->
<bean class="com.archibus.gwe.rest.GWERestConfig" />

Add the License File

If you received a ai-license-add-in-WorkflowEngine.bin file, copy and paste it into the config directory.
It should look like this:

      • ai-license-add-in-WorkflowEngine.bin
ℹ️

You can also try GWE for a limited time without a physical license file. We offer a trial cloud based license. To obtain a trial license contact us.

Start the application server and if everything was done correctly you should be able to see the current GWE version inside WEB-IN/config/archibus.log by searching for ‘GWE version’.

Create the GWE Schema

To create GWE tables and fields, log into ARCHIBUS with a system admin user such as AFM and follow the steps below:

  • Go to System Administration / ARCHIBUS System Administration / Add-In Manager / Run Database Update Wizard.
  • Select the Run Script option then click Next.
  • Select the Server File option.
  • In the path field write:
schema/ab-products/workflowengine/sql
  • Press the Refresh button and select gwe-schema-and-sample.duw from the dropdown.
  • Press the Select File button.
  • Press the Run Script button.
  • Wait for the scripts to run.

Create the Rule Chains Schema

GWE comes bundled with a module that facilitates integrations with both internal apps and 3rd party services. This module is called Rule Chains. To install it, follow the instructions below:

  • Go to System Administration / ARCHIBUS System Administration / Add-In Manager / Run Database Update Wizard.
  • Select the Run Script option then click Next.
  • Select the Server File option.
  • In the path field write:
schema/ab-products/ws-routes/sql
  • Press the Refresh button and select ws-routes-schema.duw from the dropdown.
  • Press the Select File button.
  • Press the Run Script button.
  • Wait for the scripts to run.

Add the Rule Chain Samples (Optional)

The Rule Chains come with a few samples that can help you better understand the capabilities of the module. To import them, do the following:

  • Go to System Administration / ARCHIBUS System Administration / Add-In Manager / Run Database Update Wizard.
  • Select the Run Script option then click Next.
  • Select the Server File option.
  • In the path field write:
schema/ab-products/ws-routes/sql/sample-data
  • Press the Refresh button and select ws-routes-sample.duw from the dropdown.
  • Press the Select File button.
  • Press the Run Script button.
  • Wait for the scripts to run.

Workplace Integration (Optional)

Since v2024.04.4.0 we offer the possibility to create and manage workflow requests directly from Workplace. To enable it, there are a few steps that need to be followed:


Workplace Integration Setup

Apply the License Token (Optional)

If you received a physical license file ignore this step.

To use the trial license you must update the LicenseTokenId application parameter with your token and reload all parameters.
In order to do that you must go to System / System / Archibus Administrator - Application Configuration / Configure Application Parameters.
Filter the Applications grid by AbSystemAdministration then filter the Application Parameters grid by LicenseTokenId and click on the only result left.
In the Edit Application Parameters panel replace the default LicenseIdToBeAdded value with your cloud license token.
Click Save then click Reload All Parameters.

⚠️

GWE evaluates the cloud license with priority: if a cloud license exists, the physical license file is ignored. If you received a license file after the trial, you must reset this parameter to the default value of LicenseIdToBeAdded in order for the physical license to take effect.

Restart the Server

After restarting the application server, login with the AFM user and you should be able to see the Smart Services application in the navigation sidebar.

Showcase

img