DocuPhase Forms latest - This documentation is for DocuPhase Forms v11.3. Not for you? Earlier documentation is available too.

Forms and Workflows Home Page

Check out a 5-minute Video Tour of the Forms & Workflows Home Page.

The Forms and Workflows homepage appears when you create or edit a project.

v11.1 Forms and Workflow Homepage.PNG

Navigating the Forms and Workflows Home Page

Use the Quick Start links to show step-by-step instructions for creating forms and workflows.

There are three icons at the top of the Forms and Workflows home page: 

  • v11.3 Add icon.PNG Add Content: Install a prebuilt template, create a new form, create a new workflow, or upload a form/workflow. New content will be added to the forms/workflows list. 

    • If you attempt to upload a _dashboard.zip from this page, it will upload successfully and will redirect you to the Dashboards homepage. The reverse is also true; upload a _form or _workflow.zip in the "Upload a Dashboard" dialogue, and you will be redirected to the Forms and Workflows home page.

  • v11.3 Sort icon.PNG Sort the list of forms and workflows. Content will be displayed with the last modified date on top. You can resort them by last modified date or alphabetically.

  • v11.3 Page Help icon.PNG Information about the features on the Forms and Workflows Homepage. This feature is only available for Cloud customers.

Forms and Workflows in the list can be identified by their icons:

  • v11.3 Form icon.PNG Form

  • v11.3 Workflow icon.PNG Workflow

To the right of each form/workflow name there is a Test icon v11.3 Test Icon.PNG for quickly entering test mode, and a Form/Workflow Action Menu v11.3 Action Menu icon.PNG , which provides the following options:

  •  v11.3 Edit icon.PNG Edit opens your form/workflow in the respective Form or Workflow Designer. You can also open your form by clicking on the form/workflow name.

  •  v11.3 Test Icon.PNG Test your form/workflow. See Testing Forms/Workflows.

  •  v11.3 Permissions icon.PNG Set Permissions brings up a quick-view Access Control wizard that allows the designer to specify view and edit access for the form/workflow and its submissions. Access Control will typically be managed in the Form/Workflow Properties Wizard.

  •  v11.3 Duplicate icon.PNG Duplicate creates a copy of your form/workflow. The newly copied content will be independent from the original; any changes you make to the copy won’t affect the original and vice versa. Access Control permissions assigned to the original form/workflow are retained in the copy.

  •  v11.3 Share icon.PNG Share your form/workflow. Forms/Workflows that will be shared should have the Access Control set so it can be shared with others. See Sharing Forms and Workflows.

  •  v11.3 Deploy icon.PNG Deploy a form/workflow to Production state and remove the Development watermark. This toggles the icon to the Undeploy icon. If your license enables a limited number of Production forms/workflows you will get an error message when you hit your license production limit. When a form or workflow is deployed, it will appear with a flag icon beside the form/workflow name.

  • v11.3 Download Zip icon.PNG Download a zipped version of the form/workflow. A single zip file will be created with the name of your form/workflow, followed by _form.zip or _flow.zip. 

  • v11.3 Publish Template icon.PNG Publish as Template that you can use when creating other new forms/workflows. See Templates.

  • v11.3 View Submissions icon.PNG Submissions gives access to the form/workflows submissions. 

  • v11.3 Refresh Search Fields icon.PNG Refresh Search Fields updates previous submissions when a change is made to the Searchable Fields in your form/workflow. Refer to Refresh Searchable Fields for the details.

  • v11.3 Schema icon.PNG Schema downloads the automatically generated schema associated with your form/workflow. This schema will contain all the controls added from the Palette. This will not contain controls added from your own schemas. See the Schemas topic for more details.

  • v11.3 Thumbnail icon.PNG Thumbnail attaches an icon to your form/workflow. You can select one of the icons provided by  or you can upload your own. The icons will display when you access your forms/workflows from a  portal on mobile devices such as iPhone or iPad. Learn more about thumbnails below.

  • v11.3 Translation icon.PNG Internationalize a form/workflow with translations in different languages.

  • v11.3 Delete icon.PNG Delete the form/workflow. Keep in mind there is no Undo feature so this action is permanent. Deleting a form/workflow also deletes all associated form submissions and any saved in-process form/workflow instances. See deleting forms/workflows and replacing forms/workflows below.

Refresh Searchable Fields

Searchable Fields are fields in your form/workflow that can be used to search submissions and tasks. The designer designates which controls should be set up as Searchable fields.

Adding or deleting Searchable Fields at any time will immediately take effect for future submissions, but not for past submissions. Designers, tenant or superuser administrators or any user given the permission to edit can initiate a Refresh Searchable Fields process for a particular form/workflow to reflect the changes made to the Searchable Fields in previous submissions.

For example, let's say you have an Invoice form with the First Name and Last Name fields set up as searchable fields. You can search existing submissions or tasks by setting up a filter using the data in these fields.

Your users have requested the ability to search submissions and tasks by product name in addition to the First and Last name of the customer. You must add the Product Name field to the list of Searchable Fields in your form.

  1. Login as a designer user or your production account if the form is deployed.

  2. Edit the Project where your form is located.

  3. Edit your form and click Settings. Select the Searchable Fields tab.

  4. Add the Product Name control in your form to the Searchable Fields list using the Setup Searchable Fields wizard.

  5. Follow these steps to run the Refresh Searchable Fields process. 

    1. Select v11.3 Refresh Search Fields icon.PNG  Refresh Search Fields from the form/workflow Action Menu for the form/workflow you want to update.

    2. Information about previously run refresh processes for the form/workflow display in a table.

      1. Start and End date/Time

      2. Status - completed/failed/stopped

      3. The user id and name of the initiator

      4. A description providing the Project/Form Name

    3. Click the Start iconv11.3 Start (green plus) icon.PNG to start the Refresh Process.

    4. Click Submit. The message "Index batch was successfully started" displays and the submitted process shows in the Refresh Process list table.

    5. Click the Refresh icon v11.3 Blue Refresh icon.PNG to update the table with the most recent information.

Click the Back to Forms and Workflows link to return to the Forms and Workflows Home Page.

Once the Refresh Searchable Fields process for the form is completed, the Product control and the associated data displays as a column in the Submissions Table.

The Refresh Process can be stopped or abandoned once started.

Stopping the Refresh Searchable Fields Process

Once you have initiated the Refresh Searchable Fields process, the DocuPhase Forms UI allows for the job to be stopped or aborted. The process can be stopped if it is in the STARTING or STARTED state.

You will notice a Stop column in the row in the table for the process that was started. To stop the job:

  1. Click the Stop iconv11.3 Stop icon.PNG.

  2. Click Ok to confirm.

  3. When the process is stopped, the status column will update.

Restarting a Stopped Refresh Searchable Fields Process

When the Refresh process runs, tables that store the state of the process are created in the DocuPhase Forms database. By default, if a process were to fail or be stopped, starting it again would restart the failed/stopped job from where it failed/stopped.

To restart a Stopped/Failed refresh process, simply start the batch job again with same tenant and it will resume the last stopped job. 

To prevent the last stopped job from restarting, change the status to Abandoned.

Abandoning the Refresh Searchable Fields Process

The Refresh Searchable Fields process must be stopped to mark it as abandoned. This prevents it from being restarted. You may want to abandon a batch job if it failed and restarting it would result in another failure. Abandoning the batch job allows you to start over again with a new process. The process cannot be abandoned if it is in the STARTING or STARTED state.

When you stop a Refresh process, you will notice Stop and Abandon columns in the row in the table for the process that was started. To abandon the job:

  1. Stop the Refresh Searchable Fields Process

  2. Click the Abandon icon v11.3 Abandon Remove icon.PNG in the row in the Abandon column for the process you want to prevent from restarting.

  3. Click Ok to confirm.

  4. The Refresh Job Status screen will update.

Assigning a Thumbnail Icon to a Form/Workflow

You can attach a thumbnail icon to a form/workflow by clicking the Thumbnail iconv11.3 Thumbnail icon.PNG in Form/Workflow Action Menu. Select one of the icons provided by DocuPhase Forms or upload your own. The icons will display when you access your forms/workflows from a DocuPhase Forms portal on mobile devices (iPhone and iPad) mobile devices. See below. If you do not specify an icon for your form/workflow, DocuPhase Forms will display a default thumbnail where required.

In the Thumbnail feature you will see a list of icons provided by DocuPhase Forms.

If the form/workflow does not have an icon assigned the Current thumbnail section of the screen will display the message "You have not specified a thumbnail for this form/workflow. Please select one or upload your own thumbnail. If you do not specify one, DocuPhase Forms will display a default thumbnail where required." Once you select or upload a thumbnail, the Current thumbnail section will update with that icon. You will not be able to delete the current thumbnail once it has been assigned but if you update the form/workflow icon by selecting another one from the list or by uploading an image file, the updated icon will be reflected in the Current thumbnail section.

If thumbnail changes are not reflected immediately, refresh the screen.

Production Forms/Workflows

Forms in the Development state have a watermark. Change them to Production to remove the watermark. The Deploy/Undeploy icon v11.3 Deploy icon.PNG on each form/workflow toggles this state. Your license key controls the number of forms that can be set to Production. Deployed forms and workflows appear in the list with a flag icon beside their name.

You will see this message when you click Deploy.

The deployment state defaults to Development irrespective of the default deployment state set by your license key and by your tenant admin for the following scenarios:

  • When a form/workflow is uploaded into your project

  • When you make a copy of your form/workflow

  • When you create a new form/workflow from a form template other than the default template

To manage production forms/workflows go to your My Account: Manage Production forms page. See managing production forms for more information.

Development Watermark

Undeployed forms/workflow (in development) display a watermark to help users understand the status and to prevent misuse of undeployed forms/workflows. 

Deleting Forms/Workflows

When you delete a form/workflow by clicking the Delete iconv11.3 Delete icon.PNG the form/workflow is permanently removed and cannot be restored. The delete operation also deletes all submissions from DocuPhase Forms' submission repository and any saved in-process form/workflow instances.

Before deleting you may wish to download a copy of the form/workflow by clicking the Download icon. See this topic for information on deleting projects.

Downloading the Form/Workflow .zip File

You can download your form/workflow .zip files for archiving, for sharing with another designer, moving it to a development/production project, or to send it to our support team for help troubleshooting. To do so, log in as the designer/owner of the form/workflow. Then,

  1. Click the three-dot action menu beside your form/workflow name. 

  2. Select v11.3 Download Zip icon.PNG Download a zipped version of the form/workflow. A single zip file will be created with the name of your form/workflow, followed by _form.zip or _flow.zip. 

  3. Now, you can maintain the .zip in an archive directory, email it to another user to upload to their project, or send it to DocuPhase Forms support

Uploading/Replacing Forms/Workflows

If your goal is to update your form/workflow to a new version that you had previously downloaded or to revert to an older version previously downloaded, do not first delete the form/workflow since this removes all associated saved/submitted/pending form/workflow instances. Instead, leave the original as it is and upload the version from the disk by clicking the Add Content icon and selecting Upload a Form or Workflow. A dialog will display that lets you:

  • Browse to the form/workflow zip file on disk

  • Select the option of replacing the current form/workflow with this new version

  • Ignore XML schemas in the form being uploaded if those schemas already exist in the project and you intend for the existing schemas to be used.