ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
File Download Control Settings
Add a control from which the Request participant can download files to a local computer.

Control Description

The File Download control adds an area in the Screen from which the Request participant can download a file to a local computer that was attached to the Request via a File Upload control in a different Screen in that Request.
This control is only available for the following Screen types:

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 Download icon
    in the panel to the left of the Screen Builder canvas.
    4.
    Drag the File Download 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 the control to display on the Screen.
    6.
    Configure the File Download control. See Settings.
Below is a File Download control in Preview mode. The File Download control displays No files available for download until this control references a downloadable file in the Process or during a Process's Request.
File Download 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 Download 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 File Download control in the Variable panel:

Name

Enter the name of the download file. This setting has no default value.

Label

Edit the default label that displays for this control if necessary. New File Download is the 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 File Download 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