Any user-defined text field can be called onto a template by simply placing the @ symbol in front of the field name.
Below is a list of special ‘system’ @codes that can be used on a layout (and elsewhere) to retrieve certain data.
Further Reading: List of ‘Special’ and Predefined Fields
In addition to any custom user-created fields, there are many “special” fields that Timestone Software has built in and made available to the user in details mode; these fields may be exportable, called into templates via @code, and/or appear as part of various reports.
@Code | Function |
|---|---|
account | The account description |
batch-count | The total number of pages in the batch |
batch-index | The current page in the batch |
collection | The Collection description |
collection:year | The logical year for a specific image in a collection |
composite | The name of the composite page as defined in Form Pages Mode. Defaults to the folder name |
corrections | Lists any color corrections that have been applied to the image |
createdate | The creation date |
createdby | The user responsible for creation |
date | Inserts the system date in short date format |
date(n) | Inserts a date "n" days into the future |
family | The subject’s family name |
familykey | The subject’s family key |
firstname | The contents of the field with the first name special property (regardless of the field name) |
folder | The subject's home folder |
folderkey | The subject’s home folder key |
folder:subjectscount | The total number of subjects in this subject's home folder |
folder:homesubjectscount | The number of home subjects in this subject's home folder |
historicalindex | Used for Legacy image exports, the index for the subject in each job, with 1 being the first job they belong to, 2 being the second, and so on. |
historicalsequence | Used for Legacy image exports, the sequence number of each job in the Job Collection |
historicalyear | Used for Legacy image exports, the value of the Year field for each job in the Job Collection |
ID | The Subject’s ID number from the ID field |
imagefilename | The image filename, complete with extension |
imageno | The image number |
imagetag | The image filename without the extension |
image:pathfilename | Lists the entire path to the image within the database |
jobfilename | The job file name, complete with the .tnj extension |
jobkey | The job key |
jobname | The job file name without the .tnj extension |
key | Will give the subject, folder, or family key depending on whether the product is for a subject, folder, or family. |
lastname | The contents of the field with the last name special property (regardless of the field name) |
name | combines data from the first name field and the last name field |
name-prefix | The groupname prefix |
name-suffix | The groupname suffix |
order | A list of all package codes in the order |
ordercomment | The comment on an order |
ordercost | The Order Cost |
orderpaid | The amount paid for an order |
order:deliverycode | The delivery code |
order:name | The customer name (customer-based orders only) |
orderkey | The order key |
package | The package code and description |
packagecode | The package code |
packagename, packagetitle, packagedescription | The package description |
packlayout | The template filename (without extension) or the template description if defined |
pageno | The page number of the current page (sheet) when using item sheets with item sheet backgrounds |
pagetotal | The total number of pages (sheets) when using item sheets with item sheet backgrounds |
pose | In an item, it displays the pose number or label of the current image |
product | The product code and description |
productcode | The product code |
productname, producttitle, productdescription | The product description |
queuepacks | Lists the packs in the queue for a given subject |
season | The season description |
sheet-count | The total number of sheets on the pack layout as defined by the cutmarks |
sheet-index(1), sheet-index(2), sheet-index(3)… | The sheet in a pack layout as defined by the cutmarks |
time | Inserts the current system time |
time(n) | Inserts the time"n" seconds from the current system time |
total-count | The total number of pages in the print run |
total-index | The current page in the print run |
uniqueidentifier | Used for Legacy exports, the internal identifier that matches each subject |
wholename | The contents of the field defined with the whole name special property (regardless of the field name) |
workspace | The workspace description |
FAQ
Can I call up custom information onto a template?
You can call any custom information onto a template by placing the @ symbol in front of the field name.
What is the purpose of the @codes?
The @codes are used to retrieve specific data on templates and Item sheets.
Can I retrieve the primary image name using an @code?
While there is no @code to provide the primary image directly, @imagefilename and @imagetag will display the image name with or without the file extension of the contextually selected image; meaning these codes call in the image that is displayed or selected by the customer or user for the given item or product template.
Therefore, in situations like a multi-subject proof sheet where the user selects to only display one image, typically the primary image, per subject, these @codes will provide the primary image name. Alternatively, in the case that the user includes an Identification strip on templates, these @codes will display the image name of the customer’s ordered image, regardless of that image’s primary status, or lack thereof.