Embed sFiles Experience Cloud Components

sFiles includes two Community specific lightning components in the package: Uploader and List View. The uploader gives Community users the ability upload files directly to a specific record-linked folder in SharePoint. The list view offers a list of all files and folders that the user has permission to view and allows download of files using a secure dynamically generated hyperlink. Both components are built using Lightning Web Components and are designed to work within a record context. This document will cover how to embed each of these components into another Aura component or Lightning Web Component, and what parameters each of these components accept when not used on a record page.

Feb 9, 2024
Knowledge

Title

URL Name

Embed-sFiles-Experience-Cloud-Components

Article Body

Prerequisites

Before using the Community components, a SharePoint Object Settings must be created specifically for Community-use. Furthermore, a Named Credential authenticated as a Named Principal must also be set up for Community-use. Each SharePoint Object Settings will need its name encrypted using the encryption tool for use in the Community components.
In order to embed sFiles's LWC you will need to have Lightning Web Security turned on. Read more how Lightning Web Security works here: https://developer.salesforce.com/docs/platform/lwc/guide/security-lwsec-architecture.html?q=managed+package

Steps to embed components

Upload Component

Upload component in LWC

Use the code below inside your LWC:

<fileforcem1-community-uploader record-id={recordId} unique-id="encrypteduniqueobjectkey" label="Upload file" show-folders="true" helptext="Select a file" type="none"  ></fileforcem1-community-uploader>

Upload component in Aura component

Use the code below inside your Aura component.

<fileforcem1:communityUploader recordId="{!v.recordId}" uniqueId="encrypteduniqueobjectkey" label="Upload file" showFolders="true" helptext="Select a file" type="none" ></fileforcem1:communityUploader>

Parameters

Label	Name	Description
Record Id	recordId	Override the record Id when not placed on a specific record page context.
Label	label	Larger label to show above the upload form.
Help Text	helptext	Small text to show above the upload form.
SharePoint Object Settings Key	uniqueId	Unique key of SharePoint Object Settings generated by Object Settings Key Generator in sFiles App Settings.
List View Display Type	type	Choose whether to display the files and folders in this folder in a card view or list view, or none at all. (Available types: None, List, Card)
Show Folders	showFolders	Whether to display subfolders or not. Defaults to false.
Show File Icon	showFileIcon	Show the file icon next to the name.
Search type (Only if List view is displayed))	searchType	Quick filter will filter down the folder by name. Search (beta) will search the contents of the folder and also enable you to search children. Available values: None, Quick filter, Search (beta) None: no search field will display Quick filter: Quickly filters the loaded items in the list view Search: Searches for files or folders in the current folder.
Max Height	maxHeight	Maximum height in pixels of the component.
Site Id field name	siteIdField	Override your default site by entering the name of the field where the Site Id is kept.
Document Library Id field name	documentLibraryIdField	Override your default Document Library by entering the name of the field where the Document Library Id is kept.

List Component

List component in LWC

Use the code below inside your LWC.

<fileforcem1-community-list record-id={recordId} unique-id="encrypteduniqueobjectkey" show-folders="true" type="List" ></fileforcem1-community-list>

List component in Aura component

Use the code below inside your Aura component.

<fileforcem1:communityList recordId="{!v.recordId}" uniqueId="encrypteduniqueobjectkey" type="List" showFolders="true" ></fileforcem1:communityList>

Parameters

Label	Name	Description
Record Id	recordId	Override the record Id when not placed on a specific record page context.
SharePoint Object Settings Key	uniqueId	Unique key of SharePoint Object Settings generated by Object Settings Key Generator in sFiles App Settings.
List View Display Type	type	Choose whether to display the files and folders in this folder in a card view or list view, or none at all. (Available types: List, Card)
Show folders	showFolders	Whether to display subfolders or not. Defaults to false.
Show File Icon	showFileIcon	Show the file icon next to the name.
Search type (Only if List view is displayed))	searchType	Quick filter will filter down the folder by name. Search (beta) will search the contents of the folder and also enable you to search children. Available values: None, Quick filter, Search (beta) None: no search field will display Quick filter: Quickly filters the loaded items in the list view Search: Searches for files or folders in the current folder.
Max Height	maxHeight	Maximum height in pixels of the component.
Site Id field name	siteIdField	Override your default site by entering the name of the field where the Site Id is kept.
Document Library Id field name	documentLibraryIdField	Override your default Document Library by entering the name of the field where the Document Library Id is kept.