Skip to content

Proposal Presentation Template

Description

A Proposal Presentation Template defines how the data captured by the Proposal Form Template is to be displayed.

Multiple Proposal Presentation Templates can exist for the same Proposal Form Template. Each can be used to display the form data under different circumstances.

Proposal Presentation Templates can reference any data contained in the Proposal Document, as well as any documents linked by:

The presentation of the payload of a Proposal is controlled by its Proposal Presentation Template/s.

Proposal Presentation TemplateProposal Presentation Template    Document Relationshipscluster_system_parametersSystem ParametersBrand Parameters                             Brand Parameters                        Campaign Parameters                             Campaign Parameters                        Category Parameters                             Category Parameters                        Proposal Presentation Template                         Proposal Presentation Template                    content typeapplication/schema+jsontypecb99b9bd-681a-49d8-9836-89107c02e8ef7808d2ba-d511-40af-84e8-c0d1625fdfdcidDocument IdverDocument VerparametersBrand ParametersCampaign ParametersCategory ParametersProposal Presentation Template:e->Brand Parameters1*

Validation

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

Business Logic

Front End

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

Back End

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

COSE Header Parameters

Metadata

type

Parameter Value
Required yes
Format Document Type
Type cb99b9bd-681a-49d8-9836-89107c02e8ef,
7808d2ba-d511-40af-84e8-c0d1625fdfdc

The document TYPE.

type Validation

MUST be a known document type.

id

Parameter Value
Required yes
Format Document Id

Document ID, created the first time the document is created. This must be a properly created UUIDv7 which contains the timestamp of when the document was created.

id Validation

IF ver does not == id then a document with id and ver being equal MUST exist.

ver

Parameter Value
Required yes
Format Document Ver

The unique version of the document. The first version of the document must set ver == id

ver represents new versions of the same document as it changes over time.

ver Validation

The document version must always be >= the document ID.

parameters

Parameter Value
Required yes
Format Document Reference
Valid References Brand Parameters
Campaign Parameters
Category Parameters

A reference to the Parameters Document this document lies under.

parameters Validation

In addition to the validation performed for Document Reference type fields:

  • Any linked referenced document that includes a parameters metadata must match the parameters of the referencing document, or a parent of those parameters.

For example, a linked reference to Contest Parameters is transitively a reference to the Parameters document it references, and each parameters document they reference until the Brand parameters document is reached.

The use case here is for Templates. The profile template, or proposal templates could be defined at any of these levels, and as long as they all refer to the same chain of parameters in the hierarchy they are all valid.

Payload

TBD. But roughly, will be:

  1. A way to identify where the presentation template is intended to be used.
  2. Optional CSS to control the presentation.
  3. A Handlebars templated HTML or Markdown file data which defines the presentation.

Signers

The following Admin roles may sign documents of this type:

  • Brand Admin
  • Campaign Admin

New versions of this document may be published by:

  • author
Copyright © 2024-2025 IOG Singapore, All Rights Reserved
License This document is licensed under CC-BY-4.0
Created 2024-12-27
Modified 2025-05-30
Authors Alex Pozhylenkov alex.pozhylenkov@iohk.io
Steven Johnson steven.johnson@iohk.io

Changelog

0.04 (2025-05-05)

  • First Version.