Troubleshoot server ODF

The guide is intended for IT Operations Support Engineers who own the Work.AI platform environment. Those engineers are expected to have access permissions to configure servers for the Open Development Framework (ODF).

Copy WorkFusion dependency JARs

This step is optional. You can always use WorkFusion public Nexus unless your company's policies prohibit doing so and you have trouble accessing it.

By default, WorkFusion archetypes generate Maven projects pointing to WorkFusion public Nexus. So, if you need to switch to your company's Nexus, follow the instructions below:

tip

Our recommendation is to work with Nexus Repository Manager OSS 2.14.12-01. The latest Nexus versions use an internal database to store files instead of a file system. Thus, it is not possible to manually add dependencies using a simple copy.

1. Download the archived WorkFusion dependencies.

2. Create a wf-dependencies repository on your on-premises Nexus server. The repository is similar to the public one provided for ODF enablement.

   

   As a result, you get a repository in the following path: /opt/nexus/2.0/sonatype-work/nexus/storage/wf-dependencies.

3. Upload wf-dependencies.odf-X.X.X.X.zip onto the server and unzip the archive into /opt/nexus/2.0/sonatype-work/nexus/storage/wf-dependencies. To add dependencies manually, enable SSH access to the database server and root permissions.

   1. Upload to the Nexus server:

   scp -i id_rsa wf-dependencies-X.X.X.X.zip username@dbserver.company.com:/home/username

   id_rsa is your public security key for SSH access. Request your company IT for SSH access and proper commands.

   The zip file resides in /home/username/ on the server.

   2. Enable SSH connection to the Nexus server:

   ssh -i id_rsa username@dbserver.company.com
   3. Unzip the directory:

   unzip -r /home/username/dependencies-X.X.X.X.zip /opt/nexus/2.0/sonatype-work/nexus/storage/wf-dependencies

   The default server directory where Nexus stores JARs for repositories is /opt/nexus/2.0/sonatype-work/nexus/storage. You may need to confirm that with your company IT.

   4. Copy to the repository directory:

   cp -a /home/username/wf-dependencies/. /opt/nexus/2.0/sonatype-work/nexus/storage/wf-dependencies
   5. Change all dependency permissions.

   For Nexus to have full control over JARs copied manually, change the group and owner to nexus for all copied files.

   cd /opt/nexus/2.0/sonatype-work/nexus/storage/wf-dependencies
   sudo chgrp -R nexus *
   sudo chown -R nexus *

4. Browse the wf-dependencies repository via Nexus UI to make sure it shows directories with JARs.

   

5. In Nexus UI, right-click the wf-dependencies repository. Click Update Index to let Nexus know about the file system changes. To do that, you need to have Administrator privileges configured for Nexus.

   

6. After generating a project from a WorkFusion archetype, change Nexus URLs in root pom.xml.

Configure Control Tower sync repository

In a standard installation of the Work.AI platform environment, Nexus is included with a pre-configured wf-machine-config-bundle repository. The repository is used to deploy Bot Config Bundle (BCB) JARs from Eclipse IDE to Control Tower.

The Control Tower configured to work with Nexus fetches a BCB JAR in this repository. After the fetch, Control Tower parses each BCB. All Java classes in this BCB are added to each BCB's Bot Task classpath. Thus, if you add a BCB-originated Bot Task to your Business Process, all custom Java classes used in the Bot Task work correctly.

For proper work, make sure that for the wf-machine-config-bundle repository:

• The Repository Policy is Releases.
• The Deployment Policy is Allow Redeploy.

Configure Archetypes repository

Create a Maven repository, setting the Repository ID to Archetypes. The repository is going to be used as an archetype catalog for your developers.

Make sure the Archetypes repository is accessible without authentication—by an anonymous user. To enable such access, configure Administrator privileges on Nexus and related security settings:

1. Create a new privilege for the Archetypes repository.

   

2. Create a new role and add the view permission for the Archetypes repository.

   

3. Add the role from step 2 to the Anonymous User.

   

   

Copy ODF artifacts to Nexus for further deployment

Put ODF BCB into Nexus repository

Use Asset Bundle import to put ODF BCB into your Nexus repository.

Put ODF archetypes into Nexus repository

1. To deploy archetypes, log in to the Archetypes repository as odf-user/Workfusion!5 and download a proper version from the WorkFusion public Nexus repository.

2. Select the Archetypes repository Artifact Upload, and set the following GAV:

   • Group: com.workfusion.odf
   • Artifact: bcb-bundle-quickstart, rpa-bundle-quickstart, full-bundle-classification-quickstart, full-bundle-ie-quickstart, full-bundle-quickstart, minimal-bundle-quickstart
   • Version: X.X.X.X (specify a proper version according to the release compatibility matrix)

   

Configure Nexus user

To configure Nexus users and permissions, enable Administrator privileges:

1. Go to Security > Users.

2. Сreate Privilege, then Role, and User.

   

To deploy BCBs from Eclipse directly, follow the instructions below:

1. Make sure you have a user created in Nexus with the deploy and view permissions for the wf-machine-config-bundle repository.

2. Provide the Nexus user credentials in your settings.xml.

   <!-- Credentials to deploy BCB to Nexus > CT -->
   <server>
       <id>bcb-repository</id>
       <username>deploy</username>
       <password>NEXUS_DEPLOY_PASSWORD</password>
    </server>

Deploy ODF artifacts

If you used ODF in a target Control Tower before, make sure to back up the _odf_transactions Data Store. For that, download the CSV file with data to a local workstation. If you skip the step, you may lose transaction data because Asset Bundle Migration API re-creates _odf_transactions in the ODF bundle zip file.

Use the Asset Bundle import feature to deploy ODF as described below:

1. Download the ODF bundle zip file from the Compatibility matrix page.
2. Deploy the bundle as described in the Import Asset Bundle via Control Tower UI guide.

Check file storage

Make sure that the server Control Tower has the write access to the doc-upload S3 file storage bucket.