Skip to end of metadata
Go to start of metadata


Each archiving connector can write meta information in form of an additional file to the archiving directory of each archived transfer. The format of this file, the file name and its contents are fully customizable. Each archiving connector is pre-configured with a default template in form of an Apache Velocity Template.

Velocity Context

The Velocity Context of the template includes all information which might be relevant for archiving.

 Click to see an overview of available data in the Velocity Context used for archiving ...

Apache Velocity

Context VariableObjectDescription
${date}Apache DateToolGrants access to date utility methods in order to perform tasks related to dates, such as formatting a date into a human-readable format.
${number}Apache NumberToolGrants access to number utility methods in order to perform tasks related to numbers (Integers, Float, etc.), such as converting floating point numbers to integers.
${math}Apache MathToolGrants access to math utility methods in order to perform calculation tasks, such as adding numbers.
${esc}Apache EscapeToolGrants access to escape utility methods in order to escape certain template output such as email addresses.


Update Cryptshare Version to

Beginning with Cryptshare, the algorithm for the transfer files has changed from SHA-1 to SHA-256. Therefore, another field has been added to the meta-info.xml template which specifies the algorithm with which the checksum for the transfer files was formed (${fileChecksumAlgorithm}), to be able to differentiate.

The new template is available for all new configurations.

The schema of meta-info.xml will not change automatically for existing configurations. To use the new field, add it manually or remove the existing configuration and create a new one.

Usage of context variables

Not all context variables can be used to adjust the file name (e.g. for the meta-data file), because their contents possibly contain invalid characters for a file name or their contents represent a list of elements whose contents cannot be accessed directly.

Context VariableTypeDescriptionUsing for FilenameUsing for Meta-Data content
${trackingId}StringA Cryptshare Tracking ID is a unique id for a single Cryptshare Transfer.(tick)(tick)
${provisionDate}DateThe date when a Cryptshare Transfer was provided.(tick)(tick)
${expirationDate}DateThe date when a Cryptshare Transfer will expire.(tick)(tick)
${product}StringAn identifier for the product which provided the transfer, for instance Cryptshare for Outlook.(tick)(tick)
${classification}StringThe classification used to tag a Cryptshare transfer.
${message}StringThe notification message that was written in order to inform the recipients about a transfer.
${subject}StringThe notification subject used for the notification message sent to the recipients of a transfer.(tick)(tick)
${encryptedMessage}StringThe confidential message that was attached to the transfer.
${encryptedSubject}StringThe confidential message subject used for the confidential message.(tick)(tick)
${}StringThe name of the sender.(tick)(tick)
${}StringThe phone number of the sender.(tick)(tick)
${}StringThe email address of the sender.(tick)(tick)

The ip address of the sender.

${recipients}ListThe recipients of a transfer.
<recipient>ObjectProvides access to recipient attributes such as the email address.
${<recipient>.email}StringEmail address of a recipient.
${<recipient>.metaId}StringThe transfer id of a recipient.
${fileChecksumAlgorithm}StringThe used file checksum algorithm of a transfer(tick)(tick)
${files}ListThe files in a transfer.
<file>ObjectProvides access to transfer file attributes such as the file name.
${<file>.name}StringThe original name of a transfer file.
${<file>.encryptedName}StringThe encrypted name of a transfer file.
${<file>.size}longThe file size of a transfer file in bytes.
${<file>.checksum}StringThe checksum of a transfer file (using checksum algorithm specified by ${fileChecksumAlgorithm}).
${options}ObjectProvides access to transfer options such as the selected password mode.
${options.passwordMode}StringThe password mode used for a transfer.(tick)(tick)
${options.showFilenames}booleanWhether transfer notifications show the original file names or not.(tick)(tick)
${options.uploadNotificationEnabled}booleanWhether the sender will be informed when the upload is available for the recipients.(tick)(tick)
${options.downloadNotificationEnabled}booleanWhether the sender will be informed when recipients have downloaded files from the transfer.(tick)(tick)

The Meta-Data File

File Name

For each archived transfer a meta-data file is written to the archiving directory named by the name template specified in the meta-data settings.

For the file name of the meta-file also exists access to the Meta-Data Settings mentioned above. This means that for the file name the marked transfer information is available as well.


A transfer is provided having the tracking-id '20170822-114019-3a4efd0d'. Together with a configuration shown in the above screenshot the meta-data file name will be 'meta-info_20170822-114019-3a4efd0d.xml'.

Meta-Data Content

There are 2 available templates for meta-data content. One for the legacy connector and the other for both, the local file system connector and the secure copy connector.
For all connector types the contents can be changed as required for the archiving system in use. The pre-configured templates are only examples.

Table of Contents

  • No labels