Meryam Sahin (talk | contribs)
Created blank page
 
Meryam Sahin (talk | contribs)
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
If you have want to generate a list of pages that have properties in common, you can create a data report. The easiest way is to insert a Content droplet.


{{VEinsertDroplets|name=Metadata report|inspector=1}}
== Data: Defining the report criteria ==
To define the report, provide your selection and outputcriteria in the Metadata report dialog. This dialog consists of the following tabs:
* ''Data:'' Add the properties that should be shown in your report. In addition, you can add a custom label that is shown instead of the property name itself.
* ''Options:'' Define the output format.
* ''Preview:'' Test if your criteria return any results (not available for all output formats).
=== Data to show ===
Enter the '''Property name''' and the '''Display label''' you want to show in the report output. You can provide properties from schemas, page properties or properties from the approval feature.
==== Properties from schemas ====
{| class="wikitable" style="width: 100%;"
|+
! style="vertical-align:middle;text-align:left;width:200px;" |Property
!Description
|-
| style="width:200px;" |Document control.Owner
|Shows the property ''Owner'' of subjects that are based on the schema ''Document control''.
|}
==== Page properties ====
Page properties exist for all content pages, independent of any schemas.
{| class="wikitable" style="width: 100%;"
! style="width:200px;" |Property
!Description
|-
| style="width:200px;" |categories
|Page categories
|-
| style="width:200px;" |creationTime
|Page creation time
|-
| style="width:200px;" |lastUpdated
|Latest page edit time
|-
| style="width:200px;" |lastEditor
|Last editor
|-
| style="width:200px;" |name
|Page name
|-
| style="width:200px;" |namespaceId
|Namespace ID of the page
|}
==== Approval-related properties ====
These properties are provided by the approval mechanism of the wiki. They only exist on a page if ''Approvals'' is activated for the page's namespace.
{| class="wikitable" style="width: 100%;"
! style="width:200px;" |Property
!Description
|-
| style="width:200px;" |<code>qm/state</code>
|Shows the approval status of a page - approval has to be activated in a namespace for a page to have a value (e.g., First draft, Draft)
|-
|''<code>qm/state_raw</code>''
|''Database value of the approval state (e.g., first-unstalbe, unstable) - usually not exposed in Metadata reports''
|-
|<code>qm/approved_by</code>
|Name of the page approver
|-
|<code>qm/approved_at</code>
|Page approval date
|-
|<code>qm/has_draft</code>
|Boolean value (set to ''1'' if the page has a draft)
|}
=== Filters ===
Specify one or more filters to define which pages appear in the report. Multiple filters are combined with ''AND'' (a page must match all of them).
{| class="wikitable" style="width: 100%;"
!Filter example
!Description
|-
|<code>Document control.Document type =  Process desciption</code>
|Include pages that have ''Document control'' subjects and where the ''Document type'' equals ''Process description''.
|}
==== Adding subject, namespace and category filters ====
You can conveniently select multiple filters for subjects, namespaces, and categories. After setting the filters here, they will be  added to your filter criteria afterwards. Therefore, after saving the metadata report and reopening it for editing, these fields will appear empty again.
* ''Only pages that have subjects of the following type(s):'' Select one or more schemas that have existing subjects on the pages that should be included in the report.
* ''Only pages in following namespace(s):'' Select one or more namespaces.
* ''Only pages in following category(ies):'' Select one or more categories.
== Options: Output criteria ==
In the options tab, you can select what the output should look like.
{{Textbox|boxtype=note|header=Visibility of form fields|text=No matter what format you select, the fields for ''Limit'', ''Main label'', ''Page display format'' and ''Show page link'' always remain visible, even if they might not apply. This makes it easier to switch between output formats without having to re-enter existing values. For example, if you select the format ''Count'', you can still enter a limit of pages to return, but the setting has no effect.|icon=yes}}
=== Sort ===
Define the sort order based on a property from your selection data. If empty, the results are sorted alphabetically by page name.
=== Format ===
{| class="wikitable"
!Type
!Description
|-
|<code>List</code>
|Comma-separated list of pages by default. The separator can be defined differently.
|-
|<code>Grid</code>
|Filterable and sortable data grid.
|-
|<code>Count</code>
|Number representing the total number of matching pages.
|-
|<code>Template</code>
|Custom output that requires a template. The template defines the output format for each result.
|-
|<code>Chart</code>
|Result is formatted as a visual chart (see extension [[Extension/SimpleCharts|SimpleCharts]]).
|-
|<code>KPI</code>
|Result is formatted as a KPI value (see extension [[Extension/KPIVisuals|KPIVisuals]])
|}
=== Limit ===
If you limit the output, also review your sorting criteria to make sure you "catch" the wanted pages.
=== Main Label ===
Sets the column header label for the first results column (for output format ''Grid'' only).
=== Other ===
* ''Page display format:'' Shows the page  as  ''(full) page name'', ''(full) page name with namespace prefix'' or as ''subpage name'' only.
* ''Show page link:'' If you select ''Template'' as the output format, it is often necessary to deselect the option  ''show page link'' so that you can custom-format the link in your template.
=== Preview ===
The preview tab allows you to quickly check if your query returns the expected results. If not, switch back to the Data tab to adjust your report criteria. Please note that not all output formats might have a preview. In that case, the tab is not active.

Latest revision as of 10:31, 8 September 2026

If you have want to generate a list of pages that have properties in common, you can create a data report. The easiest way is to insert a Content droplet.

To insert the Content droplet Metadata report on a page:

  1. Open the menu Content droplets.
  2. Filter for the Content droplet Metadata report.
  3. Click Insert. An inspector menu opens.
Content droplets inspector menu
Selecting a Content droplet

Data: Defining the report criteria

To define the report, provide your selection and outputcriteria in the Metadata report dialog. This dialog consists of the following tabs:

  • Data: Add the properties that should be shown in your report. In addition, you can add a custom label that is shown instead of the property name itself.
  • Options: Define the output format.
  • Preview: Test if your criteria return any results (not available for all output formats).

Data to show

Enter the Property name and the Display label you want to show in the report output. You can provide properties from schemas, page properties or properties from the approval feature.

Properties from schemas

Property Description
Document control.Owner Shows the property Owner of subjects that are based on the schema Document control.

Page properties

Page properties exist for all content pages, independent of any schemas.

Property Description
categories Page categories
creationTime Page creation time
lastUpdated Latest page edit time
lastEditor Last editor
name Page name
namespaceId Namespace ID of the page

These properties are provided by the approval mechanism of the wiki. They only exist on a page if Approvals is activated for the page's namespace.

Property Description
qm/state Shows the approval status of a page - approval has to be activated in a namespace for a page to have a value (e.g., First draft, Draft)
qm/state_raw Database value of the approval state (e.g., first-unstalbe, unstable) - usually not exposed in Metadata reports
qm/approved_by Name of the page approver
qm/approved_at Page approval date
qm/has_draft Boolean value (set to 1 if the page has a draft)

Filters

Specify one or more filters to define which pages appear in the report. Multiple filters are combined with AND (a page must match all of them).

Filter example Description
Document control.Document type = Process desciption Include pages that have Document control subjects and where the Document type equals Process description.

Adding subject, namespace and category filters

You can conveniently select multiple filters for subjects, namespaces, and categories. After setting the filters here, they will be added to your filter criteria afterwards. Therefore, after saving the metadata report and reopening it for editing, these fields will appear empty again.

  • Only pages that have subjects of the following type(s): Select one or more schemas that have existing subjects on the pages that should be included in the report.
  • Only pages in following namespace(s): Select one or more namespaces.
  • Only pages in following category(ies): Select one or more categories.

Options: Output criteria

In the options tab, you can select what the output should look like.

Visibility of form fieldsNo matter what format you select, the fields for Limit, Main label, Page display format and Show page link always remain visible, even if they might not apply. This makes it easier to switch between output formats without having to re-enter existing values. For example, if you select the format Count, you can still enter a limit of pages to return, but the setting has no effect.

Sort

Define the sort order based on a property from your selection data. If empty, the results are sorted alphabetically by page name.

Format

Type Description
List Comma-separated list of pages by default. The separator can be defined differently.
Grid Filterable and sortable data grid.
Count Number representing the total number of matching pages.
Template Custom output that requires a template. The template defines the output format for each result.
Chart Result is formatted as a visual chart (see extension SimpleCharts).
KPI Result is formatted as a KPI value (see extension KPIVisuals)

Limit

If you limit the output, also review your sorting criteria to make sure you "catch" the wanted pages.

Main Label

Sets the column header label for the first results column (for output format Grid only).

Other

  • Page display format: Shows the page as (full) page name, (full) page name with namespace prefix or as subpage name only.
  • Show page link: If you select Template as the output format, it is often necessary to deselect the option show page link so that you can custom-format the link in your template.

Preview

The preview tab allows you to quickly check if your query returns the expected results. If not, switch back to the Data tab to adjust your report criteria. Please note that not all output formats might have a preview. In that case, the tab is not active.