Getting Started with Integration Flow Design Guidelines - Timer-Initiated Scenario
- How to find existing out-of-the-box integration flow design guidelines for Cloud Integration, capability of SAP Integration Suite, and how to copy them into your tenant
- How to deploy and work with integration flow design guidelines with minimal effort
As an integration developer, you need to make sure that you design integration flows in a robust manner to safeguard your company’s mission-critical business processes. To do so, you can leverage ready-made integration content as templates. The integration flow design guidelines offer best practices and ready-made content for you to start with your integration scenario. The integration flows are designed to meet the following requirements:
- Each integration flow focuses on one dedicated guideline or pattern, giving you easy access to the topic at hand.
- Each integration flow can be deployed and executed with minimum effort. That way, you can test each guideline or pattern on your own.
- You can use each reference integration flow as a basis for creating more complex scenarios.
Currently, the following topics are covered by the integration flow design guidelines:
- Learn the Basics
- Run an Integration Flow Under Well-Defined Boundary Conditions
- Relax Dependencies to External Components
- Keep Readability in Mind
- Handle Errors Gracefully
- Apply the Highest Security Standards
- Use the Partner Directory Appropriately
- Use Scripting Appropriately
- Enterprise Integration Patterns
In this tutorial, you are going to download the easiest integration scenario currently offered by Cloud Integration: Modeling Basics - Timer-Initiated Scenario. This scenario will show you how you can leverage integration flow design guidelines in integration scenarios - quickly and efficiently.
Congratulations! You’ve successfully copied and deployed a very simple timer-initiated integration flow which is part of the Learn the Basics integration flow guideline.
- Step 1
After you’ve set up your Cloud Integration tenant (refer to the prerequisites of this tutorial for assistance), launch Cloud Integration by selecting the respective tile. Now, you find yourself in the Discover tab of Cloud Integration. Here, you find all integration packages that are pre-delivered by SAP and its partners.
Tip: If your navigation bar is collapsed and you can only see icons, select the sandwich icon the upper left corner next to the SAP logo to enlarge the navigation bar.
In the search field, type in
integration flow design guidelines. You will see a list of integration packages. For each design guideline, one or more reference integration flows are documented and packed together into so-called integration packages.
Scroll down till you find the integration package called Learn the Basics.
- Step 2
Once you’ve found the integration package called Learn the Basics, copy it into your tenant.
Select your integration flow package.
Note: Don’t wait for a confirmation message, the copying was successful without notification.
- Step 3
After you’ve successfully copied your integration flow package, go to the Design tab which you find in your left-hand navigation bar. You can now see a list of all existing integration packages on this tenant. Select your newly copied package by clicking on the title Learn the Basics.
In the package, you find yourself in the Overview tab. Switch to the Artifacts tab. You can now see all integration flows that are part of that integration package. There’s usually more than one integration flow (artifact) packed into an integration package. The integration flow names follow the naming pattern ‘Category-Guideline-extension’.
Select the integration flow you’re interested in. In our example, Modeling Basics - Timer-Initiated Scenario.
You are now looking at the integration flow editor view. Here, your integration flow is displayed, showcasing all its components and steps. Your integration flow consists of three components:
- A timer event Start Timer that is set to
Run Onceand that initiates the integration flow once it has been deployed;
- A message body Define message body that defines a hard-coded message body that reads
- A write step called Write data store entry that takes the message body and writes it to the data store.
Tip: Select the respective shapes, to view the parameters of the respective integration flow step. You might need to pull up the window from the bottom of your screen.
For integration flows, in general, you always have the following options:
- Edit: This option allows you to edit the components and steps of the integration flow. You can add or delete steps, and/or change the adapter setup. In general, the edit-option is unnecessary for integration flow design guidelines as these flows are constructed in such a way that they meet the required criteria already.
Caution: In general, if you edit an integration flow, you will not receive any automatic updates for this edited integration flow once new features or steps are available.
- Configure: This option allows you to configure parameters more easily via a quickly accessible wizard without having to edit the entire integration flow.
In this tutorial, you do not need to configure or edit anything as this integration flow design guideline is ready to be deployed.
- A timer event Start Timer that is set to
- Step 4
In this final step, check whether the data store entry “Hello world” has been written to the data store.
Wait for a message to tell you that the deployment was successful.
From the left hand navigation bar, choose Monitor.
First, check the message processing log of the message. The message processing log (MPL) stores data about the messages processed on a tenant. Select Monitor Message Processing > All Integration Flows.
You now see a list of all messages that have run on this tenant. Select the entry with artifact name Modeling Basics – Timer-Initiated Scenario and check whether the Status displays a green success message: “Message processing completed successfully.”
Now, download the message. Go back to the Monitor overview and this time select Manage Stores > Data Stores.
From the list, select the name of the data store. In this example ModelingBasics-SmokeTest.
Select Download to download a file containing the predefined message body.
Open the file with the “Hello World” message.
Which of the following integration packages are currently available?