Tokens
A token is a placeholder for a value to be inserted. Laserfiche can take advantage of tokens in a variety of ways, such as adding values to fields and certain annotations, naming new documents, and creating dynamic paths.
All tokens are in the format: %(Token). Depending on the Laserfiche client application being used, available tokens may vary.
Tokens are particularly useful as default values or when creating documents in batches, as they allow you to dynamically store information relevant to each document without having to specify each value manually.
In most cases, you can insert a token into a field, name, or other property by clicking the token button (>) and selecting the token you want to insert. You can also type a token manually.
Laserfiche Repository
The following tokens can be used in your repository and in Repository Administration. For instance, they can be used to populate fields or set default field values, or when naming documents or configuring Outlook import.
| Name | Syntax | Description |
|---|---|---|
| Date | %(Date) | The current date. |
| Time | %(Time) | The system time on the current workstation. |
| Date/Time | %(DateTime) | The current date and time. |
| Session Count | %(Count) | A token that will be replaced by a sequential number every time an entry is created or imported into a Laserfiche Client. This token starts at 1 and is specific to a particular user. |
| Repository Count | %(GCount) | A sequential number added every time an entry is created or imported into Laserfiche. This token starts at 1 and applies to the entire repository. |
| User Name | %(UserName) | The name of the current user. |
| Entry Name | %(Name) | The name of the entry. |
| Parent Name | %(ParentName) | The name of the entry's parent folder. |
| Entry ID | %(ID) | The identification number assigned to the Laserfiche document where data will be stored. This number will be generated when the Laserfiche document is created. |
| Parent ID | %(ParentID) | The ID of the entry's parent folder. |
| Parent Field | %(Parent)
%(Parent: Field) |
The value assigned to the field with the same name in the parent folder. If this token is used when a document or folder is being created, field data will be inherited from the folder in which the document or folder will be created. Once a document or folder inherits a field value, the parent token will be replaced with the value assigned to a field in the parent folder.
Note: A token will only be replaced once. If the parent's field data is updated, it does not update the children's field data. The parent token is not meant as a means of synchronizing field data between a folder and its children. Example: If you insert the %(Parent) token in the "Name" field, it will be replaced by the value assigned to the "Name" field in the parent folder. If the parent folder has not been associated with a "Name" field, the token will not be replaced. If the parent folder has been associated with a "Name" field, and the value of that field changes, the token value will not be updated. To inherit the value assigned to a field with a different name, use the %(Parent:Field) token. The term Field should be replaced with the name of the desired field associated with the parent folder. |
| Global Count | %(GCount) |
A sequential number added every time an entry is created or imported into a Laserfiche Server. By default, this token starts at 1.
Example: Jon and Ben each create a document and use %(GCount). The server count is 3 because the server starts with 1 and each user has created a document. |
| Page Count | %(PageCount) | The number of pages in a document. |
Scanning
The following tokens can be used when scanning documents into Laserfiche. For instance, they can be used to dynamically create a folder structure, name documents, or populate template information.
| Name | Syntax | Description |
|---|---|---|
| Creation Date | %(Creation Date) |
The original creation date for a file scanned by Universal Capture. |
| Date | %(Date) | The date a document is scanned. |
| Date/Time | %(Date/Time) | The date and time a document is scanned (e.g., 3/19/2008 8:01:34 PM) |
| Entry ID | %(ID) | The Entry ID associated with the scanned document. |
| Field Data | %(Field) | The value assigned to a field in the current document. The specified field must belong to the template that will be assigned to the document. |
| Parent Field | %(Parent)
%(Parent: Field) |
The value assigned to the field with the same name in the parent folder. Field data will be inherited from the folder in which the document or folder will be created. Once a document inherits a field value, the parent token will be replaced with the value assigned to a field in the parent folder.
Note: A token will only be replaced once. If the parent's field data is updated, it does not update the children's field data. The parent token is not meant as a means of synchronizing field data between a folder and its children. Example: If you insert the %(Parent) token in the "Name" field, it will be replaced by the value assigned to the "Name" field in the parent folder. If the parent folder has not been associated with a "Name" field, the token will not be replaced. If the parent folder has been associated with a "Name" field, and the value of that field changes, the token value will not be updated. To inherit the value assigned to a field with a different name, use the %(Parent:Field) token. The term Field should be replaced with the name of the desired field associated with the parent folder. |
| Modification Date | %(Modification Date) |
The original modification date for a file scanned by Universal Capture. |
| Name | %(Name) | The original name of a document scanned by Universal Capture. |
| Page Count | %(PageCount) | The number of pages in a document. |
| Parent ID | %(ParentID) | The ID of the entry's parent folder. |
| Parent Name | %(ParentName) | The name of the entry's parent folder. |
| Repository Count | %(GCount) | A sequential number added every time an entry is created or imported into Laserfiche. This token starts at 1 and applies to the entire repository. |
| Session Count | %(Count) | A token that will be replaced by a sequential number every time an entry is created or imported into a Laserfiche Client. This token starts at 1 and is specific to a particular user. |
| Time | %(Time) | The time a document is scanned. |
| User Name | %(UserName) | The name of the user that scanned the document. |
Office Integration
For document naming and field population, Office Integration supports all the same tokens as the Laserfiche repository, as listed above. The following tokens are intended to be used within the body of the document, spreadsheet, or powerpoint itself. For instance, you might want to insert the document's creator in Laserfiche into the document header or footer, or to use a field value to fill a cell in a spreadsheet.
You can add a token to an Office document by opening the Laserfiche tab on the ribbon, clicking Tokens, and selecting the token you want to insert.
| Name | Description |
|---|---|
| Repository Path |
The path to the document in the repository. |
| Parent Path | The path to the document's parent folder in the repository. |
| Laserfiche Web Client Address | The URL address of the document in Laserfiche. |
| Last Modified Time | The time the document was last modified in Laserfiche. |
| Creator | The user name of the user who created the document in Laserfiche. |
| Entry ID | The document's entry ID in Laserfiche. |
| Version Number |
The current version number of the document in Laserfiche. |
| Document Name | The document's name in Laserfiche |
| Template Name | The name of the template applied to the document in Laserfiche. |
| Field | The value of the selected field assigned to the document. |
Outlook Import
The following tokens can be used to dynamically set the default folder path for imported emails. For instance, you could automatically file all emails in the folder corresponding to the user who imported it, or in a folder corresponding to the email sender.
| Name | Syntax | Description |
|---|---|---|
| Importer User | %(ImporterUser) |
The path to the document in the repository. |
| Sender | %(Sender) | The path to the document's parent folder in the repository. |
| Time Sent | %(TimeSent) | The URL address of the document in Laserfiche. |
| Time Received | %(TimeReceived) | The time the document was last modified in Laserfiche. |
| Date | %(Date) | The user name of the user who created the document in Laserfiche. |
Snapshot
The following list details the standard tokens available in Snapshot.
| Name | Syntax | Description |
|---|---|---|
| Session Count | %(Count) |
A token that will be replaced by a sequential number every time an entry is created or imported into a Laserfiche Client. By default, this token starts at 1.
To configure this token:
|
| Current Document | %(CurrentDocument) | The name of the currently open Laserfiche document. If a document is not the last active Laserfiche window when Laserfiche Snapshot is storing information in Laserfiche, this token will be replaced by a blank value. |
| Current Folder | %(CurrentFolder) | The name of the currently open Laserfiche folder. If a Laserfiche document is the last active Laserfiche window, the folder where the document resides will be used. If neither a document nor a folder is open when Laserfiche Snapshot is storing information in Laserfiche, this token will be replaced by a blank value. |
| Date | %(Date) | The system date from the current workstation. |
| Date/Time | %(DateTime) | The system date and time from the current workstation. |
| Entry ID | %(ID) | The identification number assigned to the Laserfiche document where data will be stored. This number will be generated when the Laserfiche document is created. Unlike most tokens, this token is replaced when the document is stored in Laserfiche. |
| Field Data | %(Field:[FieldName]) | The value assigned to a field in the current document. You can insert this token in the Name and Folder destination options on the Document Properties tab in the Laserfiche Snapshot dialog box or the General tab of the Snapshot Configuration dialog box. |
| Global Count | %(GCount) |
A sequential number added every time an entry is created or imported into a Laserfiche Server. By default, this token starts at 1.
Example: Jon and Ben each create a document and use %(GCount). The server count is 3 because the server starts with 1 and each user has created a document. |
| Name | %(Name) | The file name for the scanned image. This token is available for use with Laserfiche Universal Capture. It can also be used in the Laserfiche Windows client applications to populate fields for documents. |
| Parent ID | %(ParentID) | The ID of the entry's parent folder. |
| Parent Name | %(ParentName) | The name of the entry's parent folder. |
| Print Job Name | %(PrintJobName) |
The name of the current print job, determined by the application used to print the document.
Example: Notepad uses the file name of the document being printed, while Internet Explorer uses the URL for the web page that was printed. |
| Time | %(Time) | The system time on the current workstation. |
| User Name | %(UserName) | The name of the user sending documents to a repository. Unlike most tokens, this is replaced when the document is stored in Laserfiche. Until then, it will appear where it was inserted. |
