Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Box

Custom Binding Grooper.Cloud

Defines a connection to the Box cloud storage platform.

Remarks

BoxCMIS provides a CMIS-compliant interface to the Box cloud storage platform, supporting both user-based and app-based authentication.

Authentication Modes

  • User-based authentication:
    Set the BoxUserID property to impersonate a Box user.
    1. Enable the Grooper application in your Box enterprise using the provided Client ID.
    2. Create a dedicated Box account for Grooper and grant access to the required folders.
    3. Enter the user ID in the BoxUserID property.
  • App-based authentication:
    Set the CustomAppSettings property with the JSON from your custom Box application's settings.
    Grooper will connect using the app's service account, with access to all shared folders.

Repository Structure

  • Exposes a single logical repository containing all files accessible to the configured Box account or app.
  • The repository is presented as a flat structure with a root folder ("All Files").

CMIS Type Exposure

  • Folder Type:
    Exposes a single CMIS folder type (cmis:folder).
  • Document Type:
    Exposes a single CMIS document type (cmis:document).
  • Secondary Types:
    Box metadata templates are exposed as CMIS secondary types, allowing metadata fields to be queried, imported, or exported.

Metadata Handling

  • The MetadataMode property controls how Box metadata templates are exposed:
    • Normal: Standard search, metadata fields are available but search is limited.
    • Strict: Metadata-only search, supports robust queries and immediate reflection of metadata changes.
    • Disabled: No metadata exposure; only standard file/folder properties are available.

Usage Notes

  • Only one authentication mode can be active at a time.
    If both BoxUserID and CustomAppSettings are set, CustomAppSettings takes precedence.
  • The binding supports querying, importing, and exporting Box metadata fields via CMIS secondary types.
  • All operations (create, update, delete, move, etc.) are mapped to Box API calls.
  • For more information, see the Box Developer Documentation.

Properties

NameTypeDescription

Used By

Notification