Updated On 4.0.1

Project Configuration

The project configuration file contains the primary configuration for Crafter Studio’s behavior. Each project has its own project configuration file that controls its behavior independently of other projects.

To modify the project configuration, click on from the Sidebar, then click on Configuration and select Project Configuration from the list.

Configurations - Open Project Configuration

Sample

Here’s a sample Project Configuration file (click on the triangle on the left to expand/collapse):

Sample Project Configuration

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
  ~
  ~ This program is free software: you can redistribute it and/or modify
  ~ it under the terms of the GNU General Public License version 3 as published by
  ~ the Free Software Foundation.
  ~
  ~ This program is distributed in the hope that it will be useful,
  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
  ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  ~ GNU General Public License for more details.
  ~
  ~ You should have received a copy of the GNU General Public License
  ~ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  -->

<site-config>
    <wem-project>{siteName}</wem-project>
    <display-name>{siteName}</display-name>

    <!-- Site URLs. Default to http://localhost:8080 if blank -->
    <site-urls>
        <authoring-url></authoring-url>
        <staging-url></staging-url>
        <live-url></live-url>
    </site-urls>

    <locale>
        <!--
        BCP 47 language tag (e.g. en-US) or unicode extension (e.g. "en-US-u-ca-buddhist").
        Leave empty for using the user's browser locale (i.e. dates/times will be displayed in each users's system locale).
        Specifying a locale code will apply those localization settings to *all* users regardless of their system settings
        or location. For example, if "en-US", is specified, all users will see dates as month/day/year instead of day/month/year
        regardless of their system (i.e. OS) locale preference.
        -->
        <localeCode/>
        <!--
        Use `dateTimeFormatOptions` to customize how dates & times get displayed on Studio UI.
        For full list of options and docs, visit: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat
        -->
        <dateTimeFormatOptions>
            <!--
            Specifying a time zone (i.e. `timeZone` element) will express dates/times across the UI in the time zone you specify
            here. Leaving it unspecified, will display dates/times to each user in their own system time zone.
            -->
            <!--<timeZone>EST5EDT</timeZone>-->
            <day>numeric</day>
            <month>numeric</month>
            <year>numeric</year>
            <hour>numeric</hour>
            <minute>numeric</minute>
            <!--
            Set `hour12` to "false" to show times in 24 hour format.
            -->
            <hour12>true</hour12>
        </dateTimeFormatOptions>
    </locale>

    <!--
    Specifies the regular expression patterns to match content type field
    names that require CDATA escaping.
    -->
    <cdata-escaped-field-patterns>
        <pattern>(_html|_t|_s|_smv|mvs)$</pattern>
        <pattern>internal-name</pattern>
    </cdata-escaped-field-patterns>

    <published-repository>
        <enable-staging-environment>false</enable-staging-environment>
    </published-repository>

    <publishing>
        <comments>
            <!-- Global setting would apply to all -->
            <required>false</required>
            <!-- Additional (also optional) specific overrides -->
            <!-- <delete-required/> -->
            <!-- <bulk-publish-required/> -->
            <!-- <publish-by-commit-required/> -->
            <!-- <publish-required/> -->
            <!-- <publish-everything-required/> -->
        </comments>
    </publishing>

    <form-engine>
        <!-- Indicates if postfixes should be required for all fields -->
        <field-name-postfix>true</field-name-postfix>
        <!-- List of field names that should not have a postfix -->
        <ignore-postfix-fields>
            <field>internal-name</field>
            <field>file-name</field>
            <field>placeInNav</field>
            <field>scripts</field>
            <field>mime-type</field>
            <field>force-https</field>
            <field>navLabel</field>
            <field>expired</field>
            <field>key</field>
            <field>value</field>
            <field>items</field>
            <field>redirect-url</field>
            <field>authorizedRoles</field>
            <field>role</field>
            <field>disabled</field>
        </ignore-postfix-fields>
    </form-engine>

    <!--
        Pattern that Studio will use to load plugin from the site repository
        Required placeholders: ${type}, ${name}
     -->
    <plugin-folder-pattern>/config/studio/plugins/${type}/${name}</plugin-folder-pattern>

    <!--
        This workflow parameter disallows users with _Publish_ permission from publishing their own work.
        Work performed by a user must be approved by a different reviewer before it can be published.
        Set the value to true to enable this feature.
    <workflow>
        <publisher>
            <requirePeerReview>false</requirePeerReview>
        </publisher>
    </workflow>
    -->

    <!--
        Prevent deleting, renaming or cutting root folders of sidebar
    -->
    <protected-folders-patterns>
        <pattern>^/([^ !$`&amp;*()/+]|(\\[ !$`&amp;*()+]))+$</pattern>
    </protected-folders-patterns>

    <repository rootPrefix="/site">

        <level-descriptor>crafter-level-descriptor.level.xml</level-descriptor>

        <!-- The section below classifies items into folders for two dashboard widgets:
        - Items Waiting For Approval
        - Approved Scheduled Items

        Items that match the paths specified will be grouped together in the dashboard widget
        -->
        <folders>
            <folder name="Pages" path="/website" read-direct-children="false" attach-root-prefix="true"/>
            <folder name="Components" path="/components" read-direct-children="false" attach-root-prefix="true"/>
            <folder name="Assets" path="/static-assets" read-direct-children="false" attach-root-prefix="false"/>
            <folder name="Templates" path="/templates" read-direct-children="false" attach-root-prefix="false"/>
        </folders>

        <!-- Item Patterns -->
        <patterns>
            <!-- The section below helps determine the type of content based on regex. This shows up in two places:
            - The activity audit log.
            - The UI icon used for the item
            -->

            <pattern-group name="page">
                <pattern>/site/website/([^&lt;]+)\.xml</pattern>
            </pattern-group>

            <pattern-group name="component">
                <pattern>/site/components/([^&lt;]+)\.xml</pattern>
                <pattern>/site/system/page-components/([^&lt;]+)\.xml</pattern>
                <pattern>/site/component-bindings/([^&lt;]+)\.xml</pattern>
                <pattern>/site/indexes/([^&lt;]+)\.xml</pattern>
                <pattern>/site/resources/([^&lt;]+)\.xml</pattern>
            </pattern-group>

            <pattern-group name="asset">
                <pattern>/static-assets/([^&lt;"']+)</pattern>
            </pattern-group>

            <pattern-group name="rendering-template">
                <pattern>/templates/([^&lt;"]+)\.ftl</pattern>
            </pattern-group>

            <!-- The section below enumerates the mime-types we can preview -->
            <pattern-group name="previewable-mimetypes">
                <pattern>image/(.*)</pattern>
                <pattern>application/pdf</pattern>
                <pattern>video/(.*)</pattern>
                <pattern>application/msword</pattern>
                <pattern>application/vnd.openxmlformats-officedocument.wordprocessingml.document</pattern>
                <pattern>application/vnd.ms-excel</pattern>
                <pattern>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</pattern>
                <pattern>application/vnd.ms-powerpoint</pattern>
            </pattern-group>
        </patterns>

        <!-- The patterns below identify what is allowed to show up in the Dashboard widgets -->
        <display-in-widget-patterns>
            <display-in-widget-pattern>.*</display-in-widget-pattern>
        </display-in-widget-patterns>

    </repository>
</site-config>

Project Time Zone

The default dates and times used for displays in Studio is UTC. To customize how dates & times get displayed on Studio UI for a project, edit the following:

<locale>
  <!--
  BCP 47 language tag (e.g. en-US) or unicode extension (e.g. "en-US-u-ca-buddhist").
  Leave empty for using the user's browser locale (i.e. dates/times will be displayed in each users's system locale).
  Specifying a locale code will apply those localization settings to *all* users regardless of their system settings
  or location. For example, if "en-US", is specified, all users will see dates as month/day/year instead of day/month/year
  regardless of their system (i.e. OS) locale preference.
  -->
  <localeCode/>
  <!--
  Use `dateTimeFormatOptions` to customize how dates & times get displayed on Studio UI.
  For full list of options and docs, visit: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat
  -->
  <dateTimeFormatOptions>
  <!--
  Specifying a time zone (i.e. `timeZone` element) will express dates/times across the UI in the time zone you specify
  here. Leaving it unspecified, will display dates/times to each user in their own system time zone.
  -->
    <!--<timeZone>EST5EDT</timeZone>-->
    <day>numeric</day>
    <month>numeric</month>
    <year>numeric</year>
    <hour>numeric</hour>
    <minute>numeric</minute>
    <!--
    Set `hour12` to "false" to show times in 24 hour format.
    -->
    <hour12>true</hour12>
  </dateTimeFormatOptions>
</locale>

Enabling Staging

The staging publishing target is an intermediate publishing target where the project can be fully exercised. To enable the staging publishing target, set the following to true:

<published-repository>
  <enable-staging-environment>false</enable-staging-environment>
</published-repository>

See Configuring Publishing to Staging Target for more information on how to setup the staging publishing target

Escaping Content Fields

To add/remove escaped content fields, modify the following:

<!--
Specifies the regular expression patterns to match content type field
names that require CDATA escaping.
-->
<cdata-escaped-field-patterns>
  <pattern>(_html|_t|_s|_smv|mvs)$</pattern>
  <pattern>internal-name</pattern>
</cdata-escaped-field-patterns>

For more information on escaping content fields, see the notes under Variable Names and Search Indexing

Publishing Comments

To make comments mandatory for different publishing methods, simply set to true any applicable methods the site administrators want to require comments when publishing.

<publishing>
  <comments>
    <!-- Global setting would apply to all -->
    <required>false</required>
    <!-- Additional (also optional) specific overrides -->
    <!-- <delete-required/> -->
    <!-- <bulk-publish-required/> -->
    <!-- <publish-by-commit-required/> -->
    <!-- <publish-required/> -->
  </comments>
</publishing>

See Publishing and Status for more information on the different publishing methods available from Project Tools

Requiring Peer Review for Publishing

Since 4.0.0

A publisher review workflow option is available to make approval of a publish request mandatory for users with publish permission. To enable the publisher review workflow option, set requirePeerReview to true.

<!--
     This workflow parameter disallows users with _Publish_ permission from publishing their own work.
     Work performed by a user must be approved by a different reviewer before it can be published.
     Set the value to true to enable this feature.
-->
<workflow>
  <publisher>
    <requirePeerReview>true</requirePeerReview>
  </publisher>
</workflow>

Content Monitoring

Content monitoring allows you to configure watches and notifications on your project. To add content monitors, add the following:

<contentMonitoring>
  <monitor>
    <name>Content Expiring Tomorrow</name>
    <query>expired_dt:[now+1d/d TO now+2d/d]</query>
    <paths>
      <path>
        <name>All Site</name>
        <pattern>/site/.*</pattern>
        <emailTemplate>contentExpiringSoon</emailTemplate>
        <emails>admin@example.com</emails>
        <locale>en</locale>
      </path>
    </paths>
  </monitor>
</contentMonitoring>

See Content Monitoring for more information on configuring content monitoring.

Protected Folders

The protected folders settings allows you to configure paths that can’t be deleted, renamed or moved in addition to the following paths that are protected by default:

/site/website/index.xml
/site/components
/site/taxonomy
/static-assets
/templates
/scripts
/sources

To add protected folder/s in your project, add your folder path/s like below:

<protected-folders-patterns>
  <pattern>/YOUR/FOLDER/PATH/PATTERN</pattern>
  <pattern>/MORE/FOLDER/PATH/PATTERN</pattern>
  ...
</protected-folders-patterns>

Remember to replace /YOUR/FOLDER/PATH/PATTERN and /MORE/FOLDER/PATH/PATTERN with the actual folder path pattern/s that you would like to be protected.

To see an example of configured protected folders, create a project using the Video Center blueprint from the Public Marketplace in the Create Project dialog then open the Sidebar -> -> Configuration -> Project Configuration. Scroll down to the <protected-folders-patterns> tag:

<!--
Prevent deleting, renaming or cutting root folders of sidebar
-->
<protected-folders-patterns>
  <pattern>/site/streams</pattern>
  <pattern>/site/videos</pattern>
  <pattern>/site/origins</pattern>
</protected-folders-patterns>