Create a RobinSkill Output

The purpose of RobinSkill Outputs are designing what data is displayed in the Human-in-the-Loop application.


A RobinSkill Connection is required to create a RobinSkill Output.

Create an Output for a RobinSkill in Hero Platform_

  1. Open Hero Platform_.
  2. Open Integration from the navigation menu and select Outputs.

  3. Click Create New Output.

  4. Give the Output a name and select your RobinSkill Connection.
    • Enter a name for the Robin Skill.
    • Enter a description for the Robin Skill. 
    • Select the skill status:
      • Published - Appears in the Robin application.
      • Unpublished - Does not appear in the Robin application.
    • Select the Robin Output's schema version.
    • Enter the field names under the field mapping table.
      • When changing the schema for the RobinSkill Output, the schema version number is also changed and displayed.
      • This is the only section where a RobinSkill Output schema can be created or edited.
    • Click Next.



  5. The task list editor defines the headers displayed for each task. These headers are sortable in the Robin application to allow for better organization and priorities. 
    At least one table header must be selected with a maximum of six.
    • Under Tuple fields, select the tuple fields to be used as Robin task list table headers.
    • Under Robin 'Task List' table headers, enter a title to be displayed in as a header for each field.
    • Click Next.


  6. The filters editor defines which Robin Tasks are displayed for specific Robin users. This feature also prevents Robin users from seeing tasks assigned to other teammates.
    • Select a field name for Robin users.
    • Select the filter type for each field:
      • Equals - The field value is the same as the selected filter value.
      • Not Equals - The field value is not the same as the selected filter value.
    • Select the filter values:
      • Empty - The task lists displays tasks unassigned to a specific user.
      • Robin user in Context - The task list displays assigned tasks to the user in context in Robin.
      • Empty AND Robin user in Context - The task list displays both tasked assigned to the user as well as unassigned tasks.
    • Mark the Read Only box to disable the ability to make changes to this filter by the user in the Robin application. 
    • Click Next.


  7. The schema editor defines how each field box is displayed and how they operate.
    • Confirm or enter a label name for each field.

      The label "Status" is a reserved keyword and should not be used as a label name.

    • Select the UI type for each field. (Based on the data type of the field.)
    • Select the editability for each field.
      • Read only - The data in read only fields are for display only and cannot be edited.
      • Optional - The data in optional fields can be edited. A task can be completed even if the field remains empty.
      • Required -  The data in required fields can be edited. A task cannot be completed if the field remains empty.
      • Dynamic - Configure the editability of the field with a logical operator.
        • Select dynamic under Editability and click the gear icon to configure.
        • Click Add field and select a field, a logical operator, and a value field.

          Logical operators available by data type:

          • String

            • Equals

            • Not Equals

            • Is Empty

              • Deactivates the Value field

            • Is Not Empty

              • Deactivates the Value field

          • Numerics (Long, Double, Big Decimal)

            • Equals

            • Not Equals

            • Greater Than

            • Less Than

            • Is Empty

              • Deactivates the Value field

            • Is Not Empty

              • Deactivates the Value field

          • Boolean

            • True

              • Deactivates the Value field

            • False

              • Deactivates the Value field

          • Dates

            • Not supported for Dynamic Configuration

          • Binary
            • IsEmpty
            • IsNotEmpty
          • List[Any data type], PageBoundingBox
            • Not supported
          • Field data types of logical operations must match.
            • (String → Operator → String) or (Long → Operator - > Long)
          • Multiple logical operations can be added for a Robin Output field. 
          • Editability for fields with dynamic editability is applied based on the conditions configured. If a Human-in-the-Loop user makes any changes to the fields used in these conditions, the conditions are re-evaluated and the new editability options are applied to the dynamic field.
          • All Human-in-the-Loop UI Components except PageBoundingBox and File can be configured with dynamic editability.
        • After the logical operations have been set, configure the editability:

          • Editability when a condition is false - If any false result is returned, use the selected editability.
            • Read only - The data in read only fields are for display only and cannot be edited.
            • Required - The data in required fields can be edited. A task cannot be completed if the field remains empty.
            • Optional -The data in optional fields can be edited. A task can be completed even if the field remains empty.
            • Not visible - The field is not displayed in Robin.
          • Editability when all conditions are true - If no false results are returned, use the selected editability.
            • Required - The data in required fields can be edited. A task cannot be completed if the field remains empty.
            • Optional -The data in optional fields can be edited. A task can be completed even if the field remains empty.
            • Not visible - The field is not displayed in Robin.

          Dynamic Fields and Visibility

          When conditions are met for a dynamic field with the selection of "Not visible", the field is not displayed on the Robin task details form.

          All visible fields on the same row, as shown in the layout editor, right of the non visible field are shifted to the left. 

          Automation Hero recommends:

          • Position dynamic fields with a visibility condition to the right of fields in the same row that do not have a visibility condition. This recommendation is so that Robin users are not confused by shifting fields. 
          • Be aware of circular references. A visible field depending on a non-visible dynamic field might cause the Robin user to be in a locked situation. 
      • Click the gear icon if Review Field was selected as the UI type for a field.
        • Add the corresponding coordinates and confidence fields to link the field containing the extracted value with the bounding box in the document preview.
          • Select the RobinSkill Output field that corresponds the the review field's confidence score. (Double)
          • Select the RobinSkill Output field that corresponds the the review field's page coordinates. (Tuple)
            • Only supports relative coordinates.  
        • Extraction confidence classification
          • Enter optional values (Double) to set the low and high confidence scores for the review field.
          • Choose to have the result displayed as either labels or icons. 
            • The choice of label/icon is per field. It is possible to have one review field displaying a label and another review field displaying an icon.



        Note: Review Field UI type can also have dynamic properties with the same options as other dynamic field types.

        To save, click OK.


                       Click Next.




    Robin Schemas Informational Chart by Value Type


  8. The layout editor defines where each field box is displayed in the Robin application and how large the fields are.
    • Drag and drop each of the field names on the left into the layout editor to assign where each field is displayed in the Robin application.
      • Up to four fields and be added to each line.
      • Fields can be extended horizontally to take multiple slots on the same line or vertically to take up multiple slots on separate lines.
      • The field boxes for review field's confidence score and coordinates selectable but not required to be added to the layout editor. These fields are displayed as the selected label or icon above the corresponding review field.
    • At the top of the editor, select a task header. (Required)
    • If needed, add custom components
      • To add a Robin custom component:
        • Click Add custom component.
        • Click Choose file and select the component bundle .zip file from the file system.
        • Verify the component name and version number. Click OK.
      • The new custom component is displayed in the list of unused fields and can be dragged and dropped into the layout editor. 
      • Permanently remove a custom component by clicking the X by its name in the unused field section.
      • Replace a custom component with a new one by first removing it and then uploading a new ZIP file.
    • Click Next.



  9. Select the users that have access to the Robin Skill.
    • One or more users can be selected to have access to the Robin Skill.
    • The Hero Platform_ administrator has access to the Robin_Skill by default.
    • Click Save to finish saving the RobinSkill Output.

        

Access the Robin Application

In a web browser address bar, type: <Your Hero Platform_ URL>/robin-app

After creating a RobinSkill Output, the skill is active in the Robin application. Opening and logging into the Robin application displays the skill name and the task headers. No data populates the skill until it has been used within a Flow.

Learn more in the Robin User's Guide.

Robin Schemas Informational Chart by Value Type

Value data typeUI typeHTML form in RobinValidation behavior in Robin

BIG DECIMAL

  • Decimal Number
  • Review Field
  • Text Field
  • Cannot except string values
  • Accepts negative values
BINARY
  • File
  • Document Review
  • Preview image of file
    • Downloadable
    • Upload file (Overwrites any existing file in task.)
      • Uploading a file is not available if set edibility set to Read Only.
      • File must be 100 MB or less.
  •  Full image of file displayed upon click.
    • Read only
    • Downloadable
  • File types supported:
    • pdf
    • jpg
    • jpeg
    • png
  • Document Review opens access for Review Field and PageBoundingBox UI type fields that require coordinate data from the document.
  • If two or more Document Review fields are added to a skill, Review Field and PageBoundingBox coordinate data is unavailable.
BOOLEAN
  • Checkbox
  • Select
  • Radio Button
  • Review Field
  • Checkbox
  • Dropdown and Radio button
    • Options: True / False

DATE_TIME
  • Date Field
  • Date Time Field
  • Date field w/ calendar selector
    • "Date Field" sets time at midnight server time.
    • "Date Field" does not display a time even if the tuple contains a time value.
  • Date field w/ calendar and time selector
    • "Date Time Field" sets time at midnight server time if the tuple does not contain a time value.
    • "Date Time Field" has the following time zone options
      • Server Time Zone (Time zone of the Hero Platform_ server)
      • UTC (Universal Time Coordinated)
      • Robin User's Local (as specified in the user's browser)
  • "Date Time Field" requires two columns in the layout.
  • Cannot except invalid dates.
DOUBLE
  • Decimal number
  • Review Field
  • Text field
  • Cannot except string values
  • Accepts negative values
LIST
  • Select
  • Checkbox
  • Radio Option
  • Multiple Select
  • Drop-down (single selection)
  • Checkbox (multiple selection)
  • Radio button (single selection)
  • Drop-down (multiple selection)
  • SELECT and MULTI SELECT can be set to accept custom values.
LONG
  • Whole number
  • Review Field
  • Text field
  • Cannot accept string values
  • Cannot accept decimal values
  • Accepts negative values
STRING
  • Text Field
  • Text Area
  • Table
  • Data Label
    (deprecated)
  • Review Field
  • Text field
  • Text area
  • Table
    •  JSON table structure
      {
          "table": {
              "columns": [
                  {
                      "name": "key-name-in-rows-data",
                      "label": "Column header in UI"
                  },
                  {
                      "name": "description",
                      "label": "Description",
                      "readonly": true, // Column level readonly setting
                  },
                  {
                      "name": "value",
                      "label": "Value"
                  }
              ],
              "rows": [
                  {
                      "data": {
                          "key-name-in-rows-data": "Value 1",
                          "description": "Value Description",
                          "value": "1"
                      },
                      "attributes": {
                        "score": {
                            "key-name-in-rows-data": 0.1,
                            "description": 0.2
                        }
                      },
                      "meta": {
                          "excluded": true // If this row is removed by robin user
                          "added": true // If this row is new and added by robin user
                          "readonlyColumns": ["key-name-in-rows-data"]
                      }
                  },
                   {
                      "data": {
                          "key-name-in-rows-data": "Value 2",
                          "description": "Value Description2",
                          "value": "2"
                      },
                      "attributes": {
                        "score": {
                            "key-name-in-rows-data": 0.1,
                            "description": 0.2
                        }
                      },
                      "meta": {
                          "readonlyColumns": ["key-name-in-rows-data", "value"] // Cell level readonly setting. Overrides the column level ones
                      }
                  },
                   {
                      "data": {
                          "key-name-in-rows-data": "Value 3",
                          "description": "Value Description3",
                          "value": "3"
                      },
                      "attributes": {
                        "score": {
                            "key-name-in-rows-data": 0.1,
                            "description": 0.2
                        }
                      },
                      "meta": {
                          "readonlyColumns": ["key-name-in-rows-data"] // Cell level readonly setting. Overrides the column level ones
                      }
                  }    
                  
              ]
          }
      }
      
    • Table options:
      • Exclude or include a row.
      • Add row above or below the selected row.
      • Define a column, row, or the entire table as read-only.
        • Selecting "Read only" in the Output UI overrides the table structure options.
        • Table structure priority from highest to lowest: table, row, column.
      • The table component requires four rows and four columns in the layout.
  • The data label value (deprecated) is the coordinates of a field drawn on a binary file in the Robin skill. 
    This box can be used build labeled data sets to use when building an extraction model
    • An example data label value is: {"x":365,"y":187,"w":81,"h":17,"page":1}


Platform type:

  • List of PageBoundingBox
  • Page Bounding Box
  • Text field
  • The Page Bounding Box value is the location of the box on the page given as percentages of the page. This box can be used build labeled data sets to use when building an extraction model.
    • An example Page Bounding Box value is: [{boundingBox: {height: 0.5, left: 0.001, top: 0.2, width: 0.03}, page: 1}]
    • An example of a Page Bounding Box with multiple values: [{boundingBox: {height: 0.5, left: 0.001, top: 0.2, width: 0.03}, page: 1}, {boundingBox: {height: 0.05, left: 0.1, top: 0.12, width: 0.3}, page: 1}]
    • In order to map a field in a Flow to a Page Bounding Box output field, a blank List<Tuple> field is required. 
    • A Page Bounding Box field can accept multiple values for the same field. 
    • The Page Bounding Box feature can not be used in a Robin Output that also used the Data Label (deprecated) feature.
  • Create corresponding Tuple input fields for the Page Bounding Box output fields using the Multiple Constants function

LIST UI types (Select and Multi Select) can be set to accept custom values entered by the Robin user or the automation designer can add default values from a field.

To allow custom values from Robin business users:

  • Click the gear icon next to the LIST data type field and mark the Allow Custom Values box. 

To add a default value field to the list of options:

  • Click the gear icon next to the LIST data type field and select a field from the drop-down menu.