ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
File Preview Control Settings
Preview a file that has been uploaded from a previous Task via a File Upload control in that Request.

Control Description

The File Preview control allows the Request participant to configure a file preview that has been previously uploaded to that Request via a File Upload control. After adding the control in the Screen to where to display the file preview, configure the Name setting value for the File Upload control from which to preview the file it uploaded to that Request.
This control is only available for the following Screen types:

ProcessMaker Package Required

To add a File Preview control to a Screen, the File Manager package must be installed.

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 ProcessMaker Screen

Follow these steps to add this control to the Screen:
    1.
    Create a new Screen or click the Edit icon
    to edit the selected Screen. The Screen is in Design mode.
    2.
    View the Screen page to which to add the control.
    3.
    Locate the File Preview icon
    in the panel to the left of the Screen Builder canvas.
    4.
    Drag the File Preview icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.
    5.
    Place into the Screen Builder canvas where you want this control to display the file preview on the Screen.
    6.
    Configure the File Preview control. See Settings.
    7.
    Validate that the control is configured correctly. See Validate Your Screen.
Below is a File Preview control in Preview mode.
File Preview control in Preview mode

Move the Control on the Page

After adding a control to a Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another Screen page.
Follow these steps to move a control to another location on that Screen page:
    1.
    Place your cursor anywhere on the control not displaying the Duplicate Control
    or Delete Control
    buttons.
    2.
    Hold your cursor, then drag the control above or below other controls on that Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, the
    icon displays in the preview.
    3.
    Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.

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.
Follow these steps to copy a control:
    1.
    Select the control to be copied.
    2.
    Click the Duplicate Control button
    . The control copies with its current settings, and then displays below other controls placed on that page.
As a best practice, after copying a control, change the Variable Name setting value for the copied control to its own unique variable value. Otherwise, in-progress Requests that use this Screen read from and send data to both controls.

Delete the Control from a ProcessMaker Screen

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:
    1.
    Select the control to be deleted.
    2.
    Click the Delete button
    . The control deletes. Other controls on that Screen page adjust their locations automatically.

Settings

The File Preview 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 is the setting for the File Preview 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 to reference this value in Visibility Rule setting expressions.
See best practices when editing a Request variable name.

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 is the setting for the File Preview control in the Configuration panel:

File Name

Enter the Name setting value for the File Upload control from which to preview its file that was previously uploaded to this Request. Do not use mustache syntax when entering the File Upload control's Name setting. This setting has no default value.

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 Line Input control in the Advanced panel:

Visibility Rule

Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components for "Visibility Rule" Control Settings. If this setting does not have an expression, then this control displays by default.
Note the following regarding how to use visibility rules:

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.
See the following best practices regarding custom CSS in Screens:

Related Topics

Last modified 3mo ago