Skip to main content
Version: 10.2.8

Install ODF 2 dependencies on-premises

Difference between ODF 2 and ODF in terms of installation​

ODF components are available on the Work.AI platform environment before the first deployment of the project that uses them. The deployment is completed automatically by the platform installer.

ODF 2 is different in this aspect. There is no need to pre-install it because ODF 2 core libraries are part of any ODF 2-based project deployment.

Installing ODF 2 dependencies to on-premises Nexus​

caution

ODF 2 is not shipped with the Work.AI platform installer out of the box. To run automation projects in isolated corporate environments without access to the WorkFusion public Nexus, make the preparations described in the guide.

You can always use the WorkFusion public Nexus unless your company's policies prohibit doing so or you cannot access it.

note

Nexus Repository Manager OSS 2.14.12-01 is recommended. The latest Nexus versions use an internal database instead of a file system to store files. Thus, you cannot add some dependencies manually using a simple copy.

By default, ODF 2 Archetypes generate Maven projects pointing to the WorkFusion public Nexus. If you need to switch to your company's Nexus, follow the instructions below:

  1. Download the archived WorkFusion dependencies.

  2. Verify that your company's Nexus has the dependencies/ repository. If you don't have the repository, create it with the following configuration:

    As a result, you get a repository with the following folder path on the database server (that hosts Nexus): /opt/nexus/2.0/sonatype-work/nexus/storage/wf-dependencies.

  3. Upload wf-dependencies.odf-X.X.X.X.zip (for the actual version of ODF 2, refer to the Compatibility matrix page) 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:

    Click to see helpful shell commands

    1. Upload to the Nexus server.

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

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

      Find the zip file in /home/username/ on the server.

    2. Enable an SSH connection to the Nexus server.

      ssh -i id_rsa username@dbserver.company.com
      Copy

    3. Unzip the directory.

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

      The default server directory where Nexus stores JARs for repositories is /opt/nexus/2.0/sonatype-work/nexus/storage. If needed, 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
      Copy

    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 *
      Copy
info

Perform the same manipulations with the dependencies archive on the on-premises Nexus to update the dependencies after a newer version of ODF 2 is released.

Configuring Maven and project settings​

The configuration includes the following two steps:

  1. To generate an ODF 2 project, configure a repository used to get Simple Archetype. In the case of on-premises and a single dependencies/ repository containing an Archetype (that is different from the public Nexus where Archetypes are placed in the separate archetypes/ repository), you have the same repository URL for both <id>wf-dependencies</id> and <id>wf-archetypes</id> repository settings in your Maven settings.

    After the configuration is done, run a generation process from the command line on your workstation. For more details, refer to Create project.

  2. Having generated the ODF 2 project from Simple Archetype, configure a remote profile in the root pom.xml file. Specify the Control Tower user credentials to be used. For that, modify the Maven settings in the USER_HOME/.m2/settings.xml file.

    For more details, refer to Deploy Asset Bundle | Configure access to Control Tower.

Build environment requirements​

Local builds and CI/CD pipelines require using Azul Zulu OpenJDK 8.x. For details, refer to the guide.