SFTP CREATE function with Boomi & Gloomi
Many Integration use cases still rely on the creation and sharing of files. SFTP is a common, reliable and secure mechanism for the transfer of files. As part of the UConn Boomi Service model for project teams, a service account is available on a dedicated sftp server (a.k.a. gloomi.grove.ad.uconn.edu) for each SubAccount. Each project team is responsible for ensuring proper security and privacy and use of data within their team as it pertains to file sharing and access via SFTP.
Boomi offers several Process Libraries and tutorials for learning how to use the SFTP connector. A great place to start is with Recipe: Start Connecting with SFTPs. The instructions below are intended to give a basic example, specific to the use of SFTP at UConn.
This article is intended for individuals who have a Boomi Associate Integration Developer Certification. If you do not know how to complete an action like “add a message shape”, please complete the recommended trainings
Instructions
Always look for v2 before using an earlier version of any connector. In this case we will use the sftp v2 connector. Each SubAccount comes delivered with a default sftp connector for use with gloomi.grove.ad.uconn.edu that is already populated with credentials.
Credentials are stored in LastPass for each subaccount sftp user.
The Authentication Type for connecting to gloomi is Username and Password, there is a data directory in the root, the host is gloomi.grove.ad.uccon..edu, the user name and password are specific to your subaccount and the proxy type is Atom. Nothing else needs to be set for pushing and pulling files to gloomi but other sftp connections might be different.
A simple process to put a file looks like this. Add a start shape with no data then connect a message shape. The content of the message shape will be contents of the file we are creating on gloomi.
An example message is shown below and it writs the boomi execution property account id into the message. You can put anything in this message shape that you need in the file
Add a Set Properties shape and click the green plus under the Properties to Set label and add a the File Name property of the SFTP V2 connector. Click OK.
Add the filename by clicking the green plus under the Property Values label and entering a static filename. Click OK.
Repeat steps 5 & 6 to add the Remote Directory location
Add an SFTP v2 connector to the Set Properties shape. Set the Connection to the connector created in step 2, e.g.SFTP V2 to Gloomi Connection for IAM. Set the action to CREATE. Adjust the Action if File Exists to meet you use case. In this example boomi will add a unique identifier to the filename if a file with the specified name already exists in that director.
The response profile is a File Element containing and Object with fileName and remoteDirectory elements.
When the sftp v2 connector is configured is looks like this
Add a Stop shape. Save the process.
Time to test!
How to Test
Click Test in the upper right corner of the process pallet.
Pick the Test Atom Cloud (TAC) available in your subaccount and click OK. An example shown here is the generic Test-Atom-Cloud for the mail UConn account.
The process will execute in test mode, and you will see each step get a green halo as it completes successfully. You will see a success message when it is done.
To verify the file was created you can stay in boomi and click on the Stop Shape, click on the Shape Source Data tab in Test Results and view the sftp response.
Using a third party sftp tool like FileZilla you can log in to gloomi and confirm the file created successfully.