diff --git a/docs/entities/taxonomies.md b/docs/entities/taxonomies.md index 0d5569f..bc3d264 100644 --- a/docs/entities/taxonomies.md +++ b/docs/entities/taxonomies.md @@ -95,12 +95,12 @@ The system includes predefined relation labels for common entity types: ## File Collections -File collections provide a way to organize and group documents and files within epilot, supporting both global collections and entity-specific collections. +File collections provide a way to organize and group documents and files within epilot, supporting both global collections and user-specific collections. ### Structure ```typescript -type FileCollectionSystemFamilySlug = `_system_files_collection_schema_${string}` -type FileCollectionSystemFamilyLabelSlug = `_system_files_collection_schema_${string}:${string}` +type FileGlobalCollectionSystemSlug = `_system_files_collection_schema_${schemaSlug}:${collectionName}` +type FileUserCollectionSystemSlug = `_system_files_collection_schema_${schemaSlug}_${userID}:${collectionName}` ``` ### Types of File Collections @@ -110,8 +110,8 @@ type FileCollectionSystemFamilyLabelSlug = `_system_files_collection_schema_${st - Used for shared documents, templates, and resources - Examples: Company policies, standard contracts, marketing materials -#### Per-Entity Collections (also called User Collections, since they are personal to each user) -- Collections specific to individual entity schemas +#### Per-User-Schema Collections (also called User Collections, since they are personal to each user) +- Collections specific to user and a specific schema - Organize documents related to specific entity types - Examples: Customer contracts, project documentation, compliance certificates diff --git a/docs/files/file-collections.md b/docs/files/file-collections.md new file mode 100644 index 0000000..d2dac0f --- /dev/null +++ b/docs/files/file-collections.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 3 +--- + +# File Collections + +[[API Docs](/api/file)] +[[SDK](https://www.npmjs.com/package/@epilot/file-client)] + +File Collections introduce a fast, intuitive way to group and access files as you work inside entities. They adapt to an org’s workflow, shared and / or personal, and make organising files as simple as drag & drop. And there are two flavours: + +## Global Collections + +Global collections are created from the Label Builder in the 'File Collections' tab. They can also be created using the [Taxonomies](/docs/entities/taxonomies#file-collections) functionality and [API](/api/entity#tag/Taxonomy/operation/createTaxonomyClassification). When creating a global file collection only a taxonomy classification is required to be created - no taxonomy family. + +They are created with a hard association to a schema (opportunity, order etc) and they are shared for the entire organisation. A file added to a global collection is only in that collection for the added entity. It is used to provide a common set of collections that schemas might require on a common basis. + +![Global File Collections](../../static/img/file/global-file-collections.png) + +## User Collections + +User collections are created from the Files area of an entity that has the files capability. They can also be created using the [file collection facade API](/api/file) that simplifies collection creation. + +They are unique to the user who created the collection and have a hard association to a schema (opportunity, order etc). This allows a user to create quick views on files of their choice. + +![User File Collections](../../static/img/file/user-file-collections.png) \ No newline at end of file diff --git a/static/img/file/global-file-collections.png b/static/img/file/global-file-collections.png new file mode 100644 index 0000000..8248be8 Binary files /dev/null and b/static/img/file/global-file-collections.png differ diff --git a/static/img/file/user-file-collections.png b/static/img/file/user-file-collections.png new file mode 100644 index 0000000..d963766 Binary files /dev/null and b/static/img/file/user-file-collections.png differ