Boomi Essentials - Activities - V2.0 PDF
Boomi Essentials - Activities - V2.0 PDF
Boomi Essentials - Activities - V2.0 PDF
Version 2.0
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 © 2017 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.
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 in an online form. The information is
then sent to a FTP server in XML format. You will build an Excel spreadsheet containing latest
account data and archive it for reporting.
The root folder has sub-folders storing your training exercises for all the classes you take with
Dell Boomi as well as a #Connections folder to store all your connections.
In the Component Explorer, click the blue drop-down arrow next to your main account folder.
Choose New Folder.
Once again, in the Component Explorer, click the blue drop-down arrow next to your main account
folder.
Choose New Folder.
Process Library
Below the Component Explorer,click the Browse Process Library link at the bottom of the
window.
The Process Library window appears. In the upper right corner of the window, click the Search
bar.
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 by clicking on the green Install button.
The installation screen appears. Here 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.
Click the Process Name for Local Version field, and make sure it says Account XML to CSV.
It is a best practice to use a naming convention to describe your process. In our class we
use Account XML to CSV.
Once entered, scroll to the bottom of the Process Library window and click the green Install
button in the lower right corner.
The process will install into your Component Explorer. The following confirmation screen will
display:
You can now click the View Process button to open the Account XML to CSV process on the
build tab.
You are now ready to configure your endpoint connectors.
Each shape has an optional Display Name field. Display names are used for certain
shapes (e.g., Decision and Set Properties), but they are not generally used for
Connector shapes.
The Connection is completed for you with the 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.
In the Start Shape connector configuration window next to Operation, click Create ( ) to open
a new component tab.
The FTP Operation window appears. At the top of the screen is a field where you can change
the Operation Name. Click in 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 that have a name beginning with Account (i.e. Account-1.xml, Account-2.xml, etc.).
Click OK.
The Account XML to CSV process window shows the Start shape with the connector type (FTP),
the configured connection (Boomi Training (FTP)), and the operation (Account XML Get).
Save the process once the Start shape is configured, and everything will automatically be loaded
into the component explorer.
It is a Boomi best practice to store all of your connections into 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.
Single click on the Boomi Training (FTP) connection and drag it to the #Connections folder.
Locate the Disk Connector shape on the Process Canvas and click it to open the Disk
Connector shape configuration window.
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.
In the Connection Action window next to the Operation field, click Create (+) to open a new
component tab.
The Connector now has the connection and operation settings loaded into the configuration.
Click OK.
As mentioned above, it is a Boomi best practice to store all of your connections into one folder, our
#Connections folder.
Expand the Boomi Essentials -> Connectors -> Disk -> Connectors folder.
Single click on the Boomi Training (FTP) connection and drag it to the #Connections folder.
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.
Select the In the Cloud radio button and choose 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 Test Atom Cloud.”
Click Close.
Select the In the Cloud radio button and choose Atom Cloud from the drop-down menu.
In the box for the Atom Name, type Atom Cloud.
Click OK.
A message confirms “Your new Atom has been set up in the Atom Cloud.”
Click Close.
Test Mode has limited amounts of data and/or files it can filter.
The limits are 100 documents from a given connector call and 10 MB of total data.
Checking the Accounts XML to CSV Process loads the process in the Process window
On the Build tab, click Test in the upper-right above the Process canvas.
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.
After the shape has successfully completed, the circular highlight turns green and a success
message displays in the lower-right of the Test Results window.
To verify the file is successfully loaded, click the Connection Data tab within the Test Results
section located beneath the tested process. You can also click the View the contents of this
document symbol in the far left of the Test Results window to see the physical document.
The file is in the work directory of the Test Atom Cloud, so you need to use the
Document Viewer to see the file contents. 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, such as
Notepad, and save it.
If 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.
If you are not in Edit Mode on the process canvas, click the Return to Edit Mode Arrow in the
upper-left.
From the Component Explorer, in the Boomi Essentials folder click the blue drop-down arrow and
select New Component.
The Create Component window expands above the Process Canvas. You need to choose the
component type, enter the name, and destination of the New Component. Note the file path for
the component is automatically populated in the destination field since you created your
component through the Boomi Essentials folder.
Click Create.
The Account XML tab is now selected.
Click either the blue Import button or the green Import a Profile button.
In this exercise, we will configure a Set Properties shape to change the file name using a mix of
static and dynamic parameters. Remember, static values apply the same value to each
document and dynamic values reference elements in a profile to use the data in said element.
Navigate to the Process canvas by clicking the Account XML to CSV tab.
The Choose Property window appears where you can choose the property to set.
Click the plus symbol next to the Disk Connector option 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, by clicking on the plus symbol under the Parameters
column.
Within the Parameter Value window, select Profile Element from the Type drop-down menu.
This option allows you to choose a profile to link to for our dynamic values.
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 the Grey OK.
Then click the Green OK.
It returns to the Set Properties Shape configuration window to both the Properties to Set column,
and the Parameters column 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, you do not need to add a new Property to Set.
You only need to add another parameter to the existing property, by clicking on the plus symbol
under the Parameters column.
In the Parameter Value window keep the default Type of Static and type .xml into the Static
value field. Click OK when complete.
The completed Set Properties Shape looks like the image shown below:
Click OK to return to the process canvas once the Set Properties Shape is correctly configured.
The Set Properties Shape is now complete, and it is time to insert it into your process to verify
the filename has changed.
First, detach your Start Shape from your Disk Connector shape.
Then, connect the Start Shape to your Set Properties Shape.
Finally, connect your Set Properties Shape to your Disk Connector Shape.
The result should look like the image below:
Run the process in test mode and view the results. You will be able to verify the file name has
changed by clicking on the Disk Connector Shape in test mode.
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.
In the Map Properties window, click the Create a new component ( ) symbol to open a new
map.
In the right mapping pane, click Choose to create the 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 is belongs to the address
field.
When prompted for the number of elements, enter 12, then click OK.
In addition to entering the number, use the up/down arrows next to the entry field to
increment a single digit.
Click OK.
The flat file data elements can now be populated.
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
Click Save.
Click on the StreetAddress1 element and drag it to the Address1 element 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
Website URL
StreetAddress1 Address1
StreetAddress2 Address2
City City
State State
PostalCode Zip
Country Country
Phone Phone
Industry Industry
In the Account CSV Records next to the Status field name, click the blue drop-down arrow and
select Set Default Value.
Click OK.
The Status field name changes to Status (1) showing the default value entered.
Assume the outbound CSV document for this scenario requires the Status is auto-set to
1 for reporting purposes.
The Default Value displayed in the outbound data when the destination element is null,
blank, or unmapped.
Click Save.
In the Function (middle) window, click the plus sign to add a new function.
The Get Current Date function opens in the Functions window. The value Result holds the
current date retrieved from the function.
To map the result to the destination field in our Account CSV profile, create a new field to house
this data.
In the Account CSV destination pane, click the Account CSV title to edit the profile.
Click the blue drop-down arrow next to Elements, then select Add Element.
Drag and drop 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.
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 now produces two file names. One set by the Set Properties Shape, and
the other is the default .dat filename.
Name the environment Test with an Environment Classification of Test. Click Save to finish
creating the environment.
Repeat these steps again to make a second environment: the Production Environment.
Click the +New button and select Environment from the drop-down list.
Name the environment Production with an Environment Classification of Production. Click Save
to finish creating the environment.
Once complete, your environments should appear in your Manage tab like the image below.
There is no limit to the number of environments you can create. It is a best practice to
create a development environment for development, and test and production
environments for live executions. Usually, once a process is created and tested in
development, it is promoted to production.
Click in the Attachments field and select the Test Atom Cloud from the drop down.
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.
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.
To quickly find your process, type Account in the search bar so only processes with
the keywords appear. Do NOT check the box before the process, because you need
to attach an Environment to this process first, ONLY highlight the process.
In the Unattached Environments window, highlight Test, then click << (Attach selected
Environments).
This moves the Production environment from the Unattached pane to the Attached pane.
Click the Deployments tab and make sure the Production environment is highlighted.
In the bottom-right of the Deployments window, click Deploy Latest Revision of Process.
In the Deployment Confirmation pop-up, for the Deployment Notes enter Initial Deployment,
then click OK.
The new Version 1 record appears in the Process Deployment History table. Your Deployment
Note appears in the Notes column.
Deployment Notes makes tracking deployment changes easier as you release other
versions. Deploying a process does NOT put the process into an active production state.
After you deploy a process, you must execute it either manually (Manage > Process
Reporting) or through a schedule (Manage > Atom Management).
Upon Deployment, AtomSphere audits your account to make sure you have enough
connection licenses to deploy this process into production. If you do not have the
enough available licenses you will receive an error message.
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, simply click on the green Execute Process button in the
upper right side of the Process Reporting window.
A drop-down menu will appear to allow you to select the Process you want to execute and the
Atom to run it.
Select Test Atom for the Atom field, and Account XML to CSV for the process.
Click the green Execute button to run the process through an execution.
Once you execute your process, you can refresh the table to see the status of your
process. Once completed, it will give a final status of the process and tell you of any
errors it came across along the way.
In the Executions view, note the process execution instances and monitor the Process Reporting
until the execution record with inbound and outbound data displays.
You may need to click Refresh to see new process executions logged.
Turn on Auto Refresh to automatically refresh the execution records every minute.
Click the Actions button and then select View Deployment Components.
Once you viewed the component instance, close its tab or window to return to the View
Deployed Components window.
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.
Note the details in the Show Log pane, then click Cancel to return to the Process Reporting
window.
To detach an environment
Click on the Deploy tab, highlight the process then select the Attachments tab.
Select the Attached environment, then click on the Detach Selected Environment >> button.