Boomi AtomSphere & API Management
Technical Workshop Exercises
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Introduction
Purpose:
This training is meant to serve as a set of introductory level exercises based around a real-world
integration scenario. It is structured to be instructor led in a live classroom environment and designed
for technical end users.
Integration Scenario:
Salesforce is queried for ‘Prospect’ Account records. Those records are then checked against
Customer records residing on an on-premise database. If the record already exists in the database, a
notification is configured and the record is routed out of the integration process. If the record does not
exist in the database, then the record is inserted in the database and a confirmation email is sent to a
business user.
Goals:
At the end of this training session, participants will be exposed to the following topics and features:
● AtomSphere UI ● Connector configuration
● AtomSphere terminology ● Decision logic
● Process building best practices ● Branching
● Component Explorer ● Data mapping
● Execution & Logic Pallet ● Boomi Suggest
● Process Canvas ● Test Mode
Resources:
Reference Guide:
● [Link]
Boomi Community:
● [Link]
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Contents
Lesson 1 – Log in and get oriented to AtomSphere 4
Lesson 2 – Create a new process and configure the Salesforce Start shape connector 6
Lesson 3 – Execute the process in test mode to test Salesforce connectivity 14
Lesson 4 – Configure the Database connector 17
Lesson 5 – Configure a Decision step to test for duplicate entries 24
Lesson 6 – The ‘True’ Path: Configure a Notify step 30
Lesson 7 – The ‘False’ Path: Configure a Branch step 35
Lesson 8 – Configure the data Map 37
Lesson 9 – Insert records into database 42
Lesson 10 – Configure a Message step 44
Lesson 11 – Configure a Mail connector 48
Lesson 12 – Execute the process in test mode to test database insert and email functionality 52
Lesson 13 (API) – Copy Subprocess 55
Lesson 14 (API) – Create Web Service Listener Process 60
Lesson 15 (API) – Create an API Component 69
Lesson 16 (API) – Deploy API 75
Lesson 17 (API) – Search API in API Catalog 78
Lesson 18 (API) – Test API 80
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Pervasive Connectivity
Lesson 1 – Log in and get oriented to AtomSphere
1. At the start of training, the instructor will add your email address and name to the User
Management console of the AtomSphere training account, assigning you as a Standard User.
Upon doing so, you’ll receive a registration email with your user name and temporary password.
2. Log in to Boomi AtomSphere using your credentials
a. Navigate to [Link]
b. Enter login credentials and click on the ‘Sign In’ button.
3. Take note of the ‘User-XX’ folders that reside within this folder. Each of these folders coincides
with the number assigned to you by the trainer. Once assigned, you may choose to rename the
folder to better identify you among the group (i.e. ‘User-01-Bob Smith’)
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
4. As you begin to build out your integration process, you’ll want to be sure you only create and
save components within your individual folder. Since we’re sharing one account, this will ensure
that any work you complete does not interfere with the work of others in the group. Thus, if you
have been identified as ‘User01’ at your workstation, then you’ll be building out your Boomi
process and all corresponding components within your ‘User-01’ folder
5. Take note of the other pre-defined folders.
that reside within it, primarily should not be used
during the building of this activity. It is meant to
serve as a solution template and a potential backup,
in case you need to quickly reference or replace a
component within your own process build.
The ‘SHARED’ folder houses prebuilt Connection
components that you will leverage throughout
your own process build.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 2 – Create a new process and configure the
Salesforce Start shape connector
1. Create a new Process Component. Within your ‘User-XX’ folder, create a “New Component”
2. Choose ‘Process’, name the component ‘Salesforce to Database’ and click the Create button.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. The Start Shape dialogue box appears. From the Connector dropdown, choose ‘Salesforce’.
Since this is our Start connector, the default Action is ‘Get’
4. The Salesforce Connection is already configured and is housed in the ‘SHARED’ folder.
Browse and load the prebuilt ‘Boomi Salesforce’ connector.
5. Create a new Operation by clicking on the ‘+’ button.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
6. Name the Operation ‘Get Prospect Accounts’ and click on the ‘Import’ button. This will allow
us to programmatically import the Response Profile from our Salesforce instance.
7. Browse and load the prebuilt ‘Boomi Salesforce’ connector from the ‘SHARED’ folder and click
‘Next’
8. Choose ‘Account’ from the Object Type dropdown and ‘Query’ from the Action dropdown.
Click Next
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
9. The ‘Account’ object appears with the option of choosing any child objects as well. We’ll just be
using the Account object. Click Next.
10. Click ‘Finish’ to close the Salesforce Import Wizard.
11. Notice how the Response Profile is loaded and all the corresponding Fields are listed
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
12. Now that we imported the fields that belong to the Account object, we’ll want to configure our
query to only pull in Accounts that are of type ‘Prospect’. To accomplish this, we’ll first click on
the ‘Filters’ tab and under the ‘Logical – AND’ node select ‘Add Expression’
13. Highlight the ‘Expression’ element and type ‘Type=’ for the Filter Name. Then, click on the
‘Browse’ button, select the ‘Type’ field from the profile and click ‘OK’.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
14. ‘Save and Close’ the ‘Get Prospect Accounts’ Salesforce Operation
15. Within the Start Shape configuration pane, click on the ‘Parameters’ tab. Then click on the ‘+’
button to add a parameter.
16. Browse and choose the ‘Type=’ filter that you created earlier. Click ‘OK’.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
17. Choose ‘Static’ as the Type and type ‘Prospect’ as the Static Value. Then click ‘OK’
18. This will limit our query to only pull back Accounts in our Salesforce instance that are of type
Prospect. Click 'OK'.
19. Now our Salesforce Start shape is fully configured. Click ‘Save’ to save the Connection.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 3 – Execute the process in test mode to
test Salesforce connectivity
1. Click on the ‘Test’ button in the upper-right of the Process Canvas. If you are then prompted to
Save the process, click on the ‘Save’ button.
2. From the ‘Select Atom…’ dropdown, select the ‘workshop-atom’ Atom and click ‘Run Test’.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Upon successful completion, the connector should be highlighted in green and there should be
1 Document within the Document pane, assuming only 1 Account in Salesforce is of type
Prospect. Clicking on the Connection Data tab within the Test Results pane allows for the
ability to open the Document(s) to view its contents
4. Within the Document Viewer, the ‘Formatted XML’ tab allows for a cleaner view of the
Document contents. After viewing the document, click on the ‘Close Document Viewer’ button.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. After executing the test, click on the ‘Return to Edit Mode’ arrow in the upper-left corner. This
will navigate back to the Process Canvas.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 4 – Configure the Database connector
1. Drag and drop a Database Connector onto the canvas.
2. Select ‘Send’ as the Action. For the Connection, click on the browse button and load the
preconfigured ‘Boomi MySQL’ database connection. This Connection component is configured
to connect to the trainer’s database
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Create a new Operation by clicking on the ‘+’ button
4. Name the Operation ‘Update Customer Record’. Then, click on the ‘Create a new
component’ button to create a new database Profile.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. Name the Profile ‘Customer Table’. Within the Data Elements tab, click on the ‘Statement’
node. Select ‘Dynamic Insert’ from the Type dropdown. Click on the ‘Import’ button
6. Select the “workshop-atom” Atom from the Atom dropdown. Browse and load the prebuilt
‘Boomi MySQL’ database connector from the ‘SHARED’ folder and click ‘Next’
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
7. If the Database connection was successful, we should see all the tables that reside within the
database. Select the ‘CUSTOMER’ table and click ‘Next’.
8. Click the top checkbox to select all the table columns. Click “Next” & “Finish”.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
9. Take note how the database Fields are now populated within the Customer Table Profile. Click
‘Save and Close’.
10. The ‘Customer Table’ Profile is now configured within the ‘Update Customer Record’ Database
Operation. Click ‘Save and Close’ to return back to the Connector Action pane.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
11. The database connection is now fully configured. Click ‘OK’ to return to the process canvas.
12. Click ‘Save’ to save the process with these configured connectors.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
13. Now is a good time to observe the Component Explorer. You can expand your ‘User-XX’ folder
to observe how components are stored accordingly as they get built and saved.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 5 – Configure a Decision step to test for
duplicate entries
1. Now that the Salesforce and Database connections are fully configured, we’ll want to test
incoming Salesforce Account ‘Prospect’ records against any existing Customer records in the
database. From the Logic palette, drag and drop a Decision step onto the canvas,
2. Within the Decision Properties pane, type an appropriate Label, “Does Account Exist in DB?’,
to help describe the purpose of this Decision step. Then click on the ‘browse’ button to
configure the First Value.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Select ‘SQL Statement’ from the Type dropdown. For the Connection, browse and load the
prebuilt ‘Boomi MySQL’ connection from the “SHARED” folder. For Output Type select
‘Integer’. Within the SQL window, type the following SQL statement:
select count(*) from CUSTOMER where NAME = ? and TRAINEE = 'Your Name'
4. The question mark (?) within the SQL statement represents a dynamic parameter. To bind the
appropriate parameter to this placeholder, click on the (+) ‘Add Parameter’ button
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. Select ‘Profile Element’ for the Type and ‘XML’ as the Profile Type. Then click on the browse
button and select the ‘SF_Account_QUERY_Response’ profile within your ‘User-XX’ folder
6. For the Element, click on the browse icon and choose ‘Name’. Click ‘OK’ to assign the ‘Name’
field to the Element and then click ‘OK’ again to return back to the ‘Parameter Value’ pane.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
7. Note how the ‘?’ parameter within the SQL statement is now bound to the ‘Name’ field in the
Salesforce response profile. Thus, the SQL statement will return an integer value based on
whether or not there already exists a record with that same Account Name belonging to a
particular trainee. It will return a ‘0’ if no such record exists and a ‘1’ if the record already exists.
Click ‘OK’ to return to the Decision Properties pane
8. The ‘count(*)’ value returned from the SQL lookup will be stored as the ‘First Value’ in the
Decision Properties pane. Choose ‘Not Equal To’ from the Compare Type dropdown. Click the
browse button to assign a value to the ‘Second Value’ field.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
9. Choose ‘Static’ as the Type and type ‘0’ (zero) as the Static Value. Click ‘OK’
10. Click ‘OK’ to return back to the process canvas
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
11. Organize the process by connecting the Salesforce Connector with the Decision step. Notice
that the arrow turns green once connected. Click ‘Save’
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 6 – The ‘True’ Path: Configure a Notify step
1. We now have a test in place to determine if the incoming Account record exists in the database.
If it’s true that the Account Name exists in the database, a customized notification log will be
configured and the document will not be processed any further. From the Execution pallet, drag
and drop a Notify step onto the canvas.
2. Select ‘Information’ for Message Level and check off both ‘Enable Events’ and ‘Enable User
Log’ (scroll down to the “Options” section). Type the following in the Message text:
Account {1} already exists in database.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Note how the ‘{1}’ notation within the Message statement acts as a dynamic reference
parameter. We will want to bind that to the ‘Name’ field in the Salesforce response profile.
Click on the (+) ‘Add Parameter’ button
4. Choose ‘Profile Element’ as the Type, ‘XML’ as the Profile Type and then browse and load the
‘SF_Account_Query_Response’ profile from your ‘User-XX’ folder.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. For the Element, click on the browse icon and choose ‘Name’. Click ‘OK’ to assign the ‘Name’
field to the Element and then click ‘OK’ again to return back to the ‘Notify Properties' pane
6. Note how the ‘{1}’ parameter within the Message statement is now bound to the ‘Name’ field in
the Salesforce response profile. Click ‘OK’ to return to the process canvas
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
7. From the Logic pallet, drag and drop a Stop step onto the canvas
8. Click ‘OK’ to return to the process canvas.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
9. Connect the ‘True’ path to the Notify step and the Notify step to the Stop step. You may also
begin to shift the steps to better organize the flow. Click ‘Save’ to save the process.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 7 – The ‘False’ Path: Configure a Branch
step
1. If it’s false that the Account Name exists in the database (or in other words, if it doesn’t exist in
the database), the goal would be to insert this record in the database and then email a user that
the record has been inserted. Since we wish to accomplish more than one task, we’ll leverage
a Branch step. From the Logic pallet, drag and drop a Branch step onto the canvas
2. Accept the default and allow for ‘2’ branches. Then click ‘OK’.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Connect the False path to the Branch step. Click ‘Save’ to save the process.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 8 – Configure the data Map
1. From the Execution pallet, drag and drop a Map onto the canvas.
2. Click on the (+) ‘Create a new component’ button to create a new map.
3. Name the Map ‘SF Accounts to DB Customer’. Then, on the source side, click on the ‘Profile
Chooser’ button
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
4. Choose ‘XML’ as the Profile Type. Then navigate to the ‘SF_Account_QUERY_Response’
profile in your ‘User-XX’ folder. Click ‘OK’.
5. On the destination side, click on the ‘Profile Chooser’ button.
6. Select ‘Database’ as the Profile Type’ and select the ‘Customer Table’ from your ‘User-XX’
folder. Click ‘OK’.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
7. Now that the source and destination profiles are loaded in the Map, it’s time to map over each
individual field. To have Boomi automatically map over the majority of these fields, we’ll
leverage a crowd-sourcing technology called Boomi Suggest. Click on the ‘Boomi Suggest’
link to initiate this feature
8. Click ‘Next’ over the next two screens to accept the default mappings offered by Boomi
Suggest.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
9. Click ‘Finish’.
10. Notice how the individual fields are automatically mapped across. You may need to expand the
‘Fields’ element on the destination ‘Customer Table’ profile to see the individual mappings
11. On the destination profile side of the map, scroll down and locate the TRAINEE element. Click
on the blue arrow and click on ‘Set Default Value’
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
12. Enter your name for the Value. Be sure to enter the exact string you entered for the Decision
SQL statement earlier. Remember…these must match. Click ‘OK’
13. Note how your name is now hard-coded as the value of the TRAINEE element in the database
table. Click ‘Save and Close’ to return to the Map Properties.
14. Click ‘OK’ to return back to the process canvas.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 9 – Insert records into database
1. The Map is now configured so that the incoming XML Account documents are being mapped
over and converted to database Customer records. Connect Branch 1 to the Map and the Map
to the Database Connector that was configured earlier
2. From the Logic pallet, drag and drop a Stop step on the canvas
3. Click ‘OK’.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
4. Connect the Database Connector to the Stop step. Then click ‘Save’ to save the process.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 10 – Configure a Message step
1. Now that the Customer records are inserted into the database, we’ll want to email a business
user to serve as confirmation of successful insertion. The body of the email can be populated
via a Message step. From the Execution pallet, drag and drop a Message step onto the canvas
2. In the Message Properties pane, check off the ‘Combine documents into a single message’
option. Thus, if multiple documents are inserted into the database, this will allow for a single
email message to reference all documents. Enter the following text within the Message field:
Account: {1} was inserted into the database
-----
<<hard carriage return>>
Then, click on the ‘Add Parameter’ button.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. From the Parameter Value pane, choose ‘Profile Element’ as the Type and ‘XML’ as the Profile
Type. For the Profile, browse for and load the ‘SF_Account_QUERY_Response’ profile from
your ‘User-XX’ folder.
4. For the Element, click on the browse icon and choose ‘Name’. Click ‘OK’ to assign the ‘Name’
field to the Element and then click ‘OK’ again to return back to the ‘Message Properties' pane
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. Click ‘OK’ to return to the process canvas
6. Connect Branch 2 to the Message Step. Click ‘Save’ to save the process
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 11 – Configure a Mail connector
1. Drag and drop a Mail Connector onto the canvas.
2. From the Connector Action pane, choose ‘Mail’ as the Connector (if you chose the default
Connector above) and ‘Send’ as the Action. From the Connection, browse and load the ‘Boomi
Gmail’ Connector housed in the SHARED folder
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. To create a new Operation, click on the (+) ‘Create a new component’ button
4. Type ‘Send Confirmation Email’ as the name of the Mail Operation. Type ‘Boomi Training’ as
the ‘From’ field. For the ‘To’ field, enter your own email address. Type ‘Customer Status’ as the
Subject and select ‘Inline’ as the Disposition. Click ‘Save and Close’ to return to the Connector
Action pane
Type your own email
address in the “To”
field
5. Click ‘OK’ to return to the process canvas
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
6. From the Logic pallet, drag and drop a Stop step onto the canvas.
7. Click ‘OK’.
8. Connect the Message step to the Mail Connector and the Mail Connector to the Stop step.
Click ‘Save’ to save the process.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 12 – Execute the process in test mode to
test database insert and email functionality
1. Click on the ‘Run a Test’ button in the upper-right of the Process Canvas. If you are then
prompted to Save the process, click on the ‘Save button
2. From the ‘Select Atom…’ dropdown, select the “workshop-atom” Atom and click ‘Run Test’.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. If the process was executed successfully, the steps in the process flow will be highlighted in
green.
4. At any stage in the completed test execution, you can click on a particular step to view the
Document state. Then, below in the ‘Test Results’ pane, you can click on the Connection Data
tab and open the document for viewing.
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. For example, selecting the Database connector and opening the document in the Test Results
pane, displays the contents of the document. To return to Test Mode, click on the ‘Close
Document Viewer’ button
6. When finished observing the document(s) in Test Mode, click on the ‘Return to Edit Mode’ arrow
link in the upper left of the Test Mode window
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 13 (API) – Copy Subprocess
1. First we will copy a sub process which the trainer has prepared for you.
Click on the drop-down arrow next to the process “(SUB) Get Customer as JSON” process
in the “SHARED” folder and click “Copy”:
2. Uncheck “Copy Component Dependents” and choose your User folder for the destination:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Click “OK”:
4. Confirm that you have “(SUB) Get Customer as JSON” in your User folder:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. Open the Process. Notice that there is a Parameter set on the start shape. Click on the
“Parameters” link:
6. Notice there is a “trainee” parameter. This trainee parameter is used in the database WHERE
clause for this Database connector shape:
7. Click “Cancel” to close.
8. Click “Test”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
9. Choose the “Workshop-Atom” Atom, then click on “Test Extensions”. Click on the “Dynamic
Process Properties” tab and enter your name for the trainee value. This is an easy way to
enter parameters when running tests:
Then click “Run Test”:
10. Once it runs successfully click on the “Return Documents” shape then “Shape Source Data”
-> “View Source”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
11. Confirm that you get a well formatted JSON document:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 14 (API) – Create Web Service Listener
Process
We will now create a “wrapper” process which service-enables the Get Customer process.
1. Click on “New Component” on your User folder:
2. Create a new process called “(REST) Get Customer (YOUR NAME)”. Click “Create”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. On the Start Shape choose the “Web Services Server” connector type and click on “Make the
recommended changes for me”:
4. Click on the + button to add a new operation:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. Name the operation “Get Customer”, enter “customer” for the object then choose “Single
JSON Object” for the response output type:
6. Click on the magnifying glass button next to Response Profile and choose the “Customer
JSON” profile under the “SHARED” folder:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
7. Click “Save and Close”:
8. Click “OK”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
9. Search for the “Process Call” shape. Drag and drop it next to the start shape:
10. Choose the “(SUB) Get Customer as JSON” process in your User folder:
11. Click on the “Parameters” tab and click + button:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
12. Choose “trainee” for input. Click “OK”:
13. For Type select “Dynamic Process Property”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
14. Enter “param_trainee” for the property name. The “param” prefix is used when URL parameters
are passed on from the incoming API call.
Click “OK”:
15. Click “OK”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
16. Search for the “Return Documents” shape. Drag and drop it next to the subprocess call:
17. Click “OK”:
18. Link all the shapes and click “Save”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 15 (API) – Create an API Component
1. Create a “New Component” in your User folder:
2. Choose Type “API” and enter the name “Get Customer API (YOUR NAME)”.
Click “Create”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Enter the same name for the Title. Type “1.0” for version and enter a description of your choice.
For the Base API Path enter “YOUR NAME/v1”:
4. Click on the “REST” tab and click “Help Me Create an Endpoint”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. Select “Use an existing process”. Click “Next”:
6. Choose the “(REST) Get Customer (YOUR NAME)” process in your User folder:
7. Check the “REST” checkbox and click “Finish”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
8. Click on the gear icon and click “Edit Endpoint”:
9. Enter “{trainee}” in the second resource path field. The {} represents a dynamic resource URL
parameter which is later referenced in our process as param_trainee:
10. Scroll down and click “OK”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
11. Click “Save and Close”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 16 (API) – Deploy API
For the REST process and the API component to be called they must be deployed to an Atom.
1. In the top navigation bar click on “Deploy” -> “Package Manager”:
2. On the left hand component explorer check the process “(REST) Get Customer (YOUR
NAME)” and the API “Get Customer API (YOUR NAME)”.
Click “Create” -> “New Package & Deploy”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Enter “1.0” for the version. Click “Next: Deployment Location”:
4. Select “Development – AWS” and add a deployment note. Click “Next: Review”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
5. Click “Package & Deploy”:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 17 (API) – Search API in API Catalog
1. In the right-hand corner click on the drop down and click on the icon next to “API Management”:
2. A new browser tab will open. Click on “Configure API’s and Applications”:
Click on the search button and type in your name. Once the search results show your API. Click
on ‘View’
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
3. Click on the “REST” tab, then the arrow next to “general”. Click on the “…” button
4. Click on the copy link button:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]
Lesson 18 (API) – Test API
1. Open a browser tab and paste in the copied link from the previous lesson.
Replace “{trainee}” with your name. You should get a JSON response:
2. Go back to AtomSphere and click on “Manage” -> “Process Reporting”:
3. You will see an entry for your execution:
3 Temasek Avenue, Centennial Tower, Singapore 039190
[Link]