Workspace One Connectors

Overview

These are connectors that have been developed for Workspace One Mobile Flows. Although all of them can be used as-is, they can also be used as base from which VMware customers can develop their own connectors.

The connectors are written in Java and use the Spring Framework. More specifically, they use Spring Boot, embedding Tomcat 8.5.

For a detailed, language-neutral, specification for how to develop connectors, please see the Card Connectors Guide.

This repository also includes common libraries. Please see their README for more details.

Docker

The connectors can be run as Docker containers.

Prerequisites

Docker

Running

The latest published versions of the connectors are available in the Docker Hub registry.

For example, you can run the latest jira-connector with:

docker run --name jira-connector \
           -p 8080:8080 \
           -d \
           ws1connectors/jira-connector \
           --server.port=8080 \
           --security.oauth2.resource.jwt.key-uri="https://prod.hero.vmwservices.com/security/public-key"

Fat Jars

The connectors can also be built and run as executable "fat" jars.

Prerequisites

Java 11

Building

Clone this repository or download as zip. Unzip the repo if you downloaded a zip. Use the below command from within the repository directory to build the fat JARs:

./mvnw clean install

Running

After building the JAR(s), you can run them with java -jar. For example, here is a command to run the jira-connector:

java -server \
     -jar \
     connectors/jira/target/jira-connector-2.1-SNAPSHOT.jar \
     --server.port=8080 \
     --security.oauth2.resource.jwt.key-uri="https://prod.hero.vmwservices.com/security/public-key"

NodeJS Based Connectors

The nodejs based connectors can be build and deployed using Docker.

Prerequisites

Docker

Building

Clone this repository or download as zip. Unzip the repo if you downloaded a zip. Use the below command from within the repository directory to create the docker image:

docker build -t hub-jira-service-desk-connector .

Running

You can run your local container built from the docker build command above with:

docker run --name hub-jira-service-desk-connector \
           -p 8080:8080 \
           -e PORT=8080 \
           -e MF_JWT_PUB_KEY_URI="https://prod.hero.vmwservices.com/security/public-key" \
           -d \
           hub-jira-service-desk-connector

The latest published versions of the connectors are available in the Docker Hub registry.

For example, you can run the latest hub-jira-service-desk-connector with:

docker run --name hub-jira-service-desk-connector \
           -p 8080:8080 \
           -e PORT=8080 \
           -e MF_JWT_PUB_KEY_URI="https://prod.hero.vmwservices.com/security/public-key" \
           -d \
           ws1connectors/hub-jira-service-desk-connector

Troubleshooting

For more information on common mistakes, see TROUBLESHOOTING.md.

Contributing

The connectors-workspace-one project team welcomes contributions from the community. Before you start working with connectors-workspace-one, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.