AX1616

Using a button in a form to upload attachments

You can use a Button component within a form-enabled plan file to allow users to upload attachments associated with that plan file. This functionality can be used as a substitute for the Attachments panel in the Web Client Task Bar, or in conjunction with the panel.

NOTE: This feature is primarily available for backward-compatibility. Going forward, the File Attachments panel or the File Attachment command should be used instead to allow users to upload, view, and manage attachments in the Web Client.

Requirements and limitations

  • You can allow users to upload new attachments for a plan file by using a Button component that is configured to use the Upload Plan File Attachment button behavior. This behavior option is only valid for use in form-enabled plan files, and only if the file group has enabled the plan file attachments feature. If you configure this behavior in an environment that does not support use of it, then the upload button will still operate but an error will occur when attempting to upload the attachment.

    NOTE: This button behavior is only available for Button components. Button tags for Formatted Grid components do not support this behavior.

  • When using the upload button, the normal button refresh process occurs after the upload message box is dismissed (whether the message reports success or failure). There is no way to disable this refresh.

  • The upload button only allows uploading attachments. Attachments cannot be opened, edited, or deleted using the button.

Configuring a Button component to upload attachments

To allow Axiom form users to upload file attachments using a button, you must add a Button component to the form and set the Button Behavior to Upload Plan File Attachment. The button text should be set to "Upload Attachment" or something similar.

Example upload button configuration

This button should be placed in the template file, so that all plan files created from the template have access to the button.

User experience

The following is a summary of the button behavior within an Axiom form, so you have a better understanding of the user experience.

  1. The user clicks the button when they want to upload a file attachment.

  2. The Choose File to Upload dialog opens. The user browses to the file that they want to upload as an attachment.

    NOTE: If the user is on a tablet, they are given the option to select an existing picture to upload or take a new picture to upload.

  3. A message box shows the upload progress, and then shows when the upload is complete (or if it failed).

  4. The Axiom form automatically refreshes after the message box is dismissed.