Meryam Sahin (talk | contribs)
No edit summary
Meryam Sahin (talk | contribs)
No edit summary
Line 1: Line 1:
If you have wiki pages that have structured data in the form of Subjects, you can create a data report. The easiest way is to insert a Content droplet.
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}}  
{{VEinsertDroplets|name=Metadata report|inspector=1}}  


== Data: Defining the report criteria ==
== Data: Defining the report criteria ==
To define the report, provide the data you want to show and apply the filters for which pages to include.
To define the report, provide your selection and outputcriteria in the Metadata report dialog. This dialog consists of the following tabs:
 
* Data: Here you can 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:
* Preview:


=== Data to show ===
=== 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.
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 ====
==== Properties from schemas ====
{| class="wikitable" style="width: 100%;"
{| class="wikitable" style="width: 100%;"
|+
|+
!Property
! style="vertical-align:middle;text-align:left;width:200px;" |Property
!Description
!Description
|-
|-
|Document control.Owner
| style="width:200px;" |Document control.Owner
|Shows the property ''Owner'' of subjects that are based on the schema ''Document control''.
|Shows the property ''Owner'' of subjects that are based on the schema ''Document control''.
|}
|}
Line 22: Line 26:
Page properties exist for all content pages, independent of any schemas.
Page properties exist for all content pages, independent of any schemas.
{| class="wikitable" style="width: 100%;"
{| class="wikitable" style="width: 100%;"
!Property
! style="width:200px;" |Property
!Description
!Description
|-
|-
|categories
| style="width:200px;" |categories
|Page categories
|Page categories
|-
|-
|creationTime
| style="width:200px;" |creationTime
|Page creation time
|Page creation time
|-
|-
|lastUpdated
| style="width:200px;" |lastUpdated
|Latest page edit time
|Latest page edit time
|-
|-
|lastEditor
| style="width:200px;" |lastEditor
|Last editor
|Last editor
|-
|-
|name
| style="width:200px;" |name
|Page name
|Page name
|-
|-
|namespaceId
| style="width:200px;" |namespaceId
|Namespace ID of the page
|Namespace ID of the page
|}
|}
Line 47: Line 51:
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.
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%;"
{| class="wikitable" style="width: 100%;"
!Property
! style="width:200px;" |Property
!Description
!Description
|-
|-
|qm/state
| style="width:200px;" |qm/state
|Shows the approval status of a page. (Approval has to be activated in a namespace for a page to have a value).
|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)  
Other properties
|-
|''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)
|}
|}


Line 58: Line 73:
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).
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%;"
{| class="wikitable" style="width: 100%;"
!Filter examples
!Filter example
!Description
!Description
|-
|-
|Document conrol.Document type =  Process desciption  
|Document control.Document type =  Process desciption  
|Include pages that have ''Document control'' subjects and where the ''Document type'' equals ''Process description''.
|Include pages that have ''Document control'' subjects and where the ''Document type'' equals ''Process description''.
|}
|}


=== Additional filter conditions ===
==== 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.


* '''Only pages that have subjects of the following type(s):''' Select one or more schemas
== Options: Output criteria ==
* '''Only pages in following namespace(s):''' Select one or more namespaces
In the options tab, you can select what the output should look like.
* '''Only pages in following category(ies):''' Select one or more categories


== Options: Output criteria ==
{{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 are still shown although they may not apply to your selected output format. This makes it easier to switch between output formats without having to re-enter existing values when switching to a different type. For example, if you select the format Count, you can still enter a limit of pages to return, but it has no effect.|icon=yes}}
In the options tab, you can select what the output should look like.


=== Sort ===
=== Sort ===
Line 109: Line 126:
=== Show page link ===
=== Show page link ===
If you select "Template" as the output format, it is often necessary to deselect show page link so that you can custom-format the link in your template.
If you select "Template" as the output format, it is often necessary to deselect 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.

Revision as of 10:08, 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: Here you can 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:
  • Preview:

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)

Defining the 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 are still shown although they may not apply to your selected output format. This makes it easier to switch between output formats without having to re-enter existing values when switching to a different type. For example, if you select the format Count, you can still enter a limit of pages to return, but it has no effect.

Sort

Define the sort order. If empty, the results are sorted alphabetically by page name.

Format

Type Description
List
Grid
Count
Template
Chart
KPI

Limit

Main Label

Page display format

If you select "Template" as the output format, it is often necessary to deselect 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.