Skip to content

Commit

Permalink
Add section on document ID templating in seal footer
Browse files Browse the repository at this point in the history
Add section on "Variable Templating"
  • Loading branch information
haysch committed Nov 1, 2024
1 parent 9089656 commit 66844dd
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions src/pages/signatures/graphql/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,26 @@ import createSignatureAppearanceExample from '../../../examples/createSignatureO

<GraphQLExample example={createSignatureAppearanceExample} />

### Variable Templating

Templating in signature seals can happen in either the left side of the header or the footer.

Variable templating works by enclosing the referenced variable curly brackets, e.g. `{{my-identifier}}`

In addition to templating values from claims (see [Seal display name](#seal-display-name)), we enable use of some additional variables, such as:

* Timestamp (see [Seal timestamp](#seal-timestamp)):
* Year: `$timestamp.YYYY`
* Month: `$timestamp.MM`
* Day: `$timestamp.DD`
* Hour: `$timestamp.hh`
* Minutes: `$timestamp.mm`
* Seconds: `$timestamp.ss`
* Milliseconds (1 digit): `$timestamp.z`
* Milliseconds (2 digit): `$timestamp.zz`
* Milliseconds (3 digit): `$timestamp.zzz`
* Document ID (see [Seal document ID](#seal-document-id)): `$document.id`

### Seal timestamp

By default the seal renders a timestamp in the left side of the seal header.
Expand All @@ -174,6 +194,16 @@ import addSignatoryDisplayNameExample from '../../../examples/addSignatory/displ

<GraphQLExample example={addSignatoryDisplayNameExample} />

### Seal document ID

By default the seal does not render the document ID.

The document ID can be added to the seal by templating as shown in the following example:

import addSignatoryFooterExample from '../../../examples/addSignatory/footer';

<GraphQLExample example={addSignatoryFooterExample} />

## Closing a signature order

When all signatories have signed the signature order you can close it to retrieve your signed PDFs.
Expand Down

0 comments on commit 66844dd

Please sign in to comment.