Admin Reference - Box for Salesforce Objects and Settings

Overview

This article covers the public data model exposed by the package—the objects, settings, and metadata types that Salesforce administrators and developers can query, report on, or configure.

Understanding Object Types

The package uses three types of Salesforce data structures:

• Custom Objects
• Custom Settings
• Custom Metadata Types

Custom Objects

These objects store records that can be queried, reported on, and integrated with standard Salesforce features like list views and page layouts.

Folder Management Objects

FRUP__c (Folder-Record-User-Permission)

Purpose: The central junction object that connects Salesforce records to Box folders and defines user access levels.

When to use: Query this object to report on folder collaborations, audit user permissions, or understand which users have access to which Box folders for specific Salesforce records.

How it works:

• Each record represents one user’s permission to one Box folder associated with one Salesforce record
• Multiple FRUP records can reference the same Salesforce record (via Record_ID_Indexed__c), with one record per user defining their permission level
• The package’s scheduled sync jobs automatically create and update these records based on your folder mapping configuration

Key Fields:

Relationships:

• One Salesforce record → Many FRUP records (one per user with access)
• One Box folder → Many FRUP records (one per user with access)
• One User → Many FRUP records (one per folder they can access)

Important: This is the primary object customers query when building reports on folder collaborations and permissions.

Folder_Meta__c (Folder Meta)

Purpose: Catalog object that tracks Box folders managed by the package, storing folder metadata to prevent duplicate mappings and enable share links.

When to use: Typically managed automatically by the package. Reference this object if you need to see which Box folders are being tracked or access folder share links programmatically.

Key Fields:

Relationships:

• Referenced by package Apex code and batch jobs when synchronizing folder information with Box
• Indirectly related to FRUP records through the shared Folder_ID__c field

Box Sign Objects

Object Hierarchy

BoxSign__c (Sign Request)
└── BoxSign_Signer__c (Individual Signer)
    └── BoxSign_Signer_Input__c (Form Fields/Values)

BoxSign__c

Purpose: Parent object representing a single Box Sign request.

When to use: Query this object to report on signature request status, track completion rates, or build dashboards showing sign activity across your Salesforce records.

Key Fields:

Relationships:

• Parent to multiple BoxSign_Signer__c records (one per signer)
• Optional lookups to standard Salesforce objects (Account, Opportunity, Contact, Contract)

BoxSign_Signer__c

Purpose: Represents an individual signer on a Box Sign request.

When to use: Query this object to track individual signer status, identify pending signers, or report on signer completion times.

Key Fields:

Relationships:

• Child of BoxSign__c (master-detail)
• Parent to multiple BoxSign_Signer_Input__c records (form fields)
• Optional lookup to Contact

BoxSign_Signer_Input__c

Purpose: Stores form field definitions and captured values for a signer (checkboxes, date fields, text inputs, etc.).

When to use: Query this object to extract data entered by signers during the signing process, such as agreement dates, initials, or custom form responses.

Key Fields:

Relationships:

• Child of BoxSign_Signer__c (master-detail)
• Leaf node in the Box Sign hierarchy

Document Generation Objects

DocGen_Template__c

Purpose: Stores metadata about document generation templates used by Box Document Generation. Each template references a Box file and can optionally be enabled for Box Sign.

When to use: Create template records to make document generation available to users. Query to build picklists of available templates or to track template usage.

Key Fields:

Relationships: Standalone object. May be associated with Salesforce records through custom automation or flows.

Custom Settings

Custom Settings store configuration data and are accessed via Apex rather than standard SOQL queries. They cannot be used in reports but provide efficient access to configuration values.

Box_Access_Levels__c

Functional Area: Collaborations

Purpose: Hierarchy Custom Setting that controls the Box collaboration permissions granted to users based on their Salesforce record access level. Also configures global collaboration options like folder path visibility and All Files list behavior.

When to Use

• Customize the mapping between Salesforce access levels (Edit, Read, etc.) and Box collaboration roles (Editor, Viewer, etc.)
• Override default collaboration behavior for specific users or profiles
• Control whether collaborators can see parent folder paths
• Configure whether collaborated items appear in users' All Files list

How It Works

When a user is added as a Box collaborator on a record's folder, the BoxAccessLevels class queries their UserRecordAccess.MaxAccessLevel for that record. It then maps this Salesforce access level to a Box collaboration role using the values configured in this setting.

The setting follows Salesforce's hierarchy resolution: User → Profile → Organization (default). If no mapping is configured, the system uses default behavior (Edit/Delete → Editor, Read → Viewer).

Important: The can_view_path__c and is_access_only__c fields are only read from the organization-level default, not from user or profile-specific records.

Fields

Key Fields

Access Level Mapping Fields

Valid values for All__c, Transfer__c, Delete__c, Edit__c, Read__c, and None__c:

• editor - Can upload, download, preview, comment, share, create tasks, edit, and delete
• viewer - Can preview and comment on files
• previewer - Can preview files only
• uploader - Can upload and preview files
• coowner - Same as Editor plus can manage users
• owner - Full control including deleting the folder
• previeweruploader - Can preview and upload files
• vieweruploader - Can view and upload files
• none - No collaboration will be created

Values must match Toolkit.CollaborationType enum (case-insensitive). Invalid values throw an AccessLevelException.

can_view_path__c

Determines if invited users can see the entire parent folder hierarchy. Users do not gain privileges in parent folders—they only see the path structure.

Considerations:

• Only Owner or Co-Owner can invite collaborators with can_view_path=true
• Only applies to folder collaborations
• Recommended limit: 1,000 collaborations with this enabled per user
• Only configurable at organization level (user/profile settings ignored)

is_access_only__c

Controls whether collaborated items appear in the user's All Files list and whether the root path is visible.

Use Cases:

• External vendor collaborations
• Temporary project access
• Guest user collaborations where you want to limit folder clutter

Only configurable at organization level (user/profile settings ignored).

Folder_Details__c (Folder Details) – List Custom Setting

Functional Area: Folder Management

Purpose: Stores basic folder mapping configuration used by the package’s setup flows and UI components.

When to use: Primarily populated during initial setup. Administrators may need to edit these settings when switching object folder mappings or changing the root folder.

Key Fields:

How to access:

• Via Setup → Custom Settings → Folder Details → Manage
• Via Apex: box__Folder_Details__c.getAll() or box__Folder_Details__c.getValues(name)

BoxSignSettings – Hierarchy Custom Setting

Functional Area: Box Sign

Purpose: Stores org-wide configuration for Box Sign features and Box Sign API parameters.

When to use: Administrators configure this during initial setup or when customizing Box Sign behavior. Developers reference these settings when building custom integrations.

Key configuration options:

• Default signers and signer order
• Prefill tag mappings for document merge fields
• Reminder email body and subject line templates
• Box Sign API callback URLs and parameters
• Feature flags and operational settings

How to access:

• Via Setup → Custom Settings → BoxSignSettings → Manage
• Via Apex: box__BoxSignSettings__c.getInstance()

Folder_Name_Configuration__c (Folder Name Configuration) - List Custom Setting

Functional Area: Box folder name override

Purpose: Stores object and field name to override Folder Name rather than always defaulting to the Salesforce record name.

Key Fields:
Name, Name, Text, Object Name to override folder naming convention (e.g. Account)
Field Api Name, Field_Api_Name__c, Text, Field api name to override folder name (e.g. AccountNumber)

Custom Metadata Types

BoxSignDisplaySettings (BoxSignDisplaySetting__mdt)

Functional Area: Box Sign

Purpose: Controls UI and display behavior for Box Sign, such as button labels, page layouts, and field visibility.

When to use: Referenced automatically by package components. Developers can extend to customize the Box Sign UI experience.

Key benefits:

• Deployable across orgs via change sets or source control
• Can be included in managed packages
• Version-controlled with code

How to access:

• Via Setup → Custom Metadata Types → BoxSignDisplaySetting → Manage Records
• Via Apex: Query using SOQL (SELECT ... FROM box__BoxSignDisplaySetting__mdt)

Reporting and Usage

This section applies to Custom Objects only. Custom Settings and Custom Metadata Types are not reportable through standard Salesforce reports.

Standard Report Types

The package installs standard report types for easy reporting:

• Box Folder Collaborations – based on box__FRUP__c
• Box Sign Requests – based on box__BoxSign__c and related objects

Custom Reporting

box__FRUP__c is the primary junction object for folder permissions. Build custom report types to join FRUP with your custom objects or to create cross-object reports.

Box Sign objects follow a simple parent-child hierarchy (box__BoxSign__c → box__BoxSign_Signer__c → box__BoxSign_Signer_Input__c), making them straightforward to extend with custom report types or SOQL queries.

box__DocGen_Template__c can be reported on to track available templates, usage patterns, or audit template configurations.

Best Practice: When querying box__FRUP__c, always filter on box__Record_ID_Indexed__c for optimal performance. The unindexed box__Record_ID__c field exists only for legacy compatibility.

Common Query Patterns

Find all users with access to a specific record’s Box folder:

SELECT box__Salesforce_User__r.Name, box__Permission__c, box__Folder_ID__c
FROM box__FRUP__c
WHERE box__Record_ID_Indexed__c = '001...'

Find all pending Box Sign requests:

SELECT box__Name__c, box__Status__c, box__BoxSign_url__c
FROM box__BoxSign__c
WHERE box__Status__c IN ('Draft', 'Sent', 'Viewed')

Extract signer input data from completed signatures:

SELECT box__BoxSign_Signer__r.box__Email__c, box__Label__c, box__Text__c, box__Date_Value__c
FROM box__BoxSign_Signer_Input__c
WHERE box__BoxSign_Signer__r.box__BoxSign__r.box__Status__c = 'Completed'

Reference: Box for Salesforce Architecture - ERD