Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
CrafterCMS v4.1.9
Light Logo Dark Logo
  • current
  • v4.1
  • v4.0
  • v3.1
  • Getting Started
    • Your First Project (headless)
    • Your First Project (templated)
  • Documentation by Role
    • Architects
    • Developer
      • Content Modeling
        • Form Section Control
        • Repeating Group Control
        • Input Control
        • Numeric Input Control
        • Text Area Control
        • Rich Text Editor Control
        • Dropdown Control
        • Date/Time Control
        • Time Control
        • Checkbox Control
        • Grouped Checkboxes Control
        • Item Selector Control
        • Image Control
        • Video Control
        • Transcoded Video Control
        • Label Control
        • Page Order Control
        • Filename Control
        • Auto Filename Control
        • Internal Name Control
        • Locale Selector Control
        • Components Data Source
        • Shared Content Data Source
        • Embedded Content Data Source
        • Image Uploaded from Desktop Data Source
        • Image from Repository Data Source
        • File Uploaded from Desktop Data Source
        • File Browse Data Source
        • File from WebDAV Repository Data Source
        • Image from WebDAV Repository Data Source
        • Video from WebDAV Repository Data Source
        • WebDAV File Upload Data Source
        • WebDAV Image Upload Data Source
        • WebDAV Video Upload Data Source
        • S3 Repository Data Source
        • Image from S3 Repository Data Source
        • Video from S3 Repository Data Source
        • S3 File Upload Data Source
        • S3 Image Upload Data Source
        • S3 Video Upload Data Source
        • Video Upload then Transcode from S3 using MediaConvert Data Source
        • Video Uploaded from Desktop Data Source
        • Video from Repository Data Source
        • Static Key Value Pairs Data Source
        • Simple Taxonomy Data Source
      • Information Architecture
      • Content Inheritance
      • Content Retrieval APIs
      • Static Content Access
      • Experience Builder (XB)
      • Security (Delivery)
      • Scheduled Jobs
      • Page and Component Controllers
      • Targeting
      • Servlet Filters
      • Working with Dates and Time Zones in Groovy
      • Working with Sass
      • Multi-environment Support
      • Custom Error Pages
      • Adding a New Language
      • Localization
      • Environment Variables Access
      • Templating
        • Working with Dates and Time Zones in FreeMarker
      • Composable
        • Blueprints
        • Plugins
          • Crafter Studio Sidebar Plugin Example
          • Crafter Studio Experience Builder Plugin Example
          • Crafter Studio Toolbar Plugin Example
          • Crafter Studio Dashboard Plugin Example
          • Crafter Studio Project Tools Plugin Example
          • Crafter Studio Navigation Menu Plugin Example
          • Building Form Engine Control Project Plugins
          • Building Form Engine Data Source Project Plugins
          • Crafter Studio Full Screen Plugin Example
        • Crafter Marketplace
      • DevContentOps
      • Working in Your IDE
      • Upgrade
      • Security
      • Logging
    • Author
    • Project (Site) Administration
      • Configuring Publishing to Staging Target
      • Multi-environment Support
      • Project Tools
        • Viewing Logs Through Crafter Studio
        • Workflow States
        • Publishing Status
        • Git
        • Plugin Management
    • System Administrator
      • Installation
      • Configuration
      • Security
      • Performance and Scaling
        • Delivery Environment Performance Tuning
        • Authoring Environment Performance Tuning
        • Studio Clustering
      • Maintenance
        • Backup and Restore
        • Logging
        • Troubleshooting CrafterCMS
      • Upgrading CrafterCMS
        • Upgrading CrafterCMS on a Server
        • Upgrading CrafterCMS on Docker/Kuber
        • Upgrading Studio Cluster
        • Upgrading Search
      • Disaster Recovery
  • Reference
    • Crafter Studio
      • Studio Configuration
        • Blob Stores
        • Project Policy Configuration
        • Project Configuration
        • User Interface Configuration
        • Rich Text Editor Configuration
        • Configure Simple Workflow Notifications and Dialog Messages
        • Content Type Editor Config
        • Dependency Resolver Configuration
        • Project Tools Configuration
        • Asset Processing Configuration
        • AWS Profiles Configuration
        • Box Profiles Configuration
        • WebDAV Profiles Configuration
      • Studio Security
      • Studio Administration
      • Studio Clustering
    • Crafter Engine
      • Engine Configuration
      • Engine Security
    • Crafter Deployer
    • Crafter Profile
    • Crafter Social
      • Crafter Social API
        • Get Current Actions
        • Update Actions
        • Get All Social Contexts
        • Create Social Context
        • Add Profile To Social Context
        • Remove Profile from Social Context
        • Update Email Configuration
        • Get Email Configuration
        • Update Email Template
        • Get Email Template
        • Get Context Preferences
        • Update Context Preferences
        • Delete Context Preferences
        • Clear Cache
        • Create Comment
        • Update Comment
        • Delete Comment
        • Get Comment
        • Search Comments
        • Update Comment Attributes
        • Delete Comment Attributes
        • Update Comment Flags
        • Delete Comment Flag
        • Get Comment Flags
        • Moderate Comment
        • Get Comments By Moderation Status
        • Count Comments By Moderation Status
        • Get Flagged Comments
        • Count Flagged Comments
        • Get Attachments
        • Get Attachment Content
        • Create Attachment
        • Delete Attachment
        • Update Attachment Content
        • Vote Up
        • Vote Down
        • Remove Votes
        • Get Thread Comments
        • Get Comment Children
        • Subscribe
        • Update Subscription
        • Unsubscribe
        • Get Memory Stats
        • Get Status
        • Get Version
    • FreeMarker (Templating) API
    • JavaScript SDK
    • GraphQL
    • Search
    • REST Content Retrieval APIs
    • Groovy/Java API
  • Security
    • Security Advisories
    • Security Policies
    • Security Processes
  • Accessibility
  • Roadmap
  • Support
  • Release Notes
  • Contribute
    • Documentation Standards
    • Open Source Acknowledgements
  • FAQ
    • »
  • Document Under Review
Back to top
Copyright © 2025, Crafter Software Corporation
Made with Sphinx and @pradyunsg's Furo