---
title: Service Integration Flow
slug: lowcode-en-pink/service-integration-flow
description: Learn how to access and utilize the service integration flows feature with this detailed document. Find specific items easily by applying filters through the menu. Discover how to fill registration fields, configure variables, register actions, and design
docTags: 
createdAt: 2021-10-27T21:55:34.000Z
---

Service integration flows, as the name implies, involve workflows that are executed based on system services, such as integrations and conversions, for example.

## How to access

1. Access the functionality through the menu Lowcode > Management > Integration Flow.

## Preconditions

1. Not applicable

## Filters

1. The following filter enables the user to restrict the participation of items in the standard feature listing, making it easier to find the desired items:
   - Keyword

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/a_IBh62T_wNSxeEwLw19N_image.png "Figure 1 - Search Screen")

## Items List

1. The following cadastral fields are available to the user to make it easier to identify the desired items in the standard feature listing: **Name, Description, Flow Application, Version**, and **Block date**.

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/SwvnIfCPGN8g_lpJ_MYLh_image.png "Figure 2 - Listing Screen")

## Filling in the Registration Fields - Flow data

Through this tab, all basic information about the flow to be designed is defined.

1. To add a new flow, click on New > Integration services flow, as shown in the figure below:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/HZyABzPtgJoD2yAeWiWJN_image.png "Figure 3 - Registration Screen")

1. To add a new flow data, click on Add.
2. The following screen will be displayed:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/jq43ojopo6xKXaQFUW6HG_image.png "Figure 4 - Workflow Registration / Editing Screen, Flow Data tab")

1. Enter a **name** for the flow, a **description**, which **form** will start the flow (if applicable), and whether or not flow execution will persist. If the field **"Keep running the stream"** is checked, Lowcode will persist in the database on every instance of the execution of this flow.
2. The field **version** is incremented automatically by the system whenever a new version of the workflow is created.

## Variables

In this tab are configured the variables that will be used in the drawn flow. Variables are objects that can hold and represent a value or expression. Variables are associated with "names", called identifiers, during the runtime of the flow.

1. To add new variables, choose the tab for the same and then click on "Add".
2. The following screen will be displayed:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/eBEwum6kp63HzdMKPuW66_image.png "Figure 5 - Workflow Registration / Editing Screen, Variables tab")

1. Fill in the fields:
   - Variable's name;
   - Description;
   - Whether it will be stored in the database;
     - This option will store the value of the variable internally within the **Lowcode **data model, so it will retain the value during the execution of the tasks
   - Whether it is a return variable;
     - This option will cause **Lowcode **to return the variable at the end of the flow run.
   - Whether it is a values list;
   - If it is an input variable in the flow interface;
     - This option allows the variable to be "injected" into the business process linked to this flow.
   - If it is an output variable in the flow interface;
     - This option causes the variable to have the value filled when the business process bound to the flow is executed.
   - The variable type;
     - If it is a Java object, enter the corresponding Java class;
     - If it is a business object, inform what its respective application is and what the registered name of the business object;
   - The initial value of the variable, whether constant or script.
     - If the value is a constant, it will never be changed during the flow execution, regardless of the operations performed by the user.
2. To edit a variable, select the desired variable, click on "Edit", make the necessary changes, and click on Update to complete the edit.
3. To remove a variable flow, select the desired variable, click on "Remove", and confirm the deletion.

:::hint{type="warning"}
**ATTENTION:**

To save the changes effectively, click on "**Save**" on the top bar. 
:::

## Actions

Through this menu, it is possible to register the actions that will be run in the workflow.

The actions are based on scripts programmed in the **Rhino** language.

1. To include an action, choose the tab for the same and then click on go to "Add".
2. The following screen will be displayed:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/r0X6-n-q6nuUUO6nrMhVI_image.png "Figure 6 - Register/Edit Workflow, Actions tab")

1. Fill in the fields:
   - an **identifier** for the action;
   - the literal **name** for the action;
   - and the **script** that will be run when the action is triggered.
2. To edit an action, select the action you want, click on "Edit", make the necessary changes, and click on "Update" to complete the edit.
3. To remove an action, select the action, click on "Remove", and confirm the deletion.

:::hint{type="warning"}
**ATTENTION:**

To save the changes effectively, click on "**Save**" on the top bar. 
:::

## Diagram

The diagram of a service flow does not have the same **"Task"** components as a process flow. i.e., you cannot use the **"Human Task"** components for **"Sub Process Workflow"**.

For a business process, we have, in addition, these components sections:

- **Connectors**: components used to perform operations related to the database.
- **Components**: varied components for performing various tasks.
- **Transformers**: components for converting variable types.
- **CITSmart**: components used for integration with an external Citsmart system.

The other components present in the palette resemble the components of a "Process Flow". Further information regarding the functionality and use of each of the components can be found in the Developing Applications.

1. To design a diagram, choose the tab for the same
2. The following screen will be displayed:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/g_N5G1e-09zR11BjfJyJ2_image.png "Figure 7 - Register/Edit Workflow, Diagram tab")