Open Source Content Management Framework

midcom.helper.metadata approvals

  1. Approval user interface
    1. Metadata toolbar in MidCOM Authoring Interface
    2. Scheduling in MidCOM Authoring Interface
  2. Approval permissions
    1. Group permissions in Aegir
  3. Enabling approval checks

midcom.helper.metadata provides a site-wide system for controlling approvals and visibility of objects on the MidCOM site.

Approval user interface

The user interface for this can be found from the AIS toolbar:

view_ais-metadata-toolbar

Metadata toolbar in MidCOM Authoring Interface

In addition to approval checks, the objects can be set to appear on the site, or disappear from the site at some particular time. The editor for this can be found behind the Edit metadata button:

view_ais-metadata-scheduling

Scheduling in MidCOM Authoring Interface

Approval permissions

In MidCOM 2.4.6 onwards, the approval feature is only available to users who have been explicitly granted permission for it. The approval permission can be given to groups by editing them in Aegir and checking the Approve websites button.

view_aegir-group-permissions

Group permissions in Aegir

In MidCOM 2.5.x this permission check is replaced by the midcom:approve privilege.

Enabling approval checks

There are two ways to enable approval checks for a MidCOM website. You can either deploy them using the Staging/Live system or the on-site checks described here.

By default the approvals are not required, but can be turned on server-wide using the following configuration setting in /etc/midgard/midcom.conf:

<?php
$GLOBALS['midcom_config_site']['show_unapproved_objects'] = FALSE;
?>

If you want to set them only for a specific sitegroup, you can set the following in the /sitegroup-config/midcom-template/config snippet :

$GLOBALS['midcom_config_local']['show_unapproved_objects'] = FALSE;

After this objects will be shown on the MidCOM site only when they're approved and their possible publication schedule is valid.

The approval check requires the components to query the objects using the metadata system. Some legacy components do not yet do this, and so will not be affected by this setting.

Designed by Nemein, hosted by Anykey