CSSCurrent en:Meta Data Configuration
General
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 Variable | Object | Description |
|---|---|---|
| ${date} | Modified version of Apache DateTool with additional support for the 'LocalDateTime' type | Grants 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 NumberTool | Grants 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 MathTool | Grants access to math utility methods in order to perform calculation tasks, such as adding numbers. |
| ${esc} | Apache EscapeTool | Grants access to escape utility methods in order to escape certain template output such as email addresses. |
Changed Velocity Context variables in 4.7.0
| Context Variable | Type | Description | Using for Filename | Using for Meta-Data content |
|---|---|---|---|---|
| ${trackingId} | String | A Cryptshare Tracking ID is a unique id for a single Cryptshare Transfer. | 
|
|
| ${provisionDate} | LocalDateTime | The date when a Cryptshare Transfer was provided. |
|
|
| ${expirationDate} | LocalDateTime | The date when a Cryptshare Transfer will expire. |
|
|
| ${product} | String | An identifier for the product which provided the transfer, for instance Cryptshare for Outlook. |
|
|
| ${classification} | String | The classification used to tag a Cryptshare transfer. |
| |
| ${message} | String | The notification message that was written in order to inform the recipients about a transfer. |
| |
| ${subject} | String | The notification subject used for the notification message sent to the recipients of a transfer. |
|
|
| ${encryptedMessage} | String | The confidential message that was attached to the transfer. |
| |
| ${encryptedSubject} | String | The confidential message subject used for the confidential message. |
|
|
| ${sender.name} | String | The name of the sender. |
|
|
| ${sender.phone} | String | The phone number of the sender. |
|
|
| ${sender.email} | String | The email address of the sender. |
|
|
| ${sender.ipAddress} | String | The IP address of the sender. |
|
|
| ${recipients} | List | The recipients of a transfer. |
| |
| <recipient> | Object | Provides access to recipient attributes such as the email address. |
| |
| ${<recipient>.email} | String | Email address of a recipient. |
| |
| ${<recipient>.metaId} | String | The transfer id of a recipient. |
| |
| ${fileChecksumAlgorithm} | String | The used file checksum algorithm of a transfer |
|
|
| ${files} | List | The files in a transfer. |
| |
| <file> | Object | Provides access to transfer file attributes such as the file name. |
| |
| ${<file>.name} | String | The original name of a transfer file. |
| |
| ${<file>.encryptedName} | String | The encrypted name of a transfer file. |
| |
| ${<file>.size} | long | The file size of a transfer file in bytes. |
| |
| ${<file>.checksum} | String | The checksum of a transfer file (using checksum algorithm specified by ${fileChecksumAlgorithm}). |
| |
| ${options} | Object | Provides access to transfer options such as the selected password mode. |
| |
| ${options.passwordMode} | String | The password mode used for a transfer. |
|
|
| ${options.showFilenames} | boolean | Whether transfer notifications show the original file names or not. |
|
|
| ${options.uploadNotificationEnabled} | boolean | Whether the sender will be informed when the upload is available for the recipients. |
|
|
| ${options.downloadNotificationEnabled} | boolean | Whether the sender will be informed when recipients have downloaded files from the transfer. |
|
|
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.
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.