Explanation of the most important caisy expressions and the caisy wording
Every caisy user has their own account in caisy that is connected to their email address.
The following rows describe the different settings of the acount in caisy.
– Your account
Under “Your account” users can check the Groups, Projects and Organizations they are part of and manage their Profile Details, Personal Tokens and User Settings. This section is accessible by clicking on the small button in the lower left corner that shows the current user's profile picture (if uploaded) or initials.
– Personal tokens
Under “Personal Tokens” individual tokens can be created and managed. This section is accessible by clicking on the small button in the lower left corner that shows the current user's profile picture (if uploaded) or initials.
– Profile details
Under “Profile Details” the profile picture and name of an account can be changed. This section is accessible by clicking on the small button in the lower left corner that shows the current user's profile picture (if uploaded) or their initials.
Under “Settings” specific parts of the caisy interface such as the UI-language can be changed. This section is accessible by clicking on the small button in the lower left corner that shows the current user's profile picture (if uploaded) or initials.
API (Application Programming Interface)
An “API” is a software intermediary that allows different applications to communicate, enabling developers to access and use certain features or data from another software program or platform.
Uploaded media files, such as images, pdfs or word documents plus their meta data are called “Assets” in caisy.
The following rows explain more details about assets in caisy.
Inside of an asset, the button “Preview” shows, how an asset will look like to the viewers.
Assets can be edited in caisy (see also image editor).
Inside of an asset, the option “Download” lets users download an asset to their device.
Inside of an asset, the red button “Delete” is to delete the asset from caisy.
A blueprint in caisy is a pre-designed structure for creating and managing content, facilitating consistent formatting and organization of content across all devices. When creating a blueprint users can fill it with a variety of fields that can be named individually – Without these fields, the blueprint would just be an empty frame.
The following rows describe the different fields for blueprints in caisy.
A connection field can be used to connect the document with for example components
A asset field implies that media assets, for example a logo can be uploaded there.
A string field is an empty and unformatted text field that can be used for different types of texts, such as a description or the author of something.
A richtext field is useful for longer and more formatted text blocks, such as the body text of a blog post.
A number field is to add a number, such as an ID.
A color field lets users add a color.
A boolean field can be used to store a value that is either true or false, such as whether to display a certain section on a page or not.
A Date and time field is useful to add information concerning a date and time, such as the release date of an article.
A select field can be added to select between different options.
– Geo point
A geo point field can be used to display a geo point, for example the location of a shop.
A tag field is useful to add a tag.
– UI extensions
This field is for developers to connect external UI fields.
If users need help, in the lower left corner of the interface there is a button looking like a speaking bubble that provides help in shape of a chatbot.
The caisy changelog is a record of all the changes and updates made, including new features, and improvements. The changeling is publicly available on the caisy homepage.
Components are reusable units to structure different types of content, quickly to define and fill with content, such as text, images, and other elements logically.
The “Create”-button is used to create something new in caisy, for example a new document or a new asset. This button is located in the upper right corner.
Content stored in, built or published with caisy can also be deleted again. The “Delete”-option can mostly be found under the small button with the three dots.
A document in caisy refers to a specific part of a project, which can be copied, linked to each other and specific pages to save time and structure projects.
The following rows explain more details about documents.
Under “Configurations” inside of a document the translations can be chosen.
Under “Details” inside of a document, the user can check more details, like the blueprint or when the document was created.
– Document structure
Documents in caisy are structured into different fields. Especially with large documents this is useful in order to quickly find and edit desired parts.
Every document has a status that shows when searching for a document or inside of a document in the upper right corner – this is where the status can also be changed. The different types of status in caisy:
Work that is marked with the status “draft” was started but is not yet ready to be published. “Published” means that the document was already published. And when changes were made that are not yet published, the status will show “changed”.
With extensions, developers can change caisy’s fundamental capabilities, e.g. design their own user interface, integrate third-party data or build entirely new features.
A feature refers to a specific functionality or capability provided by caisy, such as Localization or Scheduling.
A blueprint consists of different fields (described under "Blueprint"). These fields can be edited by clicking on the button that looks like a small wheel.
The following rows describe the different field editing options in caisy.
Under “Settings”, the Title, API and Description of a field can be edited.
Here users can give the field an individual title, so they always know what the field is for.
Here users can choose an API name for the field.
If a further description of the field is useful, here users can type one.
Under “Validations” some basic and other validations can be set.
–– Set field as unique
If a field should be unique, meaning no mutations, this can be selected here.
If a field is required to be filled, it can be selected here.
–– Match a specific pattern
If a field should match a specific pattern, it can be selected here.
–– Limit characters
If a field should only be allowed to fill with a limited amount of characters, users can choose between “disabled”, “no less than”, “no more than” and “between” here and choose a number.
– Advanced options
Under “Advanced options” further options can be set.
–– Disable in response
If the field should not be returned in the API, this can be chosen here.
–– Hide field
This option is to make the field visible in the API, but invisible to the editor.
Here users can activate localization for the field.
Full text search
With the full text search users can easily search data in caisy by entering text into the search bar.
For flexible and customizable data retrieval and manipulation within caisy, developers can use GraphQL. GraphQL is a query language for APIs that enables developers to request data.
For a better overview, caisy-users can create groups consisting of different members and assign them specific projects.
The following rows explain more details and options about groups.
– Create new group
Users can easily create new groups, name them and add members.
– Move Group
In an organization under “Groups”, the groups can be moved from one organization to another by clicking the button with the three dots.
By clicking on the button with the three dots right of a group, users can click on “Details” to see the members, projects and general settings of a group.
– General settings
In the general settings of a group, settings such as name, description or picture of a group can be seen, edited and a group can be deleted.
Headless CMS (Content Management System)
A headless CMS is a content management system that provides content storage and management without dictating how the content is presented, as the frontend and backend are separated. This allows for greater scalability, flexibility and freedom in development.
Caisy has an integrated image editor, to edit pictures right in the CMS. Users can make different changes to their uploaded images, such as cropping, zooming, rotating or editing the brightness, contrast, saturation and opacity.
The following row describes options for saving edited images.
After editing an image there are multiple options to save it. After clicking on “Save”, users can choose between "overwrite current" or "create new" asset. The first option overwrites the old image completely, the second option creates a new asset so that both, the original and the edited version of the image are saved.
Inside of caisy users can use links to connect assets, documents, components and more.
The following rows describe the different types of document linking in caisy.
With inline linking the linked document can be edited within the main document and be expanded downwards to edit the fields.
With separate linking the linked document can be edited in a separate tab.
Locales + localization
Translating content for different regions is referred to as “Localization”, while specific areas and their languages are called “locales”.
Organizations, groups and projects in caisy have different members. Users can be members of multiple organizations, groups and projects and have different roles that match their responsibilities.
Thanks to caisy’s multitenancy-feature, users can structure their work into multiple projects, groups and organizations easily and switch between them in seconds.
To create and modify the data of documents or components with the external API, users can work with “Mutations” in caisy. Then three GraphQL mutations will be created: A create, update and delete mutation.
For the best overview users can set up multiple organizations and switch between them. Within these they can structure corresponding projects assigned to different groups.
The following rows describe the different options to make changes to organizations.
– Create organization
Users can create a new organizations by clicking on “Create new organization”.
– General settings
In the General settings users can see the settings of an organization and make changes, for example to the picture, name or delete the organization.
In the Organizer all organizations, groups and projects the user is a part of can easily be checked, searched for and accessed.
The following rows describe the different options users have in the organizer.
– Create new group
Under the list of groups in the organizer there is the button “Create new group” to create a new one.
– Icon behind the user role
On the right of each organization, group and project in the organizer, users can see their role. Right next to that role there is an icon showing a small wheel. By clicking on that icon the corresponding members-section opens up, that shows the other members and their
– Magnifier icon
The magnifier icon in the organizer lets users search for projects quickly and easily by entering text into an empty search bar. All matching results appear.
– Create new project: Empty project
When creating a new project, users can choose to start building the project from ground up, without reusing any pre-existing work by choosing “Empty project”.
– Create new project: New from existing project
When creating a new project, users can choose to build a new project and reuse existing work from previous projects and select specific parts they want to copy by choosing “New from existing project”.
Depending on their role, every user has individual permissions concerning the changes they are allowed to make.
The space for developers to play around with caisy: The “Playground” is where developers can interact with and test GraphQL API queries and mutations in caisy, making it easier to explore the data schema, test mutations, and debug issues.
The following rows explain more details about the caisy Playground.
Type definitions for the GraphQL Schema
Tool to generate GraphQL queries with a UI
Local History of recent GraphQL queries
Custom HTTP Headers send with the request
caisy offers a (live) preview of edited content, without having to publish it first.
Users can create multiple projects in the system and switch between them whenever they like.
The following rows describe more details and options of projects.
– Move Project
It is possible to move projects, which means assigning them to a new group.
By clicking on “Details” (located under the button with the three dots next to a project), users can access the members, general settings, development and auditlog of a project.
– General settings
Under general settings, settings like the name, description or picture of a project can be changed. This is also were users can delete a project.
Under the auditlog all changes that were made to a project including the dates can be checked.
A new publication in caisy is a release. These releases can be scheduled.
The following rows describe different terms related to releases and scheduling.
Releases that are scheduled with a time and date are “upcoming” releases.
Releases that don't have a predefined publishing date and time yet go under “unscheduled” releases.
Releases that were scheduled and have already been published are sorted under “past” releases.
– Release calendar
The release calendar shows the current month and highlights dates with upcoming or past releases for a quick overview.
– Release Name
Every release can be given an individual release name. This is the first step of creating a new release.
– Release content
When creating a new release, users can add the documents that it should contain under the field “Release content”.
– Scheduled action
Not only publications, but also unpublications can be scheduled in caisy. Users can choose between these options under “Scheduled action”.
– Release date & time
When creating a new release, users can easily choose a concrete release date and time under “Release date & time”.
When creating a new release, users can also choose the timezone.
The “Rich text editor” makes it easy to write and structure texts and even include tables, media, links and more with a tool bar.
The caisy roadmap shows which changes and new features we’re working on at the moment, what is planned and what we are discussing. The roadmap is publicly available on the homepage.
Users are assigned different roles that match their responsibilities.
The following rows describe the different roles in caisy.
The role “viewer” can access and view the documents of the project but is not authorized to make any changes.
The role “contributor” supports a project by editing content and is not authorized to create new documents.
The role “editor” actively works on a project on a regular basis. An editor can create and edit content.
The role “administrator” is in charge. He or she has access to all sections of a project and can invite new users, assign and change roles.
The role “owner” can access all areas of a project, invite new users, assign and change roles.
The role “developer” can create and edit content like an editor and has more possibilities under the menu item “Development”.
SDK (Software Development Kit)
An SDK is a collection of software development tools to support developers. caisy comes with a TypeScript SDK.
A project that is not assigned to a group counts as an “ungrouped” project.
Unique document / component
If a document or component is selected as “unique”, no mutations are allowed.
If a field is selected as “unique”, no mutations are allowed.
The “Upload”-button in the lower left corner of the UI can be used to upload new files and assets into caisy.
Versioning is the name of a caisy-feature that autosaves older versions of a project and makes it easy to compare them with each other in order to publish the best version.
During a search, users can filter the main content list according to various criteria and create lists of filters, which are called views. These can be saved as shortcuts in the sidebar, with multiple views being organized into sections.
The following rows describe the different types of views in caisy.
– Shared views
Views that are shared with other members of a project are called “Shared views”.
– Personal views
Views that are private and only for personal use are listed under “Personal views”.
– Pinned views
“Pinned views” are like a shortcut to specific search filters that are used on a regular basis, so users can access these views quickly.
– Default views
The “Default view” folder is available by default.
Individual views can be structured into sections for a better overview.
A webhook is an HTTP request sent from caisy to an external system, containing information about events occurring in the project, which is useful for various external features such as form submission and email sending.