Skip to content

move to prod #18966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Oct 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion tutorials/spa-create-automation/spa-create-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ An Automation is a succession of steps to orchestrate multiple activities and ap

[ACCORDION-BEGIN [Step 1: ](Create the Automation)]

In this exercise, you will automate the process to read the *sales order* details from an Excel and select the specific sales order details based on the input from the submitted form. To design your automation, you will need an excel file filled with the sales orders data. You have the possibility to create it yourself using the following data:

In this exercise, you will automate the process to read the *sales order* details from an Excel and select the specific sales order details based on the input from the submitted form. To design your automation, you will need an Excel file filled with the sales orders data. You have the possibility to create it yourself using the following data:


| Order Number| Order Amount | Order Date | Shipping Country | Expected Delivery Date | Order Status
| :----------| :------------|:-----------| :------------------------|:-----------------------|:-----------
Expand Down
5 changes: 3 additions & 2 deletions tutorials/spa-create-decision/spa-create-decision.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ After the data types are created, you will now configure the decision:

7. Then you will create the actual decision-making parts that make the decision in the process. Under Determine approver, select **Rules**.


!![002](015.png)

8. Select **Add Rule**.
Expand All @@ -150,7 +151,7 @@ After the data types are created, you will now configure the decision:

!![002](017.png)

> A decision table is a tabular representation of the rule with If and Then header and row columns. If-header columns contain the expressions which are evaluated, and Then-header columns contain the result structure that will be returned after the decision is run.
> A decision table is a tabular representation of the rule with If and Then header and row columns. If-header columns contain the expressions, which are evaluated, and Then-header columns contain the result structure that will be returned after the decision is run.

10. You will now configure the conditions. Under **Data Types**:
- Choose **Sales Order**,
Expand Down Expand Up @@ -267,7 +268,7 @@ After you have created and configured the decision, next you have to map the inp

2. **Save** the process.

!![002](031.png)
!![002](031.png)

> You might see an error symbol on your decision. This is because the outbound connection from the decision is still dangling and not connected to any activity. You may connect it to the end activity.

Expand Down
Binary file added tutorials/spa-dox-create-automation/001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/004.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/005.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/006.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/007.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/008.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/009.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/010.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/011.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/012.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/013.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/014.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/015.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/016.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/017.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/019.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/020.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/021.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/022.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/023.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/024.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/025.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/spa-dox-create-automation/026.png
Binary file added tutorials/spa-dox-create-automation/027.png
Binary file added tutorials/spa-dox-create-automation/028.png
Binary file added tutorials/spa-dox-create-automation/029.png
Binary file added tutorials/spa-dox-create-automation/030.png
Binary file added tutorials/spa-dox-create-automation/031.png
Binary file added tutorials/spa-dox-create-automation/032.png
Binary file added tutorials/spa-dox-create-automation/033.png
Binary file added tutorials/spa-dox-create-automation/034.png
Binary file added tutorials/spa-dox-create-automation/035.png
Binary file added tutorials/spa-dox-create-automation/036.png
Binary file added tutorials/spa-dox-create-automation/037.png
Binary file added tutorials/spa-dox-create-automation/040.png
Binary file added tutorials/spa-dox-create-automation/041.png
Binary file removed tutorials/spa-dox-create-automation/1.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/10.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/11.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/12.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/14.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/15.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/16.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/17.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/18.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/19.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/2.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/20.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/21.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/22.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/23.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/24.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/25.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/26.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/3.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/4.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/5.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/6.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/7.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/8.png
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/9.png
Diff not rendered.
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/Endparameter.png
Diff not rendered.
Diff not rendered.
Binary file removed tutorials/spa-dox-create-automation/LogMessage.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
213 changes: 121 additions & 92 deletions tutorials/spa-dox-create-automation/spa-dox-create-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,53 +26,60 @@ primary_tag: software-product>sap-process-automation
[ACCORDION-BEGIN [Step 1: ](Create Automation)]

1. In the process **Get Invoice Details**:
- Choose !![00-01](AddButtonProcess.png).
- Select **Automation** > **New Automation**.
- Choose **+**,
- Select **Automation**, **New Automation**.

!![New Automation](1.png)
!![Automation](001.png)

2. A pop up will appear to configure the Desktop Agent version. Do the following in the pop up:
- From the dropdown, select the version of the Desktop Agent installed on your machine.
- Choose **Confirm**.

> It would be with suffix as **Registered**.

!![2-png](2.png)
!![Automation](002.png)

3. A new pop-up will appear to create the automation. Do the following in the pop-up:

- Enter **Name** of the automation as **Extract Invoice Data**.
- Enter **Description** of your choice, if needed.
- Enter **Name** of the automation: **Extract Invoice Data**,
- Enter **Description** of your choice,
- Choose **Create**.

!![3-png](3.png)
!![Automation](003.png)

An automation **Extract Invoice Data** will be created successfully.

!![4-png](4.png)
!![Automation](004.png)

[DONE]
[ACCORDION-END]

[ACCORDION-BEGIN [Step 2: ](Create Data Types)]

1. Create an artifact of the type **Data Type**.
1. Go to the **Overview** Tab. Choose the **Create** button. Create an artifact of the type **Data Type**.

!![21-png](21.png)
!![Automation](005.png)

2. Enter the name of the data type as **Invoice** and choose **Create**.
2. A new pop-up will appear:
- Enter **Name** of the data type: **Invoice**,
- Enter **Description** of your choice,
- Choose **Create**.

!![22-png](22.png)
!![Automation](006.png)

3. Navigate to Data Types and add new fields as following and choose **Save**.
3. In the Data Type **Invoice** and add new fields as following.

| Field Name | Type
| :------------- | :-------------
| `DocumentNumber`| String
| `GrossAmount` | Number
| `SenderName` | String

!![23-png](23.png)
!![Automation](007.png)

4. Choose **Save**.

!![Automation](008.png)

[DONE]
[ACCORDION-END]
Expand All @@ -81,18 +88,26 @@ primary_tag: software-product>sap-process-automation

Input and output parameters allow you to exchange data in the workflow of your automation between activities, screens, and scripts.

1. Click on the canvas and select the **Input/Output** section in **Automation Details**.
1. Go to the **Overview** tab. Open **Extract Invoice Data** Automation.

!![Automation](009.png)

2. In **Automation Details**, select the **Input/Output** section.

!![Automation](010.png)

3. Add Input and Output parameters.

!![00-05](Step11-InputOutput.png)
!![Automation](012.png)

2. Add Input and Output parameters as following:
4. Edit Input and Output parameters as follows:

| Parameter Name | Data type | Parameter Type | Description
| :--------------- | :------------- | :------------- | :---------------
| `FilePath` | **`String`** | Input | Path where the invoice document is stored
| `InvoiceDetails` | **`Invoice`** | Output | Extracted Invoice Details
| `FilePath` | String | Input | Path where the invoice document is stored
| `InvoiceDetails` | Invoice| Output | Extracted Invoice Details

!![Input-Output](InputandOutputParameters.png)
!![Automation](011.png)

3. Choose **Save**.

Expand All @@ -101,151 +116,165 @@ primary_tag: software-product>sap-process-automation

[ACCORDION-BEGIN [Step 4: ](Create Document Template)]

1. Create an artifact of type **Document Template**.
1. Go the **Overview** Tab. Choose **Create** and **Document Template**.

!![7-png](7.png)
!![Automation](013.png)

2. Enter the following details:

- Choose **Create a new template**.
- Enter the **Name** of the template.
- Upload the invoice document which you have downloaded from prerequisites.
2. In the **Create Document Template** window, under **Details**:
- Choose **Create a new template**,
- Enter the **Name** of the template,
- Upload the invoice document which you have downloaded from prerequisites,
- Choose **Next**.

!![8-png](8.png)
!![Automation](014.png)

3. Select **Invoice** as the document type of your template and choose **Next**.

!![9-png](9.png)

4. Choose your extraction schema.
!![Automation](015.png)

- Enter the **Name** of the schema.
- Choose the fields that you would extract the data from the Invoice document.
- In this scenario you would select `documentNumber`, `grossAmount`, `senderName`.
4. Under **Choose Schema**:
- Choose **Create New**,
- Enter the **Name** of the schema,
- Choose the Header fields that you would extract the data from the Invoice document. In this scenario you would select `documentNumber`, `grossAmount`, `senderName`,
- Choose **Add**.

!![10-png](10.png)
!![Automation](016.png)

5. Document Information Extraction SDK would be added as dependency to your project. The schema and template are created successfully.

5. Document Information Extraction SDK would be added as dependency to your project and the schema, template are created successfully.
6. Once Upload will be completed, choose **Open in a new tab**.

6. Choose **Open in a new tab**.
!![Automation](017.png)

!![11-png](11.png)

[DONE]
[ACCORDION-END]

[ACCORDION-BEGIN [Step 5: ](Annotate and Activate the Document Template)]

1. You are now navigated to Document Information Extractor. It allows you to edit and annotate the template. To work on Document Information Extractor, please check if you have been assigned to `Document_Information_Extraction_UI_Templates_Admin` role in SAP BTP Cockpit. Otherwise, add the role manually. You would get an error as below if you do not have DOX roles.
1. You are now navigated to Document Information Extractor. It allows you to edit and annotate the template. To work on Document Information Extractor, please check if you have been assigned to `Document_Information_Extraction_UI_Templates_Admin` role in SAP BTP Cockpit. Otherwise, add the role manually. You would get an error as , if you do not have DOX roles.

!![DOX roles error](DOXroleserror.png)
!![Automation](018.png)

2. Select the **Document Name**.

!![12-png](12.png)

3. Choose **Annotate**.

!![14-png](14.png)
!![Automation](019.png)

4. Choose **Edit**.
3. Choose **Annotate**.

!![Link text e.g., Destination screen](15.png)
!![Automation](020.png)

- Select the data in your invoice document which you would like to extract the information.
4. Choose **Edit**.

In this scenario, you will read the Document Number, Gross Amount and Sender Name.
!![Automation](021.png)

- Select the field **174228** in the document and map to the field `documentNumber`.
- Choose **Apply**.
5. Select the data in your invoice document which you would like to extract the information. In this scenario, you will read the Document Number, Gross Amount and Sender Name.
- Select the value **174221** in the document and map to the field `documentNumber`. Choose **Apply**.

!![16-png](16.png)
!![Automation](022.png)

- Select the value **ABC Communication** in the document and map to the field `senderName`.
- Select the value **ABC Communication** in the document and map to the field `senderName`. Choose **Apply**.

!![17-png](17.png)
!![Automation](023.png)

- Select the value **220** in the document and map to the field `grossAmount`.
- Select the value **220** in the document and map to the field `grossAmount`.

!![18-png](18.png)
!![Automation](024.png)

5. The mapping of the data in the invoice and fields are mapped. Choose **Save** and **Activate** the template.
6. Once mapping is done. Choose **Save** and **Activate** the template.

!![Save](SaveActivate.png)
!![Automation](025.png)

[DONE]
[ACCORDION-END]

[ACCORDION-BEGIN [Step 6: ](Build the Automation)]

1. Extract data template
- Search for the activity **Extract data** and add the activity **Extract Data (Template)** to the automation flow.
> ### What is going on?
1. Navigate back to Application Development and select **Extract Invoice Data** automation tab.

!![Automation](026.png)

2. Extract data template. In Automation Details, under Tools, in search field, type **Extract data**.

> You can extract data with Document Information Extraction using the chosen document template and given PDF file.

!![19-png](19.png)
!![Automation](027.png)

3. Drag and drop the activity **Extract Data (Template)** to the automation flow.

!![Automation](028.png)

4. Select the activity. Maintain the parameters for the activity as following:
- Under Document Schema: select your Schema
- Under Document Template: select your Template
- Under `documentPath`: choose `FilePath`

!![Automation](029.png)

5. You have already created the data type **Invoice** in Step 2. Now, you will create variable of the type **Invoice**.

6. Click on the canvas. Search for the datatype **Invoice**, located under the **Data Types** section.

!![Automation](030.png)

- Maintain the parameters for the activity as shown below.
7. Drag and drop the data type **Invoice** into the automation flow.

!![20-png](20.png)
!![Automation](031.png)

2. You have already created the data type **Invoice** in Step 2. Now, you will create variable of the type **Invoice**.
8. Select **Create Invoice variable**. In the Input Parameters, under value, choose **Create Custom Data**.

- Search for the datatype **Invoice**. You will find it under the **Data** section.
!![Automation](032.png)

!![24-png](24.png)
9. Choose the Edit button to map the parameters:
- `DocumentNumber` to the extracted invoice data from the activity Extract Data (template),
- Repeat the same for `GrossAmount` and `SenderName` and map it to the corresponding fields of `extractedData`.

- Drag and drop the data type **Invoice** into the automation flow and select **Create Custom Data** in the parameter **value**.
!![Automation](033.png)

!![25-png](25.png)
10. Rename the output parameter to `myinvoiceData`.

- Choose the Edit button (pencil icon) to map the parameter `DocumentNumber` to the extracted invoice data from the activity **Extract Data (template)**.
11. The final input and output parameters of **Create Invoice Variable** looks as below.

!![26png](26.png)
!![Automation](034.png)

- Repeat the same for `GrossAmount` and `SenderName` and map it to the corresponding fields of
`extractedData`.
12. Print the invoice data using the activity **Log message**.

- Rename the output parameter to `myinvoiceData`.
> With this activity you generate a log message within the tester and the trace file, which is useful for setting up an automation. By default, a log will be "Information".

The final input and output parameters of **Create Invoice Variable** looks as below.
13. Click on canvas, search for **Log Message** activity and drag and drop it into the automation flow.

!![My-invoic-eData](MyinvoiceData.png)
!![Automation](035.png)

3. Print the invoice data using the activity **Log message**.
14. Select **Log Message** activity. In Input Parameters under message add `myinvoiceData` value.

4. Add **Log Message** activity and the `myinvoiceData` to the value.
!![Automation](036.png)

> ### What is going on?
> With this activity you generate a log message within the tester and the trace file. Useful for setting up an automation. By default, a log will be "Information".
15. Select **Save**.

!![Log-Message](LogMessage.png)

[DONE]
[ACCORDION-END]

[ACCORDION-BEGIN [Step 8: ](Passing the Parameters Outside the Automation)]
[ACCORDION-BEGIN [Step 7: ](Passing the Parameters Outside the Automation)]

1. Select the **End** and pass the variable `myinvoiceData` to the output parameter `InvoiceDetails` which you have created in Step2.
1. Select the **End**. Pass the variable `myinvoiceData` to the output parameter `InvoiceDetails`, which you have created in Step 2.

!![End-parameter](Endparameter.png)
!![Automation](037.png)

2. **Save** the automation.

[DONE]
[ACCORDION-END]

[ACCORDION-BEGIN [Step 7: ](Test the Automation)]
[ACCORDION-BEGIN [Step 8: ](Test the Automation)]

1. Select Test button and enter the `Filepath` where the invoice document is stored locally on your machine.

!![Link text e.g., Destination screen](Test.png)
!![Test](038.png)[Create an automation to extract Invoice Details](spa-dox-create-automation)

2. The automation opens the Invoice Document, extracts data and prints the details i.e Document number, Gross amount and Sender name.

!![Test-Results](TestResults.png)
!![Test](039.png)

3. Your automation is built successfully.

Expand All @@ -254,15 +283,15 @@ primary_tag: software-product>sap-process-automation

[ACCORDION-BEGIN [Step 9: ](Mapping of Parameters to the Automation and Process )]

1. Navigate to the process **Get Invoice Details** and select the automation **Extract Invoice Data**.
1. Navigate to the **Get Invoice Details** process. and select the automation **Extract Invoice Data**. Map the input parameter of the automation to the form parameter `FilePath`.

2. Map the input parameter of the automation to the form parameter `FilePath`.
!![Mapping](040.png)

!![Mapping-Parameters](MappingParameters.png)
2. Select **Save**.

3. Your process looks like below once you complete this tutorial.
3. Once this tutorial is completed, the process looks as following.

!![Process-automation](Process-Automation.png)
!![Mapping](041.png)

[VALIDATE_1]
[ACCORDION-END]
Expand Down