Control Properties for Dropdown components:
You can turn on Enable Search so the form user can use search-ahead to find the option they’re looking for.
Control Properties for Checkbox Group and Button Group components:
- Orientation: Change from horizontal vs. vertical.
- Button Type: Change between standard (buttons), radio, or checkboxes.
- Colors: Format the colors for selected and unselected options.
Dropdown From List
Use the Dropdown From List component to give the user a dropdown menu with the options driven from a list in the form.
Use the initial or update calculations in the Calculations tab of the left-hand Property Pane to set the list of data in the field.
To add components into the dropdown list, you must go to the Layers in the left-hand panel. Then, select the group that is automatically within the grid field. Then, select a data type on the top and click the “+” button. To later add calculations to these fields, you will need to go back to the Layers tab to edit them.
Control Properties:
- Selection Field: Map an integer component field (which is outside of the list on the form, not in the list) to capture the index of whichever row the user has selected. The index of the first row in the list is 0 (not 1). Add a new Integer component to the form and map it in, then test it out in Preview Mode to see how it works.
- Enable Search: Configure if the form user can use search-ahead to find the option they’re looking for.
- Filter: Set a filter for which dropdown options are visible at any given time a user is using this form. Filter will hide the items from the user, but the items and the data within them will not be removed from the form/list, they just won’t be visible to the user.
- Label Field: Map to the string field within the dropdown list which should display as the options in the drop down.
- Sort: Optionally, map a key field and select a sort order to sort the list of options in the dropdown.
Data Groupings
|
|
|
|
List of repeating sections, where each item in the list has the same parameters but can have different data in each parameter.
|
|
|
List of repeating sections, where each item in the list has the same parameters but can have different data in each parameter.
|
|
|
A display-only component to display a list of data in a table or dropdown format.
|
|
|
List of repeating sections, where each item in the list has the same parameters but can have different data in each parameter.
|
|
List
Use the List component to display a list of data. You can allow the form user to add, edit, and delete rows in the list or you can turn off any or all of these options for the form user.
In the Designer, you can either select the entire list or the list item (the group within the list). You will get different configuration options in the right-hand Property Pane based on which you have selected in the designer.
To add components to your list, drag them into the list item, just like you drag components into the Section component. You can add as many components into the list item as you need. You cannot add other array components into the array list item.
Control Properties when the entire list is selected:
- Selection Field: Map an integer component field (which is outside of the list on the form, not in the list) to capture the index of whichever row the user has selected. The index of the first row in the list is 0 (not 1). Add a new Integer component to the form and map it in, then test it out in Preview Mode to see how it works.
- Max Height: Configure the max height of the list. If the list goes over the max height, then the form user can scroll within the list.
- Separator Style: Configure the color and size of the space separating each item/row in your list.
- Add Enabled: Configure if the form user can add new items/rows to the list or not (i.e. whether they see the “ADD ROW” button or not).
- Filter: Set a filter for which list items are visible at any given time a user is using this form. Filter will hide the items from the user, but the items and the data within them will not be removed from the form/list, they just won’t be visible to the user.
Control Properties when the list item is selected:
- Delete Enabled: Configure whether or not the trash icon to delete an item/row is available to the form user.
- Edit Enabled: Configure whether the items/rows are editable or readonly.
- Edit Button Shown: Configure whether the user has to click the pencil icon for each item/row in order to edit that row or the rows are already editable.
Grid
Use the Grid component to display a list of data in a grid format. You can allow the form user to add, edit, and delete rows in the grid or you can turn off any or all of these options for the form user.
To add components into the grid, you must go to the Layers in the left-hand panel. Then, select the group that is automatically within the grid field. Then, select a data type on the top and click the “+” button. To later add calculations to these fields, you will need to go back to the Layers tab to edit them.
Control Properties:
- Rows can be added: Configure if the form user can add new items/rows to the grid or not (i.e. whether they see the “+” button or not).
- Rows can be removed: Configure whether or not the trash icon to delete an item/row is available to the form user.
- Enable quick fill: Quick fill allows the form user to enter one value below the grid and then quickly add that value to multiple cells in the grid by clicking on each cell they want to add that value to.
- Rows can be selected: Configure if the form user can select rows. You can configure the style of rows which are selected in the Control Properties as well.
- Filter: Set a filter for which rows are visible at any given time a user is using this form. Filter will hide the items from the user, but the items and the data within them will not be removed from the form/grid, they just won’t be visible to the user.
- Styles: Configure cell styling specific to the type of and state of that cell, including: the default style, style for read only cells, style for label cells, and style for selected cells.
- Row Labels: Configure the row labels, either on the left and/or right of each row in the grid.
Read-Only Grid
Use the Read-Only Grid component to display a list of data for which you don’t need to do anything with the data except display it. If you want the user to be able to edit the data in the list or you want to be able to send the data in the list to some other system, do not use the Read-Only Grid component (use List, Grid, or Table components in those scenarios).
You can set the data in the list using the initial or update calculations in the Conditions tab of the left-hand Property Pane or using the Data tab in the left-hand Property Pane. See the Dropdown component in the Selectors components section above for more details on the options available in the Data tab.
Control Properties:
- Enable Refresh: Configure if the form user should see a refresh button to pull in fresh data from the data mapping you configured in the Data tab in the left-hand Property Pane.
- Enable Search: Configure if the user can search through the rows/items in the grid.
- Enable Selections: Configure if the form user can select rows. You can configure the style of rows which are selected in the Control Properties as well.
- Height: Configure the height of the grid. If the data goes over the height, then the form user can scroll within the grid.
- Type: Configure if it should display as a table or dropdown.
- Label Field: If you have type as dropdown, then configure what field shows as the options in the dropdown.
- Selected Style: Configure the background color and border format for a row that is selected.
Table
Use the Table component to display a list of data in a table format. You can allow the form user to add, edit, and delete rows in the table or you can turn off any or all of these options for the form user.
To add components into the table, you must go to the Layers in the left-hand panel. Then, select the group that is automatically within the table field. Then, select a data type on the top and click the “+” button. To later add calculations to these fields, you will need to go back to the Layers tab to edit them.
Control Properties:
- Selection Field: Map an integer component field (which is outside of the table on the form, not in the table) to capture the index of whichever row the user has selected. The index of the first row in the list is 0 (not 1). Add a new Integer component to the form and map it in, then test it out in Preview Mode to see how it works.
- Layout: Configure if the table has a horizontal or vertical layout.
- Fields: After you add fields in the Layers, add them here in Fields.
- Add Enabled: Configure if the form user can add new items/rows to the table or not (i.e. whether they see the “+” button or not).
- Search Enabled: Configure if the user can search through the rows/items in the table.
- Filter: Set a filter for which rows are visible at any given time a user is using this form. Filter will hide the items from the user, but the items and the data within them will not be removed from the form/table, they just won’t be visible to the user.
|
|
|
|
Use for any of these use cases:
- User needs to take photo on their device or upload a file/image from their device
- User can select from list of images (that are stored in Mirata)
- Display an image stored in Mirata to the user
- User needs to annotate/sketch on any image
To upload photos to Mirata, just click the + button in the Image Gallery in the Admin Tool. See Admin Tool Basics Training for more information.
|
|
|
User signs using touch-screen on a tablet or by clicking and holding the mouse on a computer.
|
|
|
Display a list of images.
|
|
|
Display multiple images via a URL.
|
|
Image & Sketch
The Image and Sketch components allow you to display an image on the form, allow the form user to take or upload an image from their device, and allow the form user to annotate images.
The only difference between the Image and Sketch components is that the Annotation feature is enabled by default for the Sketch component whereas it’s disabled by default for the Image component. After you add an Image or Sketch component, you can change the Annotation configuration in Control Properties in the right-hand Property Pane.
Control Properties:
- Annotation
- Annotation Icons
- Camera
- File Picker
- Images
- Image Selection
- Sizing
- Quality
- ANNOTATION:
- Enabled: When Annotation is enabled, the user can use the Annotation Editor for that image. Here’s what you can do with the Annotation Editor:
- Free-form drawing
- Select Color and Thickness before drawing
- Draw shapes, including:
- Solid Lines
- Dashed Lines
- Rectangles
- Circles
- Arrows
- Text
- Add Annotation Icons (see #2)
- Button Text: The Annotation button defaults to a pencil icon, but you can change it by putting a value in Button Text.
- Annotation Default Color: Defaults to red, but you can change it here.
- ANNOTATION ICONS:
In the Advanced Settings for an Annotation Icon, you can configure:
This is how these controls will display in the Annotation Editor:
- Annotation Icons: Add using the “+ ADD ICON” button, then you can select any image that’s uploaded to your organization’s Mirata.
To upload photos to Mirata, just click the + button in the Image Gallery in the Admin Tool. See Admin Tool Basics Training for more information.
- Title: Will show in the pop-up when the user hovers over the icon in the Annotation Editor.
- Category: The user can select a category in the dropdown to filter the Annotation Icons.
- Details: Will show in the pop-up when the user hovers over the icon in the Annotation Editor.
- Resizable/Rotatable/Width: Adjust for an Annotation Icon.
- Text: When Text Enabled is checked, whatever is in Text Value will be added along with the annotation icon. You can adjust the Position relative to the icon and the Size of the text.
- CAMERA:
- Enabled: Allow the user to take their own photo using their device’s camera.
- Button Text: The Camera button defaults to a camera icon, but you can change it by putting a value in Button Text.
- FILE PICKER:
- Enabled: Allow the user to take their own photo using their device’s camera.
- Button Text: The File Picker button defaults to a paper clip icon, but you can change it by putting a value in Button Text.
- Close Button Text: When the user clicks File Picker, they will get the below pop-up window. Configure the confirmation text (which the user has to click to confirm their file selection).
- Instruction Text: When the user clicks File Picker, they will get the below pop-up window. Configure the text which appears in the file selection box.
- IMAGES:
- Image Id: Click the image icon on the right to select or upload the static image you want in this component.
- URL: You can enter a URL of an image if you have a specific path. We don’t recommend using a URL instead of an Image ID unless you’re an advanced user.
- Thumb URL: Click the image icon on the right to select or upload the image that will be shown whenever the image component is collapsed by the user. You can turn on/off allowing the user to collapse the image and view the thumb image using the Collapsable switch in SIZING (see #6a).
- IMAGE SELECTION:
- Button Text: The Image Selection button defaults to an image icon, but you can change it by putting a value in Button Text.
- Image: Click to select an image. The user will be able to select anty of the images you add in the image selection for this image component.
- Title: Title the image so the user knows what he/she is picking.
- SIZING:
- Collapsible: When turned on, the user can click the image to expand it to height e. Height and collapse it to height f. Thumb Height.
- Button Size: Adjust the size of the Annotation, Camera, File Picker, and Image Selection buttons.
- Placement: Adjust the placement of the image.
- Scaling: Adjust the scaling of the image.
- Height: Adjust the height of the image. If a. Collapsible is turned on, the user can minimize the image to f. Thumb Height by clicking on the image.
- Thumb Height: Adjust the thumb height of the image if it is collapsed (if a. Collapsible is turned on). The user can collapse the image by simply clicking on it.
- QUALITY:
- Max Size: For quality control, you can adjust the maximum size of an image that can be taken with the camera or uploaded.
Signature
Use the Signature component to capture a signature from the form user. The user can draw their signature either using touchscreen or their mouse, depending on the device they’re using.
Control Properties:
- Display
- Dialogue
- Pen
- Watermark
- Alignment
- Font
- DISPLAY:
- Show Image: Turn on/off if the signature displays as an image after it’s signed.
- Signed/Unsigned Button Text: These buttons default to a pencil icon, but you can change them to text by entering desired text here.
- Button Size/Placement: Adjust the size and placement of the signed/unsigned buttons.
- DIALOGUE:
When the user clicks to sign, this is the dialogue box where they sign:
These are the dialogue settings in Control Properties (🔧):
- Cancel Text: The button defaults to “CANCEL”, but you can change it by putting a value in Cancel Text.
- Clear Text: The button defaults to “CLEAR”, but you can change it by putting a value in Clear Text.
- Save Text: The button defaults to “SAVE”, but you can change it by putting a value in Save Text.
- Title: The title defaults to no title, but you can change it by putting a value in Title.
- PEN: Pen color defaults to black, but you can change the pen Color and Width here.
- WATERMARK: By default, there’s no watermark. Add Text here if you want a watermark on the signature. You can also change the Text Color of the watermark.
- ALIGNMENT: Adjust the horizontal/vertical alignment.
- FONT: Adjust the Family, Style, Variant, Size, and Weight.
Image Grid
Use the Image Grid component to display a list of images. Add images to your Image Grid using a workflow transition and “Append to form field array” in a form update.
To add components into the image grid, you must go to the Layers in the left-hand panel. Then, select the group that is automatically within the image grid field. Then, select a data type on the top and click the “+” button. To later add calculations to these fields, you will need to go back to the Layers tab to edit them. Make sure to add an image field the image and a string field for the image titles, which you will map in the Image Fields section in the Control Properties (see #6 below).
Control Properties:
- Title Position: Configure if you want the image titles to be at the top or bottom of the image.
- Height: Configure the overall grid height and the height of each image.
- Layout: Configure how many columns there are in your grid and the spacing between.
- Image Item Scaling: Choose to scale images automatically, to full height, or to full width.
- Icon Color & Icon Position: In each Image Item (see below), you can set an icon for that image. Configure the color and position of those icons here.
- Image Fields: In the Image Fields, you map fields that are within the image grid array to specific uses:
- Cols Field: Map to an integer field which controls the columns.
- Rows Field: Map to an integer field which controls the rows.
- Title Field: Map to a string field to be used as the title of each image.
- Subtitle Field: Map to a string field to be used as the subtitle of each image.
- Image Source: Change Image Field source between a field in the form and a URL.
- Image Field: Map to an image field to be used as each image.
- Icon Field: Map to a string field to be used as the icon for each image.
Static Image Grid
Use the Static Image Grid component to display a list of images from URLs.
Control Properties:
- Title Position: Configure if you want the image titles to be at the top or bottom of the image.
- Height: Configure the overall grid height and the height of each image.
- Layout: Configure how many columns there are in your grid and the spacing between.
- Image Item Scaling: Choose to scale images automatically, to full height, or to full width.
- Icon Color & Icon Position: In each Image Item (see below), you can set an icon for that image. Configure the color and position of those icons here.
- Image Items: Add URLs of the images which you want to display in the grid. You can paste as many URLs as you need.
Graphs & Charts
|
|
|
|
Display a list of data in a chart with bars.
|
|
|
Display a list of data in a circular chart.
|
|
|
Display a list of data in a chart with lines.
|
|
Bar Chart
Use a Bar Chart component to display a list of data in a circular chart.
To add components into the chart, you must go to the Layers in the left-hand panel. Then, select the group that is automatically within the table field. Then, select a data type on the top and click the “+” button. To later add calculations to these fields, you will need to go back to the Layers tab to edit them.
Control Properties:
- Filter: Set a filter for which items in the list of data are visible at any given time a user is using this form. Filter will hide the items from the user, but the items and the data within them will not be removed from the form/graph, they just won’t be visible to the user.
- Height: Configure the height of the chart.
- Title: Configure the title of the chart.
- Loader Text: Configure the text which will appear whenever the chart data is loading.
- Labels: Configure the horizontal and vertical labels of the chart data.
- Series: Map to a field within the chart array.
- Legend: Configure the legend colors and labels.
Pie Chart
Use a Pie Chart component to display a list of data in a chart with bars.
To add components into the chart, you must go to the Layers in the left-hand panel. Then, select the group that is automatically within the table field. Then, select a data type on the top and click the “+” button. To later add calculations to these fields, you will need to go back to the Layers tab to edit them.
Control Properties:
- Filter: Set a filter for which items in the list of data are visible at any given time a user is using this form. Filter will hide the items from the user, but the items and the data within them will not be removed from the form/graph, they just won’t be visible to the user.
- Height: Configure the height of the chart.
- Title: Configure the title of the chart.
- Loader Text: Configure the text which will appear whenever the chart data is loading.
- 3D: Toggle on/off your pie chart displaying 3-dimensional vs. flat.
- Pie Size: Configure the size of the pie chart.
- Text: Configure the labels of the chart slices to be either a label calculation, values, or percentages.
- Series: Map to a field within the chart array.
- Label: Map to a string field which holds the label for each slice of the pie.
- Value: Map to a decimal field which holds the value for each slice of the pie.
Line Graph
Use a Line Graph component to display a list of data in a graph with lines.
To add components into the graph, you must go to the Layers in the left-hand panel. Then, select the group that is automatically within the table field. Then, select a data type on the top and click the “+” button. To later add calculations to these fields, you will need to go back to the Layers tab to edit them.
Control Properties:
- Filter: Set a filter for which items in the list of data are visible at any given time a user is using this form. Filter will hide the items from the user, but the items and the data within them will not be removed from the form/graph, they just won’t be visible to the user.
- Height: Configure the height of the graph.
- Title: Configure the title of the graph.
- Loader Text: Configure the text which will appear whenever the graph data is loading.
- Line Style: Configure if the line style is standard or smooth.
- Labels: Configure the horizontal and vertical labels of the graph data.
- X-Value: Map to a decimal field within the graph array which holds the values.
- Y-Value: Configure a name for the y-axis values. Use the blue “Calc” button to map each to a decimal field within the graph array.
Actions
|
|
|
Workflow Transition Button
|
A button which the form user can click to trigger a workflow transition.
|
|
|
A button which the form user can click which will take them to a provided URL.
|
|
|
A button which the form user can click to run a query to get a list of data.
|
|
Use the Workflow Transition Button component to allow the form user to trigger a workflow transition. You must first create your workflow transition in the Workflow tab and then you can use this component to trigger that transition on the form. For more information on how to use the Workflow Designer to create and configure workflow transitions, please Getting Started: An introduction and overview of Mirata’s Workflow Designer and its role in business processes.
In the Control Properties, you tie the button to a workflow transition (which you have created in the Workflow Designer) using the transition name dropdown.
Use the Launch URL Button component to allow the form user to navigate to a URL.
Control Properties:
- URL: Give a URL to add to.
- Parameters: Optionally, you can configure any parameters that are needed to launch the URL.
Use the Search Button component to allow the form user to run a query to get data.
Control Properties:
- Query Name: Paste the name of a query which is set up as a Backend Action in the Mirata Admin Tool. Go to the Backend Action Overview article for more information on backend actions
- Result Field: Map to the field which you want to hold the results of the query after it’s run. If your query should return a list of data, choose an array field here.
- Query Mappings: Optionally, you can configure any parameters that are needed as inputs to the query which you put in Query Name.