The Security Method Field in the SharePoint Object Settings allows you to show or hide files and folders as soon as an sFiles out-of-box component loads based on custom logic in an apex class.

However, the visibility of these items is static. Once the component loads, the visible files and folders cannot be changed dynamically. To update the items displayed in the list view, you must modify the data affecting the security method Apex class and reload the component.

NOTE: Because this is a more involved/complex configuration, customers often require support when implementing it. Since this solution requires custom code and our standard support plan does not cover custom code review, any implementation assistance would require a higher-tiered support.

Steps to Setup the Security Method Field

1. Create a new column in SharePoint

Create a new text column in SharePoint (ex. "SecurityMethod") where you will set the Apex method name. 

• This field will tell sFiles what apex class and method to run to perform the security check.

2. Specify the name of this new column in the Security Method Field

Specify the API name of the SharePoint column created above in the Security Method Field of the related SharePoint Object Settings metadata.

• You can find the API name of a SharePoint Column by using our Custom Column Utility in the sFiles Admin Panel.
• For the example column above, the API name is "SecurityMethod" so I would input this into the Security Method Field.

NOTE: If your filtering logic will require accessing the value of another SharePoint column, enable Run CustomSecurity Per Line.

3. Create an Apex class with sharing logic

Create a new apex class which implements Callable.

• The apex class must have a public Object "call" to implement the System.Callable interface.
  • You can also specify an action if necessary.
• Write conditional logic that returns a boolean value to display or hide the item
  • Each file/folder in the list view will pass through this logic.
• The args contains the contextRecordId (the related Salesforce record Id).
  1. If Run CustomSecurity Per Line is enabled, the args will also contain the custom columns in SharePoint as specified in Object Settings.
     1. If you are specifying visibility based on a specific custom SharePoint column, you will need to get the API name of that column from args
        1. Ex. (string)args.get('mySharePointColumn');
• Example
  • In the example below, I have created an apex class, sFilesSecure.
  • I have specified two actions in the Object call: "visible" and "invisible"
    • If the action is visible, the related file/folder will only display if the SalesforceId column field value in SharePoint equals the Salesforce Record Id.
    • If the action is invisible, the related file/folder will not be displayed.

global with sharing class sFilesSecure implements Callable {
   
    global Object call(string action, Map<string,object> args){
        switch on action {
            when 'visible' {
                //Only Display if the Active Salesforce Record Id matches the Id in the SalesforceId column
                string recordId = (string)args.get('contextRecordId');
                string columnRecordId = (string)args.get('SalesforceId');
                if(recordId == columnRecordId) {
                    System.debug('Allowed');
                    return true;
                } else {
                    return false;
                }
            }
            when 'invisible'{
                System.debug('Prohibited');
                string recordId = (string)args.get('contextRecordId');
                return false;
            }
            when else{
                return false;
            }
        }
    }
}

4. Reference the Apex class and action in the SharePoint column

We have prepared the configuration on the SharePoint-side and the Salesforce-side. Now we need to bring them together.

• In your SharePoint column (ex. "SecurityMethod"), set the name of the Apex class (ex. sFilesSecure).
• If you are using an action, add a "." after the apex class and add the action (ex. sFilesSecure.visible).
• Example: In our example we have setup three folders to follow 3 different scenarios:
  1. Engineering folder: Uses the visible action and the SalesforceId column matches the Salesforce record Id.
  2. Opportunities folder: Uses the visible action, but the SalesforceId column does NOT match the Salesforce record Id
  3. Project Managment folder: Uses the invisible action. 

4. Verify the Configuration in your sFiles component

Navigate to your sFiles component and verify that only the desired items are visible.

Example: In our example, only the Engineering folder will display because it meets the necessary requirements:

1. The action is set to "visible"
2. The SalesforceId field value matches the Salesforce record Id.