Setting up the Development Environment

To customize Flowable an environment to develop Java projects is required. Therefore, you need to install a Java JDK and an Integrated Development Environment (IDE) of your choice.

In case you are interested in also customizing the frontend checkout the Setting up the Frontend Development Environment.

Setup Maven to Download Flowable Dependencies

To download dependencies for Flowable Work/Engage you need to have access to the Flowable artifactory. Therefore, you can configure your Maven repository for example with the following ~/.m2/settings.xml. The USER and PASSWORD needs to be replaced with your credentials.

The password can be stored encrypted, therefore you can follow one of the following guides:

• Use a master password with maven for password encryption
• Use a JFrog API key: Therefore, go to Flowable Artifacts and select at the top right Welcome ..., then Edit Profile. Unlock the settings with your password and generate a new API key. This key can be used as a password in your settings.xml.

info

The Flowable artifactory is restricted and credentials are only provided to active customers. In case of issues accessing the Flowable artifactory, please reach out to the Flowable Support Team or to your Customer Success Manager.

<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
        <server>
            <id>flowable-repo</id>
            <username>USER</username> <!-- Replace USER -->
            <password>PASSWORD</password> <!-- Replace PASSWORD -->
        </server>
    </servers>

    <profiles>
        <profile>
            <id>flowable-artifacts</id>
            <repositories>
                <repository>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <id>flowable-repo</id>
                    <name>flowable-maven-all</name>
                    <url>https://artifacts.flowable.com/artifactory/flowable-maven-all</url>
                </repository>
            </repositories>
        </profile>
    </profiles>

    <activeProfiles>
        <activeProfile>flowable-artifacts</activeProfile>
    </activeProfiles>
</settings>

Deprecation of API Keys

To distribute the artifacts Flowable uses JFrog. JFrog deprecated the API Keys and therefore those need to be replaced with Identity Tokens or the password itself.

info

You can either use the password to login or an identity token. If identity tokens or the password is a better fit depends on where you are using the password. An identity token expires automatically after one year, and you can revoke the token.

For a central place when you proxy the artifactory it might be better to use the password, since it does not expire.