Deploying and Viewing a Digital Process
  • PDF

Deploying and Viewing a Digital Process

  • PDF

Article Overview

This article describes what is the difference between global and local deployment and what to check before deploying a digital process.  The article also details the different deployment environments, how to deploy and view a digital process, and what happens when alerts or errors are discovered.

NOTE

To quickly learn how to deploy and view a digital process, watch the following video. 

Global and Local Deployment 

Deployment is a process of publishing new changes into a selected server or environment. The Deploy button exists in various screens such as Themes, Services, Webflow, Model. When you click the Deploy button you are prompted to select an environment to which the new changes will be published. When initiating deployment from global platform screens such as Themes or Services, the new published changes will be implemented across the platform on all relevant created digital processes. At the stage of creating a digital process, when you click the Deploy button from screens such as the Webflow, Model, PDF, and Workflow Manager, changes will be published locally and affect only the digital process you are currently working on and will appear when viewing it. Figure 1 describes the flow of publishing new changes from a global platform screen such as Themes:

Figure 1: Deployment from a Global Platform Screen

Figure 2 describes the flow of publishing new changes from screens such as Webflow, Model, and PDF while creating a digital process:  

Figure 2: Local Deployment while Creating a Digital Process

NOTE

The rest of the sections in this article describe how to deploy and view a digital process.

What to check Before Deploying a Digital Process?

This section describes best practices to check and verify before deploying a digital process. It is important to remember that not everything listed in the section is mandatory, it depends on what you are building.

  • Webflow:
    • The Webflow is attached to the desired theme (if more than one theme exists).
    • Webflow components are added to the canvas, and their properties are configured.
    • Webflow components are connected to the model.
NOTE
  • Model:
    • The transaction data items are created and organized according to the desired data structure (objects).
    • Each transaction data item is set to the appropriate field type:
      • string.
      • object.
      • boolean.
      • file.
      • signature.
  • Each transaction data item is set to the appropriate field type:
  • Each transaction data item is associated with a Webflow component.
  • The association is valid (highlighted in yellow).
  • Implementation of:
    • Values:
      • User Input (Default).
      • Autocomplete Service.
      • Multi-option (Static).
      • Computed (Service).
      • Computed (Inline).
      • Expression.
    • Conditions:
      • Visibility.
      • Edit.
    • Validations.
    • Permissions.
NOTE

For additional detailed information regarding the Model, view the Model Overview, Values, Conditions, Field Types, Validations, Permissions, and Setting Up the Model articles.

  • PDF:
    • Adding a PDF:
      • Add pages.
      • Connect PDF to the preview component.
      • Define fields.
      • Connect to the Model.
      • Connect pages to the Model to apply conditioning.
    • Adding a flexible (dynamic) PDF:
      • Install add-in (if required).
      • Add pages.
      • Connect PDF to the preview component.
      • Create/edit pages with Microsoft Word.
NOTE

For additional detailed information regarding PDFs, see the PDF Overview and the Creating and Defining a PDF articles.

  • Workflow Manager:
    • Creating steps.
    • Applying step conditions.
    • Creating communication channels.
NOTE

For additional detailed information regarding the Workflow Manager, view the Workflow Manager Overview and the Configuring a Workflow articles.

Which Environment to Use?

(See Figure 3)

You will usually have two types of environments that you can use to deploy a digital process:

  • Development (dev) - an environment for testing.
  • Production (PROD) - an environment for live deployment.

Figure 3: Deploy Environments

How to Deploy and View?

(See Figure 4 to Figure 8)

To deploy and view a digital process, perform the following steps:

Figure 4: Deploy Button

  1. Click the Deploy button (1).

Result:

A list of available environments (dev and PROD) (2) appears:

Figure 5: Deploy Button

  1. Click the desired environment from the list (2).

Result:

The deployment indicator (3) appears:

Figure 6: Deployment Indicator

  1. Wait until the deployment indicator (3) disappears.

Result:

The deployment is finished, and the result indicator appears (4):

Figure 7: Deployment Indicator

NOTE
  • If the deployment result indicator is it means that the deployment process failed with errors. For additional details see the What Went Wrong - Troubleshooting section.
  • If the deployment result indicator is it means that the deployment process passed but with alerts. For additional details see the What Went Wrong - Troubleshooting section.

Figure 8: Preview Button

  1. Click the Preview button (5).

Result:

The digital process is viewed.

A digital process URL is sharable, for example:
your-server.herokauapp.com/customer-digital-process/page0/0?rid=x1xTxh78TrvA

The Request Identifier (RID) is a unique identifier of an EasySend digital process. A New RID is generated every time a digital process is previewed, and it is a part of its URL.

When sharing the URL of the digital process the RID parameter must not be included, for example:
your-server.herokauapp.com/customer-digital-process/. Each time this link is shared and used, a new unique RID will be generated automatically.

In case the RID is shared as part of the link, it will result in a single session that is shared for all users with the link, making all information fields public.

The URL of the digital process can always be edited using the Process Settings screen. For additional information, see the Process Settings Screen section of the Webflow Overview article.

What Went Wrong? - Troubleshooting

(See Figure 9)

The deployment process may produce some alerts and/or errors in case something went wrong. The indication for alerts (1) and/or errors (2) appears on the right side of the screen next to the Deploy button once the deployment process is over.

Figure 9: Alerts and Error Indicators

Deployment Alerts

(See Figure 10)

Deployment alerts appear when there is an incorrect setup in one of the modules (Webflow, Model PDF, Workflow Manager), for example, a component is not linked to a Model field. The alerts will not break the process, but the process might not work well. In addition, the alerts will not fail a deployment to a non-production server but will fail the deployment to a production server. The alert indicator (1) also indicates how many alerts were discovered during the deployment process.

Clicking the alert indicator opens the Alerts window that displays detailed information about the alerts and enables you to perform different actions.

Figure 10: Alerts Indicator

Alerts Window

(See Figure 11)

The Alerts window displays a list of alerts. It indicates the number of alerts that were discovered (1) and provides a detailed description (2) for each alert. The window has two action buttons, the first one (3) enables you to mark the alert as read to indicate to other Builder users that the alert was acknowledged. Clicking it again marks the alert as unread. The second one (4) enables you to go to the target. Clicking it closes the Alerts window, displays the Webflow again, and marks the Webflow component related to the alert.

Figure 11: Alerts Window

NOTE
If the detailed description is not clear enough, please contact our support team.

Viewing a Digital Process

(See Figure 12)

As mentioned above, a digital process can still be viewed even if alerts were discovered and have not been addressed yet. When viewing a digital process with alerts the following message will appear:

Figure 12: Viewed Digital Process with Alerts

Deployment Errors

(See Figure 13)

Deployment errors appear when the system discovers failures that prevent the deployment process from finishing. The error indicator (1) does not automatically indicate how many errors were discovered during the deployment.

Clicking the error indicator opens the Deploy List window that displays detailed information about the errors and enables you to perform different actions.

Figure 13: Alerts Indicator

Deploy List Window

(See Figure 14)

The Deploy List window displays a list of errors. It describes general information for each error (1), such as when it was discovered, and provides a detailed description (2) for each error. The window has two action buttons, the first one (3) enables you to mark the error as read to indicate to other Builder users that the error was acknowledged. Clicking it again marks the error as unread. The second one (4) enables you to go to the target. Clicking it closes the Deploy List window, displays the Webflow again, and marks the Webflow component related to the error.

Figure 14: Deploy List Window

NOTE
If the detailed description is not clear enough, please contact our support team.

Was this article helpful?