Back to Documentation

Back to Documentation

Google API Key Provider

Using a Google API key is recommended to provide users with the optimum experience for searching arbitrary addresses, postal codes, cities and more.

The base provider requires a full non-typed address to get results – Google provides a more “fuzzy” matching experience.

Google provides (as of 1/1/2023) 200 dollars per month credit to a Google cloud account. This entails that your organization can use up to 20,000 api calls a month free of charge.

Obtaining a Google API Key

• • Getting Started with Google Maps Platform
  • Get Google Maps API Key

Using Google API Key

Paste API Key into the Google box in the FirmWorks Geo Configuration screen. 

Interact with any Geocode API using Custom Providers Setups and your own APEX.

Works with standard data integrations in just seconds.

BACK TO TOP

Can be set up for a custom object using APEX to import the geocode data from a provider.

BACK TO TOP

Easily set up multiple configurations for address fields and filters for easy address targeting.

BACK TO TOP

Export list of data for customer visits or plan a specific sales route. 

BACK TO TOP

Customize insights by choosing the data you see on the map and search list.

BACK TO TOP

• From Setup, go to Data Integration Rules
• Enable the following
  • Geocodes for Account Billing Address
  • Geocodes for Account Shipping Address
  • Geocodes for Contact Mailing Address
  • Geocodes for Lead Address

FirmWorks Geo has multiple components that can be used to facilitate showing users what they need to see.

Entity Locator

The Entity Locator includes all components: FirmWorks Geo Search, FirmWorks Geo List, and FirmWorks Geo Map. It is the most comprehensive and versatile component. Just drop it and go.

See below for more information on each individual component.

FirmWorks Geo Search Component

This component allows you to reference the various configurations you have set up to search for addresses within the chosen location.

I am looking for—Here you will choose a configuration build by an admin to set the addresses you want to find.

Filtered to—This allows you to reference filters that are part of that configuration.

With in—Set a number and a distance unit for your search radius.

Of—Enter an address or use your current location. *Note: If you are using the out of box US Census Geo Code data, the address will need to be a full address and cannot be address parts.

i.e. 111 N. Green St Wiltlen, CA 81919, NOT 111 Green Street

Search—Enter an Address or use your current location. *Note: If you are using the out of box US Census Geo Code data, the address will need to be a full address and cannot be address parts.

FirmWorks Geo List Component

The List Component will display a list of the records found based on the criteria set in the search component.

• • Clicking the Download button will download the list of records returned in an Excel document.
  • Clicking on the radio button on the left will center your FirmWorks Geo Map component on that address.
  • Clicking View on the right will navigate you to the record in a new tab.

The columns can be set in the configuration you choose in the ‘I am looking for’ section of the search component.

FirmWorks Geo Map Component

The FirmWorks Geo Map component will show the items from the FirmWorks Geo List based on the search criteria in the FirmWorks Geo Search. When the component loads, it will show a blue circle for the radius of your search.

It can be moved by clicking and dragging, and can be re-centered by clicking on an item on the FirmWorks Geo List component.

You can also switch between Map and Satellite by clicking the buttons on the top left.

FirmWorks Geo Configurator Component

This component can be used to access FirmWorks Geo Configuration wherever you add it. This can be helpful when you need to quickly add a column or change the mapped address fields.

NOTE: Not everyone should have access to the FirmWorks Geo Configuration, only Admins and team members who are familiar with how geocode mapping works. You can conditionally hide the component on pages and lightning apps. Please use the article HERE to understand how.

BACK TO TOP

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 FirmWorks Files Reporting permission set. To assign a permission set, please follow the documentation from Salesforce HERE.

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

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.

Click ‘Run Report’ to return results from your org based on the filters established by the Quick Report selected.

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

BACK TO TOP

There are two buttons in the top right of the Reports section that 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.

• 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.

• Save As: This will open the UI to save a new report whether the report exists or not.

BACK TO TOP

To add a filter to the Selected Object in Step 1, click on the ‘Add a Filter For’ button in the top right. Once the filter row has been added, selecte 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.

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 trash can 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.

BACK TO TOP

Filter Sets

Using Filters Sets, File Reporting can be even more powerful. A Filter Set represents a set of criteria for a single Salesforce objects or File you want to include in your report.

When used in Section 1 of a report a Filter Set will functions as an additional way of grouping filters on a single object. This allow for more comprehensive filtering using AND and/or OR on your chosen object.

When used in Section 2 of a report, a Filter Set represents the same thing, but also offers a second option to track multiple documents as part of a single report. For example, if you wanted to see if an account has both a file tagged as an NDA and a file tagged as an MSA based on a picklist tag field, you would do the following:

First, set up a Filter Set where your criteria is Picklist equal to = NDA. Click + Filter Set and add a Second set with the criteria Picklist equal to = MSA. Finally, change your operator to ‘And Has’. The And Has operator will check for multiple Files for a given object.

Filter Set Evaluation Pattern

Use this box in a Filter Set to determine how your logic evaluates. If all the operators between your criteria are the same, you can use the drop down to set the operator. If your logic needs to change between nodes, you can type your custom logic in the Filter Set Evaluation Pattern box. Once you type logic in this box, the Drop down list will disappear since they are no longer relevant. To get them back remove your custom logic.

View Syntax Button

This button can be clicked at any time to show you the current logic you are using in your filter.

If you are using the And Has operator, the syntax will show a set of criteria for each Filter Set separated by a comma.

Record Return Criteria

• All Records – This will return all records that fulfill the selected object criteria in Step 1.
• Records With Documents – This will return all records that fulfill the selected object criteria in Step 1 and have documents that meet the criteria in Step 2.
• Records Without Documents – This will return all records that fulfill the selected object criteria in Step 1 and do not have documents that meet the criteria in Step 2.

Record Return Criteria

• Schedule Report – This will allow you to schedule a report to drive business process based on the returned results. For more, see the Scheduling Reports section below.
• Run Report – This button will run the report. When clicked, it will go retrieve the data set again and capture any new records that should be returned based on the criteria.
• Download – This button will download an Excel sheet with metadata on the Content Version records returned in the Results section.
• Download Files – This button will download a zip file containing all the documents returned in the Results section.
• View Details – This button will open a new window to show that row’s Selected Objects Salesforce Record.

BACK TO TOP

Basic Scheduling

Scheduling reports allows a report to be run regularly and post platform event. To learn more about which Salesforce technology can subscribe to platform events, please see this Salesforce Article.

To start, click the ‘Schedule Reports’ button to access the scheduling UI. This UI will open the scheduling UI for the current report and also allow you to set schedules for all the saved reports in the org.

• Frequency – There are two options for Frequency: Monthly and Weekly.
• Days – This is a multi-select list that allows you to pick one or more days for the schedule to run on.
• Start At – Set the time of day which you’d like the scheduled report to run on the frequency and days previously selected.

At this point, click ‘Create Schedule’ to generate a scheduled job for the report with the settings selected. 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).

BACK TO TOP

Scheduling a File Report results in a Platform Event being published for each returned from the report. You can subscribe to these events by using a Platform Event-Triggered flow. To setup a Platform Event-Triggered Flow, use the Salesforce documentation HERE. When asked which Platform Event you want to choose, select File Report Event as seen below.

The File Report Event allows access to the following information for use with the flow:

• Event Type – This value is currently set to “Report” to indicate where the event was sourced. It may be updated with new values in the future.
• Message – This Field will be populated with any system error messages that occur.
• # of Documents – This is the Number of Documents associated with the record that was returned from the report for this Platform Event. If the report is set up to return records without documents, this will be 0.
• Report – The ID of the metadata record associated with the report that created the Platform Event.
• Report Details – The Description field from the metadata record associated with the report that created the Platform Event.
• Report Name – The name (Custom-) of the Scheduled Job associated with the  Report Schedule.
• Source ID(s) – The ID of the record returned from the report that created the platform event.
• Status – Blank unless there is an issue.

These files are available from the record object when using the elements in a flow. Generally, using the Source ID(s) field to get records to update is a good practice. Some use cases are:

• Updating a field on a record when a document exists or does not exist.
• Creating a task or Chatter on the Source ID(s) record to alert the owner that action is needed.

Alternatively, you can also ust the File Report Runner for Records.

BACK TO TOP

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’.

BACK TO TOP

Back to Documentation

Enhancements

• File Uploads fields can now be set to be required within the File Configuration Manager. This ability gives your organization the flexibility to require fields per workflow/business unit/department and more. Combined with Salesforce flows – an implementor can set different configurations to the component giving complete flexibility of tagging files.

• When a date or date/time field is positioned first in the filter field configuration for FileViewer component – the date filters will appear before other fields, instead of after.

Features

• Fixed issue with default configuration on upload components errantly setting blank field lists. Default behavior of showing all ContentVersion fields restored.

Features

• Fixed issue with Upload flow component not displaying result tiles after upload completed.

Features

• Firmworks files now supports Spanish and Spanish (Mexico) in user facing components.

Enhancements/Fixes

• Corrected FileViewer Component’s label not resolving from designer.
• When downloading more using FileViewer or Download Button Component) a modal screen now displays giving users the ability to retry a download if the browser or another security mechanism blocks the request.

Features

• FirmWorks files report integration. Run reports directly from the FileViewer component – and then filter the results further. This functionality enables users to engage with many more files

Enhancements/Fixes

• Permissions sets updated to include BulkFileUploadController which is required for the Download button
• File upload visual bug where the word ‘Step’ + number had no space
• Radio button list visual bug where Salesforce CSS selection appears outside of DOM element – appearing clipped
• Fixed issue with bulk upload not indicating matching criteria

Features

• Salesforce Content Notes Integration
• Manage Salesforce Enhanced Content (Notes, Enhanced Notes)
• Search for and tag notes with your own custom picklist fields
• Convert Notes to PDF to share externally 
• Add Notes component to any record layout to help users access, amend and keep Notes current on the record
• Notes are automatically versioned – see what changed between versions and even roll back by promoting an older version

Enhancements

• When entering a User record to share Files/Notes, the user interface will display an option to change ownership
• FileViewer – Exclude specific file types when searching (This feature defaults to excluding SNOTE)

• File Events Integration
  • Control your business processes with File Event Flow Support
  • Create flows using our flow templates to start automating processes around uploading, editing, deleting, and changing content document links and more
  • Unleash the power of flows and let Files automate and finish out your business processes

• French language support for main components

• Fix for invocable method failing without named configuration

• File Searching Issue
  • Addressed issue where Text Area Fields were ignored in search parameters
• File Upload Issue
  • Addressed issue where if the post action is ‘Show Results’ the updating message would sometimes not stop showing—falsely indicating that the process was incomplete (when it had in fact completed)
  • Addressed issue where if the post action is ‘Show Results’ that the embedded file viewer component would show files outside of the current upload sesssions context

• Searching records issue resolved
  • An exception is thrown when searching for records in Sharing and Configuration was surfaced when Salesforce’s Schema service would report that an object (namely form another managed package) is accessible, but that doesn’t take into account if the user has a license to permit searching functionality

• No Changes

• FileViewer, Record Viewers
  • Enhancement—View related record’s files all from one record page. This ability gives admins/configurators the ability to show the relationship’s files from a single record page. For instance, from the Account page layout, view the related Contact’s, Opportunities, Case, or any custom object’s files in addition to the Account’s. This ability can be added to any configuration and supports custom private object relationships to support more strict private access schemas. Contact FirmWorks for any questions

• Minor enhancement in sorting entity sharing results in the drop down

• License check performed on all abjects/fields from other managed packages
  • Behavior appears if a managed package includes a managed Content Version field Salesforce schema checks were erroneously showing fields that a user isn’t license for causing issues when querying information

• FileViewer
  
  • Added option to show/hide titles on tile view
  • Titles no concatenate the Title field with the File Extension field
  • Option provided to hide titles for views (recommend using the “Record’s Content Viewer” component for images ONLY)
• Fixed issue where the user’s value for a field was not being respected when a default value for a field was set in addition to showing the field in the user interface via the filter fields
• Changed default behavior of the file upload components—where the file extensions list is no longer populate. This is inline with Salesforce default behavior.
• The File Extensions now also support the values of ‘any’ or ‘all’ in order to provide support for components that are already on layouts and ahve the default values set (Salesforce doesn’t allow fully clearing designer values)

• Fixed Visual issue with the record editor picklists on FileViewer component

• Compatibility for old version of Files

Enhancements

• File Report result
• Added menu action to show files in FileViewer component

• Added support to use component in flows
  • Added property to pass a list of Records to evaluate “4. Data: Run for these Record Ids” This supports the ability of using a flow to run a report on related items. For example – from an account layout show all of the related contacts that are missing an NDA on their record.

• • When including lookup fields in the report—now pulls the name field to build a hyperlink
• File Tagging
  • Reworked screen initialization to only display options once the configuration has downloaded
• FileViewer
  • Design Configuration added show deleted options to enable Scalable image views
  • Added layout customization to show images and content stacked vertically or horizontally

Fixes

• File Report result
• Added menu action to show files in FileViewer component

Enhancements

• Updated All Metadata to 59.0
  • Record’s Content Viewer Component
    • Added a new Tile View as an option
    • Added ability to control width of component (1-12 for reactive design)
  • FileViewer Component
    • Fixed issue with Sort Direction not being set when sorting on List
    • Added ability to use Scalable Image in Tile View with width/height controls
  • Flows
    • Added Invocable Method to return a File Report Result for a record—this “headless” option can now be used to control a flow-based funtion on the complex criteria of a FirmWorks Files Report
  • File Batch Upload (Available in Upload Layouts)
    • Detect Duplicate Records on Upload
      • Allows Users to remove duplicates based on Title and Size
      • Allows Users to ONLY remove duplicates that Match Title and Size
      • Gives Users the ability to Upload Files with Matching Titles as a new Version instead of a new file
    • New Configuration ‘Default Upload Mode’ to allow Batch to be the default upload style
    • Consolidated UI to a single table
  • Viewer support for HEIC files
    • View HEIC files directly in Safari browser on iOS and MacOS
    • View HEIC files with built-in converter for other supported browsers
  • Updated browser viewer support for PDF
    • Directly handles file data to get around Salesforce misreporting of mime types
    • Helpful for when the built-in image generator doesn’t work as expected
  • File Reporting
    • Include Object fields in the report results

• Added Custom Metadata types to permission sets
  • ContentRecordTypeMapping__mdt
  • File_Viewer_Configuration__mdt
  • Report_Configuration__mdt
• FileViewer Component now supports setting file form records to ‘readonly’ in the configuration
  • (Configuration: Recrd Edit) Accepted values are ‘view’, ‘edit’, and ‘readonly’ 
  • Default value is ‘view’

• Defensive client side checks for firing mobile platform events

• Security house keeping—deprecate use of WITH SecurityEnforced for UserMode

• Allow null/blank values to set on Taxonomy Upload

• FileViewer rebranded to FirmWorks Files

Fixes

• Fixed issue where Date fields were not handled correctly when searching

Enhancement

• FileViewer
• Enabled FileViewer to be available to Flows

Fixes

• File Upload & Tagger for Flows
• Respect blank/empty values for flow component title

What’s New

• Entity Sharing –  Suggested Links Feature
  • Provides administrators the flexibility to suggest which relationships are important to their Users. Provides Users 1-click functionality to share files easily with related records
  • Added Object Type names to help remove ambiguity
• Content Record Viewer
  • Keyboard navigation support or carousel view
• FileViewer Configurator
  • Added additional help text
  • Added Suggested Links configuration to Sharing section
  • New configurations auto open at the top

Fixes

• Fixed issue with Lookup component used for lookup fields (visible from FirmWorks Files List View and Taxonomy screen)
• Added known issue where Salesforce throws an exception using undocumented SOQL

What’s New

• Reporting Enhancements
  • Allow for more complex reporting scenarios with AND/OR in the UI
  • See you SOQL syntax on-screen to aid in report development
  • Multiple document reporting with filter sets
    • For instance, if 3 documents, each with their own criteria, are required, FirmWorks Files reporting now supports these complicated criteria
• Flow Component for File Tagging
  • Ensure documents come in with the correct tagging from screen flows
• Flow component for File report validation. Visually aid users in a screen flow what documents are required to continue. Works with file reports to even block the continuation of a screen flow until documents are added to satisfy the constraints.
• Public Link generation now gives the ability to set the Title, Expirations, and With Password
• Configuration Wizard—Walks you through the process of creating a configuration to use and reuse for your Users
• Support for Record Types on Content Version—Created a utility to cache Record Types and their picklist values for an Admin User. Salesforce does not support access to this information without using an API and all Users do not have API access
• Support to link a document to a library folder in Entity Sharing (Library folders are not marked as searchable from the Salesforce schema)
• New experience permission set to avoid having to clone the File Viewer permission set and remove access to application

Fixes

• Entity Sharing—Correctly resolves names now and does not show [object object]
• Content Viewer—Remove loading screen if User does not have access to specified record
• File Tagging—Removed ‘Step’ verbiage if uploading is only step available
• File Viewer—Tiff support for Safari on OSX
• Home Screen—Detection of new Custom Permissions to aid in erroneous access to links

Fixes

• File Reporting issue where reporting on Salesforce Objects that don’t have Name as the name field has been corrected
• File Reporting issue where downloading results as a CSV for tasks incorrectly attributed the subject column to ‘contentdocumentid’
• Entity Sharing corrected issue not allowing seraching for objects without a Name field (Task, Event, Case, etc.)

What’s New

• Tag+ Upload changes
  • Duplicate file upload check on bulk uploader. When using the bulk uploader a duplicate check is performed and allows the User to remove duplicates and prevent uploading files that already are uploaded
• Upload + Tag no was the ability to have ‘Post Upload Actions’
  • Close—Closes the modal
  • Show Results—Displays a FileViewer with the uploaded files in the same screen
  • Fileviewer—Opens FileViewer in a new tab with the recent uploaded values
• FileViewer control
  • Accepts URL parameter of c__contentids—As a comma delimited list of content document IDs to display. Searching, filtering, and all other behaviors are performed within the list of IDs as the base

What’s New

• Bulk Upload Function for File Tagger Button for Upload—Normally Salesforce only allows you to upload 10 files at a time, but with the new Bulk File Upload feature you can upload 100x as many in a single go
  • NOTE: If you have clickjack protection turned on you will need to add a trusted site to enable Bulk File Upload (Click HERE for more information)
• Download Record Files Component—If you ahve many files in your system use this Bulk Download feature to get a zip file of all your important documents
• Public Link Generation—Whether you want to generate a password protected public link for a single file or bulk generate public links for all your files, we have you covered. The new tabs in the FileViewer UI will allow Users to create public links quicker and easier than ever
• File Sharing Enhancement—Sharing files with another record in Salesforce usually takes a lot of navigation. With the sharing tab in FileViewer, Users can share an existing files with any other object they have access to

Enhancements

• FirmWorks Files Interface Update—We cleaned up the gear menu in the FirmWorks Files component to better organize the new features that have been added in this and previous releases
• Component Name Changes—The name of your favorite FirmWorks Files components have been updated to be more helpful when designing lightning apps
  • Content Viewer is now Single Content Record Viewer
  • File Tag Launcher is now File Tagger Button for Upload
  • Record Content Viewer is now Tabbed Display of Record Content
• Tabbed Display of Record Content—This component can now be filtered using a configuration and can support both horizontal and vertical tabs

Bug Fixes

• There was a validation issue with currency fields in the List View UI for the FirmWorkds Files Component
  • It will say that “The entry is not a valid increment,” but it still saves and updates
  • This no longer happens and the issue has been resolved

What’s New

• Content Viewer Control—Preview PDFs, documents, videos, and audio directly in lightning layouts
• Content Viewer List—Quickly enable your Users by dropping this control on a record layout to visually tab through all of the files related to a record
• File Report Result—Define a FileViewer Report to run and drop this result set anywhere to drive activities
• File Record Report—Define a FileViewer Report and drop this component on a record to visually tell your Users whether the record is in compliance or not with the attached records
• New Persona Support—Data entrym, configure your content versions to enable Users to work through a queue of documents, tagging and building usable libraries quickly and easily within one screen
• Schedule Reports to run generating FileViewer Report platform events to drive behaviors required of your organization (create Task, Chatter Users, etc.)

Enhanced File Previews Using Content Viewer Components

• Integrate your files directly into your work flow, no more navigating away to vew file contents
• View documents directly on record layouts
• View supported audio and video files directly within the lightning page
• Enhanced File Previews directly integrated into the FirmWorks Files search screen to allow for enhanced data entry, minimizing mistakes as Users have direct context to the document being viewed

Data Entry From Files Made Easy

• FileViewer list view user interface updated to support heavy data entry from Salesforce files for auditing file content
• Auto-complete data in rows to more easily enter large amounts of data when using the FileViewer list
• Pagination added to lists to allow for easy navigation over hundreds of files while maintaining changes on previous pages

Reporting

• Enhanced experience of working with, editing, and saving reports
• New reporting control—Configure a report for your Users and deploy it into lightning pages
  • Configure a report and drop a record report on a layout to let your Users know if the record has the appropriate documents related or not
• Scheduled reports to run regularly that publish platform events allowing your implementors to create tasks, objects, drive activities, and flows to close the gap in your document lifecycle

Enhancements

• Files Search
  • List view is now editable to assist Users in data entry directly in the file search
  • List view supports side by side content viewing to facilitate easier data entry from a document into Salesforce
• Reports
  • Reports can be scheduled to run to produce platform event to drive business process
  • Hook into reports using an automation to provide you User insight into data that is out of compliance
• Bug Fixes
  • You will no longer see the following error when editing a page with a FileViewer Component:

Bulk file upload appears to hang on ‘Awaiting Registration’

Experience:

When choosing bulk upload the UI appears to get hung up indefinitely on ‘Awaiting Registration’.

Cause:

Clickjack protection is enabled.

Reason:

Clickjack protection prevents Visualforce pages from being iframed in other domains.

Solution:

Add a trusted domain to your org’s own lightning domain. This will allow components in your org’s domain to serve Visualforce Pages within an iframe.

Add your own Lightning domain as a trusted domain to serve up your Visualforce domain— https://<YOUR DOMAIN>.lightning.force.com.

Success:

Back To Top

File Tagger Component Changes

Moving forward the File Tagger is no longer able to be used in page layouts. If you experience the above error installing the new package you will need to do the following:

• • Remove any uses of the File Tag Launcher component from page layouts and Experiences. Republish any Experiences you removed uses from.
• • Remove any uses of the File Tagger component from page layouts. They will need to recreated later as File Tag launcher buttons so keep track of your Design Settings.
• • Remove from page layouts and delete any Custom Actions that reference the FileTaxonomy component.

Once you install the new package you will need to recreate what you removed, so please make sure to keep track of all of the use cases.

Back To Top

Easily tag Files as they are uploaded.

Driven by you organization’s values.

BACK TO TOP

View image, pdf, and doc files directly on record without navigating away.

BACK TO TOP

Resize the viewing pane directly on the layout to read the fine print.

BACK TO TOP

Create, Delete, View Content Public links easily to provide external users access. Enhances default public link experience by giving users the option to use passwords to protect links. Delete public links easily to redact access.

BACK TO TOP

Create, Delete, View Content Document Link records directly on the layout. Easily create links to any object record in Salesforce more than just users.

Suggested Links to Records

Enable your users to quickly give access to related records using suggested links.

Suggested links look at the currently linked records to the file and gives a one click option to create relationships to related records.

Example: This file was linked to an opportunity. By using a FirmWorks Files configuration the suggested path of ‘AccountId’ is used to suggest the Account ‘DIA’ for the Opportunity ‘DIA’.

After the Account ‘DIA’ linked to the note, the child contact records are then suggested.

BACK TO TOP

Upload hundreds, if not thousands, of files at a time.

BACK TO TOP

Quickly and easily work with your existing files and documents to give them the metadata they need to report, find, sort, and work with them going forward. With support to use the last edited value to quickly update files.

BACK TO TOP

Guide users and customer through a flow to upload files as part of a process and use reporting to validated the files exist before moving on to future steps.

BACK TO TOP

Load viewable file content directly on the screen so users do not have to navigate away from the record they are on.

BACK TO TOP

Report on files and their field values – something not currently available in Salesforce

This example looks for all Accounts where an opportunity has been set to Closed Won within the last fiscal quarter, that also have a file title with ‘MSA’ in it (we recommend using picklists in practice). The power here is that not only can you find Accounts in Compliance with your legal standards – you can quickly find Accounts that are OUT of compliance as well by switching to Records without documents.

BACK TO TOP

Reports can be built to your exacting requirements and scheduled to run on your schedule. Scheduled reports produce Salesforce Platform Events that can be used to drive the behavior and activities required to keep your company in compliance.

BACK TO TOP

Save a report and drop a component on a layout to help alert your users if documentation is missing.

BACK TO TOP

The first step a Salesforce user will need to access FirmWorks Files is the FirmWorks Files Permission Set.

To assign to multiple users at one time:

Setup -> Users -> Permission Sets -> FirmWorks Files -> Manage Assignments (button) -> Add Assignments -> Check the desired users (small checkboxes next to Edit) – >Assign

To assign from a single User record:

Setup -> Users -> Users -> Click on the desired user -> Permission Set Assignments (Related List) -> Edit Assignments (button) -> Move the FirmWorks Files Permission Set to the Right.

The second step to provide users with access to the FirmWorks Files Application will be to allocate a license to them.

Setup -> Installed Packages -> FirmWorks Files -> Manage Licenses -> Add the desired users

BACK TO TOP

Create a ‘Tag & Upload’ Global Action

A Global Action allows system administrators to reuse the same configuration on multiple objects and locations within Salesforce.

Set Up -> Global Actions -> New Action -> Enter the Global Actions as the displayed example -> Save

This Global Action will now be available to add onto any Standard or Custom Object Lightning Record Pages that will provide users with the ability to upload documents and ‘tag’ them all at once.

Adding FWF Components to Lightning Record Pages

The FirmWorks Files’ Managed Package provides three plug-and-play Lightning Components: FileViewer, File Tagger, and File Tag Launcher.

These can all be found below the Standard Components on the Lightning Record Page Editor.

• Content Viewer is a Lightning Component that can be passed a Content Version Id to allow anyone to view that file on any page that allows Lightning Components in Salesforce.

• File Report Results is the Lightning Component that can be used to show File Viewer Report result on any page that allows Lightning Components in Salesforce.

• File Report Runner for Records is a Lightning Component that can be used to sho2 if a record is in compliance based on being a result of a File Viewer Report on any page that allows Lightning Components in Salesforce.

• FileViewer is the Lightning Record Page Component that provides searching, File Tagging, File Downloading, and more directly on a record. This component does not include an upload button, so it is used in conjunction with either File Tagger or File Tag Launcher.

• File Tag Launcher is the Lightning Record Page Component that provides a Tag & Upload customizable button on records. This button is an alternative to the File Tagger component. The button launches a pop-up screen with tagging, uploading, and visibility configurations.

• Record Content Viewer is a Lightning Component that will show a visual for each file on a record in a tabbed form on any record page in Salesforce.

To add any of these components, drag and drop the desired component into the target region of the Lightning Record Page and Save.

Repeat these steps for all Lightning Record Pages per Object where FirmWorks Files will be used.

BACK TO TOP

​The FirmWorks File’s Managed Package provides two plug-and-play Lightning Components to provide a user-friendly way to Tag & Upload Files directly on any Standard or Custom Object Lightning Record Page.

For those conscious of optimizing record page real estate, File Tag Launcher will meet those needs and more. The compact Lightning Component is a single customizable button that will launch the Tag & Upload screen, consuming minimal space on Lighting Record Pages yet still providing all key features for tagging and uploading files quickly.

For those looking to reduce the number of clicks or screens needed to accomplish a single task, File Tagger provides a landscape-like interface that will display the same Tag & Upload options as File Tag Launcher, but directly on the Lightning Record Page.

All FirmWorks Files Lighting Components can also be controlled via standard Salesforce Component visibility.

BACK TO TOP

In the context of FirmWorks Files, a ‘tag’ is the categorization of a file using a custom field on the Content Version Object.

Navigate to the Content Version Object within the Object Manager to create custom fields. Once a custom field on the Content Version Object is saved, it will automatically appear in the FirmWorks Files’s Lightning Components for immediate use.

Setup -> Object Manager -> Content Version -> Fields & Relationships -> New

The following field types ARE NOT currently supported for File tags:

• • Auto-Number
  • Formula
  • Geo-Location
  • Text Area (Long)
  • Text Area (Rich)
  • Text (Encrypted)

BACK TO TOP

By default, the FirmWorks Files Lightning Components will display all custom fields from the Content Version Object anywhere the FirmWorks Files Components are in use.

If you are using FirmWorks Files to tag and organize a wide variety of documents, you may have tags that are applicable to Files attached to Accounts and different tags that are applicable to Files attached to Opportunities.

User-Friendly configurations within the FirmWorks Files Lightning Components allow for you to easily control which custom fields are available within the FirmWorks Files Components based on the Lightning Record Page Assignments.

Control Custom Fields by Object/Lightning Record Page

To control visibility of the custom Content Version fields on different Object’s Lightning Record Pages, enter a list of the applicable field’s API names separated with a comma (comma delimited) into the Configuration: Content Version Fields field.

Example: Custom Field 1 and Custom Field 2 are fields to tag Files uploaded to Contact records, but there is also a Custom Field 3 that is utilized to tag Files on Account records.

 

By entering Custom_Field_1__c, Custom_Field_2__c into the lightning configuration, only the desired Contact related custom fields for tagging are displayed on the Contact Lightning Record Page.

 

Alternatively, Custom_Field_3__c should be entered into the same configuration on the Account Lightning Record Page.

Control FirmWorks Files Filter and Search Fields

To control visibility of the custom Content Version fields available to Filter and Search by on different Object’s Lightning Record Pages, enter a comma delimited list of the applicable field’s API names into the Configuration: Filter Fields field.

Control FirmWorks Files List Columns

FirmWorks Files provides users the ability to view File Search results by List, similar to Salesforce’s List Views.

The List will always have the Files’ Title as the first column, but configuration within the FirmWorks Files Lightning Component provides control of which fields to include and their order. Enter a comma delimited list of the desired field’s API names in desired order.

BACK TO TOP

Back to Documentation

• Flow support for components

• Due to unforseen issues with the original FirmWorks Geo package (namespace firmworks)—We have re-released FirmWorks Geo as “FirmWorks-Geo” with it’s own firmworksGeo namespace. The new package and the old package can be installed concurrently (although confusing as many things are named the same). The removal of the FirmWorks Geo package with the namespace “firmworks” is neccessary to use any other FirmWorks products.

• Support searching from geo coordinates – easily get coordinates from a provider like Google Maps and enter it into the address field – this bypasses API call outs to geocode the address. The accepted values – are valid decimal latitudes and decimal longitudes separated by a comma.
  • 32.80979973546311, -116.906332705415
  • 38.483378, -109.681333
  • 45.019120, -76.898557
  • 0.5, 0.5

• Added ability to limit results returned – helpful for areas where thousands of results causing performance degradation.

• Updated all metadata to v59.0
• Modified firmworks__Nearby_Setting__mdt from Package Protected to public
• Modified Permission Sets to include Custom Metadata
• Introduced Interop – Component Group Alias
  • Because the search, list and map components work via client side events – adding multiple components (via tabs or other layout) resulted in inconsistent behavior.
  • The design time configuration can be set with a unique arbitrary custom value so that the search/list/map and other components can subscribe to the same group that have the same setting.
• List component now can show a driving directions button which can be turned on/off in design – this feature opens a google.com directions screen for the first 23 addresses in the list component. The url can be subsequently shared to a phone for drive navigation.
• List component can now hide the download button
• Introduced contextId in search – If adding the search component to a record layout – a filter can be set to provide subsets
  • for example the search component can be added to an account layout, it can be configured to show a contacts map and list
  • Create a filter on the Contacts Mailing Configuration – Add ‘(AccountId = :contextId)’
  • From within the configuration for the search component on the account layout – set the default filter list and set the filter to the one you created

• Rebrand from “Nearby” to “FirmWorks Geo”

Enhancement

• Map component and List components can now be placed in tabs or other deferred rendering sections aiding with dynamic and smaller page layouts

Fixes

• Support for specifying parent relationships in configuration screen
• Minor fix for using Geo fields on a page layout

• FirmWorks Geo application supports:
  • Multiple ways to set searching from-
    • Built-in Geo Encoding using full address
    • Support for Google API key
    • Using device location
    • Record based from layout
  • List of results with ‘Download as CSV’ option
  • Graphical map showing multiple markers
• Extensible support for contextual record selection for custom LWC and Aura components