Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 comes frevvo comes with a built-in submissions repository. The repository can run on top of most SQL databases. By default, your form data is stored in the repository and can be viewed from the Submissions page. Fields in your form/workflow, set up as Searchable fields by the designer, can be used as criteria when searching submissions. You can also filter by default fields such as error, error description, submitter id, lock user id, started date, etc. The Insight Server and the Insight service must be running for the Submission view to work.

...

A Shared Items link is added to newly created Portals automatically and can be added to existing portals.

Image Removed

...

Searchable,

...

Summary, and Export Fields

ExportSearchable, Summary, Searchable and Summary Export Fields are available for configuration in the form/workflow Settings editing mode. They define which controls in your form can be used in search/filter, the submissions detail display, and the CSV download. It's important to understand the difference between each of these three settings.

Image RemovedImage Added

Searchable Fields

Searchable Fields can be used as search criteria for submissions and tasks. They also define the columns that will be available in the Submissions TableOnce defined,  can  frevvo can also go back and re-index your existing  existing submissions so you can search them using the same fields. Searchable fields and Export fields will be included in the Submission CSV download.

Info
  • Cloud customers can configure up to 20 Searchable Fields.

  • In-house customers can change change the default value by adding the frevvo.max.searchable.fields configuration parameter to the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file.

...

Initially, the Submissions Filter section is collapsed. 
Image RemovedImage Added

Click on the blue arrow to expand it. Click Reset to revert to the default filters.

...

When the expression or any of the sub-expressions change in any way, the submissions query is automatically re-run and the results are updated in the Submissions Table.

Image RemovedImage Added

Submission From Date and To Date

...

Expand
titleClick here for a list of the default columns

Default Columns


Description
Submitted DateDate and Time of the submission. You can also filter Submitted Date using the 'A' (upper left) section in the Submission Filter.
ErrorShown as a yellow triangle if the there is a submission error.
StateSubmission status: SUBMITTED, PENDING, ABORTED, SAVED, ERROR WAITING. This column displays the submission types selected in the State section. The submission status is 'B' in the submission filter.
Submitter IdID of the last submitting user.
Submitter NameThe first and last name of the user who submitted the form/workflow.
Lock User IdIf the submission is currently locked (and not SUBMITTED), this is the user id of the user who has it locked.
Lock DateDate and time a workflow last locked.
Lock User NameIf the submission is currently locked (and not SUBMITTED), this is the first and Last name of the user who has it locked.
Started DateDate and time a form/workflow first started.
Age/DurationFor completed submissions (State=Submitted) this is the time interval for how long it was in process - from the first incomplete submission (Pending, saved, etc.) until it reached SUBMITTED status. If the submission is currently incomplete (i.e. SAVED, PENDING or WAITING), then the time interval shows how long has it been in process so far (Age).
Error DescriptionDescriptive text about a submission error.


Image RemovedImage Added

Condition Column

...

For example, the choices in the Condition dropdown, will be different if you select the Submitted Date or the ProjectName, which is a searchable field in the form/workflow from the Fields list.

Section


Column

Image Removedenhancedsubmissionsview9.pngImage Added

Condition Choices when a Date field is selected from the Fields list.


Column

Condition Choices when ProjectName, a text field in the Expense Report workflow, is selected from the Fields list.


...

For Example, if you select a Date field, the Date Picker is provided to help enter the value. If you select a Text field from your form/workflow, you will be prompted to "Enter text" for the value. If you select the Error metadata field, the value choices will be True or False in a dropdown in the Value column.
Image RemovedImage Added

Info

A Date/Time field with the "is within last" condition selected, requires a special time duration entry. The duration must be entered in this format: Years:Months:Days:Hours:Minutes. Fields to the left may be omitted. For example, if you were searching for submissions that were submitted within the last 2 hours you can enter 02:00 or as 2:0. To search for submissions created within the last 2 months and 12 days, enter 02:12:00:00.

If you enter an invalid value, an error will display with instructions, e.g. "Bad time duration value, must be Yr:Mn:Dy:hh:mm".

...

For example, let's say you have a Job Application that has 3 submissions:
Image RemovedImage Added

You want to display the submissions that were submitted on January 11, 2022 or any of the applicants that live in Connecticut (Mobile Phone Area Code is 203):

...

At this point, the expression displays only one submission that has an Acknowledgement Date of 01/11/2022 AND has a Phone number that begins with an area code of 203.
Image RemovedImage Added

This is not the expected results. To display the submissions that were submitted on January 11, 2022 OR have a Phone number that starts with an area code of 203, the logical expression has to be modified.

  • Click the Edit button.
  • Change the expression to A AND B AND (1 OR 2)
  • Click the Save button.

Image RemovedImage Added

The submissions that match the Date range and State conditions and either were submitted on January 11, 2022 OR contain a phone number that starts with an area code of 203:

Image RemovedImage Added

Upon selecting the Save button, the logic expression is parsed for correctness. If there is any parsing failure, an error message describing the failure is displayed and the screen remains in edit mode. If there is no error, then the screen returns to read-only mode.
Image RemovedImage Added

Recap

In summary, let's say Jerry, a manager wants to create a submission query to check the status of all Expense Reports for Sales Demonstrations performed by the Sales department within the last month:

  • Make sure you have a field in your Expense Report to specify the Project Name - for example, a dropdown with Infrastructure, Sales Demonstration and Customer Meeting options.
  • Make sure Jerry has been granted permission to view submissions in the Access Control List for the Expense Report workflow.
  • Create a portal and distribute the link to the portal to Jerry
  • Jerry access the portal and logs into frevvo.
  • Jerry clicks on the Important Items tab in the portal.
  • Jerry clicks on the Shared Items tab.
  • Jerry clicks the View Submissions option in the Expense Report workflow's Action Menu
    Image RemovedImage Added

  • On the Submission Filter screen, Jerry selects:
    • The Project Name field from the Fields dropdown
    • The contains condition from the Condition dropdown.
    • Types "Sales Demo" in the Value column.
    • In the Submission Table, Jerry can quickly see that Maria Meyers has an Expense Report for a Sales Demonstration pending approval, Ricard Richard Walker has saved an Expense Report for a Sales Demo to his Task List, and an Expense Report for a Sales Demonstration was completed for Deborah Morris.

Image RemovedImage Added

Submissions Table

Submissions matching the submission filter are displayed in the Submissions table. The table has the following features and behaviors:

  • The results are displayed display a page at a time. The Previous, Next page buttons  buttons and individual page links, located in the lower right corner, can be used to "page" through the submissions.
  • Select the number of submissions to display on a page from the choices in the Show 10 entries dropdown in the upper left corner. The default is 10, with 25, 50, and 100 being the other available sizes.
  • The Record/Page summary appears on the lower left of the table. This details the records being shown on the current page and the total records matching the criteria.
  • To select an Individual submission, check the checkbox next to that submission in the Select column (second) in the table. Checking the checkbox in the Select column header , selects  selects all submission records in the table. This action toggles the selection state of all rows in the table.
  • The table is responsive and only displays columns it can fit on the display. Additional columns can be viewed by clicking the plus icon. The overflow columns are displayed in this secondary row. The overflow columns will wrap if necessary.
  • Most columns in the table can be sorted. Clicking on a single column determines the sorting direction (ascending/descending) for all the sortable columns. An example of a column that cannot be sorted is Age/Duration. See below for the details.

Image RemovedImage Added

Some of the Action buttons on the upper right of the Submissions Table require the selection of one or more submissions while others do not. Click below for a list of the buttons and their functions.

Expand
titleClick here for a list of the buttons on the Submission Table and their functions

Action Button


PurposeSubmissions SelectedBehavior/Description
RefreshRefresh the submission pageN/ARe-runs the query using the filter and re-loads the current page of data. Not often needed as most changes and actions automatically refresh the results table as needed.
View/EditView or edit submission detailsOne must be selectedThis action is disabled unless one and only one submission row is selected. Double-clicking a row (desktop only) displays the submission details.
DeleteDelete Submission(s)One or more must be selected.Only enabled when one or more submissions is selected. The user is prompted with an ok/cancel dialog to make sure they want to delete the selected submissions. If ok/yes, the submissions are deleted and the filter re-run and the page of data refreshed. Only submissions in the SUBMITTED, ABORTED or ERROR state may be deleted.
DownloadDownload to CSV fileN/ADownloads a CSV data file containing rows for all of the matching submission records with all columns included. This CSV file can easily be uploaded to Excel.
ColumnsShow/hide table columnsN/AUsed to show/hide columns in the  Submission Table. See below SubmissionTableColumns for the details.


Submission Table Columns

...

This image shows a PENDING submission for a Purchase Order workflow. The first step of the workflow was submitted by a designer user (Submitter ID), Giorgio Armani (Submitter Name). It is currently pending approval by his manager, Jerry Mouse (Lock User Name). Jerry's user frevvo user id is jerry (Lock User ID).
Image Removed
Image Added

Searchable Field Columns

In addition to the default columns, the Submission Table contains columns for each searchable field setup for the form/workflow. Notice the Report Date, Project Name, Employee Name, Reviewer, Expenses Approved, Paid On Date and Check in the Expense Report workflow submission shown in the image. These columns are generated by fields in the workflow configured as Searchable fields.

Image RemovedImage Added

You can change the order of the Searchable Field columns by moving field positions in the Searchable Fields wizard. The changes will not reflect in the Submission Table until a new submission is created or existing submissions are resubmitted.

...

Clicking the Columns button in the Submission Table, allows the user to toggle the visibility of each table column. Initially, all columns are visible indicated by displaying their respective button in yellow. You will see the default columns and columns for each of the Searchable fields defined in the form/workflow.
Image Removed
Image Added

Clicking a column toggles it to grey to indicate that it is not visible. Clicking it again toggles to visible/yellow. As you check/uncheck columns, the columns in the table change as appropriate.
Image Removed
Image Added

Once you select your columns, the modified column view displays until you go back to the Forms and Workflows Homepage. If you redisplay the submissions, the original column view displays. If you use your computer function key to refresh the screen, the original column view displays. Use the Refresh button on the Submissions Table if you require a refresh.

...

  • The Submission Info Section contains summary info about the submission, including the Form/Workflow Name, version, status and if applicable, error details, Submitted by <user> and the submission date and time.

    The Form/Workflow name is a clickable link that opens the form/workflow in either read-only or edit mode.
    • PENDING workflows will only open in read-only mode.
    • SUBMITTED forms/workflows will open in read-only mode for users with View Submission permission, and edit mode for user with Edit Submissions permission. In read-only mode, you will see a blue banner at the top of the form/workflow "This form is read only." See Editing Submissions for more details on edit mode.
    • In read-only mode, workflows will open at the current step. You can use the navigation toolbar to navigate back to prior steps if needed. 
      Image RemovedImage Added
  • The Data Tab displays controls selected as Summary Fields in the form/workflow settings, and attachments such as the PDF Snapshot, mapped PDF's and attachments uploaded by the user. This tab shows the user’s view of the data. This means for money controls you’ll see dollar signs, decimals and commas, for example. The Label column corresponds to the labels on your form, and the Value column shows you what the user entered in each control. This tab is view-only; you cannot edit any data shown here. If you do not see a specific form field then go back and edit this form to add the field to the Summary Fields tab.

    The Summary Fields are shown in the order they were configured in the form/workflow Settings. However, controls that are grouped in a repeating section or a table will be grouped in this view regardless of the order set. This data is available for forms/workflows in SAVED or PENDING state (i.e. not only SUBMITTED) as long as the field contains data.

    Attachment links are clickable and will open the attachment in a new browser tab.


  • The Signatures Tab shows you all the users that signed the form using using frevvo'wet and digital signature features.
  • The Documents Tab shows you the exact XML document that was generated when the form was submitted.

...

One of the attachments is a Wet Signature image. Clicking on the Signature  SubmissionsDetailtab lists the manager, Jerry's digital signture and the and wet signature image of the new employee. The signature image can be downloaded from the Data or Signature tabs of the form submission. There you will find information about any digital signatures that were stored with the form. See Electronic Signatures for more information.

...

Info

Selecting zip as the Restricted/Mime type, uploading a zipfile zip file and submitting the form may exhibit some unexpected behavior when downloading the zipfile zip file from the submission. Clicking on the attachment in the submission frevvo submission repository does not save the uploaded zipfile as a zipfile. Instead, it will save it as a file with an unrelated name e.g. Upload91 or ProfilePicture. As a workaround, you can open the file using winrar.exe and then save it or simply use right-click and and select the 'save as' option if it is available.

...

The File Name property allows the designer to rename attachments uploaded using the Upload Control.

Viewing XML Documents

 always frevvo always stores your form data as XML documents. To view the XML data, click the Documents tab in the Submission Details panel.

...

  • Hover over the icon
  • Display the Error Description column. The Error Description column is the last default column in the Submission table.

Image RemovedImage Added

Another way to get information about the error is to double-click on the submission to view its details, and again hover over the  icon.

...

Note

The Error Description column is the last default column in the Submission table.

Image RemovedImage Added

If the Insight Server is down, submissions for ALL of your forms/workflow will no longer display. You will not see the error icon or any error description in the Error or Error Description columns.
Image Removed
Image Added

The tenant admin receives an email to alert them that the submission never reached the Insight Server.

Image RemovedImage Added

The following error is logged in the In the <frevvo-home>\tomcat\logs\frevvo_YYYY-MM-DD.log,

...

Reports will show the message "No data available in table". Once the Insight server is restarted, the submissions will show in the Recent Submissions report and submissions will redisplay reporting the error. Remember, the Error Description column is the last default column in the Submission table.
Image Removed
Image Added

Email Size Exceeded Error

This section applies only to  Cloud to frevvo Cloud Customers.

The frevvo mail server limits email size to 30MB. If emails sent in Activity Doc Action or Document Actions exceed this limit, your tenant admin may receive an email bounceback from "Mail Delivery System <"MAILER-DAEMON@sysops+stage"@frevvo.com>" that contains an error like this "message size 34559092 exceeds size limit 31457280 of server smtp.sendgrid.net[107.20.8.136]".

The only workaround for this issue at this time is to limit the Upload control max size and/or min # properties in your form. If you have a submission that has hit this error, you must edit the submission, delete some of the attachments and then resubmit.

Editing Submissions

Only submissions in the SUBMITTED state can be edited. If you have the correct permissions, submissions can be edited easily by clicking the form name rendered as a clickable URL on the submission. In this image below click on "Product Order Form" to edit the submission.

...

This will reload the current version of the form with the data from this old submission. If the form is linked to any back-end systems (via Doc URIs) these links will not execute as it would possibly change the submissions data. You can then edit the data in the form. All date/time controls will have the values automatically loaded in your machines your machine's local timezone. The submission date/time in the image below  shows shows Aug 21, 2014, 2:42 pm. This date/time is the timezone where the form server was running when this form was originally submitted. The <OrderDate>2012-05-15T20:38:44Z</OrderDate> is the date/time value in the OrderDate form field converted to UTC timezone. When this form loads, if the browser's timezone is America/New_York, the OrderDate control will display the value 16:38:44 as America/New_York is -4 hrs from UTC on a date where Daylight Savings Time is in effect.

...

Forms configured with a Doc URI will not execute the Doc URI when you edit  the the submission. The data displayed when you edit a form/workflow submission is from the submission data at the point in time when the form was originally submitted. Any Doc URIs will not execute and thus will not refresh data from your backend system. 

When you click submit on the form/workflow the data in  submission repository with , the frevvo submission repository will be updated with the new data. If the form properties are set to save a PDF then the PDF will also be replaced. You must perform a refresh to see the updated information for Searchable fields for forms/workflow on the Data tab after editing a submission.

Note

If the current version of the form is different then than when the data you're editing was originally submitted then some of the data may not be visible. For example, if your form contained a field for "detailed description", and the current version of your form no longer has that field as the designer removed it, then the detailed description data will exist but will not be visible/editable.

The designer can grant permission to view/edit submissions to non-designer users via the Access Control feature. Once permission is granted, submissions are accessible as Shared Items. It is also possible to build your own project that enables editable access to non-designers using the Data API.

Cloud frevvo Cloud users can edit submissions by default. In-house customers can turn off the edit link for all users by modifying the frevvo.submission.edit.link configuration property in the <frevvo-home>/WEB-INF/web.xml or the <frevvo-home>/tomcat/conf/catalina/localhost/frevvo.xml files.

...

At any time as a shortcut, you also can click anywhere inside the column header to toggle the sort of the results in ascending or descending order.
Image Removed
Image Added

Changing the sort of a column from a submission table page > 1, goes back to the first page when when displaying the results. This is as designed.

...

The ability to delete submissions from the Submissions Table depends on your rolefrevvo role, assigned Access Control permissions and the type of submission.

...

The form/workflow owner (the designer who created the form/workflow) and any user given the Edit Submission permission by the designer , can delete submissions in the SUBMITTED, ABORTED, and ERROR states.

The tenant admin, workflow admin, or the workflow’s designer/owner can delete submissions in the PENDING, SAVED, or WAITING states in addition to submissions in the SUBMITTED, ABORTED, and ERROR states,.

Deletions of PENDING, SAVED, or WAITING submissions are first aborted then soft deleted.  Users given with the Edit Submission permission that are not the tenant admin, a workflow admin or the designer/owner of a form/workflow will see this error when attempting to delete submissions in these states.

...

The Delete button is only enabled when one or more submissions is are selected. The user is prompted with an ok/cancel dialog to confirm the deletion of the selected submissions. If ok/yes, the submissions are deleted, the filter re-runs, and the Submission Table is refreshed.

...

To delete all the submissions on the page, check the checkbox in the select column header then click the Delete button.
Image Removed
Image Added

You will be asked to confirm.
Image Removed
Image Added

To delete a single submission, check the checkbox preceding the submission in the table. Notice the View/Edit and the Delete buttons become enabled. You will be asked to confirm.

Image RemovedImage Added

Users that are not granted permissions to delete submissions see this error:

...

Submission data can be exported to a CSV (comma-separated value) file that can be easily opened in Microsoft Excel. The CSV will contain the submissions currently shown in your submissions table, and the control values configured in the Export Fields tab of your form/workflow. The default columns and any form fields designated as Export Fields appear as columns from left to right in the CSV file.

...

If you open the CSV file with Microsoft Excel, the file will look like this. The columns Date of Invoice, Last Name, First Name, Phone, Product, and Email are set up in the form as Export Fields and reflect the data in these fields. The order of the columns is determined by the order set in the Export Fields tab.

...

For example, let's say your requirement is to upload submission data from to frevvo to a different website.

  1. Perform the submission query so the data that you want to download displays in the table. The default columns SubmissionTable in the submission table appear in the spreadsheet even if you are not displaying them in the table. Hide the columns in Excel if you do not want to display them in your spreadsheet.
  2. Click the Download button to save the CSV file.
  3. Open the file in Microsoft Excel.
  4. Show/Hide columns in the spreadsheet if desired.

...

The CSV column order will be a) the Submissions table fields, including Searchable Fields in the order they are set, then b) Export fields in the order they are set, then c) additional metadata fields from the Submissions Table. To change the order of the columns in the Submissions CSV file, change the order on the Searchable Fields and Export Fields tabs. The CSV The CSV file will reflect the new column order. When editing the file in a spreadsheet application (e.g. Excel) you can easily rearrange the columns if needed. 

...

Here is how the Excel workbook looks when you initially open it after downloading.

Image RemovedImage Added

The CSV file viewed in a text pad will also reflect this pattern.

...

This happens because Excel makes assumptions about the way imported data should be formatted; usually leading zeros are mathematically insignificant, so they are removed. You can keep the leading zeros in CSV files by using Excel's Text Import Wizard. (These instructions may vary based on your Excel version.)

  1. Launch Excel Spreadsheet. Click the Data tab. 
  2. Click the From Text/CSV icon. Use the file manager to locate the CSV file you want to import.

  3. Click Import.

  4. Select Comma from the Delimiter dropdown. 
  5. Click Transform Data.

  6. Select the column(s) that contains the data with leading zeros. Change the Data Type to "Text". The preview will refresh to show your data with leading zeros.

  7. Click Close & Load.

...

The Submission view screen is designed to be responsive to different screen sizes. You will notice a different layout for small screens (< 640px) such as the iPhone. The "Other Filter Items" grid renders with a vertical layout of field, condition, and value.

  • Values are selected from a wheel scroller user control that displays when the user touches the field.
  • The matching submissions grid/table only displays columns it can fit. Click the plus icon to view additional columns.
  • The Action buttons (Refresh, View Submission Details, Delete and Show/Hide columns) do not have text labels on phone screens (<640px). Also,
  • The page size selector and individual page selection buttons do not show on smaller screen sizes (<640 px).
    Image RemovedImage Added
Info

Viewing submissions from the Shared Items tab (inside or outside of a portal) on an IOS device (iPad,iPhone), may require an application to edit and save Excel.xls files. This requirement is browser specific.

Processing submission data using the frevvo API

 provides frevvo provides a complete API for interacting with the system. Using the API, you can query submissions, download submission PDF/XML, etc. Using the API is documented in its own Tutorial.

...