Boomi Essentials-Activities-Feb2021
Boomi Essentials-Activities-Feb2021
Activity Guide
ersion 7.1
se Title
Copyrights and Trademarks
This guide contains proprietary information protected by copyright and/or other legal grounds. The software described in this guide is furnished
under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable
agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying and recording for any purpose other than the purchaser’s personal use without the written permission of Boomi, Inc. (“Dell Boomi”).
The information in this document is provided in connection with Dell Boomi products. No license, express or implied, by estoppel or otherwise,
to any intellectual property right is granted by this document or in connection with the sale of Dell Boomi products. EXCEPT AS SET FORTH IN THE
TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, DELL BOOMI (TOGETHER WITH DELL INC. AND ITS
DIRECT AND INDIRECT SUBSIDIARIES) ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY
RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL DELL BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR
INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF
INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF ANY OF THEM HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES. Dell Boomi makes no representations or warranties with respect to the accuracy or completeness of the contents of this
document and reserves the right to make changes to specifications and product descriptions at any time without notice. Dell Boomi does not
make any commitment to update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Boomi, Inc.
Attn: LEGAL Dept.
legalnotices@dell.com
Boomi, Inc., Legal Department, 1400 Liberty Ridge Drive, Chesterbrook, PA 19087
Trademarks
Copyright © 2020 Boomi, Inc. All rights reserved. Dell, the Dell logo, Dell Boomi, Boomi, AtomSphere, Atom, and AtomSphere Integration Cloud
are trademarks of Dell Inc. and/or its subsidiaries in the United States and/or other countries. Other trademarks and trade names may be used
in this document to refer to either the entities claiming the marks and names or their products.
Revision History
Publication Date Summary
Boomi Essentials
ii
Boomi Essentials
iii
Table of Contents
Copyrights and Trademarks ................................................................................................. ii
Boomi Essentials .................................................................................................................... 5
Folder Setup ........................................................................................................................... 6
Download Process from the Process Library .......................................................................... 8
Access the FTP Connection ..................................................................................................10
Create an FTP Operation ......................................................................................................12
Create the Disk Connection ...................................................................................................16
Create a Disk Operation ........................................................................................................18
Set up the Atom Cloud and Test Atom Cloud ........................................................................21
Test the Process ...................................................................................................................23
Create an XML Profile ...........................................................................................................27
Create a Set Properties Shape ..............................................................................................30
Create a Map and Source Profile...........................................................................................36
Create a Flat File Destination Profile .....................................................................................38
Map Fields .............................................................................................................................43
Add Get Current Date Map Function .....................................................................................45
Create a Branch Shape to Manage the Process Flow ...........................................................49
Create Environments and Attach Atoms ................................................................................51
Package and Deploy the Process ..........................................................................................56
Execute the Process..............................................................................................................61
Track Live Executions in Process Reporting ..........................................................................63
Undeploy the Process ...........................................................................................................66
Boomi Essentials
iv
Boomi Essentials
Boomi Essentials
You are a Boomi consultant with this assignment: Your customers sign up for an AtomSphere
trial account by entering account and contact information into an online form. The information is
sent to an FTP server in XML format. You will build an Excel spreadsheet containing the latest
account data and archive it for reporting.
Boomi Essentials
5
Folder Setup
Folder Setup
When developing a new integration project, in the Build tab, it is important to organize the
Component Explorer, by setting up folders to organize processes and components. This lets
you configure and store a unique process containing the workflow and processing rules for your
business scenario.
The root folder has sub-folders to store your training exercises for all the classes you take with
Boomi as well as a #Connections folder to store all your connections.
In the Component Explorer, click the arrow next to your main account folder.
Choose New Folder.
Boomi Essentials 6
Folder Setup
Boomi Essentials 7
Download Process from the Process Library
Process Library
Below the Component Explorer, click the Browse Process Library link at the bottom of the
window.
The Process Library dialog appears. In the upper right corner, click the Search bar and enter
Boomi Essentials in the filter.
The Process Library processes are filtered based on the search criteria. The Account
XML to CSV process for the Boomi Essentials class is now displayed.
Select the Account XML to CSV process from the list and click Install.
The installation screen appears where you can select the installation location and process name
for the local version.
Click the location field where it says Choose and select the Boomi Essentials folder created
earlier.
Boomi Essentials 8
Download Process from the Process Library
Click the Process Name for Local Version field, and make sure it says Account XML to CSV.
Once entered, scroll to the bottom of the Process Library dialog and click Install.
The process will install into your Component Explorer. The following confirmation screen will
display:
Click View Process to open the Account XML to CSV process on the Build tab.
You are ready to configure your endpoint connectors.
Boomi Essentials 9
Access the FTP Connection
Each shape has an optional Display Name field. Display names are used for certain
shapes (e.g., Decision and Set Properties), but are not generally used for Connector
shapes.
Boomi Essentials 10
Access the FTP Connection
The Connection is completed using Boomi Training (FTP). It includes all the information
needed to log into the FTP server previously set up for this class.
You can open the Boomi Training (FTP) connection component by clicking on the pencil symbol
on the right side of the Connection component field.
✓ Do NOT change any information in the Boomi Training (FTP) connection component
or you will not successfully connect to the Boomi FTP server.
Boomi Essentials 11
Create an FTP Operation
In the Start shape connector configuration dialog next to Operation, click the plus symbol to
create a new Operation.
The FTP Operation dialog appears. The top of the screen is a field where you can change the
Operation name. Click the title section and enter Account XML Get.
Pay special attention to the case and spelling of the Remote Directory and File Filter
names. Enter the names exactly as they look in the table above.
The wildcard (*) symbol filters files containing a certain character set. We are filtering all
files with names beginning with Account (i.e. Account-1.xml, Account-2.xml, etc.).
Boomi Essentials 12
Create an FTP Operation
Click OK.
Boomi Essentials 13
Create an FTP Operation
The Account XML to CSV process window shows the Start shape with the connector type of
FTP, the configured connection of Boomi Training (FTP), and the operation of Account XML Get.
Save the process once the Start shape is configured, and everything will automatically load into
the Component Explorer.
Boomi recommends you store all your connections in one folder. We have called our common
connections folder #Connections. Since our folders will be in alphabetical order, the # will force it to
the top.
Expand the Boomi Essentials > Connectors > FTP > Connections folder.
Boomi Essentials 14
Create an FTP Operation
Single click the Boomi Training (FTP) connection and drag it to the #Connections folder.
Boomi Essentials 15
Create the Disk Connection
Locate Disk Connector shape on the Process Canvas and click to open the Disk Connector
shape configuration dialog.
Boomi Essentials 16
Create the Disk Connection
For Directory, enter work as the location to save the output files.
✓ The files for our training exercises are written to a directory on the Test Atom Cloud.
The directory name is spelling and case-sensitive.
Boomi Essentials 17
Create a Disk Operation
In the Connector shape, next to the Operation field, click plus symbol to open a new component
tab.
Click Save. The Connector now has the connection and operation settings loaded into the
configuration.
Click OK.
Boomi Essentials 18
Create a Disk Operation
Expand the Boomi Essentials > Connectors > Disk > Connectors folder.
Single click the Work Directory connection and drag it to the #Connections folder.
Boomi Essentials 19
Create a Disk Operation
The Account XML to CSV Process window now shows the connector shape with the connector
type (Disk), the configured connection (Test Directory), and operation (Write Unique).
Click and drag the arrow from the Start shape to the connector.
The arrow turns green when the shapes are connected.
After pressing the Save button, your connectors are automatically loaded into the
Component Explorer.
Boomi Essentials 20
Set up the Atom Cloud and Test Atom Cloud
If you do not have the Welcome tab displayed, click the Welcome tab.
Under the Create column, click Atom.
The Atom Setup dialog displays. For Setup Preference, select the In the Cloud radio button and
for Choose a Cloud, select your Regional Test Atom Cloud from the drop-down menu.
In the box for the Atom Name, type Test Atom Cloud.
Click OK.
A message confirms “Your new Atom has been set up in the USA East Integration Test Cloud.”
Your cloud many be different based on the regional cloud being used.
Click Close.
Boomi Essentials 21
Set up the Atom Cloud and Test Atom Cloud
Once again, above the Process Canvas, click the Welcome tab.
Under the Create column, click Atom. The Atom Setup dialog displays.
For Setup Preference, select In the Cloud radio button and select your regional Cloud from the
drop-down menu.
In the box for the Atom Name, type Atom Cloud and click OK
A message confirms “Your new Atom has been set up in the USA East Integration Cloud.”
Your cloud many be different based on the regional cloud being used.
Click Close.
The Atom Cloud is now available for Production Environment.
Boomi Essentials 22
Test the Process
Remember, test mode limits are 100 documents and 10 MB of total data from a connector
call.
On the Build tab of your process Account XML to CSV, click the Test button.
✓ During the test, the shape being processed has a yellow circular highlight. This helps
to keep track of the process flow through the test execution run.
Boomi Essentials 23
Test the Process
After the shape has successfully completed, the circular highlight turns green and a success
message displays in the lower-right corner of the Test Results window.
To check if the file successfully loaded, click the Connection Data tab under Test Results.
The file is in the work directory of the Test Atom Cloud, so you must use the Document
Viewer to see its contents because you do not have access to the physical directory. To
save the contents of the file to your physical drive, download the file or copy and paste
the contents from the Document Viewer to a text editor, like Notepad, and save it.
Boomi Essentials 24
Test the Process
To copy your XML file, please make sure the Formatted view is off.
Boomi Essentials 25
Test the Process
When using a Local Atom, the files are written to the local directory defined in the Disk
Connector. View the results by opening the files from within the specified output
directory.
When finished, click Close Document Viewer, and in the upper-left corner of the Process
Canvas, click the Return to Edit Mode arrow symbol.
The reason we saved the document output is to use the format of the document to
structure something we call a Profile. You will create a Profile in the next activity and
will reference the account.xml file you just created.
Boomi Essentials 26
Create an XML Profile
From the Component Explorer, in the Boomi Essentials folder click the arrow and select New
Component.
The Create Component dialog displays above the Process Canvas. You must choose the
component type, enter the name, and destination of the New Component. Notice the file path for
the component is automatically populated in the destination field since you created your
component through the Boomi Essentials folder.
Boomi Essentials 27
Create an XML Profile
Click Create.
The Account XML tab is now selected.
Boomi Essentials 28
Create an XML Profile
The XML Import Wizard displays a message saying the profile is loaded.
Boomi Essentials 29
Create a Set Properties Shape
Navigate to the Process Canvas by clicking the Account XML to CSV tab.
From the shapes palette, click Execute and drag the Set Properties shape to the Process
Canvas.
Boomi Essentials 30
Create a Set Properties Shape
The Choose Property dialog appears where you can choose the property to set.
Select Document Property from the drop-down, click the plus symbol next to Disk and choose
File Name. Once complete, click OK.
Notice under the Properties to Set column it now says Disk-File Name.
It is now time to set the Parameters, click Disk-File Name and click the plus symbol under the
Parameters column.
Boomi Essentials 31
Create a Set Properties Shape
In the Parameter Value dialog, select Profile Element from the Type drop-down menu.
In the Profile Type drop-down menu, select XML.
This option filters out any non-XML profiles from the following Profile field.
Click the Magnifying Glass to search your Component Explorer for your desired profile. Click the
Account XML profile you created earlier.
Click in the Element field where it says Choose to select an Account XML profile element. Select
CompanyName and click OK.
Then click OK.
Boomi Essentials 32
Create a Set Properties Shape
It returns to the Set Properties shape configuration dialog to both the Properties to Set column,
and the Parameters column. It look like the image below:
The dynamic document property is now set, and the filename of each document passing
through this shape reflects the data flowing through the CompanyName field from your Account
XML profile. We will now add a static value of .xml to the end of the filename.
To add a static value to your existing filename, add a new parameter to your Disk property, by
clicking the plus symbol under the Parameters column.
Boomi Essentials 33
Create a Set Properties Shape
In the Parameter Value dialog keep the default Type of Static, type .xml into the Static value field
and click OK.
The completed Set Properties shape looks like the image shown below:
The Set Properties shape is now complete, it is time to insert it into your process and verify the
filename has changed.
Boomi Essentials 34
Create a Set Properties Shape
Run the process in Test Mode and view the results. You will be able to verify the file name has
changed by clicking the Disk Connector shape in Test Mode.
Then select a document in the Documents tab.
Select Connection Data in the Test Results tab.
Look for the file name under the File Name column.
The file name should match the file name displayed below.
It is important to understand the parameter order. The name is built from top to bottom in
the parameter list, so our name is CompanyName.xml since the file extension is last in
the list.
Boomi Essentials 35
Create a Map and Source Profile
In the Map Properties dialog, click the plus symbol to create a new map.
Boomi Essentials 36
Create a Map and Source Profile
Boomi Essentials 37
Create a Flat File Destination Profile
Boomi Essentials 38
Create a Flat File Destination Profile
A double quote text qualifier handles data belonging to a particular field containing a
comma but is not interpreted as a separate data element. For example, “123 Adams
Road, Suite 400” ignores the comma so the entire address belongs to the address field.
Boomi Essentials 39
Create a Flat File Destination Profile
Next to Elements, click the arrow and then select Add Multiple Elements.
When prompted for the number of elements, enter 12, and click OK.
Boomi Essentials 40
Create a Flat File Destination Profile
For the first element, in the Data Name field, type AccountID.
The name updates automatically in the Data Elements list on the left.
After entering AccountID as the first element, name the remaining 11 New Flat File Elements
using these field names:
AccountName
Industry
Address1
Address2
City
State
Zip
Country
Phone
URL
Status
Boomi Essentials 41
Create a Flat File Destination Profile
On the Map screen’s right mapping window, next to Elements, click the Expand ( ) symbol to
expand the element list to view the entered file elements.
Click Save.
Boomi Essentials 42
Map Fields
Map Fields
With both sides of our Map populated, we are ready to link the fields either by manually
dragging the source field to the matching destination field or by using Boomi Suggest. In this
exercise, we will use both methods to map our fields. Also, we will learn how to set a default
value for a field.
Click the StreetAddress1 field and drag it to the Address1 field to drop it. The selected
destination element highlights in green.
Continue dragging and dropping elements until mapped, or use Boomi Suggest. Using the table
below, verify all fields are mapped correctly.
✓ Boomi Suggest may not suggest the correct mapping of a field, so you must verify all
mappings completed with the tool to make sure the mapping is correct. You can always
manually map or un-map a field.
SOURCE DESTINATION
CompanyID AccountID
CompanyName AccountName
Industry Industry
StreetAddress1 Address1
StreetAddress2 Address2
City City
State State
PostalCode Zip
Country Country
Phone Phone
Website URL
Boomi Essentials 43
Map Fields
In the Account CSV Records next to the Status field name, click the arrow and select Set Default
Value.
Click OK.
The Status field name changes to Status (1) showing the default value entered.
The Default Value is displayed in the outbound data when the destination element is
null, blank, or unmapped.
Click Save.
Boomi Essentials 44
Add Get Current Date Map Function
In the Functions dialog, click the plus symbol to add a new function.
The Get Current Date function opens in the Functions dialog. The value Result holds the current
date retrieved from the function.
To map the result to the destination field in our Account CSV profile, we need to create a new
field to house this data.
Boomi Essentials 45
Add Get Current Date Map Function
In the Account CSV destination, click the Account CSV title to edit the profile.
Boomi Essentials 46
Add Get Current Date Map Function
Boomi Essentials 47
Add Get Current Date Map Function
Boomi Essentials 48
Create a Branch Shape to Manage the Process Flow
Drag a Branch shape from the shapes palette to the Process Canvas.
The greatest number of branches is 25, however, most are between 2 and 6.
Click OK.
Boomi Essentials 49
Create a Branch Shape to Manage the Process Flow
On the Process Canvas, connect the Start shape to the Branch shape.
Connect branch 1 to the Set Properties shape.
Connect branch 2 to the Map shape.
Connect both the Set Properties shape and Map shape to the Disk Connector.
Click Save.
The Component Explorer now has more components:
Notice each document produces two file names. One by the Set Properties shape, and the other
is the default .dat filename.
Boomi Essentials 50
Create Environments and Attach Atoms
Create Environments
Name the Environment Test and update Environment Classification to Test. Click Save to finish
creating the Environment.
Boomi Essentials 51
Create Environments and Attach Atoms
Click the +New button and select Environment from the drop-down list.
Name the Environment Production and keep the Environment Classification as Production.
Click Save to finish creating the Environment.
Boomi Essentials 52
Create Environments and Attach Atoms
Once complete, your Environments should appear in your Manage tab below:
Click in the Attachments field and select the Test Atom Cloud from the drop-down.
Boomi Essentials 53
Create Environments and Attach Atoms
The Test Atom Cloud is now attached to the Test environment as shown in the image below.
Click in the Attachments field and select the Atom Cloud from the drop-down.
Boomi Essentials 54
Create Environments and Attach Atoms
The Atom Cloud is now attached to the Production environment as shown in the image below.
You should now see the Atom Cloud under the Production Environment and the Test Atom
Cloud under the Test Environment.
Boomi Essentials 55
Package and Deploy the Process
Or from the Deploy > Create Packaged Components menu, select the Create Packaged
Component menu option.
Check the box next to the component(s) you want to add to the Packaged Components and click
the Next: Add Details button.
Boomi Essentials 56
Package and Deploy the Process
Enter the following and click the Create Packaged Component button.
Boomi Essentials 57
Package and Deploy the Process
A Packaged Components Successfully Created message will display. Click the Deploy button.
Choose your Deployment Environment and enter the Deployment Notes. Click the Next:
Select Versions button.
Boomi Essentials 58
Package and Deploy the Process
Confirm your destination environment and release version are accurate, then click the Deploy
button.
Boomi Essentials 59
Package and Deploy the Process
You will receive a Deployment Successful message. Click the View Deployments button.
When deploying, AtomSphere checks your account to make sure you have enough
connection licenses to deploy this process into production. If you do not have enough
available licenses you will receive an error message.
Boomi Essentials 60
Execute the Process
Navigate to the Manage tab, and select Process Reporting from the drop-down menu.
The Process Reporting page defaults to the Executions view. From here, you can see the
recent executions of all deployed processes on your account. You also can manually execute
your process.
To Execute your deployed process, click the Execute Process button in the upper right side of
the Process Reporting dialog.
An Execute Process page appears to allow you to select the process you want to execute and
the Atom to run it on.
Select Atom Cloud for the Atom field, and Account XML to CSV for the process.
✓ Once you execute your process, you can press the refresh button to see the
status of your process. Once completed, it will display the process’s final status and
tell you of any errors it encountered.
Turn on Auto Refresh to automatically refresh the execution records every minute.
Click the Actions button and then select View Deployment Components.
Once you view the component instance, close it to return to the View Deployed Components.
The component revision number from the Components in this Deployment Version table
corresponds to the component revision number in the Revision History. You can view the
specific component configuration the Atom is executing and reporting on the Manage tab.
Highlight the first execution record and then click the View Process Logs symbol.
Note the details in the Show Log, and click Cancel to return to the Process Reporting window.
For the the Account XML to CSV process in the Production environment, click the Actions Menu
and select Undeploy.
The Packaged Component still exists. You will get back any licenses used with this
deployment.