Overview
Snippets and popups are an important part of IOS enabling the photographer to display messages and banners on their site.
The ability to make these objects Conditional means they can be displayed in different circumstances.
A powerful feature of snippets is the ability to display variable data through the use of @codes.
Shoot level data
The following @codes display information about the current Access Key (shoot key)
To display the .. | @code | Example/Comment |
|---|---|---|
access key | @shootkey | |
the type of key | @shoottype | subject/family/folder/job |
the shootname | @shootname | the 'friendly' version of the subject/family/folder/job name |
Job level data
The following @codes display information about the current job.
To display the .. | @code | Example/Comment |
|---|---|---|
job name | @job.jobname | the actual job name |
friendly job name | @job.friendlyname | the friendly name as set in tsIOS |
job key | @job.jobkey | |
job tags | @job.jobtags | |
value of a job field | @job.jobvalue.jobfieldname | eg @job.jobvalue.schoolname |
value of a job field | @job.jobvalue.jobfieldname | |
season code | @job.seasoncode | |
season description | @job.seasondescription | |
workspace code | @job.workspacecode | |
workspace description | @job.workspacedescription | |
account code | @job.accountdcode | |
account description | @job.accountdescription | |
provider code | @job.providercode | |
provider name | @job.providername | |
job expiry date | @job.expiresdate | the optional expiry date set in tsIOS |
job expiry countdown | @job.expiresin.expressive.days days, @job.expiresin.expressive.hours hours, @job.expiresin.expressive.minutes minutes | eg 44 days, 13 hours, 24 minutes |
Subject data
When the current shoot key (access key) is a subject key, the following codes can be used to retrieve subject data.
To display the .. | Use @code | Example/Comment |
|---|---|---|
firstname | @shootvalue.firstname | |
lastname | @shootvalue.lastname | |
ID | @shootvalue.id | |
subject fields | @shootvalue.fieldname | eg @shootvalue.homeroom |
home folder | @folder.name | |
folder key | @folder.folderkey | |
folder tags | @folder.foldertags | |
folder fields | @folder.foldervalue.fieldname | eg @folder.foldervalue.teacher |
family name | @family.name | |
family tags | @family.familytags |
Identify ordering
With identify the following @codes can be used.
To display the .. | Use @code | Example/Comment |
|---|---|---|
firstname | @identify.subject.firstname | |
folder | @identify.subject.folder | |
family | @identify.family.name | |
family members | @identify.family.members | |
contact name | @identify.contact.name | |
contact phone | @identify.contact.phone | |
contact email | @identify.contact.email |
FAQ
What are snippets in IOS?
Snippets are messages and banners that photographers can display on their site using IOS.
Can snippets be made conditional?
Yes, snippets can be made conditional to display different messages in different circumstances.
What are @codes used for in snippets?
@codes are used to display variable data within snippets.
How can I display the subject name in a snippet?
When the shoot key is a subject key, @shootvalue.firstname displays the subject’s firstname.
How can I display the job name in a snippet?
You can display the job name using the @job.jobname code.
Is it possible to retrieve subject data with snippets?
Yes, when the current shoot key is a subject key, you can retrieve subject data using specific @codes.
Can I display the job expiry date?
Yes, you can display the job expiry date using the @job.expiresdate code.