Skip to content

Commit 111c8a7

Browse files
authored
Automatic commit: Move 'spa-create-outlook-automation' from QA to Production (#18804)
1 parent 5bf2c79 commit 111c8a7

2 files changed

Lines changed: 33 additions & 30 deletions

File tree

-99.4 KB
Loading
Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
---
22
author_name: Ramakrishnan Raghuraman
33
author_profile: https://github.com/r3ksk
4-
title: Build your first automation using Outlook SDK of SAP Process Automation
5-
description: In this tutorial, you will be developing basic automation using Outlook SDK of SAP Process Automation. In the end, by using the activities in this Outlook SDK, you will know how to search outlook inbox or a specific email folder and download any attachments found in the email context to a specific local folder.
4+
title: Build Your First Automation Using Outlook SDK of SAP Process Automation
5+
description: In this tutorial, you will be developing a basic automation using Outlook SDK of SAP Process Automation. In the end, by using the activities in Outlook SDK, you will know how to search outlook inbox or a specific email folder and download any attachments found in the email to a specific local folder.
66
auto_validation: true
77
time: 20
88
tags: [ tutorial>beginner, software-product>sap-business-technology-platform, tutorial>free-tier]
99
primary_tag: software-product>sap-process-automation
1010
---
1111

1212
## Details
13-
SAP Process Automation has native integration to several Microsoft Office products including Outlook, Excel SDK. In this Tutorial, you will explore how to use Outlook SDK to your automations.
13+
SAP Process Automation has native integration to several Microsoft Office products including Outlook and Excel SDK. In this Tutorial, you will explore how to use Outlook SDK to your automations.
1414

1515
## Prerequisites
1616

1717
- Complete the tutorial: [Subscribe to SAP Process Automation Using Booster in SAP BTP Free Tier](spa-subscribe-booster)
1818
- Complete the tutorial: [Install and Set Up the Desktop Agent](spa-setup-desktop-agent)
19-
- Familiarity to create an automation using SAP Process Automation
19+
- Basic understanding of SAP Process Automation. You may review the below missions
20+
- [Build Your First Business Process with SAP Process Automation](mission.sap-process-automation)
21+
- [Boost your Business Process with Automation, Decision and Process Visibility](mission.sap-process-automation-boost)
2022

2123
### You will learn
2224

@@ -27,7 +29,7 @@ SAP Process Automation has native integration to several Microsoft Office produc
2729
[ACCORDION-BEGIN [Step 1: ](About Outlook SDK in SAP Process Automation)]
2830

2931
The Outlook SDK in SAP Process Automation, is a collection of activities allowing you to create automations using Microsoft Outlook.
30-
It comes with rich set of functionality. For ex,
32+
It comes with a rich set of functionality. For example,
3133

3234
- Search an email
3335
- Read an email
@@ -40,27 +42,24 @@ It comes with rich set of functionality. For ex,
4042

4143
[ACCORDION-BEGIN [Step 2: ](Create an Automation Project)]
4244

43-
1. Our example project will be called `Outlook Sample`. Feel free to name your project as per your convenience.
45+
1. There are two ways to create an automation project from SAP Process Automation Lobby.
46+
1. You can click the shortcut **Create an automation**
47+
2. You can get started with a **Business Project** either through **Create a Process** or using the **Create** -> **Business Process** and include automation within that.
4448

4549
!![Create an automation Project](01-CreateNewProject.png)
50+
For this tutorial, use **Create an automation** option.
4651

47-
There are two ways to create an automation project from SAP Process Automation Lobby.
48-
49-
2. You can click the shortcut **Create an automation**
50-
51-
or you can get started with a **Business Project** either through **Create a Process** or using the **Create** -> **Business Process** and include automation within that.
52-
53-
We will follow **Create an automation** approach for this tutorial. i.e indicated by number 1 in the below image.
52+
2. Project used in this tutorial is called as `Outlook Sample`. Feel free to name your project as per your convenience.
5453

5554
!![Name your project appropriately](02-CreateAutomationProject.png)
5655

57-
3. Subsequently it will ask you to select your desktop agent, At the time time of this tutorial creation, we took the screenshot based on **Agent Version 0.24**. You can pick your active desktop agent version.
56+
3. Subsequently it will ask you to select your desktop agent, At the time time of this tutorial creation, a screenshot was taken based on **Agent Version 0.24**. You can pick your active, (preferably) latest desktop agent version.
5857

5958
> By the time you follow these scripts, newer Desktop agent versions may have been introduced. so always kindly install the latest version of desktop components and select the latest version of agent in this step.
6059
6160
!![Link to your active desktop agent version](03-SelectAgentVersion.png)
6261

63-
4. Subsequently, you will see a dialog box to create a new automation. You can give a name to your automation. In this example, we named it `searchInOutlook`. You can follow your own naming convention and name for your automation.
62+
4. Subsequently, a dialog box is displayed to create a new automation. You can give a name to your automation. For example, you may use `searchInOutlook`. You can follow your own naming convention and name for your automation.
6463

6564
!![Add an automation to your project](04-CreateNewAutomation.png)
6665

@@ -74,13 +73,13 @@ It comes with rich set of functionality. For ex,
7473

7574
!![Core SDK and Excel SDK are standard core dependencies added](06-CoreDependencies.png)
7675

77-
6. Once an empty project is created, we need to include Outlook SDK dependency to this project. Locate the settings wheel icon in your project
76+
6. Once an empty project is created, you need to include Outlook SDK dependency to this project. Locate the settings wheel icon in your project
7877

7978
!![Locate the settings Icon in your projects](07-SettingsIcon.png)
8079

81-
7. From the dependency section, locate Outlook SDK and include it as a dependency to your project. At the time of creation of this tutorial, we have used Outlook SDK `Version 1.24.58`
80+
7. From the dependency section, locate Outlook SDK and include it as a dependency to your project. At the time of this tutorial creation, Outlook SDK `Version 1.24.58` was used.
8281

83-
> Again, by the time you follow these scripts, newer versions of Outlook SDK may have been introduced. so always kindly update Outlook SDK to the latest version in this step.
82+
> Again, by the time you follow these scripts, newer versions of Outlook SDK may have been introduced. so always kindly update Outlook SDK to the latest version.
8483
8584
!![Add Outlook SDK to your project](08-AddOutlookSDK.png)
8685

@@ -89,35 +88,38 @@ It comes with rich set of functionality. For ex,
8988
[DONE]
9089
[ACCORDION-END]
9190

92-
[ACCORDION-BEGIN [Step 3: ](Working with Outlook SDK)]
91+
[ACCORDION-BEGIN [Step 3: ](Search using Outlook SDK)]
9392

9493
1. From the `Tools` panel on the right side, search for the activity **Open Outlook Instance**
9594
!![Find Open Outlook Instance Activity](09-OpenOutlookInstance.png)
9695

9796
2. Drag it onto your automation flow
9897
!![Drag Open Outlook Instance on to your automation](10-AddOpenOutlookInstance.png)
9998

100-
3. First we will attempt a simple folder search. so locate **Search Email** activity and add it to the flow
99+
3. Your task will be to do a simple folder search. So locate **Search Email** activity and add it to the flow
101100
!![Add Search Email Activity to the automation](11-AddSearchEmailActivity.png)
102101

103102
4. Select the newly added activity and **Create Custom Data** as search criteria under `Parameters` section.
104103
!![Add a custom search criteria](12-SearchEmailCustomCriteria.png)
105104

106-
5. Provide a folder name and a `storeName` as per the input form. Here `storeName` refers to the email inbox, where you wanted the SDK to search. As some of you, may have additional mailbox configured within your outlook application, this field could be handy to search specific folder in your inbox. If you wanted to search the default inbox, you can leave the `storeName` empty.
105+
5. Provide a folder name and a `storeName` as per the input form. Here `storeName` refers to the email inbox, where you wanted the SDK to search.
106+
- `folderName` : it is optional input. You need to provide one if you wanted automation to search a specific outlook folder
107+
- `storeName` : As some of you, may have additional mailbox configured within your outlook application, this field could be handy to search specific folder in your inbox. If you wanted to search the default inbox, you can leave the `storeName` empty.
108+
107109

108-
| Name | Value
109-
| :------------| :---------------
110-
| `folderName` | outlook
111-
| `storeName` | <your email id>
110+
| Name | Value | Example
111+
| :------------| :------------------------ | :---------------------
112+
| `folderName` | *Outlook sub folder name* | Invoices/ToCreate
113+
| `storeName` | *Email id* | mymail@bestrunsap.com
112114

113115
!![Give your search criteria](13-EnterCustomSearchCriteria.png)
114116

115-
> Review the option `SearchCriterionList`; You can include additional search criteria like emails with specific subject or from specific sender. You can refer to our documentation [page](https://help.sap.com/docs/IRPA/8e71b41b9ea043c8bccee01a10d6ba72/2ea6c87f0bef430f9aed40eb824576bc.html) for additional information
117+
> Review the option `SearchCriterionList`. You can include additional search criteria like emails with specific subject or from specific sender. You can refer to the [documentation](https://help.sap.com/doc/e57d7b179db649e6b5f2d26d9894f9d9/Cloud/en-US/datatypes/emailSearchCriterion.html) for additional information
116118
117-
6. Add `GetEmailsinContext` activity to the flow. Our previous step creates a context which is what we are going to use in our next steps.
119+
6. Add `GetEmailsinContext` activity to the flow. The previous step creates a context which is what you are going to use in the next steps.
118120
!![Add Get Email In Context Activity](14-AddGetEmailsInContext.png)
119121

120-
7. As this is our first automation using Outlook SDK, we can do a simple check to find out if there is a result in our search. For ex, We can find out how many emails are present in that outlook folder. For this we will add a **Log Message** activity
122+
7. As this is your first automation using Outlook SDK, you can do a simple check to find out if there is a result in the search. For example, you can find out how many emails are present in that outlook folder. For this, add a **Log Message** activity
121123
!![Add Log Message](15-LogTotalEmailsInSearchResult.png)
122124

123125
8. If you wanted, you can include a custom message using the expression editor
@@ -132,8 +134,9 @@ It comes with rich set of functionality. For ex,
132134
11. Save the project, test run the project, you should see your expected result
133135
!![Test & Validate Result](19-SearchResultInTest.png)
134136

135-
> - Do review our Microsoft Outlook Best Practices from our help documentation [page](https://help.sap.com/docs/IRPA/8e71b41b9ea043c8bccee01a10d6ba72/5a48c81502db40b08e4aac866e04592a.html)
136-
> - Also don't forget to review Outlook Email Best Practices Automation from our [SAP Process Automation Store](https://irpa.store.sap.com/#/package/a4c61c62-356e-4165-bdcb-bef08e236cf5)
137+
> - Do review the below resources
138+
> - Microsoft Outlook Best Practices from the SAP Process Automation [documentation](https://help.sap.com/docs/IRPA/8e71b41b9ea043c8bccee01a10d6ba72/5a48c81502db40b08e4aac866e04592a.html)
139+
> - Outlook Email Best Practices Automation from the [SAP Process Automation Store](https://irpa.store.sap.com/#/package/a4c61c62-356e-4165-bdcb-bef08e236cf5)
137140
138141
[VALIDATE_1]
139142
[ACCORDION-END]

0 commit comments

Comments
 (0)