Photo/Video Control Settings

Add a control that captures a photo or video from the Screen user.

Control Description

The Photo/Video control has the following functionality:

Designing the control: While designing the Screen as a Process Designer, select whether a selected Photo/Video control is used to capture a photo or video when the Screen user interacts with that control. Optionally select a custom overlay that displays over the real-time capture area.
Using the control: Based on how the Process Designer configured that Photo/Video control, the Screen user may capture one photo or video directly from a laptop camera or mobile device. While doing so, an overlay image can display over the control to guide the Screen user to frame what the control captures. That user may evaluate in real-time with the control overlay whether the capture is appropriate and adequate quality. For example, the overlay can help frame taking a photograph of oneself or a national ID card to submit for an application process.
Send the captured video or photo to ProcessMaker IDP: After the photo or video is captured, send it to a ProcessMaker IDP folder for processing using a specified document type. Note that prior to the Screen user capturing a photo or video, ensure to configure which ProcessMaker IDP folder(s) the captured photo or video may be sent after capture. You may need to ask your ProcessMaker IDP Administrator for assistance.

Permissions Required

Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:

Screens: Edit Screens
Screens: View Screens

See the Screens permissions or ask your Administrator for assistance.

Add the Control to a Screen

Permissions Required

Permissions are required to do this.

Design Best Practice

Avoid designing with more than 25 controls in one Screen.

Follow these steps to add this control to the Screen:

View the Screen page to which to add the control.
Locate the Photo/Video icon in the panel to the left of the Screen Builder canvas.
Drag the Photo/Video icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.
Place into the Screen Builder canvas where you want the control to display on the Screen. The following message displays in the control to indicate that the Photo/Video control does not capture while in Design mode: Photo/Video is unavailable in design mode..
Configure the Photo/Video control. See Settings.
Validate that the control is configured correctly. See Validate Your Screen.

Below is a Photo/Video control in Preview mode.

Move the Control on the Page

See Move a Control on the Page.

Copy the Control with its Settings

Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.

Permissions are required to do this.

Follow these steps to copy a control:

Select the control to be copied.
Click the Duplicate Control button. The control copies with its current settings, and then displays below other controls placed on that page.

Delete the Control from a Screen

Permissions are required to do this.

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.

Follow these steps to delete a control from a Screen page:

Select the control to be deleted.
Click the Delete button. The control deletes. Other controls on that Screen page adjust their locations automatically.

Settings

Permissions are required to do this.

The Image control has the following panels that contain settings:

Variable Panel Settings

Click the control while in Design mode, and then click the Variable panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Image control in the Variable panel:

Variable Name

Edit the default Variable Name setting value for this control if necessary. The Variable Name setting value represents data in this control during Requests. Ensure that the Variable Name setting value is a unique name from other controls in this Screen and contains at least one letter. This is a required setting.

Use the Variable Name setting value in the following ways:

Reference this control by its Variable Name setting's value. The Data Preview panel in Preview mode represents the state of the Photo/Video control using its Variable Name value in the Request's JSON data model.
Reference this control's value in a different Screen Builder control. To do so, use mustache syntax and reference this control's Variable Name value in the target control. Example: {{ PhotoVideoControl }}.
Reference this value in Visibility Rule setting expressions.

See best practices when editing a Request variable name.

Label

Edit the default label that displays for this control if necessary. New Photo Video is the default value.

Required

Select to indicate that this control is required for the user to submit the Screen. This option is not selected by default.

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Photo/Video control in the Configuration panel:

Helper Text

Enter text that provides additional guidance on this control's use. This setting has no default value.

What to Capture

Select one of the following that this control captures:

Photo: Select the Photo option to capture a still image from the device. Use this option to record a photograph of the face or a national ID card. This is the default option.
Video: Select the Video option to capture a video from the device.

If the device has more than one camera available, such as a front and rear camera, optionally switch between them in Preview mode and during use.

Intelligent Capture: Send to IDP

Enable the Send to IDP toggle key to send the captured photo or video to a pre-configured ProcessMaker IDP folder.

If the Send to IDP toggle key is enabled but at least one ProcessMaker IDP folder is not already configured, then the following message displays when the Screen opens: 401 Unauthorized: Unable to access the IDP folders. The folders may not be configured for your environment or may not exist. Please contact your administrator. Ensure to configure a ProcessMaker IDP folder prior to deploying this Screen to production.

Understand How to Specify a Document Type

Use a Request variable to indicate the name of the Document_Type Domain's Name setting value in ProcessMaker IDP that the IDP connector uses to process the document(s). This setting does not refer to a file type, such as PDF or DOCX. Instead, this setting refers to the name of the document type in ProcessMaker IDP that has been previously trained to process document(s) in your Dossier. Note that this setting requires the Document_Type Domain's Name setting value, not its Pretty Name setting value. Reference this Request variable using mustache syntax.

To see the document types available on your ProcessMaker IDP instance, see the note Determine Which Document Type to Use in Enter the Document Type to Process section.

Understand How to Configure to Which ProcessMaker IDP Folder to Store the Processed Document(s)

Configure to which existing ProcessMaker IDP folder to store the processed document(s). Configure this folder in one of two ways:

Enter a Request variable that contains reference to the folder.
Select the folder from the Select Destination drop-down menu. Note the following:
- The folder must already exist in ProcessMaker IDP. This setting does not create the folder.
- In the IDP tab within Settings, the destination folder(s) must be configured to be available for use in ProcessMaker Platform.

Follow these steps to use intelligent capturing:

Enable the Send to IDP toggle key. The Document Type setting displays.
In the Document Type setting, enter using mustache syntax the Request variable that indicates the Entity in ProcessMaker IDP that the IDP connector uses to process the document(s).
From the Select Destination setting, do one of the following:
- Use a Request Variable to configure the folder:
  1. Select the Use Request Variable setting. An edit box replaces the drop-down menu.
  2. In the edit box, enter the Request variable name without mustache syntax that specifies the folder name and then press Enter.
- Select the folder:
  1. Ensure that the destination folder is configured in settings for IDP.
  2. Ensure that the Use Request Variable setting is not selected.
  3. From the drop-down menu, select to which ProcessMaker IDP folder to store processed documents.

File Name

Enter the file name that the control saves the capture. Optionally use mustache syntax to set this value. This is a required setting.

Optionally, click the Upload Overlay button to upload a custom overlay that displays over the real-time capture area prior to recording the photo or video. The following file types are supported:

GIF
JPG
PNG
WebP

When an overlay is uploaded, a preview displays below the Upload Overlay button.

Below is an example in Preview mode.

Design Panel Settings

Click the control while in Design mode, and then click the Design panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Image control in the Design panel:

Background Color

Select the background color that displays for this control. Optionally, click the Clear Color Selection option to remove the selected color.

Text Color

Select the text color that displays for this control. Optionally, click the Clear Color Selection option to remove the selected color.

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Image control in the Advanced panel:

CSS Selector Name

Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.

Visibility Rule

Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components. If this setting does not have an expression, then this control displays by default.

Note the following regarding how to use visibility rules:

To make this control hidden until another control contains a value, enter the Variable Name setting value of that control to this control's Visibility Rule setting.
Visibility rules override custom CSS settings.

See the following best practices regarding custom CSS in Screens:

Device Visibility

Select on which device types this control displays:

Desktop: The control displays only on desktop devices. Enable the Show for Desktop toggle key.
Mobile: The control displays only on mobile devices. Enable the Show for Mobile toggle key.
Both: The control displays on both desktop and mobile devices. Both toggle keys are enabled by default.