PSFileAttachTemplate

THIS SOFTWARE IS COVERED BY THIS DISCLAIMER.

This package contains a Lightning component for declaring a template to define required/optional files to attach to a target record.

It provides following key functionality:

• File Template - create a template to define the required and optional files to allow user to attach to a record. The template utilizes the PSFileAttachTemplate and PSFileAttachDef custom objects. You can specify the following for each file to be attached:

  Parameter	Description
  Filename	the name to set at the title of the uploaded file
  Required	set boolean if file is required
  Allowed Extensions	the file extensions allowed for this document. Provide a comma separated value list like "jpg,png,pdf,zip". Leave blank if you will accept any document format
  Description	a description of the file to upload and any user instructions
  Online Template	a URL to a document template that user can download to fill out and upload
  Upload Field	the API name of field (checkbox) on target object that will get set to true when file is uploaded or false if file is deleted. This field can be used to trigger Process Builer flows for automating other tasks. For example, you could create workflow to trigger once all required files have been uploaded
  Community Access	a boolean field to set if community users should be able to view the file uploaded by internal user
  Review	a boolean field to identify that this document should be reviewed. It will show "yellow" when document is first uploaded until a user clicks the "Document Reviewed" checkbox at bottom of the document card. The user name and datetime when the checkbox was clicked will be logged and displayed
  Filter Field	the field API name on the parent object that you want to filter documents by. This provides ability to show/hide documents based on a record field value. A good use case is to filter based on picklist field
  Filter Values	a comma-separated list of values that above filter field must match to show this document

• Lightning Component - a component that can be used on internal pages or community pages. Component provides a card based layout for your required/optional files to be attached. Uploaded files are highlighted in green, required files that have not been uploaded are highlighted in red, and optional files are highlighted in grey (but change to green when uploaded).

  Configuration options:

  Parameter	Description
  Record ID	[ONLY SET THIS IF USED IN FLOW] this is record id to attach files to which should be variable passed in from Flow
  Template	select the template to apply
  Show File PreviewD	for uploaded files, show a preview of file in bottom of card that allows user to click in to it for more features

The card shows the following:

Parameter	Description
Title	the name of the file as defined in file definiton above. The file name is clickable once a file is uploaded
Description	the description details as defined in the file definition above
File Upload button	section to upload file (either pick file on file system or drag-n-drop)
File State	for files that have been uploaded, the file stats: size, type, load date/time
Template Icon	icon that when clicked will take user to the online template defined in the file definition
Delete Icon	for an uploaded file, a delete icon to easily be able to delete file if needed

Here are steps to use this component:

1. Install the component per the "Deploy to Salesforce" button below
2. Setup users to have access to custom objects that drive the template. Either assign the permset "PSFileAttachTemplate" to your users ...or... make sure users have read/write access to the PSFileAttachTemplate and PSFileAttachDef objects and PSFileAttachTemplate tab
3. If you are using the component in a community, by default is seems the org wide default for the PSFileAttachTemplate object will default to 'Private'. Make sure that is set to 'Public Read Only' else the component will not show in community.
4. Navigate to the PSFileAttachTemplate tab and create a new template. Give it a logical name as you will use this when configuring the Lightning Component later
5. For the template, create a list of file definitions for the files to attach to the record. Set the record fields (filename, required, description, etc...) as defined above
6. Drop the PSFileAttachTemplate Lightning Component on an internal or community page. Configure the Lightning Component and select the appropriate template name you specified earlier.

PSFileAttachTemplate2

A modified version of this component is also provided. This was built for demo requiring uploading multiple files for a given section. This component provides a subsection of features that will be defined below. Here is screen shot of component:

A sample of the component being used is here:

Here are steps to use this component:

1. Install the component per the "Deploy to Salesforce" button below

2. Setup users to have access to custom objects that drive the template. Either assign the permset "PSFileAttachTemplate" to your users ...or... make sure users have read/write access to the PSFileAttachTemplate and PSFileAttachDef objects and PSFileAttachTemplate tab

3. If you are using the component in a community, by default is seems the org wide default for the PSFileAttachTemplate object will default to 'Private'. Make sure that is set to 'Public Read Only' else the component will not show in community.

4. Navigate to the PSFileAttachTemplate tab and create a new template. Give it a logical name as you will use this when configuring the Lightning Component later

5. For the template, create a list of file definitions for the files to attach to the record. Set the record fields (filename, required, description, etc...) as defined above. This component only uses the following fields of the PSFileAttachDef object:

   Parameter	Description
   Filename	the name of the section to upload multiple document for
   Description	a description of this section. For the section header, it will concatenate "[filename] - [description]" as shown in sample screenshots above.
   Order	the order to show the sections in
   Required	boolean if this section is required to upload files
   Community Access	a boolean field to set if community users should be able to view the file uploaded by internal user
   Upload Field	the API name of field (checkbox) on target object that will get set to true when file is uploaded or false if file is deleted. This field can be used to trigger Process Builer flows for automating other tasks. For example, you could create workflow to trigger once all required files have been uploaded
   Minimum	minimum number of files to upload before it is marked as completed for that section
   Allowed Extensions	the file extensions allowed for this document. Provide a comma separated value list like "jpg,png,pdf,zip". Leave blank if you will accept any document format

   All other fields in PSFileAttachDef are ignored for this psFileAttachTemplate2 component.

6. Drop the psFileAttachTemplate2 Lightning Component on an internal or community page. Configure the Lightning Component and select the appropriate template name you specified earlier.