# Getting Started

This tutorial is an introduction into configuring [Straatos](https://cumuluspro.com/straatos). In particular, we will configure a process with a start event, a manual data entry step using Web Validation as well as an automated processing step and a script.

At the end of this tutorial, you should be able:

* To create a new process.
* Use the CumulusPro Scan+Process*Lite*, Scan+Express and Mobile Capture as a starting point to a process.
* Use Web Validation in the process to validate documents by an operator.
* Use an automated module to process documents.
* Use the Process Designer to create a workflow.
* Use the Process Monitor to view documents in active processes.

### Prerequisites

As this tutorial focuses on the [Straatos Process](https://cumuluspro.com/straatos), we assume that you have already setup an Organisation and the Scan+Process*Lite*, Scan+Express or Mobile Capture clients.

{% hint style="danger" %}
**Ensure that you have created at least one (1) Document Type.**
{% endhint %}

### 1. Creating a new Workflow

In this step, we create a new workflow

1. Log in to the [CumulusPro Admin Panel](https://admin.cumuluspro.net/) with your credentials.
2. Open your organisation you want to create the workflow.
3. Click on 'Workflows'.
4. Click on the 'Create Workflow Configuration' tile.
5. Name the new 'Workflow Configuration' 'Tutorial Process' and then click on the tile.

Watch this video to see how a workflow is created:

{% embed url="<https://youtu.be/SiSoKVAN1bE>" %}

### 2. Adding Index Fields

In this step, we will add some index fields. The Index Fields created here are only available in the workflow and are separate to the index fields you may have created on your Document Types.

{% hint style="info" %}
If you want the Index Field values from your Document Type in the Scan or Mobile clients to be passed to your workflow, create an index field in the workflow with the same name as you created them in the Document Type.
{% endhint %}

1. Click on the + next to the 'Index Fields'.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_03_26_391.png?dc=201512290324-54)

2\. A new field 'NewField1' has been created.

3\. Add another two fields by repeating step 1 until your screen looks like this.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_03_30_042.png?dc=201512290328-12)

{% hint style="info" %}
If you have created too many fields or want to delete a field later, click on the blue x. This will remove the field from the workflow.
{% endhint %}

We are now going to rename the fields. For each field perform the following steps 1-3.

1. Click on the Index Field.
2. Change the field name to according to the table below.
3. Click 'Back' in the browser.

| Original Field | Display Name  | Field Name |
| -------------- | ------------- | ---------- |
| NewField1      | Email Address | email      |
| NewField2      | Name          | firstname  |
| NewField3      | Date          | date       |

### 3. Creating the Flow - Start Event

Watch this short video for an introduction:

{% embed url="<https://youtu.be/XabZW2OEI90>" %}

Click on the Design Process button.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_03_51_303.png?dc=201512290349-59)

This will open an empty Process Designer. On the left side, you find the steps that can be added to the process. We start by adding a Start Event.&#x20;

{% hint style="info" %}
A Start Event is the beginning of a workflow. This is where documents from Scan+ProcessLite, Scan+Express and Mobile Capture enter the workflow. Additionally, email import can as well be configured at a start event and third party integrations such as Zapier can use a start event to send documents to CumulusPro.
{% endhint %}

{% hint style="info" %}
A process flow can have multiple Start Event, one for each document type if necessary.
{% endhint %}

Click on the Start Event icon and drag it onto the design canvas: &#x20;

<div align="left"><img src="/files/-Mgddvrj0g_5uq-0beln" alt=""></div>

Your screen should now look like this:

<div align="left"><img src="https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_00_415.png?dc=201512290358-46" alt=""></div>

To edit the properties of the Start Event, click on the Settings icon.

<div align="left"><img src="/files/-MgdfAKwDHkWt0hyp-9M" alt=""></div>

This opens a pop up showing the settings for the Start Event.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_19_457.png?dc=201512290417-73)

Select the Document Type from the Dropdown. In the screenshot above, the document type 'Document' has been selected.

### 4. Adding a User Task

Now, having a Start Event where documents get into the workflow, let's add a User Task to the workflow. There are two ways this can be done, both described below. You will only need to perform one.

Video on how user tasks are created:

{% embed url="<https://youtu.be/F0wdm4-kpXw>" %}

Click on the Start Event. Select the 'Append User Task'.

<div align="left"><img src="https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_29_039.png?dc=201512290427-10" alt=""></div>

Place the User Task on the canvas like this:

<div align="left"><img src="https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_30_1510.png?dc=201512290428-12" alt=""></div>

Give the User Task a name 'Data Entry'.

Now that we have a user task, we need to assign a user to this task. For each User Task in the workflow, there is a role with the same name in the 'Authentication' section of the Organisation.

#### Add a New Account

1. Goto the Organisation Level in Admin Panel.
2. Click on 'Authentication'.
3. Click on 'Accounts'.
4. Click on 'Create Account'.
5. Enter a username (email address).
6. Enter a password.

#### Add an Account to the Workflow Step

1. Goto the Organisation Level in Admin Panel.
2. Click on 'Authentication'.
3. Click on 'Roles'.
4. Click on 'Data Entry' (the name of the step we created above).
5. Tick the account that should have access to the 'Data Entry' step.

The user has now access to the workflow step 'Data Entry'. However, if you haven't done yet so, you will need to give this user as well access to MyHome.

#### Access to My Home

MyHome is where a workflow user sees all the workflows and steps they have access to. If you do not have given those rights before. Follow the steps below:

1. Goto the Organisation Level in Admin Panel.
2. Click on 'Authentication'.
3. Click on 'Roles'.
4. Create a new Role and call it 'MyHome' and open the Role.
5. Tick the account that should have access to the 'MyHome' step.
6. Under Functions click on 'My Home'.
7. Under Document Types click on the document type the user should have access to.

#### Add an End Event

Click on the User Task 'Data Entry' and click on the 'End Event'.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_31_5411.png?dc=201512290430-15)

Drop the End Event onto the canvas.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_33_1012.png?dc=201512290431-7)

Now you have a complete workflow with a User Task. At this stage, the workflow does not do much, it just displays the document to a user, but afterwards, does not do anything with it. So, lets add a task to send the document via email.

On the left side, click on the Service Task and drag it over the line between the 'Data Entry' and 'End Event'.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_40_5913.png?dc=201512290439-40)

Drop the Service Task on top of the line and the step will be inserted there as shown in the screenshot below:

Name the Step 'Send Document'.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_42_2314.png?dc=201512290440-10)

Click on the step 'Send Document' and then onto the 'Settings' icon. From the actions dropdown, select the 'SendGrid Send Email'.

Your screen should look like this:

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_44_1115.png?dc=201512290442-66)

For the 'To Email Address', we want to use the email address of the Index Field 'email' we created earlier.

1. Click into the field 'To Email Address'.
2. Click onto the dropdown 'Insert Field at Cursor'.
3. Select 'email'.
4. For the 'From Email Address' enter the sender email address. For example '<noreply@cumuluspro.com>'.
5. For 'Subject' enter 'Your Document'.
6. For 'Text Body' Enter the below text:\
   `Hi {firstname},`\
   `Here is your document.`\
   `Regards,`\
   `The CumulusPro Team`
7. For 'Add Attachment' select 'Original Document'.
8. Close the pop-up box by clicking the x on the top right.

Now we are are ready to publish and test the process flow.

### Publish and Test the Process Flow

Click on 'Publish Workflow'.

<div align="left"><img src="https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_04_55_2916.png?dc=201512290453-45" alt=""></div>

One the workflow is successfully published, the date and time of the publishing appears next to the workflow.

{% hint style="info" %}
Any changes to the workflow will need to be published in order to be active in production. This includes adding, removing of index fields.
{% endhint %}

Now, submit a document from one of the Scan or Mobile Clients for the Document type specified.

### 5. Workflow Monitor & Processing Documents

After having submitted a document, you may want to see the document in the workflow. This section show you how to see the document in the workflow.

{% embed url="<https://youtu.be/-tMSYTbGyWI>" %}

Once the workflow is published, you can enter the monitor either in the Designer screen as shown below.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_05_30_4717.png?dc=201512290529-50)

Or on the workflow configuration, as shown below.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_05_31_5519.png?dc=201512290530-60)

The Process Monitor displays the same process flow as in the designer. Under each workflow step, the number of documents currently in the step are visible.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_05_47_5120.png?dc=201512290546-49)

To view the details of the documents in a particular step, click on the step and a pop up displays the details of the document.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_05_49_3921.png?dc=201512290547-99)

To see a preview of the document, click on a document and a viewer opens to see the documents.

![](https://dzf8vqv24eqhg.cloudfront.net/userfiles/3385/5046/ckfinder/images/2015_12_29_05_50_4822.png?dc=201512290549-136)

The document is currently ready in the User Task 'Data Entry'. In this section, we are going to process the document.

1. Log Out from Admin Panel.
2. Enter the username and password for the 'Data Entry' operator created earlier.
3. You will now be logged into 'My Home'.
4. At the bottom left, select the process ' Tutorial Process' and then click on 'Data Entry'.
5. The Web Validation client will be opened and you see the document with the index fields at the right.
6. Enter a valid email address where you want the document to be sent to.
7. Enter a first name that appears in the greetings line of the email.
8. Press the 'Complete' button on the top left.
9. The document is then processed by the workflow and the document is sent to the email address entered.
10. Check the email received as well as the document in the Monitor (which is now in the end event).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.cumuluspro.net/tutorials-and-best-practices/straatos-tutorial-getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
