Procesio Forms & Tasks Designer

https://docs.procesio.com
Admin
A tool within Procesio for creating web forms, collecting user information, and streamlining...
Tokens:6,490
Snippets:36
Trust Score:8.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Creating a Data Model from JSON Example

Source: https://docs.procesio.com/platform-tricks

This JSON example demonstrates the structure for creating a data model in Procesio, including nested objects for owner details. It can be used as a template for defining custom data structures.

```JSON
{
  "model": "prius",
  "manufacturer": "toyota",
  "year": 2021,
  "mileage": 40129.4,
  "owner": {
    "name": "john smith",
    "city": "boston"
  }
}
```

--------------------------------

### Sample JSON Payload for Webhook

Source: https://docs.procesio.com/configure-and-assign-webhook-example

This JSON object illustrates the structure of the data sent from Postman to a procesio webhook, demonstrating the expected input format for process triggering.

```JSON
{ name "john doe", age 30 }
```

--------------------------------

### JSON Mapper Example for Test Action

Source: https://docs.procesio.com/updates

An example JSON payload used to test JPath configurations within the Procesio JSON Mapper, demonstrating a typical user address structure. This snippet helps validate how the 'Test Action' feature processes structured data.

```JSON
{
  "firstname": "john",
  "lastname": "doe",
  "age": 26,
  "address": {
    "streetaddress": "main street",
    "city": "new york",
    "postalcode": "6300192"
  }
}
```

--------------------------------

### Procesio Run Endpoint Request Body Example

Source: https://docs.procesio.com/process-custom-response

Provides an example of the JSON request body required when calling the Procesio 'run' endpoint synchronously to trigger a process and obtain a custom response.

```JSON
{
  "payload": []
}
```

--------------------------------

### JSON Jarray Format for URL Data Source

Source: https://docs.procesio.com/create-form

Example of the required JSON array format for data retrieved from a URL endpoint. Each item in the array must contain 'label' and 'value' properties, providing both display text and corresponding values, respectively.

```JSON
[ { "label": "item 1", "value": "value1" }, { "label": "item 2", "value": "value2" }, { "label": "item 3", "value": "value3" } ]
```

--------------------------------

### JSON Data Source for List of Primitives

Source: https://docs.procesio.com/list-and-table-control

Example JSON arrays for a list control when 'add multiple fields' is off. The data source is expected to be a list of primitive values (strings, numbers, booleans).

```JSON
["first entry", "second entry"]
```

```JSON
[1, 2, 3]
```

```JSON
["first entry", 2, "3", false]
```

--------------------------------

### Get Current Date in Procesio Process

Source: https://docs.procesio.com/your-first-process

This snippet describes how to obtain the current date within a Procesio process using the 'today' platform action. It involves declaring an output variable of type 'datetime' to store the result and connecting the action to the process start/stop points.

```Procesio Process Flow
1. Identify 'today' action in 'datetime' folder.
2. Declare output variable 'currentdate' of type 'datetime'.
3. Connect 'today' action to 'start' and 'stop' nodes.
4. Validate the flow.
5. Run process to verify 'currentdate' value.
```

--------------------------------

### JSON Data Source for Array of Objects

Source: https://docs.procesio.com/list-and-table-control

Example JSON array for a list control when 'add multiple fields' is on. The data source is expected to be an array of objects, where each object represents an item with multiple fields.

```JSON
[
  { "id": 1, "name": "john doe", "address": "123 main st" },
  { "id": 2, "name": "jane doe", "address": "456 elm st" }
]
```

--------------------------------

### Configure REST API Credential with API Key Authentication

Source: https://docs.procesio.com/rest-api-credential

Guide to setting up a REST API credential with API Key Authentication in procesio. It covers specifying the API URL, an optional test endpoint, the API key ID (name), its value, and the location for including authentication details (headers, query params, or both).

```APIDOC
REST API Credential: API Key Authentication
  API URL: The base URL to which you want to make the request
  Test Endpoint: Add /info endpoint for your base URL (optional)
  Authentication Method: API Key
  Authorization Key: Fill in the ID (name) of your API key
  Value: Fill in the value of your API key
  Add To: If you need to include your auth details in the relevant part of the request, i.e., in headers, query params or both
  Test Connection: Verify configuration once all mandatory fields have values
  Save Configuration: Store the credential settings
```

--------------------------------

### Stepper Control for Multi-Step Forms

Source: https://docs.procesio.com/create-form

The Stepper control creates multi-step forms or guided processes, allowing users to progress through different stages. It ensures a structured and organized data collection process, ideal for complex surveys or multi-page data entry.

```APIDOC
StepperControl:
  Purpose: Create multi-step forms or guided processes within forms.
  Functionality: Allows form users to progress through different stages or sections of a form, ensuring a structured and organized data collection process.
  Configuration:
    - Step_Level_Settings: Select individual steps (e.g., Step1) to define settings at the step level, not at the stepper control level.
    - Task_Assignees: Sections can select assignees responsible for specific tasks or approvals. Users can be notified for data entry and submission. Assignee replacement allows multiple assignees and reordering via drag-and-drop. Note: Once the first user submits the assigned task, it will be considered completed for all other task assignees. Only workspace users are displayed in assignee selection lists.
  UsageTips:
    - Scenarios: Consider using a stepper when you have a form that involves multiple stages or sections, such as a multi-page survey or a complex data collection process.
    - Labeling: Label each step with descriptive titles to guide users through the process effectively.
    - Task_Assignment: Use task assignee to assign users to complete steps.
```

--------------------------------

### Form Control Data Source: Static List JSON Example

Source: https://docs.procesio.com/create-form

This JSON format is used to define options for form controls such as select inputs, checkboxes, or radio buttons when a static list data source is required. Each object within the array represents a single option, containing a 'label' for display to the user and a 'value' for internal data processing. It is crucial to ensure that all 'value' fields are unique across the options.

```JSON
[ { "label": "yes", "value": "yes" }, { "label": "no", "value": "no" } ]
```

--------------------------------

### Postman Configuration for Procesio Process Execution

Source: https://docs.procesio.com/running-a-process-with-api-keys

Illustrates how to set up a POST request in Postman to run a Procesio process. This includes specifying the base URL, endpoint, required headers (API key, workspace), and the JSON request body.

```APIDOC
Method: POST
Base URL: https://webapi.procesio.app
Example Endpoint: /api/projects/e6bb2d64-2f96-4e43-a84b-b25a08c0764d/run

Headers:
  - key: <your_api_key_name>
  - value: <your_api_key_value>
  - workspace: <your_workspace_name> (e.g., "demo")

Body (raw, JSON):
{
  "connectionid": "string"
}
```

--------------------------------

### Procesio API Endpoint for Running a Process

Source: https://docs.procesio.com/running-a-process-with-api-keys

Defines the structure and parameters for the POST method used to trigger a Procesio process via its API, including path parameters, required headers, and the JSON request body schema.

```APIDOC
Endpoint: POST /api/projects/{id}/run

Parameters:
  - Path:
    - id (string): The process ID, required in the URL.
  - Headers:
    - workspace (string): The name of the workspace where the process resides.
  - Body (JSON):
    - connectionid (string): A string representing the connection ID.
```

--------------------------------

### Microsoft SQL Credential Configuration

Source: https://docs.procesio.com/sql-credential

Detailed parameters for setting up a Microsoft SQL Server credential in procesio, including server details, database connection, encryption, and authentication.

```APIDOC
SQL Credential Configuration:
  Name: Insert a name for the new configuration
  Type: SQL
  Description: Add details on the configuration (optional)
  MSSQL Configuration:
    Server Type: mssql
    Protocol Type: (implied)
    Server Name: hostname/ip to identify the location of the microsoft sql server database
    Database Port Number: server port for the microsoft sql server database
    Database Name: the name of the microsoft sql server database (optional, thus recommended)
    Encrypt: select to use encrypted communication with the database server
    Pooling: (implied)
    Trust Server Certificate: rely on the certificate provided by the server to verify secure data transfer
  Authentication:
    Username & Password: the user name & password for the microsoft sql server connection
  Whitelist IP: 20.126.178.130 (procesio outbound IP)
```

--------------------------------

### Procesio Supported Data Types and Mapping Rules

Source: https://docs.procesio.com/working-with-data-types

This section outlines the various data types supported by Procesio, including primitive types, custom data models, and the special 'file' data type. It also details the compatibility and mapping rules for each type when assigning values to action properties, highlighting exceptions and specific format requirements.

```APIDOC
Data Types:
  - Primitives:
    - string
    - integer
    - float/double
    - boolean
    - datetime
    - json
    - guid
  - Custom Data Model: object (custom data type with one or more attributes)
  - File: A data model that contains the following attributes:
    - path: path to file (set on upload)
    - name: name of the file
    - mime type: file type
    - size: file size
    - hash: file checksum

Mapping Rules:
  - General Compatibility:
    - Variable type must match the expected property type of the action.
    - Exception: Conversion from integer to float is allowed.
    - Exception: Conversion from any primitive data type to string is allowed.
    - List<> type: Cannot map a process variable declared as a single value to a process variable declared as a list, even if they have the same data type.
  - string property:
    - Can map any type of variable and concatenations.
    - Exception: A data model cannot be mapped directly to a string property.
    - Mapping of a data model attribute to a string property is allowed.
  - integer property:
    - Can map only integer variables.
  - float property:
    - Can map only float and integer variables.
  - boolean property:
    - Can map only boolean variables.
  - datetime property:
    - Can map only datetime variables and hard coded values with the format dd/mm/yyyy hh\:mm\:ss.
  - data model property:
    - Can map only a data model variable of the same type (e.g., a "customer" property accepts only the "customer" data type as a variable).
  - file property:
    - Can map only another file variable.
```

--------------------------------

### Procesio Variable Usage Syntax

Source: https://docs.procesio.com/working-with-data-models

This snippet illustrates the syntax for declaring and referencing custom data model variables within Procesio processes. It shows how a variable of a custom data type is declared and how its attributes can be accessed in action configurations.

```APIDOC
Variable declaration example:
<country var>

Variable usage example:
<%country var%>

Accessing data model attributes in action configuration:
<%variable name%> <data model attribute name>
```

--------------------------------

### Configure REST API Credential with Basic Authentication

Source: https://docs.procesio.com/rest-api-credential

Instructions for configuring a REST API credential using Basic Authentication in procesio. This includes defining the API URL, an optional test endpoint, username, password, and where to include authentication details (e.g., query params).

```APIDOC
REST API Credential: Basic Authentication
  API URL: The base URL to which you want to make the request
  Test Endpoint: Add /info endpoint for your base URL (optional)
  Authentication Method: Basic
  Name: Enter basic authorization user name of the REST API web service
  Password: Enter the password of the basic authorization protocol
  Add To: If you need to include your auth details in the relevant part of the request, i.e., query params
  Test Connection: Verify configuration once all mandatory fields have values
  Save Configuration: Store the credential settings
```

--------------------------------

### Configure Call API Action for Product Details (Nintendo Graph API)

Source: https://docs.procesio.com/process-custom-response

Details the configuration for a 'Call API' action within Procesio to fetch product details from the Nintendo Graph API. It specifies the base URL, HTTP method, endpoint, and required headers for the API call.

```APIDOC
Base URL: https://graph.nintendo.com/
Method: GET
Endpoint: ?operationName=productsBySku&variables=%7b%22locale%22%3a%22en-us%22%2c%22personalized%22%3afalse%2c%22skus%22%3a%5b%227100067229%22%2c%227700013808%22%5d%7d&extensions=%7b%22persistedQuery%22%3a%7b%22version%22%3a1%2c%22sha256Hash%22%3a%2243251a1c4b24ba477cc4e12a8fd13e03bcc4dfee223ad0bb8c3792f001a6ebe6%22%7d%7d
Headers:
  Content-Type: application/json; charset=utf-8
```

--------------------------------

### Process Variable Properties Definition

Source: https://docs.procesio.com/working-with-process-variables

Defines the configurable properties of a process variable within the Procesio platform, including its name, data type, default value, and flags for single/list, input, and output behavior. These properties dictate how the variable behaves and is used throughout a process.

```APIDOC
ProcessVariable:
  properties:
    name:
      type: string
      description: Name of the variable.
    data_type:
      type: string (primitive or custom)
      description: The type of data the variable holds.
    default_value:
      type: any
      description: The value used if no other value is set at runtime.
    single_value_or_list_flag:
      type: boolean
      description: Indicates if the variable holds a single value (default) or a list of values.
    input_flag:
      type: boolean
      description: If true, the variable's value is expected to be set when starting the process.
    output_flag:
      type: boolean
      description: If true, the variable's value is expected to be set after running the process.
```

--------------------------------

### SMTP Inbound Credential Configuration

Source: https://docs.procesio.com/smtp-inbound-credential

Details the parameters required to configure an SMTP Inbound Credential for incoming email, including server details, protocol, port, encryption, and authentication. It also outlines steps for testing and saving the configuration.

```APIDOC
SMTP Inbound Credential:
  server name/ip: string (e.g., mail.example.com) - Incoming email configuration server name or IP.
  protocol type: string (imap | pop3) - Select IMAP or POP3. IMAP maintains emails in your account, POP3 removes them once the operation is completed.
  port number: integer - Outgoing server port.
  encryption: string (none | tls | auto) - Encryption type.
  username: string - Enter your username.
  password: string - Enter the associated password.
  test connection: action - Test the configuration once all mandatory fields have values.
  save configuration: action - Save the configuration.
```

--------------------------------

### Procesio Form Options Data Format

Source: https://docs.procesio.com/updates

Defines the required structure for options that can be set directly from process output for Procesio forms. Options must conform to a specific object format, either using 'name' or 'label' alongside a 'value'.

```JSON
{
  "type": "object",
  "oneOf": [
    {
      "properties": {
        "name": { "type": "string" },
        "value": { "type": "any" }
      },
      "required": ["name", "value"]
    },
    {
      "properties": {
        "label": { "type": "string" },
        "value": { "type": "any" }
      },
      "required": ["label", "value"]
    }
  ]
}
```

--------------------------------

### Convert Weekend Boolean to Custom Message in Procesio Process

Source: https://docs.procesio.com/your-first-process

This snippet explains how to transform the boolean output of the 'is weekend' action into custom 'yes'/'no' string messages. It utilizes 'decisional', 'map process data', and 'join' actions to implement conditional logic and merge branches.

```Procesio Process Flow
1. Declare output variable 'message' of type 'string'.
2. Use 'decisional' action to create branches based on 'isweekend' (true/false).
3. For 'true' branch, use 'map process data' to set 'message' to 'yes'.
4. For 'false' branch, use 'map process data' to set 'message' to 'no'.
5. Use 'join' action to merge the decisional branches.
6. Validate and run the process to see the 'message' output.
```

--------------------------------

### JSON Mapper Query for Extracting Regular Price

Source: https://docs.procesio.com/process-custom-response

Illustrates the JSONPath query used in the Procesio JSON Mapper action to extract the 'regularPrice' from a nested JSON structure, specifically from the first product's prices.

```JSONPath
$data.products[0].prices.minimum.regularPrice
```

--------------------------------

### List Component for Data Display

Source: https://docs.procesio.com/create-form

The List component is a fundamental element for organizing and displaying collections of items. It is ideal for scenarios like product catalogs, task lists, or contact directories, streamlining data presentation and enhancing user experience with dynamic and interactive lists.

```APIDOC
ListComponent:
  Purpose: Organize and display collections of items with efficiency and clarity.
  UseCases: Product catalogs, task lists, contact directories.
  Features: Streamlines data presentation, enhances user experience, intuitive interface, robust functionality, dynamic and interactive lists tailored to specific requirements.
```

--------------------------------

### Tabs Control for Content Organization

Source: https://docs.procesio.com/create-form

The Tabs control organizes related content within a single container, allowing users to switch between different sets of information. It helps manage and present complex information efficiently by segmenting it into distinct, navigable sections.

```APIDOC
TabsControl:
  Purpose: Organize related content and allow users to switch between different sets of information within a single container.
  Properties:
    - General: Allows you to manage tabs within the control.
```

--------------------------------

### Configure REST API Credential with No Authentication

Source: https://docs.procesio.com/rest-api-credential

Details on setting up a REST API credential in procesio that does not require any authentication. It covers specifying the base URL, an optional test endpoint, and the process for testing and saving the configuration.

```APIDOC
REST API Credential: No Authentication
  API URL: The base URL to which you want to make the request
  Test Endpoint: Add /info endpoint for your base URL (optional)
  Authentication Method: No Authentication
  Test Connection: Verify configuration once all mandatory fields have values
  Save Configuration: Store the credential settings
```

--------------------------------

### Columns Control for Layout Structuring

Source: https://docs.procesio.com/create-form

The Columns control allows structuring forms with multiple columns, useful for arranging fields side by side. It optimizes space and improves overall form layout, enhancing usability and presenting information in a structured and visually appealing manner.

```APIDOC
ColumnsControl:
  Purpose: Structure forms with multiple columns, arranging form fields side by side.
  Benefits: Optimizes space, improves overall form layout, enhances layout and usability, presents information in a structured and visually appealing manner.
  UsageTips:
    - Scrolling: If 4+ columns are defined, hold down the Shift key and scroll using the mouse to scroll left or right.
    - Grouping: Consider using columns when you want to present related form fields side by side (e.g., first name and last name, or date and time).
    - Responsiveness: Test your form on various devices to ensure that the column layout remains user-friendly and responsive.
```

--------------------------------

### Formbuilder Theme Properties

Source: https://docs.procesio.com/themes

This specification outlines the customizable properties available for themes in procesio's Formbuilder. It includes color definitions, font settings, and styling options for various input and display elements to ensure visual consistency and brand alignment.

```APIDOC
Theme Properties:
  Colors:
    primary: #0039e3
    primary variant: #2a64ff
    on primary: #f7f9fc
    error: #f42727
    on error: #f2f5fa
    success: #409920
    on success: #f2f5fa
    info: #0671d6
    neutral 900: #0f1427
    neutral 800: #141a32
    neutral 700: #202b47
    neutral 600: #2c3a5c
    neutral 500: #8d9bb5
    neutral 400: #c3cee2
    neutral 300: #e3e8f3
    neutral 200: #ecf1f8
    neutral 100: #f2f5fa
    neutral 50: #f7f9fc
  Fonts:
    input font size: 14px
    input line height: 20px
    label font size: 12px
    label line height: 16px
    button font size: 16px
    heading font size: 21px
    heading line height: 25px
    paragraph font size: 15px
    paragraph line height: 22px
  Form Elements:
    form background color: neutral 50
    surface color: white
    padding: 16px
    gap: 20px
    link color: primary
    link decoration: none
    heading color: neutral 800
    paragraph color: neutral 800
    input:
      width: inherit
      height: 40px
      padding vertical: 10px
      padding horizontal: 8px
      label color: neutral 800
      input color: neutral 800
      placeholder color: neutral 500
      background color: neutral 50
      background color hover: neutral 100
      alternative background color: white
      alternative background color hover: neutral 50
      border radius: 4px
      border width: 1px
      border color: neutral 300
      border color focused: primary
      border color error: error
      outline width: 4px
    select: (properties similar to input)
    button: (properties similar to input)
    checkbox: (properties similar to input)
    radiobox: (properties similar to input)
    approval: (properties similar to input)
    file upload: (properties similar to input)
    section: (properties similar to input)
    list: (properties similar to input)
    columns: (properties similar to input)
    stepper: (properties similar to input)
    tabs: (properties similar to input)
```

--------------------------------

### Set Dynamic Default Values in Form URL

Source: https://docs.procesio.com/index

Demonstrates the pattern for adding dynamic default values to form fields directly in the URL before sharing. This allows pre-populating form fields by appending control names and their corresponding values as query parameters.

```URL Query String
controlname1=controlvalue&controlname2=controlvalue…&controlnamen=controlvaluen
```

--------------------------------

### Procesio API Endpoints for Custom Response

Source: https://docs.procesio.com/process-custom-response

Documents the two main API endpoints used in Procesio for handling custom responses: one for synchronous process execution and another for retrieving a custom response from a specific instance.

```APIDOC
POST https://webapi.procesio.app/api/projects/{id}/run
  Description: Executes a Procesio process synchronously, returning a custom response.
  Path Parameters:
    id (string): The ID of the project.
  Request Body:
    payload (array): Optional array for process input data.

GET https://webapi.procesio.app/api/projects/{id}/instances/{instanceid}/customresponse
  Description: Retrieves the custom response from a specific process instance.
  Path Parameters:
    id (string): The ID of the project.
    instanceid (string): The ID of the process instance.
```

--------------------------------

### File Upload Control Properties and Validation

Source: https://docs.procesio.com/create-form

This control allows users to upload files within a form. It provides options for specifying allowed file types, enabling multiple file uploads, setting validation requirements, and defining maximum file sizes. This ensures proper file handling and user input validation.

```APIDOC
FileUploadControl:
  Properties:
    allowed_file_types:
      type: string[]
      description: Select one or many file types from a predefined list or add custom extensions.
    allow_multiple_files_upload:
      type: boolean
      description: Set if the control will allow single or multiple file uploads.
    validation_required:
      type: boolean
      description: Makes the file upload control mandatory, requiring users to select a file. Ensures the form's submit button remains disabled until a file is selected.
    max_file_size:
      type: number (bytes)
      description: Set the maximum allowed size of each file that a user can upload.
```

--------------------------------

### Procesio Process Variables for Custom Response

Source: https://docs.procesio.com/process-custom-response

Defines the variables used within a Procesio process to handle product details, custom response prices, and status codes. These variables are crucial for data flow and output within the process.

```APIDOC
Variable Name: productDetailsJson
  Type: JSON
  Single Value: Yes
  Output: Yes

Variable Name: customResponsePrice
  Type: Double
  Single Value: Yes
  Output: Yes

Variable Name: statusCode
  Type: Integer
  Single Value: Yes
  Output: Yes (useful for debugging)
```

--------------------------------

### Section Control for Grouping and Visibility

Source: https://docs.procesio.com/create-form

The Section control allows grouping multiple form controls together. It supports assigning tasks to specific users, managing assignee replacements, and defining visibility rules to control who can see the section based on their role or custom criteria.

```APIDOC
SectionControl:
  Properties:
    task_assignees:
      type: User[]
      description: Select assignees responsible for specific tasks or approvals within the form. Users will be notified for data entry and submission.
    assignee_replacement:
      type: User[]
      description: Add multiple assignees for efficient task management. Supports reordering using drag-and-drop functionality. Note: Once the first user submits the assigned task, it will be considered completed for all other task assignees. Only users who are part of your workspace will be displayed.
    visibility:
      type: string (enum)
      description: Determine which users will see this section within the form.
      Options:
        - All Users:
            description: All users who open the form will see this section in a read-only view; they cannot enter data, only view it for informational purposes.
        - Task Assignees:
            description: Only users defined as task assignees see the section (need to submit data for this section).
        - Custom:
            description: Add any user who needs to see this section in a read-only view. Task assignees are added by default since they need to perform actions on the section, including data entry and submission.
```

--------------------------------

### Check if Date is Weekend in Procesio Process

Source: https://docs.procesio.com/your-first-process

This snippet details how to determine if a given date falls on a weekend using the 'is weekend' platform action. It requires an input date (from the 'today' action) and declares a boolean output variable 'isweekend' to store the result.

```Procesio Process Flow
1. Identify 'is weekend' action in 'datetime' folder.
2. Declare output variable 'isweekend' of type 'boolean'.
3. Chain 'is weekend' action to the 'today' action (using 'currentdate' as input).
4. Validate the flow.
```

--------------------------------

### Dynamic Table Rows Expected Data Source Structure

Source: https://docs.procesio.com/list-and-table-control

This API documentation defines the expected JSON structure for the data source used by the 'dynamic table rows' control. Each object within the array represents a row in the table, where keys correspond to column titles and values are the cell data. Nested objects under the 'children' key allow for hierarchical data representation within rows.

```JSON
{
  "columntitle": "value",
  "startedon": "value",
  "lastupdate": "",
  "submittedby": "",
  "children": [
    {
      "columntitle": "value child",
      "startedon": "value child",
      "lastupdate": "",
      "submittedby": ""
    }
  ]
}
```

--------------------------------

### Divider Control for Form Structure

Source: https://docs.procesio.com/create-form

The Divider control, found under the 'Structure' tab, provides visual separation within a form. Its role is to enhance readability by separating different sections, making the form easier for respondents to navigate and understand.

```APIDOC
DividerControl:
  Location: Under the 'Structure' tab.
  Purpose: Provide structure to your form.
  Benefit: Used to separate different sections of the form in order to make it easier to read by your respondents.
```
Tokens:
Raw