Skip to content
Treehill Studio

System Settings

Agenda contains some system settings in the agenda namespace.

These are available in the MODX system settings panel and in the settings tab (cog wheel icon) of the Agenda custom manager page.

Key Name Description Default
agenda.blur_data Blur Data Since 1.5.6 Blur data to present the functionality without revealing personal data. No
agenda.category_required Category Required An event requires a category. Yes
agenda.cronjob_id Cronjob ID String, that has to be added to the cronjob url as cronjob_id parameter. -
agenda.debug Debug Log debug information in the MODX error log. No
agenda.default_calendar Default Calendar Since 1.7.7 ID of a calendar that is set by default for new events. -
agenda.default_category Default Category Since 1.7.7 ID of a category that is set by default for new events, if a category is required. -
agenda.default_location Default Location Since 1.7.7 ID of a location that is set by default for new events. -
agenda.default_repeat_type Default Repeat Type Since 1.8.0 Create new events with the selected repeat type. -
agenda.default_repeating Default Repeating Event Since 1.8.0 Create new events as a repeating event. No
agenda.default_timezone Default Timezone Default time zone for events. Europe/Berlin
agenda.detail_id Detail ID ID of a resource containing AgendaDetail snippet call. -
agenda.download_mediasource Download Media Source Since 1.7.0 Media Source for Event Downloads. 1
agenda.download_mime_types Download MIME Types Since 1.9.0 Comma separated list of MIME types that can be used in the downloads grid. application/pdf
agenda.editor_type Editor Type Editor type for text fields (htmleditor, modx-texteditor or textarea). htmleditor
agenda.extended_event_fields Extended Event Fields JSON-encoded array of extended event fields. -
agenda.extended_location_fields Extended Location Fields Since 1.4.0 JSON-encoded array of extended location fields. -
agenda.extended_repeat_fields Extended Repeat Fields Since 1.4.0 JSON-encoded array of extended repeat fields. -
agenda.extended_xtypes_script Extended xtypes Script Since 1.4.0 Url to a script, that defines custom xtypes. Relative to the manager url or (if absolute) to the base url. -
agenda.google_maps_api_key Google Maps API Key Request a Google Maps API Key. -
agenda.google_maps_default_lat Google Maps Default Latitude Default latitude for the displayed map when creating/editing a location. 51.977825
agenda.google_maps_default_lng Google Maps Default Longitude Default longitude for the displayed map when creating/editing a location. 7.291066
agenda.google_maps_default_zoom Google Maps Standard Zoom Default zoom for the displayed map when creating/editing a location. 9
agenda.google_maps_region Google Maps API Preferred Region Preferred region for the geocoding result. -
agenda.image_crops Image Crops JSON encoded object of crop configurations, that are used to create different crops of the selected image. Example: {"full":{"name":"Full","size":"1280x720"}} -
agenda.image_mediasource Image Media Source Media source for event images. 1
agenda.image_mime_types Image MIME Types Comma separated list of MIME types that can be used in the images grid. image/jpeg,image/png,image/gif
agenda.import_export_type Import/Export Type Since 1.5.0 File type of the imported/exported files. Can be set to 'csv', 'excel', 'yaml' csv
agenda.list_id List ID ID of a resource containing an AgendaList snippet call. -
agenda.locale Locale Set the locale for Agenda. Leave blank to use the MODX system setting 'locale'. See the PHP documentation for more information. -
agenda.manager_date_alt_formats Date Alt Formats Since 1.4.0 Multiple date formats separated by "|" that are tried when a user input value is parsed and it does not match the defined format. Each format must be valid according to Ext JS Date. (lexicon)
agenda.manager_date_format Date Format The format must be valid according to Ext JS Date. (lexicon)
agenda.manager_date_format_long Date Format (long) The format must be valid according to Ext JS Date. (lexicon)
agenda.manager_time_format Time Format The format must be valid according to Ext JS Date. (lexicon)
agenda.manager_time_increment Time Steps Number of minutes between individual time values in the time selection field. 15
agenda.parents_calendar Calendar Parent Resources Comma-separated list of parent resources to select a resource connected with a calendar. -
agenda.parents_category Category Parent Resources Comma-separated list of parent resources to select a resource connected with a category. -
agenda.parents_event Event Parent Resources Comma separated list of parent resources to select a resource connected with an event. -
agenda.parents_location Location Parent Resources Comma separated list of parent resources to select a resource connected with a location. -
agenda.preview_height Preview Height Since 1.9.0 The height of the image preview in the image editing window in pixels. 350
agenda.repeating_max_occurrence Maximum Occurrence Maximum orccurance of repeating events. 100
agenda.show_ids Show ID Columns Since 1.5.5 Show ID columns in the tables. No
agenda.thumbnail_height Thumbnail Height Since 1.9.0 The height of the image crop previews in the image editing window in pixels. 100
agenda.thumbnail_width Thumbnail Width Since 1.9.0 The width of the image preview in the image grid in pixels. 100
agenda.upload_path Upload Path Since 1.9.0 Upload path in the different media sources. The fields of the current event can be used as placeholder with the prefix 'event_', i.e. [[+event_id]] [[+event_id]]/
agenda.use_activate_at Use Activate Since 1.6.0 Show the ‘Activate/Deactivate At’ input in the event, the repeat, the location, the image, the video, the category and the calendar edit window. The data will be activated/deactivated during a page request. No
agenda.use_category Use Category Show the category input in the events editing window. Show the categories column in the events grid. Show the categories tab in the Agenda custom manager page. Yes
agenda.use_content Use Event Content Since 1.6.3 Show the content tab in the event edit window. Yes
agenda.use_context Use Contexts Show the context input in the event edit window. Yes
agenda.use_downloads Use Event Downloads Since 1.7.0 Show the downloads tab in the event edit window. Yes
agenda.use_images Use Event Images Since 1.6.3 Show the images tab in the event edit window. Yes
agenda.use_location Use Location Show the location input in the event edit window. Show the locations tab in the Agenda custom manager page. Yes
agenda.use_users Use Event Users Since 1.6.3 Show the users tab in the event edit window. Yes
agenda.use_videos Use Event Videos Since 1.6.3 Show the videos tab in the event edit window. Yes
agenda.video_mediasource Video Media Source Media Source for Event Videos. 1
agenda.video_mime_types Image MIME Types Since 1.9.0 Comma separated list of MIME types that can be used in the videos grid. video/mp4

Path bindings

The settings agenda.extended_event_fields, agenda.extended_repeat_fields and agenda.extended_location_fields can use @FILE or @CHUNK bindings. Path placeholders like {core_path}, {base_path} and {assets_path} can be used. All paths have to stay inside the MODX base path because of security reasons.

Image crops

Since Agenda 1.9.0 the images in Agenda can be cropped. The crops can be set with a JSON encoded object in the agenda.image_crops system setting. The JSON contains an array of crop settings. Each crop setting has a key that contains an array of setting values. The setting values must contain the name key and can contain one of the following keys: size, ratio, width and height. size, ratio contain two values separated by x. size, width and height restrict the size of the target image in pixels. ratio restricts the size of the target image by the crop.

Example: 

{
  "full": {
    "name": "Full",
    "size": "1280x720"
  },
  "square": {
    "name": "Square",
    "ratio": "1x1"
  },
  "free": {
    "name": "Free"
  },
  "width": {
    "name": "Fixed Width",
    "width": "1000"
  }
}

Upload path

Since Agenda 1.9.0 the files and images in Agenda can be uploaded directly without using the MODX file browser. The path inside the media source can be set with the agenda.upload_path system setting. The fields of the current event can be used as placeholder with the prefix event_, i.e. [[+event_id]]. [[+event_calendar]] contains the alias of the calendar, [[+event_categories]] contains a comma-separated list of the aliases of the event categories.