/
Getting Started with File Management in docuWeaver

Getting Started with File Management in docuWeaver

Overview

  • The steps for uploading and managing files with docuWeaver in Salesforce are outlined in this section.

  • The docuWeaver Lightning Web Component (LWC) must be added to the desired object’s Lightning record detail page before beginning file upload and management.

Adding docuWeaver Component on Lightning Record Detail Page

  1. Navigate to the Salesforce record page (e.g., Account, Opportunity) where docuWeaver needs to be added.

  2. Click the gear icon (⚙️) in the top-right corner.

  3. Select Edit Page to launch Lightning App Builder.

    image-20241223-062133.png
    Add docuWeaver component on lightning page

  4. In the Components panel (left sidebar), scroll to the Custom - Managed section.

  5. Find the docuWeaver component (labeled as "docuWeaver”).

    image-20241223-062833.png
    Add docuWeaver component on lightning page

  6. Drag and drop the docuWeaver component into the desired section of the page layout (e.g., below related lists or in a custom tab).

  7. Configure component properties if required (e.g. Allowed Storage Profile, Max File Size(kB),Always ask profile, Base Path).

Reference

https://enzigma.atlassian.net/wiki/spaces/docuWeaver/pages/329744445/docuWeaver+Lightning+Component#Configuration-Attributes
https://enzigma.atlassian.net/wiki/spaces/docuWeaver/pages/327778305/Storage+Profiles#Base-Path
image-20241223-064503.png
Add docuWeaver component on lightning page

  1. Click Save in the top-right corner to preserve changes.

  2. Activate the page:

    • Click Activation to set the layout as the org default.

    • Assign the layout to relevant profiles or apps as needed.

  3. Return to the record page and confirm the docuWeaver component appears.

image-20241223-065839.png
docuWeaver component on lightning record page

After successfully adding and configuring the docuWeaver Lightning Web Component (LWC) on the desired Salesforce record page, the following steps outline how to upload files and perform key file management actions directly within the component.

Uploading a File

  1. Navigate to the Salesforce record where the file needs to be uploaded.

  2. Locate the docuWeaver Document Management Lightning Web Component (LWC) on the record detail page.

    Locate docuweaver component.png
    Upload File

  3. Click the Upload Files button.

    Upload File 1.png
    Upload File

  4. Select the desired file and click Open.

    Upload File.png
    Upload File

  5. The uploaded file will appear in the component.

    File Uploaded.png
    Upload File

Note: docuWeaver provides Salesforce Files as the default storage option. When no other storage servers are configured, all files uploaded through docuWeaver are stored in Salesforce Files by default.

Previewing a File

  1. After uploading, locate the file in the component.

  2. Click the row menu next to the file to be previewed.

  3. Select View.

    View.png
    Preview File

Note: File preview functionality is dependent on the file extension and browser support. Only file types supported by the browser will be previewable.

Updating a File

  1. In the file list, click the row menu next to the file requiring an update.

  2. Select Upload.

  3. Choose the new version of the file and click Open.

    Update.png
    Update File

  4. The file will be updated, and a new version will be added. To view previous versions, use the row menu and select Version to see the file’s version history.

    All versions.png
    All Versions

Note: When a file is uploaded using the docuWeaver component, the following sequence occurs:

  1. File Upload to Storage Server:
    The file is uploaded directly to the configured storage server (such as Salesforce Files, Amazon S3, Azure Blob, or another supported provider).

  2. File Record Creation in Salesforce:
    After the file is successfully stored on the storage server, docuWeaver creates a file record inside Salesforce. This record is stored under a custom object (named “Attachments”) within the docuWeaver managed package.

  3. Record Association:
    The file record is associated with the specific file, enabling tracking, management, and retrieval of the file directly from within Salesforce records

Downloading a File

  1. In the file list, click the row menu next to the file to be downloaded.

  2. Select Download.

    Download.png
    Downloading File

Deleting a File

  1. In the file list, click the row menu next to the file to be deleted.

  2. Select Delete.

  3. Confirm the deletion in the popup dialog by selecting Yes.

    Delete.png
    Deleting File

Note: When a file is deleted from a component in Salesforce, it is also deleted from the connected external storage but remains in the storage's recycle bin. The corresponding Salesforce record is moved to the salesforce’s recycle bin. Recovering the file from either Salesforce or the external storage automatically restores it in both systems, ensuring synchronization.