Stash Connector - File to Stash project demo

This example application shows simplified use of the Stash Connector. It serves as a simple example about how to automatically create Projects from file input. It periodically polls a folder for new files and automatically creates projects from file input. The section immediately below describes the functions of each of the flows in the application.

This example assumes that you are familiar with Mule, the Anypoint Studio interface, Global Elements, DataSense, and the DataMapper transformer. Further, it is assumed that you are familiar with Stash and have a Stash account. Learn more about flows and subflows to gain more insight into the design of this example.

Author

Hotovo s.r.o.

Supported Mule runtime versions

Mule 3.6.x or higher

Stash supported versions

Stash 3.9.2 or higher

Service or application supported modules

Stash Rest API 3.9 or higher

Running on Studio

Once you have imported this example into Anypoint Studio you need to follow these steps to run it:

• Install Stash Connector into Anypoint Studio [Installing connector](#installingConnector)

• Locate the properties file common.properties, in src/main/resources

• Complete all the properties required as per the examples in the section Properties to be configured

• Update stash-project-input.csv from src/main/resources accordingly. Project key MULETEST should be replaced with some existig Project key in your Stash instance.

• Copy stash-project-input.csv from src/main/resources into your 'directory.source' folder

• Once that is done, right click on project folder

• Hover you mouse over "Run as"

• Click on "Mule Application"

Installation

This module can be used in several different ways depending on your needs and requirements. The following sections details how to use and install this module under different scenarios / environments. To make the module available to a Mavenized Mule application, first add the following repositories to your POM:

<repositories>
    <repository>
        <id>mulesoft-releases</id>
        <name>MuleSoft Repository</name>
        <url>http://repository-master.mulesoft.org/releases/</url>
        <layout>default</layout>
    </repository>
    <repository>
        <id>mulesoft-snapshots</id>
        <name>MuleSoft Snapshot Repository</name>
        <url>http://repository-master.mulesoft.org/snapshots/</url>
        <layout>default</layout>
    </repository>
</repositories>

Then add the module as a dependency to your project. This can be done by adding the following under the dependencies element your POM:

<dependency>
    <groupId>org.mule.modules</groupId>
    <artifactId>stash-connector</artifactId>
    <version>RELEASE</version>
</dependency>

or if you want to be on the bleeding edge

<dependency>
    <groupId>org.mule.modules</groupId>
    <artifactId>stash-connector</artifactId>
    <version>LATEST</version>
</dependency>

If you plan to use this module inside a Mule application, you need add it to the packaging process. That way the final ZIP file which will contain your flows and Java code will also contain this module and its dependencies. Add an special inclusion to the configuration of the Mule Maven plugin for this module as follows:

<plugin>
    <groupId>org.mule.tools</groupId>
    <artifactId>maven-mule-plugin</artifactId>
    <extensions>true</extensions>
    <configuration>
        <excludeMuleDependencies>false</excludeMuleDependencies>
        <inclusions>
            <inclusion>
                <groupId>org.mule.modules</groupId>
                <artifactId>stash-connector</artifactId>
            </inclusion>
        </inclusions>
    </configuration>
</plugin>

Properties to be configured (With examples)

In order make this example running you need to configure properties (Credentials, configurations, etc.) in common.properties file

stash.username=admin
stash.password=admin
stash.serverUrl=https://example.net/stash

directory.source=path-to-csv-file-source-folder
directory.target=path-to-csv-file-backup-folder

Customize It!

This section contains a brief description about how this example works. Flow configuration file is separated in three disctinct flows to make it more readable.

mainflow

Inbound File connector periodically polls a directory for a new csv file in following structure

Key,Name,Description
TEST,TEST Project,Long description
...

Datamapper then converts each row fetched from the csv file to a map element. Each map element servers as input map for inserting new project into configured Stash instance. Result of the operation is logged to console.

Complete flow:

<mule xmlns:data-mapper="http://www.mulesoft.org/schema/mule/ee/data-mapper" xmlns:file="http://www.mulesoft.org/schema/mule/file" xmlns:stash="http://www.mulesoft.org/schema/mule/stash" xmlns:context="http://www.springframework.org/schema/context" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans" version="EE-3.6.1"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-current.xsd
http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/stash http://www.mulesoft.org/schema/mule/stash/current/mule-stash.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-current.xsd
http://www.mulesoft.org/schema/mule/ee/data-mapper http://www.mulesoft.org/schema/mule/ee/data-mapper/current/mule-data-mapper.xsd">
    <stash:config-type name="Stash__Basic_Authentification" username="${stash.username}" password="${stash.password}" serverUrl="${stash.serverUrl}" doc:name="Stash: Basic Authentification"/>
    <context:property-placeholder location="common.properties"  />
    <data-mapper:config name="CSV_To_List_ProjectCreate_" transformationGraphPath="csv_to_list_projectcreate_.grf" doc:name="CSV_To_List_ProjectCreate_"/>

    <flow name="mainFlow" >
        <file:inbound-endpoint path="${directory.source}" moveToDirectory="${directory.target}" responseTimeout="10000" doc:name="File"/>
        <data-mapper:transform config-ref="CSV_To_List_ProjectCreate_" doc:name="CSV To List&lt;Project&gt;"/>
        <foreach doc:name="For Each">
            <stash:projects-project-create config-ref="Stash__Basic_Authentification" entityType="ProjectCreate" doc:name="Stash"/>
            <logger message="#[payload]" level="INFO" doc:name="log response"/>
        </foreach>
        <exception-strategy ref="default-exception-strategy" doc:name="Reference Exception Strategy"/>
    </flow>
    <catch-exception-strategy name="default-exception-strategy">
        <logger message="#[payload]" level="ERROR" doc:name="Log exception"/>
    </catch-exception-strategy>
</mule>

Reporting Issues

We use JIRA for tracking issues with this connector. You can report new issues at this location https://hotovo.jira.com