Site Config Configuration

The Site Config configuration file allows you to specify which items can be accessed from the dropdown list in Site Config -> Configuration.

To find this configuration xml through studio follow the next instructions:

  1. Click on siteConfig located in the Sidebar.

  2. Choose Configuration from the menu.

  3. Select Configurations.

Configurations - Open Configurations

Sample

Here’s a sample config-list.xml file:

SITENAME/config/studio/administration/config-list.xml
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?xml version="1.0" encoding="UTF-8"?>
<!--
    This file configures the list of configurations available in the SiteConfig section for this site/blueprint.

    For every configuration you'd like to make editable, you need:
        <file>
            <module />
            <path />
            <title />
            <description />
            <samplePath />
        </file>

    The elements are:
    - module: Crafter CMS module
    - path: the path to the file. This path is rooted in /config/<module> off the base of the site/blueprint
    - title: the title of this file. This should be a key into the string-table in Studio's localization string table
        "base.js", if no entry is found, Studio will use the string you have here as is
    - description: the description of this file.  This should be a key into the string-table in Studio's localization
        string table "base.js", if no entry is found, Studio will use the string you have here as is
    - samplePath: the path to a sample file to help the user update the file
-->
<config>
   <version>8</version>
   <files>
      <file>
         <module>studio</module>
         <path>site-config.xml</path>
         <title>confTabSiteConfiguration</title>
         <description>confTabSiteConfigurationDesc</description>
         <samplePath>sample-site-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>context-nav/sidebar.xml</path>
         <title>confTabSidebarConf</title>
         <description>confTabSidebarConfDesc</description>
         <samplePath>sample-sidebar.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>form-control-config/rte/rte-setup.xml</path>
         <title>confTabRTEConf</title>
         <description>confTabRTEConfDesc</description>
         <samplePath>sample-form-control-rte-setup.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>form-control-config/rte/rte-setup-tinymce5.xml</path>
         <title>confTabRTEtMCE5Conf</title>
         <description>confTabRTEtMCE5ConfDesc</description>
         <samplePath>sample-form-control-rte-setup-tinymce5.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>code-editor-config.xml</path>
         <title>confTabCodeEditorConf</title>
         <description>confTabCodeEditorConfDesc</description>
         <samplePath>sample-code-editor-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>preview-tools/components-config.xml</path>
         <title>confTabPreviewComponentsConf</title>
         <description>confTabPreviewComponentsConfDesc</description>
         <samplePath>sample-preview-components-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>targeting/targeting-config.xml</path>
         <title>confTabTargetingConfiguration</title>
         <description>confTabTargetingConfigurationDesc</description>
         <samplePath>sample-targeting-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>preview-tools/panel.xml</path>
         <title>confTabPreviewPanelConf</title>
         <description>confTabconfTabPreviewPanelConfDesc</description>
         <samplePath>sample-preview-panel.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>workflow/notification-config.xml</path>
         <title>confTabNotificationConf</title>
         <description>confTabNotificationConfDesc</description>
         <samplePath>sample-notification-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>permission-mappings-config.xml</path>
         <title>confTabPermissionsMappings</title>
         <description>confTabPermissionsMappingsDesc</description>
         <samplePath>sample-permission-mappings-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>role-mappings-config.xml</path>
         <title>confTabRoleMappings</title>
         <description>confTabRoleMappingsDesc</description>
         <samplePath>sample-role-mappings-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>data-sources/cmis-config.xml</path>
         <title>confTabCMISConfiguration</title>
         <description>confTabCMISConfigurationDesc</description>
         <samplePath>sample-cmis-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>context-nav/contextual-nav.xml</path>
         <title>confTabContextualNavigationConf</title>
         <description>confTabContextualNavigationConfDesc</description>
         <samplePath>sample-contextual-nav.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>administration/site-config-tools.xml</path>
         <title>confTabSiteConf</title>
         <description>confTabSiteConfDesc</description>
         <samplePath>sample-site-config-tools.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>administration/config-list.xml</path>
         <title>confTabConfigurations</title>
         <description>confTabConfDesc</description>
         <samplePath>sample-config-list.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>mime-type.xml</path>
         <title>Mime Types</title>
         <description>mime Types</description>
         <samplePath>sample-mime-type.xml</samplePath>
      </file>
      <file>
         <module>engine</module>
         <path>site-config.xml</path>
         <title>confTabEngineSiteConfiguration</title>
         <description>confTabEngineSiteConfigurationDesc</description>
         <samplePath>sample-engine-site-config.xml</samplePath>
      </file>
      <file>
         <module>engine</module>
         <path>application-context.xml</path>
         <title>confTabEngineSiteAppContextConfiguration</title>
         <description>confTabEngineSiteAppContextConfigurationDesc</description>
         <samplePath>sample-engine-application-context.xml</samplePath>
      </file>
      <file>
         <module>engine</module>
         <path>urlrewrite.xml</path>
         <title>Engine URL Rewrite Configuration (XML Style)</title>
         <description>Engine URL Rewrite Configuration (XML Style)</description>
         <samplePath>sample-urlrewrite.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>dependency/resolver-config.xml</path>
         <title>Dependency Resolver Configuration</title>
         <description>Dependency Resolver Configuration</description>
         <samplePath>sample-resolver-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>aws/aws.xml</path>
         <title>AWS Profiles</title>
         <description>AWS Profiles</description>
         <samplePath>sample-aws.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>box/box.xml</path>
         <title>Box Profiles</title>
         <description>Box Profiles</description>
         <samplePath>sample-box.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>webdav/webdav.xml</path>
         <title>WebDAV Profiles</title>
         <description>WebDAV Profiles</description>
         <samplePath>sample-webdav.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>asset-processing/asset-processing-config.xml</path>
         <title>Asset Processing</title>
         <description>Asset Processing</description>
         <samplePath>sample-asset-processing-config.xml</samplePath>
      </file>
      <file>
         <module>studio</module>
         <path>blob-stores-config.xml</path>
         <title>Blob Stores</title>
         <description>Blob Stores</description>
         <samplePath>sample-blob-stores-config.xml</samplePath>
      </file>
      <file>
         <module>engine</module>
         <path>proxy-config.xml</path>
         <title>Proxy Config</title>
         <description>Proxy Config</description>
         <samplePath>sample-blob-stores-config.xml</samplePath>
      </file>
   </files>
</config>

Description

List of available configuration tags

Tag
Description
files
This tag contains each file.
file
This tag contains the configuration of each file.
path
Path where the system will find the specific xml file
title

This tag refers to file title. It will be showed in the configuration
dropdown at the top of the page. See #1 in the image above
description

This tag refers to file description. It will be showed to explain the file
functionality. See #2 in the image above
samplePath

Path where the system will find an example of the specific xml.
See #3 in the image above

Sample File

You can click on the View Sample button to see a configuration file example.

Basic Configuration Sample

Adding a new configuration file

To add a new configuration file please follow the steps below.

  1. Add file tags to the configuration list xml file (config-list.xml).

    SITENAME/config/studio/administration/config-list.xml
        <file>
        <module>studio</module>
                <path>/workflow-config.xml</path>
                <title>Workflow Configuration</title>
                <description>Defines workflows available in the system</description>
                <samplePath>/administration/samples/sample-workflow-config.xml</samplePath>
        </file>
    
    Basic Configuration Step 1
  2. Click on the Save button

    Basic Configuration Step 2
  3. Go to configuration tab, then open the dropdown and finally look for your new configuration file

    Basic Configuration Step 3