View on GitHub

fileviewer

firmworks product FileViewer documentation and release details

Documentation

File Reporting

Configuration and Setup

All System Administrator based profiles can see the File Report tab after installation. To allow other users to see the tab you will need to assign them the FileViewer Reporting permission set. To assign a permission set please follow the documentation from Salesforce (https://help.salesforce.com/s/articleView?id=sf.perm_sets_assigning.htm).

Using Select Reports

Start off by clicking the Select Reports button to see some out of box reports based on standard Sales Cloud objects (Accounts, Contacts, and Opportunities).

FileViewer Report Quick Reports

Once the Reports UI is open click the load icon to the left of a report to fill in the criteria in the sections below.

FileViewer Report Quick Report Filters

Clicking Run Report will return results from your org based on the filters established by the Quick Report selected.

FileViewer Report Quick Report Results

From here you can save reports, add/remove filters, change the record to return criteria, and interact with result records.

Saving Reports

There are two buttons on the top right of the Reports section will save the current filters. This will start a save event that will commit the report to the database and make it available in the Quick Reports menu.

  1. Save Report - This will save the report under the existing name. If it is a new report it will ask you to input a name and a report description.

  2. Save As - This will open the UI to save a new report regardless if the report exists or not.

FileViewer Report Quick Report Saving

Adding or Removing Filters

To add a filter to the Selected Object in Step 1, click on the Add a Filter For button on the top right. Once the filter row has been added selected the field from the Field Name selection, choose an Evaluation criteria, and set a value. For more help on supported values click the question mark at the end of the row.

FileViewer Reporting Filters

You can also change the Selected Object by using the Selected Object drop down. This will remove all of the current filters, so make sure to save your changes before modifying the Selected Object.

To remove a filter click the trashcan next to the filter row you wish to remove.

Follow the same steps above to add or remove a filter from the tagged documents section in Step 2.

Record Return Criteria

FileViewer Reporting Included Records

The buttons in Step 3 will allow you to change the returned record set.

Results Buttons

FileViewer Reporting Results

Scheduling Reports

Basic Scheduling

Scheduling reports will allow a report to be run regularly and post platform event/ To learn more about which Salesforce technology can subscribe to platform events please see the following Salesforce Article, https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_subscribe.htm.

To start click the Schedule Reports button to access the scheduling UI. This UI will open the scheduling UI for the current report but will also allow you to set Schedules for all the save reports in the org.

FileViewer File Report Scheduling

At this point you can click Create Schedule to generate a scheduled job for the report with the setting you choose. You can generate more than one scheduled job for a report if needed.

Advanced Scheduling

The Advanced button in the scheduling UI allows a user to input their own cron expression or have the choices build one. Once the advanced button is set the cron expression is no longer going to affect the choices (they are greyed out to indicate this)

FileViewer File Report Scheduling

Using Flows to Automate Action From on Scheduled Reports.

Scheduling a File Report results in a Platform event being published for each returned from the report. You can subscribe to these event by using a Platform event triggered flow. To setup a Platform Event Triggered Flow use the Salesforce documentation here https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_subscribe_flow.htm. When asked which platform event you want to choose select File Report Event as seen below.

FileViewer File Report Scheduling with Flow

The File Report Event allows access to teh follow information fo use with the flow:

FileViewer File Report Scheduling with Flow

These files are available from teh REcord object when using the elements in a flow. Generally, using the Source Id(s) field to get records to update is a good way to go. Some use cases are:

Alternatively you can also use the FIle Report Runner for Records

Creating Custom Reports

Instead of using Quick Reports, a custom report can be created to store reports for specific business needs. To create a new report choose an object from the Select Object section in Step 1. Next add filters to that object and the docmuents you want to see in Step 2 and Step 3, respectively. Then choose which results you want to return in Step 4 and click Run Report.

FileViewer Reporting Custom Report Creation

You can save this report for future use using the same steps in the Saving Reports above.


FileViewer FAQ

For FileViewer Support, please contact support@getfirmworks.com