Skip to main content

DocumentParameter

Overview​

1. AccPack_DocumentParameter​

The AccPack_DocumentParameter gets the value of a document parameter. Supports parameters from Combobox, Text Field, and CheckBox types.

2. Strategic Choice: Document Parameters vs. Attributes or Metadata​

Selecting the correct data source is critical for efficient template management. A consultant should choose Document Parameters when a value is defined at the document or publication level rather than being tied to a specific data record.

Data SourcePlaceholderBest Use Case
Data Record AttributesAccPack_AttributeKeyValueStandard product data (e.g., Color, Weight) that changes per item.
Entity MetadataAccPack_ContentMetaDataRecord-specific operational flags or instance-specific copy (e.g., Headline for a specific placement).
Global ParametersAccPack_DocumentParameterPer-document values such as "Catalog Year," "Chapter Title," or "Legal Disclaimer" that apply to every page of the document.

Technical Specification​

Placeholder type: Text

Entity: Document parameters (supports Combobox, Text Field, and CheckBox types)

Function Variables​

  • identifier: The unique identifier of the document parameter as defined in the priint Planner.

  • Value Field: Determines which field of the parameter to load.

    • For Text Fields and Comboboxes, options include: value1, value2, value3, or combined.

    • For other parameter types (like CheckBoxes), this field should be left empty.

  • Result Entity ID: Identifier of the key-value result entity.

Developer Specifications​

  • Data Query:

    • com.priint.accpack.placeholder.dataquery.ParameterDataQueryPlugin.getDocumentParameters.

    • com.priint.accpack.placeholder.dataquery.ParameterDataQueryPlugin.getDocumentParameterByIdentifier.

  • Data Mapping:

    • com.priint.accpack.placeholder.datamapping.ParameterDataMapping.getValueListOfParameters.

    • com.priint.accpack.placeholder.datamapping.ParameterDataMapping.getValueOfFirstParameter.

    • com.priint.accpack.placeholder.datamapping.ParameterDataMapping.getValueOfParameterByIdentifier.

  • Data Processing: None.

Global Configuration Logic​

1. Context Definition​

Unlike attribute-based placeholders, AccPack_DocumentParameter does not typically use language or country context. The values are derived directly from the document's parameter settings in the Planner UI.

2. Selection Variable Logic​

This placeholder does not support standard "Selection" variables (Ignore, Only, Use all) because it does not query linked data buckets or planning records.

Technical Environment & Deployment​

Consultants could find guide for deployment of generic placeholders here: installation & configuration

Demonstration & Implementation Examples​

Demo data for example:

Figure 1: Prepared data to be displayed in priint:admin

  • Document parameter: Catalog title
  • Identifier: catalog_title
  • Metadata Type: Text Field

Prepared data

Figure 2: Prepared document to be displayed in priint:neowise

Document in neowise

Figure 3: Result

Text "AccPack Demo" is displayed.

Result

Further Reading​