Skip to main content
Version: 10.3.1

Configure local environment

Install Java​

  1. Download an appropriate Java Dev Kit (JDK). Make sure you install JDK, not JRE.

  2. Follow the steps in the installation wizard. Do not customize any settings. Use the default ones.

  3. Create the JAVA_HOME system variable containing the full path to the directory with the installed Java.

  4. In the command line, run java -version to verify the installation.

Install Maven​

AutoML SDK provides project blueprints as Maven Archetypes for model customization.

To install Maven, follow the steps:

  1. Download Maven v3.9+ from the official Maven website.

  2. Extract the archive to C:\Program Files\apache-maven-3.9.x.

  3. Create the MAVEN_HOME system variable containing the full path to the directory with the unzipped Maven. For details, see Create and Modify Environment Variables on Windows.

  4. Add %MAVEN_HOME%\bin to the PATH system variable.

  5. In the new command line, run mvn -version to verify the installation.

Get access to Nexus repository​

Find out about the Nexus access restrictions applicable to your team. Unless it is prohibited or restricted within a corporate network, use WorkFusion's public Nexus repository for all Maven project artifacts: Archetypes, WorkFusion-specific Java dependencies, ML dependencies, third-party Java dependencies. Start by exploring https://repository.workfusion.com.

note

During the build, to access all repositories, except for archetypes and idea-plugins, log in using odf-user. Find the password in settings.xml.

Configure local Maven​

To configure your local Maven, follow the steps below:

  1. In the <%user.home%>/.m2/ directory, find the settings.xml file. If the directory is empty, create settings.xml.

  2. Modify the settings.xml file as shown below:

    <settings>

      <servers>
        <!-- Nexus credentials for Maven to download the WF dependencies to build a project. Read only permissions are needed for this user -->
        <server>
          <id>wf-ml</id>
          <username>odf-user</username>
          <password>Workfusion!5</password>
        </server>
        <!-- Credentials for Asset Bundle API for importing to your remote Control Tower server -->
        <server>
          <id>remote-control-tower</id>
          <username>[TYPE HERE USERNAME]</username>
          <password>[TYPE HERE PASSWORD]</password>
        </server>
      </servers>
      
      <profiles>
        <profile>
          <id>wf-repo</id>
          <repositories>
            <repository>
              <id>wf-archetypes</id>
              <url>https://repository.workfusion.com/content/repositories/archetypes</url>
            </repository>
            <repository>
              <id>wf-ml</id>
              <url>https://repository.workfusion.com/content/repositories/ml-sdk</url>
            </repository>   
          </repositories>
        </profile>
      </profiles>
      
      <activeProfiles>
        <activeProfile>wf-repo</activeProfile>
      </activeProfiles>
      
    </settings>

  3. Replace the [TYPE HERE USERNAME] and [TYPE HERE PASSWORD] placeholders (lines 13 and 14) with your server Control Tower user credentials. Make sure this user has permissions to import an Asset Bundle. Note that the Control Tower URL is configured in the root pom.xml file of the Maven project you will generate later.

  4. If you have access to the WorkFusion Nexus, add it to your Maven's local configuration as described below. If you work with your company's on-prem Nexus repository, change the https://repository.workfusion.com URL (lines 24 and 28) to the actual on-prem one.

Add mirror repository​

For cases with no Internet connection, when you are seting up the environment, add the following code to the settings.xml file:

<mirrors>
    <mirror>
        <id>central</id>
        <name>central</name>
        <url><%nexus_instance_host%>/nexus/content/repositories/ml-sdk/</url>
        <mirrorOf>*</mirrorOf>
    </mirror>
</mirrors>

Set up Maven-to-Nexus SSL​

To use a secure connection when setting up the environment, follow these steps:

  1. In the <%user.home%> directory, create a .mavenrc file.

  2. Add the following code snippet:

    MAVEN_OPTS="-Dmaven.wagon.http.ssl.insecure=true -Dmaven.wagon.http.ssl.allowall=true -Dmaven.wagon.http.ssl.ignore.validity.dates=true"

Use IDE of your choice​

As a prerequisite to work with an AutoML model, you should have an IDE installed. You can use either of the following IDEs: