Site Config Tools

The Site Config tools configuration file defines what modules are available for administration use when clicking on siteConfig from the Sidebar. This configuration is unique in that a configuration file exists in the following location of each site: SITENAME/config/studio/administration/tools.xml

Site Config Tools

To modify the site config tools configuration, click on siteConfig from the bottom of the Sidebar, then click on Configuration and select Site Config Tools from the dropdown list.

Configurations - Open Site Config Tools

Sample

Here is a sample tools configuration file.

SITENAME/config/studio/administration/tools.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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright (C) 2007-2019 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 as published by
  ~ the Free Software Foundation, either version 3 of the License, or
  ~ (at your option) any later version.
  ~
  ~ 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 Configuration Tools

  This file helps configure the Site Config section with tools. The tools specified here appear on the left-
  hand-side of the Site Config section.

  The file has the the following structure:
  <config>
    <tools>
      <tool>
        <name>sync-from-repository</name>
        <label>Sync From Repository</label>
        <icon> (Optional icon configuration)
          <styles> ( Change default icon styles - using css rules )
            <color>#409a00</color>
            <font-size>16px</font-size>
            <font-width>bold</font-width>
          </styles>
        </icon>
        <... tool specific configuration ../>
      </tool>
    </tools>
  </config>
-->
<config>
  <tools>
    <tool>
      <name>content-types</name>
      <label>Content Types</label>
      <formSection>
        <icon>
          <class>fa-object-group</class>
        </icon>
      </formSection>
      <repeatSection>
        <icon>
          <class>fa-repeat</class>
        </icon>
      </repeatSection>
      <controls>
        <control>
          <name>input</name>
          <icon>
            <class>fa-pencil-square-o</class>
          </icon>
        </control>
        <control>
          <name>numeric-input</name>
          <icon>
            <class>fa-pencil-square</class>
          </icon>
        </control>
        <control>
          <name>textarea</name>
          <icon>
            <class>fa-paragraph</class>
          </icon>
        </control>
        <control>
          <name>rte</name>
          <icon>
            <class>fa-code</class>
          </icon>
        </control>
        <control>
          <name>rte-tinymce4</name>
          <icon>
            <class>fa-code</class>
          </icon>
        </control>
        <control>
          <name>dropdown</name>
          <icon>
            <class>fa-sort-desc</class>
          </icon>
        </control>
        <control>
          <name>time</name>
          <icon>
            <class>fa-clock-o</class>
          </icon>
        </control>
        <control>
          <name>date-time</name>
          <icon>
            <class>fa-calendar</class>
            <stackedclass>fa-clock-o</stackedclass>
          </icon>
        </control>
        <control>
          <name>checkbox</name>
          <icon>
            <class>fa-check-square-o</class>
          </icon>
        </control>
        <control>
          <name>checkbox-group</name>
          <icon>
            <class>fa-check-square-o</class>
          </icon>
        </control>
        <control>
          <name>node-selector</name>
          <icon>
            <class>fa-crosshairs</class>
          </icon>
        </control>
        <control>
          <name>image-picker</name>
          <icon>
            <class>fa-picture-o</class>
            <styles>
              <color>#7e9dbb</color>
            </styles>
          </icon>
        </control>
        <control>
          <name>video-picker</name>
          <icon>
            <class>fa-video-camera</class>
          </icon>
        </control>
        <control>
          <name>label</name>
          <icon>
            <class>fa-tag</class>
          </icon>
        </control>
        <control>
          <name>page-nav-order</name>
          <icon>
            <class>fa-sort</class>
          </icon>
        </control>
        <control>
          <name>file-name</name>
          <icon>
            <class>fa-file-o</class>
          </icon>
        </control>
        <control>
          <name>auto-filename</name>
          <icon>
            <class>fa-file-o</class>
            <stackedclass>fa-magic</stackedclass>
          </icon>
        </control>
      </controls>
      <datasources>
        <datasource>
          <name>child-content</name>
          <icon>
            <class>fa-child</class>
          </icon>
        </datasource>
        <datasource>
          <name>shared-content</name>
          <icon>
            <class>fa-share-alt</class>
          </icon>
        </datasource>
        <datasource>
          <name>embedded-content</name>
          <icon>
            <class>fa-dot-circle-o</class>
          </icon>
        </datasource>
        <datasource>
          <name>img-desktop-upload</name>
          <icon>
            <class>fa-picture-o</class>
          </icon>
        </datasource>
        <datasource>
          <name>img-repository-upload</name>
          <icon>
            <class>fa-file-image-o</class>
          </icon>
        </datasource>
        <datasource>
          <name>file-desktop-upload</name>
          <icon>
            <class>fa-upload</class>
          </icon>
        </datasource>
        <datasource>
          <name>file-browse-repo</name>
          <icon>
            <class>fa-hand-o-up</class>
          </icon>
        </datasource>
        <datasource>
          <name>CMIS-repo</name>
          <icon>
            <class>fa-plug</class>
          </icon>
        </datasource>
        <datasource>
          <name>img-cmis-repo</name>
          <icon>
            <class>fa-square</class>
            <stackedclass>fa-plug fa-inverse fa-image-plug</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>video-cmis-repo</name>
          <icon>
            <class>fa-square-o fa-video-square</class>
            <stackedclass>fa-plug fa-video-plug</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>CMIS-upload</name>
          <icon>
            <class>fa-plug</class>
          </icon>
        </datasource>
        <datasource>
          <name>img-CMIS-upload</name>
          <icon>
            <class>fa-square</class>
            <stackedclass>fa-plug fa-inverse fa-image-plug</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>video-CMIS-upload</name>
          <icon>
            <class>fa-square-o fa-video-square</class>
            <stackedclass>fa-plug fa-video-plug</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>WebDAV-repo</name>
          <icon>
            <class>fa-square-o fa-server</class>
          </icon>
        </datasource>
        <datasource>
          <name>img-WebDAV-repo</name>
          <icon>
            <class>fa-square-o fa-server</class>
          </icon>
        </datasource>
        <datasource>
          <name>video-WebDAV-repo</name>
          <icon>
            <class>fa-square-o fa-server</class>
          </icon>
        </datasource>
        <datasource>
          <name>WebDAV-upload</name>
          <icon>
            <class>fa-square-o fa-server</class>
          </icon>
        </datasource>
        <datasource>
          <name>img-WebDAV-upload</name>
          <icon>
            <class>fa-square-o fa-server</class>
          </icon>
        </datasource>
        <datasource>
          <name>video-WebDAV-upload</name>
          <icon>
            <class>fa-square-o fa-server</class>
          </icon>
        </datasource>
        <datasource>
          <name>S3-repo</name>
          <icon>
            <class>fa-file-o</class>
            <stackedclass>fa-amazon</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>img-S3-repo</name>
          <icon>
            <class>fa-square</class>
            <stackedclass>fa-amazon fa-inverse</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>video-S3-repo</name>
          <icon>
            <class>fa-film</class>
            <stackedclass>fa-amazon</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>S3-upload</name>
          <icon>
            <class>fa-file-o</class>
            <stackedclass>fa-amazon</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>img-S3-upload</name>
          <icon>
            <class>fa-square</class>
            <stackedclass>fa-amazon fa-inverse</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>video-S3-upload</name>
          <icon>
            <class>fa-film</class>
            <stackedclass>fa-amazon</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>video-S3-transcoding</name>
          <icon>
            <class>fa-film</class>
            <stackedclass>fa-amazon</stackedclass>
          </icon>
        </datasource>
        <datasource>
          <name>video-desktop-upload</name>
          <icon>
            <class>fa-video-camera</class>
          </icon>
        </datasource>
        <datasource>
          <name>video-browse-repo</name>
          <icon>
            <class>fa-file-video-o</class>
          </icon>
        </datasource>
        <datasource>
          <name>key-value-list</name>
          <icon>
            <class>fa-key</class>
          </icon>
        </datasource>
        <datasource>
          <name>site-component</name>
          <icon>
            <class>fa-puzzle-piece</class>
          </icon>
        </datasource>
      </datasources>
      <objectTypes>
        <type>
          <label>Page</label>
          <name>page</name>
          <properties>
            <property>
              <name>display-template</name>
              <label>Display Template</label>
              <value></value>
              <type>template</type>
            </property>
            <property>
              <name>no-template-required</name>
              <label>No Template Required</label>
              <value></value>
              <type>boolean</type>
            </property>
            <property>
              <name>merge-strategy</name>
              <label>Merge Strategy</label>
              <value>inherit-levels</value>
              <type>string</type>
            </property>
          </properties>
        </type>
        <type>
          <label>Component</label>
          <name>component</name>
          <properties>
            <property>
              <name>display-template</name>
              <label>Display Template</label>
              <value></value>
              <type>template</type>
            </property>
            <property>
              <name>no-template-required</name>
              <label>No Template Required</label>
              <value></value>
              <type>boolean</type>
            </property>
            <property>
              <name>merge-strategy</name>
              <label>Merge Strategy</label>
              <value>inherit-levels</value>
              <type>string</type>
            </property>
          </properties>
        </type>

      </objectTypes>
    </tool>
    <tool>
      <name>admin-configurations</name>
      <label>Configuration</label>
    </tool>
    <tool>
      <name>groups</name>
      <label>Groups</label>
    </tool>
    <tool>
      <name>audit</name>
      <label>Audit</label>
    </tool>
    <tool>
      <name>workflow-states</name>
      <label>Workflow States</label>
    </tool>
    <tool>
      <name>logging</name>
      <label>Logging Levels</label>
    </tool>
    <tool>
      <name>log-view</name>
      <label>Log Console</label>
    </tool>
    <tool>
      <name>status-view</name>
      <label>Publishing</label>
      <icon>
        <class>fa-cloud-upload</class>
      </icon>
    </tool>
    <tool>
      <name>repository</name>
      <label>Remote Repositories</label>
      <icon>
        <class>fa-database</class>
      </icon>
    </tool>
  </tools>
  <tool>
    <name>graphiql</name>
    <label>GraphiQL</label>
    <icon>
      <class>fa-line-chart</class>
    </icon>
  </tool>
</config>

Description

/config/tools/tool

Site Config tool definition

/config/tools/tool/name

Tool name (javascript module name)

/config/tools/tool/label

Display label in admin console navigation menu

Content Type Specific tool configuration

/config/tools/tool/controls

List of available content type form controls

/config/tools/tool/controls/control

Control name (javascript control module name)

/config/tools/tool/datasources

List of available datasources for content type form controls

/config/tools/tool/datasources/datasource

Datasource name (javascript datasource module name)

/config/tools/tool/objectTypes

List of available object types

/config/tools/tool/objectTypes/type

Type configuration (Page or Component) - name, label, properties

List of available tools

Here’s a list of available tools defined in the Website_Editorial blueprint.

Tool

Description

content-types

Allows you to create/modify content types

admin-configurations

Contains all the configuration files managed through Crafter Studio

groups

Allows you to manage site groups and group membership

audit

Allows you to view your site activity log

bulkoperations

Allows you to publish multiple items at once

workflow-states

Contains a list of all files in the site with its corresponding state

log-view

Allows you to tail logs depending on what logging levels are set

logging

Allows you to set logging levels for the log console

List of available content type form controls

Control
Description
Form Controls - Form Section



Create a new section in the form, this is to help the content
authors by segmenting a form into sections of similar concern.

Details are in the Form Section Control page.
Form Controls - Repeating Group




Repeating groups are used when the form has one or several controls
that repeat to capture the same data as records. For example: a
list of images in a carousel, or a list of widgets on a page.

Details are in the Repeating Group Control page.
Form Controls - Input


A simple textual input line.

Details are in the Input Control page.
Form Controls - Text Area


A simple block of plain text.

Details are in the Text Area Control page.
Form Controls - Rich Text Editor (TinyMCE 2)


A block of HTML.

Details are in the Rich Text Editor (TinyMCE 2) Control page.
Form Controls - Rich Text Editor (TinyMCE 5)


A block of HTML.

Details are in the Rich Text Editor (TinyMCE 5) Control page.
Form Controls - Dropdown


Dropdown list of items to pick from.

Details are in the Dropdown Control page.
Form Controls - Date Time


Date and Time field with a picker.

Details are in the Date/Time Control page.
Form Controls - Check Box


True/False checkbox.

Details are in the Checkbox Control page.
Form Controls - Grouped Check Box


Several checkboxes (true/false).

Details are in the Grouped Checkboxes Control page.
Form Controls - Item Selector


Item selector from a Data Source

Details are in the Item Selector Control page.
Form Controls - Image


Image selector from a Data Source.

Details are in the Image Control page.
Form Controls - Video


Video selector from a Data Source.

Details are in the Video Control page.
Form Controls - Transcoded Video


Transcoded Video selector from Video Transcoding Data Source.

Details are in the Transcoded Video Control page.
Form Controls - Label




Details are in the Label Control page.
Form Controls - Page Order




Details are in the Page Order Control page.
Form Controls - File Name




Details are in the Filename Control page.
Form Controls - Auto Filename




Details are in the Auto Filename Control page.

List of available content type data sources

Datasource
Description
Form Data Sources - Shared Content
Details are in the Shared Content Data Source page.
Form Data Sources - Embedded Content
Details are in the Embedded Content Data Source page.
Form Data Sources - Child Content
Form Data Sources - Image Uploaded From Desktop
Form Data Sources - Image From Repository
Details are in the Image from Repository Data Source page.
Form Data Sources - File Uploaded From Desktop
Form Data Sources - File Browse
Details are in the File Browse Data Source page.
Form Data Sources - CMIS Repo
Details are in the CMIS Repository Data Source page.
Form Data Sources - CMIS Image From Repository
Form Data Sources - CMIS Video From Repository
Form Data Sources - CMIS Upload
Details are in the CMIS File Upload Data Source page.
Form Data Sources - CMIS Image Upload to Repository
Form Data Sources - CMIS Video Upload to Repository
Form Data Sources - WebDAV Repo
Form Data Sources - WebDAV Image Repo
Form Data Sources - WebDAV Video Repo
Form Data Sources - WebDAV Upload
Details are in the WebDAV File Upload Data Source page.
Form Data Sources - WebDAV Image Upload
Details are in the WebDAV Image Upload Data Source page.
Form Data Sources - WebDAV Video Upload
Details are in the WebDAV Video Upload Data Source page.
Form Data Sources - S3 Repo
Details are in the S3 Repository Data Source page.
Form Data Sources - S3 Image Repo
Details are in the Image from S3 Repository Data Source page.
Form Data Sources - S3 Video Repo
Details are in the Video from S3 Repository Data Source page.
Form Data Sources - S3 Upload
Details are in the S3 File Upload Data Source page.
Form Data Sources - S3 Image Upload
Details are in the S3 Image Upload Data Source page.
Form Data Sources - S3 Video Upload
Details are in the S3 Video Upload Data Source page.
Form Data Sources - Video Upload then Transcode from S3 Repo
Form Data Sources - Video Uploaded From Desktop
Form Data Sources - Video From Repository
Details are in the Video from Repository Data Source page.
Form Data Sources - Static Key Value Pairs
Details are in the Static Key Value Pairs Data Source page.
Form Data Sources - Site Component
Details are in the Site Component Data Source page.