DOCUMENTATION
  • Welcome
  • Releases
    • 2025
      • Release v6.20.2 (2025-05-07)
      • Release v6.20.1 (2025-05-06)
      • Release v6.20.0 (2025-04-30)
      • Release v6.19.2 (2025-04-11)
      • Release v6.19.1 (2025-03-31)
      • Release v6.19.0 (2025-03-27)
      • Release v6.18.2 (2025-03-11)
      • Release v6.18.1 (2025-03-07)
      • Release v6.18.0 (2025-02-26)
      • Release v6.17.3 (2025-02-14)
      • Release v6.17.2 (2025-02-07)
      • Release v6.17.1 (2025-02-06)
      • Release v6.17.0 (2025-01-30)
    • 2024
      • Release v6.16.0 (2024-12-12)
      • Release v6.15.0 (2024-11-27)
      • Release v6.14.2 (2024-11-05)
      • Release v6.14.1 (2024-11-01)
      • Release v6.14.0 (2024-10-31)
      • Release v6.13.3 (2024-10-16)
      • Release v6.13.2 (2024-10-10)
      • Release v6.13.1 (2024-10-02)
      • Release v6.13.0 (2024-09-25)
      • Release v6.12.2 (2024-09-18)
      • Release v6.12.1 (2024-08-01)
      • Release v6.12.0 (2024-07-25)
      • Release v6.11.5 (2024-07-09)
      • Release v6.11.4 (2024-07-05)
      • Release v6.11.3 (2024-07-03)
      • Release v6.11.2 (2024-06-21)
      • Release v6.11.1 (2024-06-14)
      • Release v6.11.0 (2024-06-05)
      • Release v6.10.2 (2024-05-15)
      • Release v6.10.1 (2024-05-08)
      • Release v6.10.0 (2024-04-30)
      • Release v6.9.3 (2024-03-19)
      • Release v6.9.2 (2024-03-15)
      • Release v6.9.1 (2024-03-06)
      • Release v6.9.0 (2024-02-28)
      • Release v6.8.5 (2024-02-02)
      • Release v6.8.4 (2024-02-01)
      • Release v6.8.3 (2024-01-12)
      • Release v6.8.2 (2024-01-05)
    • 2023
      • Release v6.8.1 (2023-12-22)
      • Release v6.8.0 (2023-12-14)
      • Release v6.7.4 (2023-11-15)
      • Release v6.7.3 (2023-11-14)
      • Release v6.7.2 (2023-11-03)
      • Release v6.7.1 (2023-10-17)
      • Release v6.7.0 (2023-10-13)
      • Release v6.6.4 (2023-09-29)
      • Release v6.6.3 (2023-09-28)
      • Release 6.6.2 (2023-09-14)
      • Release v6.6.1 (2023-08-10)
      • Release v6.6.0 (2023-08-03)
      • Release v6.5.1 (2023-06-23)
      • Release v6.5.0 (2023-06-22)
      • Release v6.4.0 (2023-05-31)
      • Release v6.3.1 (2023-04-28)
      • Release v6.3.0 (2023-04-05)
      • Release v6.2.5 (2023-03-16)
      • Release v6.2.4 (2023-02-01)
      • Release v6.2.3 (2023-01-12)
      • Release v6.2.2 (2023-01-12)
      • Release v6.2.1 (2023-01-05)
    • 2022
      • fylr first Production Ready Release 🎉 (2022-12-22)
  • License
  • Help
    • FAQs
    • Tutorials
      • For Users
      • For Administrators
        • Exporting & Importing Hierarchical Lists
        • Regenerating preview images
        • Search Text in images or office files
      • For System Administrators
        • How to setup and use IIIF
        • External access: Sharing collections with anonymous users
    • Glossary
  • FOR USERS
    • Getting Started
    • Asset / Records Management
      • Creating Records
      • Editing Records
        • Input Fields
        • Group Editor
      • Deleting Records
    • Quick Access
      • Collections (& Presentations)
      • Saved Searches (& Lists)
    • Lists
    • Plugins
      • Plugin Overview
  • FOR ADMINISTRATORS
    • Permissions
      • User
      • Groups
      • Object Types
      • Pools
      • Tags & Workflows
      • Presets
    • Tools
      • CSV Importer
        • General Information
        • Options
        • Examples
          • All Data Types
          • Lists
          • Hierarchies
          • Files
      • JSON Importer
        • Step-by-Step Tutorial
          • Write Import Manifest
          • Create Basetype Payloads
          • Create Object Payloads
          • Collection Payloads
          • Optional: Update links between Objects
          • Start Import
      • Permissions Download & Upload
    • Base Configuration
      • General
      • Access
      • User Management
      • Languages
      • Email
      • Export & Deep Links
      • Workflow Webhooks
      • Publications
      • File Worker
        • Preview Configuration
        • Location Defaults
        • Custom .icc Color Profiles
      • Objectstore
      • Services
      • License Management
      • Development
      • Plugins
    • Plugin Manager
    • Location Manager
    • Messages
    • Events
    • Backup Manager
    • Additional Features
      • IIIF
      • Connector
      • Wordpress
      • Zooniverse
      • Protocols
        • OAI/PMH
  • FOR SYSTEM ADMINISTRATORS
    • Installation
      • Linux
        • multiple fylrs in one Linux
        • proxy and fylr
      • Windows
      • Kubernetes
    • Configuration
      • fylr.example.yml
      • fylr.default.yml
      • performance tuning
      • pre-load frontend config
      • Load Custom Plugins
      • HTTP and HTTPS
      • DNS Domains
    • Backups & Restore
    • Migration Tool
      • Create payloads (fylr backup)
      • Insert payloads (fylr restore)
      • Best Practice
      • Using the fylr inspect page
    • Integration
      • Authentication
      • Hotfolder
    • Symptom & Solution
      • Log messages that can be ignored
      • too many clients are connected
      • too many nested clauses
      • context canceled
      • ContainerConfig error
      • Purge objects
    • PostgreSQL versions
  • Tutorials
    • Project Workflow
    • Hotfolder & File System Connect
      • Preparations Before Usage
      • Setting Up An Upload Collection
      • Importing Files
    • PDF Creator
    • Extracting File Metadata Later On
    • Overlay Resource
    • Authentication
      • LDAP
      • SAML
    • Data Model Sync
    • Purge a fylr instance
    • typo3 plugin
    • Use fylr in Google docs via CI HUB
  • FOR DEVELOPERS
    • API
      • OAuth2
      • Endpoints
        • /api/collection
        • /api/config
        • /api/db_info
        • /api/db
        • /api/eas
        • /api/event
        • /api/export
        • /api/group
        • /api/l10n
        • /api/mask
        • /api/message
        • /api/oaipmh
        • /api/objects
        • /api/objecttype
        • /api/plugin
        • /api/pool
        • /api/publish
        • /api/right
        • /api/schema
        • /api/search
        • /api/settings
        • /api/suggest
        • /api/system
        • /api/tags
        • /api/transitions
        • /api/user
        • /api/webdav
        • /api/xmlmapping
        • /api/task
    • System Data Types
      • pool
      • file
      • user
      • group
      • pool
      • collection
      • message
      • publish
      • event
    • User Data Types
      • text, text_oneline
      • string
      • text_l10n, text_l10n_oneline
      • boolean
      • number
      • integer.2
      • double
      • date, datetime
      • daterange
      • geojson
    • Custom Data
    • Emails
    • Export
    • Exec server
    • File versions
    • WebDAV
    • Plugin
    • Collection Pin Code
    • easydb 5
    • Localization
    • Access private Repositories
Powered by GitBook
On this page
  • Gather Information
  • Data Model
  • Rights Management
  • Installation
  • Migration
  • Setting Up
  • Installation
  • Base Configuration
  • Data Model
  • Metadata Mapping
  • Tags & Workflows
  • Groups
  • Object Types
  • Pools
  • Migration
  1. Tutorials

Project Workflow

This tutorial describes what information needs to be gathered when starting a new project and in which order fylr should be set up.

Gather Information

First, you need to gather some information from your customers. This includes the data model (which fields they need), rights management (which user groups they need), installation (amount of files, URL, ...) and migration (data that should be imported).

Data Model

For setting up the data model, you need at least:

  • Field name (how should the field be called)

  • Field type (should it a single-line or multi-line field, a list, a date field, a number or an upload field)

  • Multiple field (should the field be assigned to the record multiple times or not)

  • List type (should it be a simple list or a hierarchical list)

Depending on the complexity and the customer's knowledge, the following information should be gathered:

  • Mandatory fields

  • Multi-language fields

  • Fields for standard view

  • Fields for text view

  • Fields for table view

  • Fields for full text search

  • Fields for expert search

  • Fields for the filter

  • Splitter

  • Preview versions

  • Metadata mapping

Rights Management

To set up the user groups and permissions, the following information should be gathered:

  • Name of the groups

  • Permissions of the groups

  • Tags & Workflows

  • Name of the pools

  • Anonymous access?

  • Self-Registration?

  • Collection sharing?

  • ...

Installation

To decide on the server size and setup, gather the following information:

  • Storage size of the assets

  • Number of assets

  • Frontend URL

  • Authentification services

Migration

In case you're not migrating from easydb5 or start with an empty fylr, you should ask for the structure of the existing data and how it should be imported.

Setting Up

When all the information is gathered, fylr can be set up.

Installation

Base Configuration

Stuff you might want to configure:

  • General > Title

  • General > Logo, Favicon

  • General > Background Image & Color, Marker Color

  • User Management

  • Languages

  • E-Mail

  • Export & Deep Links

  • File Worker

  • Services

Data Model

When creating the data model, follow these tips:

  • Create the object types for the lists first so you can link to them.

  • If you work with multiple masks, first finish one mask and then copy this mask and make the changes to prevent having to make adjustments twice.

  • Use "Number of new fields" to create multiple fields at once.

  • When adding new fields to existing object types make sure to activate them in the mask(s), otherwise they won't be available.

  • ...

Metadata Mapping

Once the data model is done, you can set up the metadata mapping (if needed).

  • ...

Tags & Workflows

If needed, create the tag groups and tags, so you can use them for the permissions.

Groups

In case there are groups with (almost) the same system rights, create one group with all the needed settings first and then copy this group, change the name and adjust the system rights to save some time.

If you configured anonymous access, make sure to set up the system rights for the group "Anonymous Users" (at least enable "Access Search").

If you want to use collection sharing, make sure to set up the system rights for the group "Pseudo users to see single collections" and "Users invited by e-mail" (at least enable "Access Quick Access (Without Search)").

Object Types

Define for each object type which user group should get which permissions on this list. Please keep in mind, that groups need at least "View Records" and "Allowed Masks" to use the expert search. It could make sense, to assign these two permissions to the group "All users" and then only add the groups that should get more than just read permissions to this object type.

Use the copy & paste buttons on the bottom to copy single permissions or all permissions from one object type to another.

Pools

Create the pools which are needed and set up the permissions. Permissions which apply to all pools should be set up for "All pools" (as permissions are inherited). Permissions that should be used for multiple pools (but not all) can be configured at one pool and then the pool (including the permissions) can be copied. Alternatively use the copy & paste buttons on the bottom to copy single permissions or all permissions from one pool to another.

In case you use a metadata mapping, choose the default mapping for:

  • XMP/IPTC/EXIF Import Profile

  • XMP/IPTC/EXIF Export Profile

In case you need watermarked version, upload a watermark file.

Migration

...

PreviousPostgreSQL versionsNextHotfolder & File System Connect

Last updated 1 year ago

Please refer to , and for more information and make sure to get a .

For more information, please refer to .

For more information, please refer to .

For more information, please refer to .

For more information, please refer to .

installation
configuration
backups
license
"Tags & Workflows"
"Groups"
"Object Types"
"Pools"