Child pages
  • Remote Controlled Document

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionA remote controlled document uses macros that enable to control the content being rendered by request parameters.
Doctypeglossary-itemhide
NameRemote Controlled Document
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
valuefinished

hide
Type
Name List
doctypefaq-type
render-no-hits-as-blanktrue
propertyType

Abbreviation
Word Type
Domain
Relation
Name List
doctyperelation
render-no-hits-as-blanktrue
namesprojectdoc
propertyRelation

Sort Keyhide
Section
show-titlefalse
titleDescription

Remote documents allow to select the content of the document to be rendered. A remote controlled document uses macros that expose some or all of their parameters to be controlled by query parameters provided with the HTTP request.

This feature is useful for use cases where the content of a page should be controlled by an external information system. A typical use case is to aggregate a page based on an error code. The remote system can reference a remote controlled document on a Confluence server and select the information by providing the error code and some context information.

Section
titleSupporting Macros

A number of macros from the PDAC1 support being controlled remotely:

Display Table
doctypemacro
render-modedefinition
selectName, Short Description
space-keysPDAC1
where$<Tags>=[Remote Control]

...