+ +
+

PyAMS management interface

+
+

Module contents

+
+
+pyams_zmi.includeme(config)
+

Pyramid include

+
+ +
+ +
+

Submodules

+
+

pyams_zmi.admin module

+
+
+class pyams_zmi.admin.MainAdminPage
+

Bases: pyams_zmi.view.AdminView

+

Main administration page

+
+ +
+
+

pyams_zmi.control_panel module

+
+
+class pyams_zmi.control_panel.GlobalRegistrationsHeaderAdapter(context, request, view)
+

Bases: pyams_skin.page.DefaultPageHeaderAdapter

+

Global registrations header adapter

+
+
+icon_class = 'fa fa-fw fa-codepen'
+
+ +
+ +
+
+class pyams_zmi.control_panel.GlobalRegistrationsHelpAdapter(context, request, view)
+

Bases: pyams_skin.help.ContentHelp

+

Global registrations help adapter

+
+
+header = 'Global registry utilities'
+
+ +
+
+message = "The global registry groups local utilities as well as utilities registered outside\nsite's Object Database (ZODB).\n\nThese utilities are declared statically (generally using include or ZCML directives) and can't be setup\nwithout modifying site configuration."
+
+ +
+
+message_format = 'rest'
+
+ +
+ +
+
+class pyams_zmi.control_panel.GlobalRegistrationsMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

Global registrations menu

+
+
+label = 'Global registrations'
+
+ +
+
+url = '#global-registrations.html'
+
+ +
+ +
+
+class pyams_zmi.control_panel.GlobalRegistrationsTable(context, request)
+

Bases: pyams_skin.table.BaseTable

+

Utilities global registrations table

+
+
+data_attributes = {}
+
+ +
+
+id = 'global_registrations_table'
+
+ +
+
+title = 'Global utilities registrations'
+
+ +
+ +
+
+class pyams_zmi.control_panel.GlobalRegistrationsValuesAdapter(context, request, view)
+

Bases: pyams_utils.adapter.ContextRequestViewAdapter

+

Global utilities values adapter

+
+
+values
+
+ +
+ +
+
+class pyams_zmi.control_panel.GlobalRegistrationsView(context, request)
+

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

+

Global registrations view

+
+
+table_class
+

alias of GlobalRegistrationsTable

+
+ +
+ +
+
+class pyams_zmi.control_panel.LocalRegistrationsHeaderAdapter(context, request, view)
+

Bases: pyams_skin.page.DefaultPageHeaderAdapter

+

Local registrations header adapter

+
+
+icon_class = 'fa fa-fw fa-codepen'
+
+ +
+ +
+
+class pyams_zmi.control_panel.LocalRegistrationsHelpAdapter(context, request, view)
+

Bases: pyams_skin.help.ContentHelp

+

Local registrations help adapter

+
+
+header = 'Local registry utilities'
+
+ +
+
+message = "A local registry is a registry defining utilities stored into\nsite's Object Database (ZODB).\n\nYou can manage these utilities and modify their properties and site's behaviour without\nmodifying the application."
+
+ +
+
+message_format = 'rest'
+
+ +
+ +
+
+class pyams_zmi.control_panel.LocalRegistrationsMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

Local registrations menu

+
+
+label = 'Local registrations'
+
+ +
+
+url = '#local-registrations.html'
+
+ +
+ +
+
+class pyams_zmi.control_panel.LocalRegistrationsTable(context, request)
+

Bases: pyams_skin.table.BaseTable

+

Local utilities registrations table

+
+
+data_attributes = {}
+
+ +
+
+id = 'local_registrations_table'
+
+ +
+
+title = 'Local utilities registrations'
+
+ +
+ +
+
+class pyams_zmi.control_panel.LocalRegistrationsValuesAdapter(context, request, view)
+

Bases: pyams_utils.adapter.ContextRequestViewAdapter

+

Local utilities values adapter

+
+
+values
+
+ +
+ +
+
+class pyams_zmi.control_panel.LocalRegistrationsView(context, request)
+

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

+

Registrations view

+
+
+table_class
+

alias of LocalRegistrationsTable

+
+ +
+ +
+
+class pyams_zmi.control_panel.RegistrationsComponentColumn(context, request, table)
+

Bases: z3c.table.column.GetAttrColumn

+

Registrations component column

+
+
+getValue(obj)
+
+ +
+
+header
+
+ +
+
+weight = 1
+
+ +
+ +
+
+class pyams_zmi.control_panel.RegistrationsInterfaceColumn(context, request, table)
+

Bases: z3c.table.column.GetAttrColumn

+

Registrations interface column

+
+
+getValue(obj)
+
+ +
+
+header
+
+ +
+
+weight = 5
+
+ +
+ +
+
+class pyams_zmi.control_panel.RegistrationsNameColumn(context, request, table)
+

Bases: z3c.table.column.GetAttrColumn

+

Registrations name column

+
+
+getValue(obj)
+
+ +
+
+header
+
+ +
+
+weight = 10
+
+ +
+ +
+
+class pyams_zmi.control_panel.UtilitiesHeaderAdapter(context, request, view)
+

Bases: pyams_skin.page.DefaultPageHeaderAdapter

+

Utilities header adapter

+
+
+icon_class = 'fa fa-fw fa-codepen'
+
+ +
+ +
+
+class pyams_zmi.control_panel.UtilitiesMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

Utilities menu

+
+
+icon_class = 'fa-codepen'
+
+ +
+
+label = 'Utilities'
+
+ +
+
+url = '#utilities.html'
+
+ +
+ +
+
+class pyams_zmi.control_panel.UtilitiesTable(context, request)
+

Bases: pyams_skin.table.BaseTable

+

Utilities table

+
+
+data_attributes
+
+ +
+
+id = 'utilities_table'
+
+ +
+
+title = 'Site utilities'
+
+ +
+ +
+
+class pyams_zmi.control_panel.UtilitiesTrashColumn(context, request, table)
+

Bases: pyams_skin.table.TrashColumn

+

Utilities trash column

+
+
+checker(col, x)
+
+ +
+
+icon_hint = 'Delete utility'
+
+ +
+
+permission = 'pyams.ManageSystem'
+
+ +
+ +
+
+class pyams_zmi.control_panel.UtilitiesValuesAdapter(context, request, view)
+

Bases: pyams_utils.adapter.ContextRequestViewAdapter

+

Utilities values adapter

+
+
+values
+
+ +
+ +
+
+class pyams_zmi.control_panel.UtilitiesView(context, request)
+

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

+

Control panel view

+
+
+table_class
+

alias of UtilitiesTable

+
+ +
+ +
+
+pyams_zmi.control_panel.delete_utility(request)
+

Delete utility from site manager

+
+ +
+
+

pyams_zmi.extension module

+
+
+class pyams_zmi.extension.GoogleAnalyticsPropertiesAJAXEditForm(context, request)
+

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.extension.GoogleAnalyticsPropertiesEditForm

+

Google Analytics properties edit form, JSON renderer

+
+ +
+
+class pyams_zmi.extension.GoogleAnalyticsPropertiesEditForm(context, request)
+

Bases: pyams_zmi.form.AdminDialogEditForm

+

Google Analytics properties edit form

+
+
+ajax_handler = 'analytics-properties.json'
+
+ +
+
+edit_permission = 'pyams.ManageSystem'
+
+ +
+
+fields = <z3c.form.field.Fields object>
+
+ +
+
+input_css_class = 'col-md-8'
+
+ +
+
+label_css_class = 'control-label col-md-4'
+
+ +
+
+legend = 'Update Google Analytics properties'
+
+ +
+ +
+
+class pyams_zmi.extension.GoogleAnalyticsPropertiesMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

Google Analytics properties menu

+
+
+icon_class = 'fa-line-chart'
+
+ +
+
+label = 'Google Analytics...'
+
+ +
+
+modal_target = True
+
+ +
+
+url = 'analytics-properties.html'
+
+ +
+ +
+
+class pyams_zmi.extension.GoogleTagManagerPropertiesAJAXEditForm(context, request)
+

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.extension.GoogleTagManagerPropertiesEditForm

+

Google Tag Manager properties edit form, JSON renderer

+
+ +
+
+class pyams_zmi.extension.GoogleTagManagerPropertiesEditForm(context, request)
+

Bases: pyams_zmi.form.AdminDialogEditForm

+

Google Tag Manager properties edit form

+
+
+ajax_handler = 'tag-manager-properties.json'
+
+ +
+
+edit_permission = 'pyams.ManageSystem'
+
+ +
+
+fields = <z3c.form.field.Fields object>
+
+ +
+
+input_css_class = 'col-md-8'
+
+ +
+
+label_css_class = 'control-label col-md-4'
+
+ +
+
+legend = 'Update Google Tag Manager properties'
+
+ +
+ +
+
+class pyams_zmi.extension.GoogleTagManagerPropertiesMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

Google Tag Manager properties menu

+
+
+icon_class = 'fa-tags'
+
+ +
+
+label = 'Google Tag Manager...'
+
+ +
+
+modal_target = True
+
+ +
+
+url = 'tag-manager-properties.html'
+
+ +
+ +
+
+class pyams_zmi.extension.UserReportPropertiesAJAXEditForm(context, request)
+

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.extension.UserReportPropertiesEditForm

+

UserReport properties edit form, JSON renderer

+
+ +
+
+class pyams_zmi.extension.UserReportPropertiesEditForm(context, request)
+

Bases: pyams_zmi.form.AdminDialogEditForm

+

UserReport properties edit form

+
+
+ajax_handler = 'user-report.json'
+
+ +
+
+edit_permission = 'pyams.ManageSystem'
+
+ +
+
+fields = <z3c.form.field.Fields object>
+
+ +
+
+input_css_class = 'col-md-8'
+
+ +
+
+label_css_class = 'control-label col-md-4'
+
+ +
+
+legend = 'Update UserReport service properties'
+
+ +
+ +
+
+class pyams_zmi.extension.UserReportPropertiesMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

UserReport properties menu

+
+
+icon_class = 'fa-comments'
+
+ +
+
+label = 'UserReport settings...'
+
+ +
+
+modal_target = True
+
+ +
+
+url = 'user-report.html'
+
+ +
+ +
+
+

pyams_zmi.form module

+
+
+class pyams_zmi.form.AdminAddForm(context, request)
+

Bases: pyams_form.form.AddForm, pyams_zmi.view.AdminView

+

Admin add form

+
+ +
+
+class pyams_zmi.form.AdminDialogAddForm(context, request)
+

Bases: pyams_form.form.DialogAddForm, pyams_zmi.view.AdminView

+

Admin dialog add form

+
+ +
+
+class pyams_zmi.form.AdminDialogDisplayForm(context, request)
+

Bases: pyams_form.form.DialogDisplayForm, pyams_zmi.view.AdminView

+

Admin dialog display form

+
+ +
+
+class pyams_zmi.form.AdminDialogEditForm(context, request)
+

Bases: pyams_form.form.DialogEditForm, pyams_zmi.view.AdminView

+

Admin dialog edit form

+
+ +
+
+class pyams_zmi.form.AdminDisplayForm(context, request)
+

Bases: pyams_form.form.DisplayForm, pyams_zmi.view.AdminView

+

Admin display form

+
+ +
+
+class pyams_zmi.form.AdminEditForm(context, request)
+

Bases: pyams_form.form.EditForm, pyams_zmi.view.AdminView

+

Admin edit form

+
+ +
+
+class pyams_zmi.form.InnerAdminAddForm(context, request, view=None)
+

Bases: pyams_form.form.InnerAddForm, pyams_zmi.view.AdminView

+

Inner admin add form

+
+ +
+
+class pyams_zmi.form.InnerAdminDisplayForm(context, request, view=None)
+

Bases: pyams_form.form.InnerDisplayForm, pyams_zmi.view.AdminView

+

Inner admin display form

+
+ +
+
+class pyams_zmi.form.InnerAdminEditForm(context, request, view=None)
+

Bases: pyams_form.form.InnerEditForm, pyams_zmi.view.AdminView

+

Inner admin edit form

+
+ +
+
+

pyams_zmi.layer module

+
+
+

pyams_zmi.site module

+
+
+class pyams_zmi.site.BackOfficePropertiesAJAXEditForm(context, request)
+

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.site.BackOfficePropertiesEditForm

+

Back-office properties edit form, JSON renderer

+
+
+get_ajax_output(changes)
+
+ +
+ +
+
+class pyams_zmi.site.BackOfficePropertiesEditForm(context, request)
+

Bases: pyams_zmi.form.AdminDialogEditForm

+

Back-office properties edit form

+
+
+ajax_handler = 'back-office-properties.json'
+
+ +
+
+dialog_class = 'modal-large'
+
+ +
+
+edit_permission = 'pyams.ManageSystem'
+
+ +
+
+fields
+
+ +
+
+getContent()
+
+ +
+
+legend = 'Update site back-office properties'
+
+ +
+
+updateWidgets(prefix=None)
+
+ +
+ +
+
+class pyams_zmi.site.BackOfficePropertiesMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

Back-office properties menu

+
+
+icon_class = 'fa-tachometer'
+
+ +
+
+label = 'Back-office properties...'
+
+ +
+
+modal_target = True
+
+ +
+
+url = 'back-office-properties.html'
+
+ +
+ +
+
+class pyams_zmi.site.PropertiesAJAXEditForm(context, request)
+

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.site.PropertiesEditForm

+

Properties edit form, AJAX renderer

+
+
+get_ajax_output(changes)
+
+ +
+ +
+
+class pyams_zmi.site.PropertiesEditForm(context, request)
+

Bases: pyams_zmi.form.AdminEditForm

+

Properties edit form

+
+
+ajax_handler = 'properties.json'
+
+ +
+
+edit_permission = 'pyams.ManageSystem'
+
+ +
+
+fields
+
+ +
+
+getContent()
+
+ +
+
+legend = 'Update main site properties'
+
+ +
+ +
+
+class pyams_zmi.site.PropertiesEditFormHeaderAdapter(context, request, view)
+

Bases: pyams_skin.page.DefaultPageHeaderAdapter

+

Utilities header adapter

+
+
+icon_class = 'fa fa-fw fa-twitch'
+
+ +
+
+title
+
+ +
+ +
+
+class pyams_zmi.site.PropertiesMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

Properties menu

+
+
+icon_class = 'fa-edit'
+
+ +
+
+label = 'Properties'
+
+ +
+
+url = '#properties.html'
+
+ +
+ +
+
+class pyams_zmi.site.SiteRootTitleAdapter(context, request, view)
+

Bases: pyams_utils.adapter.ContextRequestViewAdapter

+

Site root title adapter

+
+
+title
+
+ +
+ +
+
+

pyams_zmi.skin module

+
+
+class pyams_zmi.skin.AdminSkin
+

Bases: object

+

PyAMS administration skin

+
+
+label = 'PyAMS management skin'
+
+ +
+
+layer = <InterfaceClass pyams_zmi.layer.IAdminLayer>
+
+ +
+ +
+
+class pyams_zmi.skin.UserSkinnablePropertiesAJAXEditForm(context, request)
+

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.skin.UserSkinnablePropertiesEditForm

+

User skin properties edit form, JSON renderer

+
+ +
+
+class pyams_zmi.skin.UserSkinnablePropertiesEditForm(context, request)
+

Bases: pyams_zmi.form.AdminDialogEditForm

+

User skin properties edit form

+
+
+ajax_handler = 'user-skin-properties.json'
+
+ +
+
+edit_permission = 'pyams.ManageSkin'
+
+ +
+
+fields
+
+ +
+
+input_css_class = 'col-md-8'
+
+ +
+
+label_css_class = 'control-label col-md-4'
+
+ +
+
+legend = 'Graphic theme elements'
+
+ +
+ +
+
+class pyams_zmi.skin.UserSkinnablePropertiesMenuDivider(context, request, view, manager)
+

Bases: pyams_skin.viewlet.menu.MenuDivider

+

User skin properties menu divider

+
+ +
+
+class pyams_zmi.skin.UserSkinnablePropertiesMenuItem(context, request, view, manager=None)
+

Bases: pyams_skin.viewlet.menu.MenuItem

+

User skin properties menu

+
+
+icon_class = 'fa-paint-brush'
+
+ +
+
+label = 'Graphic theme...'
+
+ +
+
+modal_target = True
+
+ +
+
+url = 'user-skin-properties.html'
+
+ +
+ +
+
+

pyams_zmi.view module

+
+
+class pyams_zmi.view.AdminView
+

Bases: object

+

Base admin view

+
+
+layer = <InterfaceClass pyams_zmi.layer.IAdminLayer>
+
+ +
+ +
+
+class pyams_zmi.view.ContainerAdminView(context, request)
+

Bases: pyams_zmi.view.InnerAdminView

+

Container admin view

+
+
+table_class
+

alias of Table

+
+ +
+
+update()
+
+ +
+ +
+
+class pyams_zmi.view.InnerAdminView
+

Bases: pyams_zmi.view.AdminView

+

Inner admin view

+
+ +
+
+pyams_zmi.view.handle_admin_form(event)
+

Set skin for admin forms

+
+ +
+
+pyams_zmi.view.handle_admin_view(event)
+

Set skin for admin views

+
+ +
+
+
+ + +