Agenda Agenda 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 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_timezone Default Timezone Default time zone for events. Europe/Berlin
agenda.detail_id Detail ID ID of a resource containing AgendaDetail snippet call. -
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_mediasource Image Media Source Media source for event images. 1
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.repeating_max_occurance Maximum Occurance Maximum orccurance of repeating events. 100
agenda.show_ids Show ID Columns ** Since 1.5.5 ** Show ID columns in the tables. No
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_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

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.