A406 / Internet Services X-FC tags

Session and site tags
Global tags
Container listing tags
Calendaring tags
Directory listing tags
Forms
Date formats

This document contains X-FC tags tags grouped by scope (the context in which the tags function) and a description of what each tag does and how it works.
Internet Services script X-FC tags are separated into six categories:

•       Session and site tags
        These tags work in all templates and server-parsed files.
•       Global tags
        These tags work in all templates.
•       Container listing tags
        These tags work only in the actual list templates.
•       Calendaring tags
        These tags work in all templates.
•       Directory listing tags
        These tags work in the -101 Directory listing template.
•       Forms
        These tags work in all forms.
For an overview of using X-FC tags, see Internet Services Script Library - An Introduction.
Top

Session and site tags

Session and site tags access data about the current session or web site. This tag category includes various bits of information about the:

•       server
•       current user
•       browser the user is using
•       current request Internet Services is processing on the user's behalf.

Since this information is the same anywhere you go in the FirstClass site, they are available to all templates and server-parsed files.

X-FC-BACKGROUND-PICTURE

Used to output the URL to the background picture selected for a given page.
These images can come either from the Global Site Preferences form (field 5700) or from the container's layout information, if the current object is a container.
Syntax

• <X-FC-BACKGROUND-PICTURE [HTML|STYLE]>

Retrieves the URL of the background image specified on the Global Site Preferences form.

• <X-FC-BACKGROUND-PICTURE UPPER|LOWER|LEFT|RIGHT [HTML|STYLE]>

Retrieves the URL of the background image for a container specified in that container's layout.
If no layout image is defined, defaults to the Global Site Preferences form background image.
Parameters
UPPER
LOWER
LEFT
RIGHT
Use the UPPER, LOWER, LEFT or RIGHT parameter to specify which pane you want the background image for.

Note

Internet Services only supports one split in a container, UPPER is the same as LEFT and LOWER is the same as RIGHT. If the container is in non-split view, the one pane visible is the UPPER or LEFT one.

Formatting Arguments

HTML URL is output in the form ' background="The URI"' suitable for use in an HTML <body> tag

If there is no background picture defined, nothing is output.
STYLE URL is output in the form 'background-image:url(The URI);background-repeat:[no-]repeat;' suitable for use in a Cascading Style Sheet (CSS).

Background pictures do not repeat (tile) except in containers if explicitly set to do so.

Image names and locations

There are a number of possible locations where Internet Services searches for an image defined in the Global Site Preferences form or container layout. The supported image formats vary from location to location, and in which location Internet Services looks for a particular image is determined from the name:

Location 1 relative to the current object

Image types any

Activated by the first two characters of the image name are "./" (period and forward-slash).
This prefix will be trimmed off in the URL sent to the browser, for example "./LocalImage.jpg" would be trimmed to just "LocalImage.jpg".

Location 2 absolute URL

Image types any
Activated by the image name starts with / or http://

This URL will be sent literally to the browser.

Location 3 current user's homepage folder

Image types any
Activated by the first character of the image name is '~" (Tilda)

For example, for user John Doe, an image name of "~UserBG.png" might be converted to "http://www.sitename.com/~John_Doe/UserBG.png".

Location 4 Internet Services resource files

Image types Mac PICT format

Activated By the Image name does not fit any of the criteria above and does not have an extension

In this case, Internet Services will look for the image in the current lang.rez file. If it can't find it there, it will then fall back to the pictures.rez file.

Location 5 site "Images" folder

Image Types any

Activated By the Image name does not match any of the criteria listed above

X-FC-BROWSER

Accesses information about the user's browser.
Syntax

•       <X-FC-BROWSER>
        Outputs the browsers complete user-agent header. Exact contents and format vary from browser to browser.
•       <X-FC-BROWSER NAME>
        Outputs the name of the browser.
•       <X-FC-BROWSER NAME.Name>
        Returns 1 if the name of the browser matches Name, 0 otherwise. Comparison is case-insensitive.
•       <X-FC-BROWSER OS>
        Outputs the name of the operating system the browser is running on.
•       <X-FC-BROWSER OS.Os>
        Returns 1 if the name of the operating system the browser is running on starts with Os. Comparison is case-insensitive.
•       <X-FC-BROWSER Version>
        Outputs the version of the browser.

Arguments

NAME returns the name of the browser
OS returns the operating system the browser is running on
VERSION returns the version of the browser

X-FC-FIELD LANG

Accesses a resource from the current lang.rez file.
This is a X-FC-FIELD variant.
Syntax

•       <X-FC-FIELD LANG.CMD.CmdID.Index [DEFAULT=DefaultValue][Format]>
        Used to access the tooltips for various toolbar commands.
•       <X-FC-FIELD LANG.SingleStringID [DEFAULT=DefaultValue] [Format]>
        Used to retrieve a single string resource.

Note

A single string resource is not the same as a "plain" string resource).

•       <X-FC-FIELD LANG.StringID.Index [DEFAULT=DefaultValue] [Format]>
        Used to retrieve a string resource (a single string resource is not the same as a "plain" string resource).
•       <X-FC-FIELD LANG.FormID.FieldID.PropertyID [DEFAULT=DefaultValue] [Format]>
        Used to retrieve data about various controls on a form. FieldID 0 retrieves data about the form itself.

For details on the formatting the Format argument, see Format argument.

X-FC-FIELD PREFS

Accesses data from the user's preferences or the local (.sitepref) or Global Site Preferences form.
Syntax
<X-FC-FIELD PREFS.FieldID[.Index][DEFUALT=DefaultValue][Format]>
This is an X-FC-FIELD variant. For details on formatting the Format variable, see Format argument.
This tag finds the specified field in the current user's preferences. If it fails to find it there then it will look in the site's local site preferences form first and then the Global Site Preferences form, if no local form is found.

X-FC-LANGUAGE

Outputs the ISO code for the first language or dialect in the browser's accept-language header that Internet Services supports.
This is the language that Internet Services attempts to use in the templates and for online help.

Note

Most browsers allow you to configure your preferred language in your preferences. The language(s) you select will form the content of the browser's accept-language header.

Syntax
<X-FC-LANGUAGE>

X-FC-LOGIN

Outputs a unique session identifier URL (if the user is logged in) that Internet Services uses to identify the user and prevent caching issues with misconfigured internet proxies. If the user is not logged in, this tag returns a single forward slash.
Syntax
<X-FC-LOGIN>

X-FC-OBJPATH

Outputs a version of the user's current request URL suitable for use by the FirstClass Java Chat application.
Syntax
<X-FC-OBJPATH>

X-FC-OBJURL

Outputs the current user request.
By default, no modification is made on the URL the user requests.
Syntax
<X-FC-OBJURL[BASE][SLASH|NOSLASH]>
Arguments

BASE This switch causes Internet Services to strip off any "action" url fragment that is not part of the base object's URL, such as "FormEdit" on an editable document or "Lookup" on a directory search. This is often useful when trying to specify a template override, or object relative operation.
SLASH This switch forces the URL to have a trailing slash, whether or not it would normally have one. Useful in preventing double-slashes that can confuse some browsers if you aren't sure whether or not the template you are writing may be used for a container or not.
NOSLASH This switch suppresses any trailing slash on the URL, whether or not it would normally have one. Useful for much of the same reasons SLASH is.

X-FC-OBJURL-UP

Outputs the URL of a the folder that is the parent of the current object.
By default, no modification is made on the URL of the current object's parent.
Syntax
<X-FC-OBJURL-UP [SLASH|NOSLASH]>
Arguments

SLASH This switch forces the URL to have a trailing slash, whether or not it would normally have one. Useful in preventing double-slashes that can confuse some browsers if you aren't sure whether or not the template you are writing may be used for a container or not.
NOSLASH This switch suppresses any trailing slash on the URL, whether or not it would normally have one. Useful for much of the same reasons SLASH is.

X-FC-SERVER-NAME

Outputs the name of the server as defined on the system profile.
Syntax
<X-FC-SERVER-NAME>

X-FC-SERVER-TIME

Outputs the current server time. By default, the time is output in the server's time zone.
Syntax
<X-FC-SERVER-TIME [SERVER|USER|FORM|UTC] Format>
Arguments

SERVER outputs the time in the server's native time zone (this is the default)

USER outputs the time in the user's preferred time zone

FORM           outputs the time in that time zone, if the current object is a form with a time zone field
                      If the object is not a form, or if the form does not have a timezone field, falls back to USER.
UTC            outputs the time in universal time (for example, Greenwich Mean Time)

Format See Date formats

X-FC-URL-PARAMETER

Used to access the value of a given URL parameter in the current request.
It is particularly useful for assigning URL param values to Internet Services script variables for later processing. By default, this tag just outputs the value of the named parameter, or nothing if that parameter doesn't exists, but there are 2 switches which are occasionally useful.
Syntax
<X-FC-URL-PARAMETER ParamName [EXISTS|NUMBER]>
In HTTP, any URL can have an arbitrary number of query parameters (also known as URL parameters), which are the form ParamName=ParamValue and are separated by ampersands "&". The query parameters must occur at the end of the URL and are separated from it by a question mark "?". For example, http://www.somesite.com/folder/item?parameter1=value1¶meter2=value2 and so on.

EXISTS Instead of outputting a value, this switch causes the X-FC-URL-PARAMETER tag to just check for the presence of a given URL parameter. It returns 1 if it is present in the current request, 0 otherwise.
NUMBER This switch forces the value output by X-FC-URL-PARAMETER to be a numeric value. If the value of the parameter is not a number, or if the parameter is not present, 0 is output.

X-FC-USER

Accesses various data about the current user.
Syntax

Global tags

Global tags access information that is common to all FirstClass objects. These can be used in any template but have no relevance in a .shtml file.

X-FC-FCPURL

Creates an fcp:// link to the current object.
If your machine is configured correctly, clicking on this link will open this object using the FirstClass client.
Syntax
<X-FC-FCPURL>

X-FC-FIELD
The majority of FirstClass data is stored in chunks known as "fields". A given field will generally contain a single piece of data; a single number, for instance, or a string. Every control on every form maps to one of these fields that are stored on the server, as are the user and site preferences. Moreover, the formatting of the controls themselves (their width, height, default value, and so on) can also be extracted from the lang.rez file as field data. The X-FC-FIELD tag accesses these fields and is one of the most important tags in the Internet Services script library.
Syntax

<X-FC-FIELD FieldSpecifier [DefaultValue][Format]

Arguments

FieldSpecifier argument
The FieldSpecifier argument is used to specify where to find the required field data. Currently, there are three possible sources of this data, the current object (for example, the message/form/conference, and so on that is being rendered), the user's preferences, site preferences or both, and the currently active lang.rez file.
Depending on where the field data is stored, the number and type of arguments needed will vary. For data stored in the current object or in the preferences there are usually one or two arguments: a FieldID and an Index that is usually optional. For field data stored in the lang.rez file, the number of arguments depends on the type of resource in which it is stored. For "Single String" resource, there is one argument, the ResourceID. For "String" resource, there are two arguments: ResourceID and Index. For "Form" resources, there are three arguments: the Resource (Form) ID, the FieldID and a PropertyID).
The possible formats for the FieldSpecifier argument are:
FieldID[.Index]

This retrieves field data from the currently opened object.

Note

The Index portion of the argument is usually optional. If it is excluded, then it is assumed to be 0.

The majority of fields only have index 0, for those that don't, the number of available indices can be determined using X-FC-FIELD-COUNT. At present, indexed field data only occurs in connection with "Expanding group" controls or special calendaring fields.
PREFS.FieldID[.Index]

This syntax is used to extract data from the user or site preferences.

Note

At present the two live in a common "bag". This is so that users can override the default site preferences using their personal preferences.

While this syntax does include support for indexed field data, this data does not presently exist in any shipping FirstClass preferences or site preferences forms.
LANG.ResourceID

This syntax is used to retrieve a "Single String" resource from the lang.rez file

LANG.ResourceID.Index

This syntax is used to retrieve "String" resource from the lang.rez file

LANG.FormID.FieldID.PropertyID

This syntax is used to retrieve field data from at form resource from the lang.rez file. You can treat the following FirstClass Designer resource types as forms: "Local Form", "Document Form", "Registered Form", "Database Query", "Reserved" and "Toolbar"

FORM.PropertyID

This is a shorthand for LANG.CurrentFormID.0.PropertyID. This syntax may only be used reliably in message and document forms. It can be used in some system forms, but may never be used in conference listings, search listings or memforms.

FORM.FieldID.PropertyID

This is a shorthand for LANG.<CurrentFormID>.FieldID.PropertyID. The same limitations as the FORM.PropertyID syntax apply here.

CMD.CommandID.Index

This syntax is used to retrieve a string resource associated with a FirstClass menu command. Using this syntax will ensure that the retrieved string is for the correct platform (internet), and that any menu hot key designator is properly removed.

ERR.ErrorID

This syntax is used to retrieve a string resource associated with a given FirstClass error code.

DefaultValue argument
The DefaultValue argument is used to specify a value to be used if the field designated by the FieldSpecifier argument cannot be retrieved. Default values can be either hard coded or retrieved from the current lang.rez file.
Valid formats for DefaultValue are:
ExplicitNumericValue

an explicit numeric default

ExplicitStringValue

an explicit string default with no spaces or special characters

"ExplicitStringValue" (must be enclosed in quotes)

an explicit string default that may contain spaces or special characters

LANG.SingleStringID

uses the specified single string resource from the lang.rez file as the default

LANG.StringID.Index

uses the specified string resource from the lang.rez file as the default

LANG.FormID.FieldID.PropertyID

uses the specified control property from the lang.rez
file as the default

FORM.FieldID.PropertyID

shorthand for LANG.CurrentFormID.FieldID.PropertyID

PROP.PropertyID

shorthand for LANG.CurrentFormID.CurrentFieldID.PropertyID

Different controls use different properties as their inherent default value. A list of common controls, their default properties, and their data type is shown below:

Control        Default               Default
                      property              Property Type

Checkbox               85                   Numeric
Colour Picker   11                   Numeric
Date Picker            11                   Numeric
Duration Picker 11                   Numeric
Editable List          9                    String
Icon Picker            12                   Numeric
Numeric        11                   Numeric
Progress Bar    11                   Numeric
Static List            11                   Numeric
Text Box/Area   9                    String

Note

There is no easy way to extract the default value for a radio group because of how they are implemented. For a radio group, the server saves the field as the ID of the group, but the individual values (and whether or not an option is the default value) are stored in the individual buttons.

Format argument
Because of the diversity and usage of data that can be stored in fields, it is necessary for you to specify how you wish to present the data from a given field. The available formats depend on the type of data stored in the field. This can usually be determined with some examination of what kind of control creates the data. In cases where associating a control with a field data type is not obvious, refer to the default property table.
The following works for all fields:
LENGTH

outputs the length (in bytes) of the current field

If the field does not exist, returns 0.
The following formats work for controls that store their data as string fields:
STRING

formats the data as an HTML encoded string

MULTILINESTRING

formats the data as an HTML string, but does not convert line breaks into <br>

LITERALSTRING

outputs the data as a raw string (no formatting or encoding).

Note

LITERALSTRING does not suppress charset translation.

PASSWORD[,char]

outputs a number of chars equivalent to the number
of characters in the string.

If no char is specified, asterisks (*) are used.
STRLEN

outputs the number of characters in a string.

Note

This is not the same as LENGTH for a multibyte character sets, for example, Japanese.

ESCAPED

outputs the string with C-style escaping, making it suitable for assignment to a Javascript variable

URLESCAPED

outputs the string using URL escaping

IMGURL

treats the string as a path to an image or picture resource

The rules for this argument are:

•       if the string begins in "./", it is assumed to be a path to an image relative to the current object. The ./ is removed, but the string is otherwise unaltered.
•       if the string begins in "/" or "http://", it is assumed to be an absolute path to an image. The string is output unaltered.
•       if the string begins with "." it is assumed to be a reference to an image the Pictures.rez file. The string is formatted accordingly
•       if the string begins with "~" it is assumed to be a reference to an image in the user's homepage folder. The string is formatted accordingly.
•       otherwise the string is assumed to be an image in the current sites "Images" folder. The string is output as /Images/<string>.

The following format works for numeric fields:
NUMBER[,switch]
outputs the data as a raw number
Some switches can be used to affect the precise format are:

• d

formats the number as a signed decimal (default)

• u

formats the number as an unsigned decimal

• [0]x

formats the number as a hex value using lowercase a-f.

The '0' prefix causes the number to be left-padded with 0s to 8 digits

• [0]X

formats the number as a hex value using uppercase A-F.

The 0 prefix causes the number to be left-padded with 0s to 8 digits.

RGB[,switch]

treats the data as a color

By default the data is output as an HTML colour (ie #RRGGBB). There are also a number of switches that can be applied for finer control:

• x

suppresses the '#' prefix.

The colour is output as a hex number RRGGBB.

• d

outputs the RGB parts of the colour as a decimal number

• R[d]

outputs the 00-FF value of the red component of the colour

The optional [d] switch forces output in decimal (0-255).

• G[d]

outputs the 00-FF value of the green component of the colour

The optional [d] switch forces output in decimal (0-255).

• B[d]

outputs the 00-FF value of the blue component of the colour

The optional [d] switch forces output in decimal (0-255).

• A[d]

outputs the 00-FF value of the alpha component of the colour

The optional [d] switch forces output in decimal (0-255).

• a[x|d]

enables the output of the alpha component in the colour output

Default is #AARRGGBB, but may be altered with the x and/or d switches.

FONTSIZE

treats the data a font size and normalizes it depending on browser and OS in order to produce a consistent sizing

CHECKBOX

outputs X if the data is non-zero, and nothing otherwise

This is a semi-obsolete format.
CHARSET

treats the data as a character set ID and outputs a string name for that charset

Generally, only used with lang.rez fields.
DURATION

treats the data as a number of seconds and outputs it as a duration, for example, converts it to weeks/days/hours and so on, whichever is most convenient

DATE[,Format]

treats the data as a number of seconds since a specific date

This depends on the format, but generally Jan 1, 1904, and outputs it as a date

Format for dates can be either a date format string or a reference to a lang string, for example, LANG.singlestring, LANG.string.index, LANG.formid.fieldID.propertyID. Currently, there is no support for the FORM lang shortcuts.

IF [List]

LIST [List]
treats the data as an enumerated list, for example, a string<-> number mapping

The obsolete IF variant only allows one list value, while LIST allows an arbitrary number of list values.
List may be one of:
A comma separated list of enumeration value pairs (ie "Default=0", "First Value=100", "Second Value=200")

• A reference to a LANG string, for example, LANG.SingleStringID, LANG.StringID.Index, LANG.FormID.FieldID.PropertyID, FORM.FieldID.PropertyID, FORM.FieldID.

The PropertyID for the enumeration values of a control is 10. If the List argument is omitted, it assumed to be LANG.CurrentFormID>.<CurrentFieldID>.10, which should be the default enumeration list for the current control.
NLIST Increment "Format" List
the primitive version of the NUMFIELD format, specifying hard-coded Multipliers, Format, and List parameters

Note

This argument is obsolete. Don't use it.

NUMFIELD[ID]

treats the data as the value of a numeric control

This argument uses various pieces of lang.rez data in order to format the number in the same manner as the client, for example, using the Format, Multiplier and Enumeration properties.
The optional [ID] argument is used to explicitly specify which numeric control on which form to use. The Format is FormID.FieldID. The default is CurrentFormID.CurrentFieldID.
Formats for graphical data
POINT[,x|h|v|y]

treats the data as an x,y point

The default output is as an ordered pair, but can use the x, y, h (horizontal) or v (vertical) switches to specify only one coordinate. Data is never stored on the server in this format, but some lang.rez file properties may use data in this structure.
RECT[,t|l|b|r|h|w]

treats the data as a rectangle containing two (x,y) coordinates for the top-left and bottom-right corners

The default output is (top,left,bottom,right), but the t, l, r, and b switches can be used to access a specific coordinate. The w and h switches can be used to output the width (right - left) or height (bottom - top) of the rectangle.

X-FC-FIELD-COUNT

Outputs the number of entries (for example, Mac Index -1) in a filed array. If the field is empty, returns 0. If the field is not indexed, returns 1.

Note

Indexed field data only occurs in the calendar

Syntax
<X-FC-FIELD-COUNT FieldID>

X-FC-HEADER-ONLY

Aborts a listing mid-progress.
For example, if you are rendering a conference, but only need the first template in the listing, you can use this tag to tell Internet Services not to send the other templates that would normally be part of such a listing.
Syntax
<X-FC-HEADER-ONLY>

X-FC-ITEM

Retrieves a wide variety of data about the current FirstClass object.
Syntax
X-FC-ITEM DATA [datatype][Format]
Arguments

DATA [datatype] Specifies which part of the object's data should be retrieved. [datatype] is normally numeric, but for certain elements, text keywords are provided.

Note

The formats for this tag are shared with X-FC-LIST-ITEM except where explicitly noted otherwise.

The normal data types support the same formatting arguments as the X-FC-FIELD tag, but the special data elements often use these specific formatting arguments:
Data element formID
The formID determines how the form is rendered by FirstClass. FormID matches the numeric ID (the numeric ID in FirstClass Designer) of the template used to render that item to the web or in the client. This data format is valid for X-FC-ITEM only.
Numeric ID: -1

Format: Numeric

Data Element Objtype
The object type of an object determines the way FirstClass treats, stores, and processes that object. The object type determines, for example, whether an object can contain other items (folders or conferences), whether it can be sent to other users (messages or forms), whether it appears in the Directory (conferences or users) and so on. The object type is one of the most important pieces of information about an object.
Numeric ID : 0

Default Format: Resource String (A localized string from the lang.rez file representing the object's type, for example, "Desktop" or "Message")

Alternative Format(s):

NUMBER returns the objtype as a number
ESCAPED same as the default format, but escaped in a manner suitable for assignment to a Javascript variable (see X-FC-FIELD ESCAPED format)

Objtype If the format argument is the name of a specific objtype, then the tag will return 1 if the objtype of the current object matches the one specified, or 0 if it does not.

Common valid objtypes (and their numeric equivalents) are:

• Desktop (0), Conference (1), Folder (2), ConfItem (3), Message (4), Text (5), File (6), Form (12), FormDoc (17), Document (22), Mailbox (24)

Other valid objtypes (and their numeric equivalents) are:

• DirList (7), Profile (8), UserList (9), ExternalFolder (10), ACL (11), History (13), Chat (14), ChatInvite (15), SystemMonitor (16), HitLIst (19), MemForm (20), User (21), WorkForm (23), PrivGroupFolder (25), GateWayFolder (26), MailListFolder (27), DeskTopFolder (28), Archive (29), ModelFolder (30), PermStationery (31), FCFile (35), RemoteAdmin (36)

Data Element SubType
The subtype of an object refers to a refinement of an object's general behavior above and beyond its objtype, for instance an address book, which is a folder, but has some special characteristics, or a calendar, which is a conference with special characteristics.
Numeric ID: 1

Default Format: Numeric subtype
Alternative Format(s):

SubType A boolean result can be obtained on whether or not the given objects subtype matches one specified.

Common valid objtypes (and their numeric equivalents) are:

• AddressBook (7), UserHomePage (15), BookMarks (16), VoiceGreetings (20), Calendar (21), ResourceCalendar (22), LocationCalendar (23), MemosFolder (26), GroupCalendar (28)

Other valid objtypes (and their numeric equivalents) are:

• Mailbox (1), OffLineConfs (2), DirSync (3), SiteSync (4), Conferences (5), Gateways (6), ModelFolder (8), PrivGroups (9), MailList (10), UserDeskTop (11),InternetServicesConfig (12), VoiceServicesConfig (13), ResourceLibrary (14), JavaFolder (17), SPAMFilters (18), IVRFolder (19), Volumes (24), MultiVolConferences (25), CertificatesFolder (27),

Data Element Date
The last modified date of the object
Numeric ID: 2

Format: same as X-FC-FIELD DATE

Data Element Status
This field contains various switches used by the server and Internet Services to determine the current status of the object.
Numeric ID : 3

Default Format: A bitmask of the object's various status bits
Alternative Format(s):

StatusBit More that one of these bits can be enabled at once. The List of bits (and the hex equivalent in the bitmask) are:

• Unread (0x8000), Urgent (0x4000), Sent (0x2000), Deleted (0x1000), OutGoing (0x0800), Protected (0x0400), Unapproved (0x0200), Moved (0x0100), AutoOpen (0x0080), Addressed (0x0040), Attachments(0x0020), Subscribed (0x0010), Replicated (0x0008), Partial (0x0004), URLDoc (0x0002), Voice (0x0001)

Data Element Location
The coordinates of this objects icon is a list view used in X-FC-CONFERENCE-ITEM only.
Numeric ID: 4

Default Format: An ordered pair representing the objects coordinates (x,y)
Alternative format(s):

• X: The object's icon x coordinate
• Y: The object's icon y coordinate.

Data Element Icon
The object's icon.
Numeric ID: 5

Default format: Numeric IconID
Alternative format(s):

•       SMALL: ID for the small icon for this object
•       LARGE: ID for the large icon for this object
•       HREF:  the url to the icon for this object
•       HTML:  an <img> tag for the icon for this object.

Data Element Size
The object's physical size on disk.
Numeric ID: 6

Default format: The object's size in bytes
Alternative format(s):

•       K: the object's size in kilobytes
•       SCALED: the objects size scaled to the most appropriates size (bytes, K, M, G, or T)
•       SCALEDK:       the object's size scaled to the most appropriate size with a minimum size of 1K.

Data Element Name
The object's name
Numeric ID: 7

Default format: The name as a textual string
Alternative format(s):

•       ESCAPED: same as X-FC-FIELD ESCAPED format
•       HTML: adds HTML formatting suitable for an object name in a conference listing (for example, a bolded To prefix on outgoing messages or italics on unapproved items)
•       HREF: takes the output of the HTML argument and embeds it in an <a href> tag that will open this object.

Data Element Subject
The object's subject
Numeric ID: 8

Default format: the subject as a textual string
Alternative format(s):

•       ESCAPED: as the X-FC-FIELD ESCAPED format
•       HTML: adds HTML formatting suitable for an object subject in a conference listing (for example, bolded if urgent, priority and sensitivity prefixes and so on)
•       HREF: takes the output of the HTML arguments and embeds it in an <a href> tag that will open this object.

Data Element Flag
The object's flag (if any).
Numeric ID: 9

Default format: Numeric ID of this object's flag icon. 0 if no flag
Alternative format(s):

•       PATH: path to the icon for this flag
•       ALT:   text string representing this flag (for example, UnRead and UnSend)
•       HTML: an <img> tag for this icon for this flag

Data Element Attach
Icon representing the presence and type of attachments on this object.
Numeric ID: 10

Format: Numeric ID of this object's attachment icon. 0 if no attachments

Data Element ThreadID
A double long representing the thread to which this item belongs. Used when grouping on subject. [0:0] for non-threadable objects.
Numeric ID: 11

Format: [long1:long2]

Data Element MessageID
A double long which is the object's unique ID within the FirstClass system.
Numeric ID: 12

Format: [long1:long2]

Data Element SysID
A long which is the object's unique ID within the server's unread tracking system.
Numeric ID: 13

Format: Numeric sysID

Data Element Title
The Icon title for this object. Will default to either name or subject based on the object's type. If the default string does not exist, then the tag will return the alternative string (for example, messages default to using subject in the icon title, but if no subject exists, then it will use the name instead.)
Numeric ID: 14

Format: As the Name and Subject columns. The exact format will depend on whether the title winds up being the name or the subject.

Data Element InFolder
Path to the folder in which the object resides. This data element is valid only for the X-FC-LIST-ITEM tag and only in search listings.
Numeric ID: 15

Default format: text string representing the path

Alternative format(s):
• ESCAPED: same as the X-FC-FIELD ESCAPED format

Data Element Expiry
The expiry date of the current object. 0 if object does not expire.
Numeric ID: 16

Format: Same as X-FC-FIELD DATE

Data Element Options
A bitmask containing various flags affecting a message's delivery behavior (for example, priority/sensitivity/receipts and so on)
Numeric ID: 17

Default format: Numeric bitmask of the object's various message options

Alternative format(s):
Like Status, you can test for individual message options.

Note

The priority and sensitivity result will be a value between 0 and 3 representing the numeric priority/sensitivity level. The options are:

• MachineGenerated (0x0004), ReturnContent (0x0008), SuppressNDN (0x0010), RemoteOnlyReceipt (0x0020), VerboseReceipt (0x0040), RouteReceipt (0x0080)RouteReceipt (0x0100), DeliveryReceipt (0x0200), Sensitivity (0x1C00), Priority (0xE000)

Data Element EndTime
The calculated end date/time of a voice greeting or a calendar event/task. This data element is valid only for the X-FC-LIST-ITEM tag and only in calendars/voice greetings folders.
Numeric ID: 18

Format: as X-FC-FIELD DATE

X-FC-LAYOUT

SPLITTYPE specifies the current split type for this container, 0 == No Split, 1 == Split Horizontal, 2 == Split Vertical

SPLITPERCENT specifies the split size as a percentage

SPLITPOS specifies the split size in pixels

All of the subsequent arguments must be prefixed with either UPPER, LOWER, LEFT, or RIGHT specifying for which pane to retrieve the data.

UPPER and LEFT the same pane as LOWER and RIGHT

If there is no split, the sole pane is the UPPER or LEFT pane.

(PANE).DISPLAYFORMAT type of display used for this pane, 0 == List, 1 == Small Icon, 2 == Large Icon

(PANE).FORMID specifies which calendar mode to use (158 == Monthly, 159 == Weekly, 160 == Daily, 164 == Today), if the container is a calendar

(PANE).SORTON specifies the current sort column.

If the sort order is reversed the high bit (0x80000000) will be set

(PANE).GROUPON specifies the current group column, -1 == No Grouping

(PANE).DEFCOLLAPSE specifies that the groups should be collapsed, if not zero

(PANE).FONT specifies the name of the font to use when rendering the conference

(PANE).FONTSIZE specifies the size of the font to use when rendering the conference
(PANE).USECOLOR specifies to use the (PANE).COLOR attribute when rendering the listing, if not zero

(PANE).COLOR specifies the font color to use when rendering the container (use only if (PANE).USECOLOR is not zero)

(PANE).SHOW.COLTITLES specifies to show the column titles
(PANE).SHOW.ROWNUMBERS specifies to show the row numbers

(PANE).SHOW.VGRID specifies to draw vertical grid lines in the table (if in listing mode)
(PANE).SHOW.HGRID specifies to draw horizontal grid lines in the table (if in listing mode)

(PANE).HIDEICONTITLES specifies to suppress the icon titles, if in icon mode

(PANE).BG.IMAGE        specifies what background image to use
                                                  Use only if (PANE).BG.USE is not zero.
(PANE).BG.USE                 specifies whether or not to use the (PANE).BG.IMAGE
(PANE).BG.TILE                specifies to tile any background picture used if not zero
(PANE).LOCKICONS               specifies to not permit icon placement to be changed
(PANE).SINGLECLICK      specifies to open items with single as opposed to double-clicks
(PANE).SHOWFOLDERS      specifies that this pane's listing should include folders (typically, this is always on in the UPPER/LEFT pane and always off in the LOWER/RIGHT pane)
(PANE).SHOWFILES               specifies that this pane's listing should include files (typically, this is always on in the LOWER/RIGHT pane, and on in the UPPER/LEFT pane if there is no split)

(PANE).TRANSPARENTTEXT specifies to not draw a white box around the icon titles (if in icon view), if not zero

(PANE).NCOLS specifies the number of columns visible, if in list mode

(PANE).FIELDID[ColumnID] specifies the index in the schema of the ColumnIDth layout column

                                                                ColumnID must be between 0 and                              (PANE).NCOLS - 1, inclusive.
(PANE).WIDTH[ColumnID]         specifies the width (in pixels) of the                              ColumnIDth layout column
                                                                ColumnID must be between 0 and (PANE).NCOLS - 1, inclusive.

X-FC-LIST-COUNT

Returns the number of attachments in the current list.
Syntax
<X-FC-LIST-COUNT>

Note

This tag replaces X-FC-ATTACHMENT-COUNT.

X-FC-LIST-ITEM

Returns the number of items in a list.
Syntax
<X-FC-LIST-ITEM>

X-FC-LIST-ITEM-URI

Returns the URL to the AttachmentNum(th) attachment of the current form.
AttachmentNum must be between 0 and (X-FC-LIST-ITEM-URI> -1), inclusive.
Syntax
X-FC-LIST-ITEM-URI

Note

This tag replaces X-FC-ATTACHMENT-URL and X-FC-CONFERENCE-ITEM-URI.

X-FC-NUMITEMS

X-FC-NUMITEMS TOTAL                   total number of items in the current container
X-FC-NUMITEMS CONTAINERS        total number of containers in the current container
X-FC-NUMITEMS DELETED          total number of deleted items in the current container
X-FC-NUMITEMS VISIBLE          total number of visible items in the current container
X-FC-NUMITEMS HIDDEN           total number of hidden items in the current container
X-FC-NUMITEMS UNREAD           total number of unread items in the current container
X-FC-NUMITEMS FOLDERS          total number of folders in the current container

X-FC-NUMITEMS CONFERENCES       total number of conferences in         the current container
X-FC-NUMITEMS MESSAGES         total number of messages in the current container
X-FC-NUMITEMS DOCUMENTS                total number of documents in the current container
X-FC-NUMITEMS TEXT                           total number of text items in the current container
X-FC-NUMITEMS UPLOADED         total number of uploaded items in the current container

X-FC-PERMISSIONS

Determines the user's permissions for the current object.
This tag outputs a bitmask of the user's permissions for the object as seen on the Conference Permissions form. Most of these permissions are only meaningful in conferences (folder and leaf objects inherit the permissions from their parent object), but some can be used in documents and messages as well, for example Delete, Write, Download (attachments), ViewHist, and GetInfo.
Syntax

<X-FC-PERMISSIONS Permission>

where Permission is used to test for the presence of a specific permission.

Permissions

If the user has the permission in question, the tag returns 1, otherwise the tag returns 0. The possible permissions that you can test for are:

Approve

user may approve/unapprove items (mail sent to this conference by the user does not require approval)

Bitmask value = 0x00000001

Create user

may directly create items (documents and subfolders)

Bitmask value = 0x00000008

CrtConf

user may create subconferences

Bitmask value = 0x00002000

DeleteOwn

user may delete own items (user can unsend messages that they have sent to this conference)

Bitmask value = 0x00000100

Download
user may upload/download files to this conference

Bitmask value = 0x00004000

Edit
user may edit read-only items (sent messages)

Bitmask value = 0x00000010

EditACL
user may edit the Conference Group Permissions form

Bitmask value = 0x00000001

EditWInfo
user may size and sort window (change View Properties permission)

Bitmask value = 0x00000040

Delete
user may delete or move items

Bitmask value = 0x00000004

GetInfo
object0 supports Get Info(Mac) and Properties (Windows)

Bitmask value = 0x00080000

Moderator
user can moderate conferences

Bitmask value = 0x00000002

Open
user may open items and read messages

Bitmask value = 0x00001000

Read
user may open this conference

Bitmask value = 0x00000200

Search
user may search this conference/folder

Bitmask value = 0x00000400

Send
user may send mail to this conference

Bitmask value = 0x00000800

ViewACL
user may view the Conference Group Permissions form

Bitmask value = 0x00008000

ViewDates
user may view calendar times

Bitmask value = 0x00200000

ViewHist
object supports history, and the user is allowed to view it

Bitmask value = 0x00010000

Write
user may edit editable items

Bitmask value = 0x00000020

X-FC-SCHEMA

Collects information detailing the data available for display in a container listing. This tag also contains the attributes necessary to display this data in a columnar format.

Note

The schema contains a list of possible columns. Conferences usually display only a small subset of these columns. The list of currently visible columns is contained in the conference layout, see X-FC-LAYOUT.

• a positive integer as determined by the use of <X-FC-LAYOUT Pan.FIELDID[n]>
• a string representing one of the set of default columns available in most conference listings.

Arguments

NCOLS
outputs the number of possible columns available
COLUMN[ColumnID].FIELDID
the field ID of the data for this column
COLUMN[ColumnID].TYPE
data type for this column (0==text, 1==icon, 2==resource string, 4==picture, 8==numeric, 16==date, 32==checkbox)
COLUMN[ColumnID].ATTR          bitmask containing data about sorting and alignment (Bit 0:default, sort order reversed if bit is on, Bit 1:right aligned data, Bit 2:centered data, Bit 3: justified data)
COLUMN[ColumnID].ICONID use this icon as the column title (use the TITLE attribute as the tooltip, for example alt tag), if not zero
                                                                If ICONID is 0, use the text title.
COLUMN[ColumnID].TITLE         textual column title
COLUMN[ColumnID].FORMID contains the ResourceID from which to pull the string, if data type is a resource string
COLUMN[ColumnID].WIDTH         default width of this column (this is the default width of the column when it is first displayed)
                                                                To find the current width, use <X-FC-LAYOUT Pane.WIDTH[n]>. The actual current width is part of the data in the layout, see X-FC-LAYOUT.

X-FC-WINDOW

Outputs information about the window layout.

Syntax

Arguments

LEFT, RIGHT, TOP and BOTTOM:
outputs the pixel coordinates of the window borders
WIDTH and HEIGHT
outputs (RIGHT - LEFT) and (BOTTOM - TOP) respectively

SPLIT
places the split bar in a conference listing

A SPLIT of 0 means the client (template) should place the split bar where it thinks it is most appropriate. A SPLIT greater than zero should be interpreted as 1 + % of the screen occupied by the upper or left pane in the conference listing.

Note

The SPLIT argument is independent of the actual existence of a split bar. A conference can be in non-split mode and still have a positive SPLIT percentage defined so that when the view is next placed in split mode, the bar will be where it was left by the user. The existence of the split bar can be determined using the X-FC-LAYOUT tag.
Top

Container listing tags

Container listing tags work only in container listing templates.

X-FC-CONFERENCE-FOLDER-LIST-END

Controls paging in container sub-container listings.
If the [LastFolder] argument is present, the last item on the page is set to the value of that argument. If the argument is absent, then the tag returns the current last item.
Syntax
X-FC-CONFERENCE-FOLDER-LIST-END [LastFolder]

<X-FC-CONFERENCE-FOLDER-LIST-MAX>

Controls paging in container sub-container listings.
If the [MaxFolders] argument is present, the number of items on the current page is set to the value of that argument. If the argument is absent, then the tag returns the current page size
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-MAX [MaxFolders]>

X-FC-CONFERENCE-FOLDER-LIST-NEXT

Creates a link to the next page (if there is one) in a container sub-container listing.
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-NEXT>

X-FC-CONFERENCE-FOLDER-LIST-PREV

Creates a link to the previous page (if there is one) in a container sub-container listing.
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-PREV>

X-FC-CONFERENCE-FOLDER-LIST-START

Used to control paging in container sub-container listings.
If the [FirstFolder] argument is present, the first item on the page is set to the value of that argument. If the argument is absent, then the tag returns the current first item.
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-START [FirstFolder]>

X-FC-CONFERENCE-LIST-END [LastItem]

Used to control paging in container leaf listings.
If the [LastItem] argument is present, the last item on the page is set to the value of that argument. If the argument is absent, then the tag returns the current last item.
Syntax
<X-FC-CONFERENCE-LIST-END [LastItem]>

X-FC-CONFERENCE-LIST-MAX

Used to control paging in container leaf listings.
If the [MaxItems] argument is present, the number of items in on the current page is set to the value of that argument. If the argument is absent, then the tag returns the current page size
Syntax
<X-FC-CONFERENCE-LIST-MAX [MaxItems]>

X-FC-CONFERENCE-LIST-NEXT

Creates a link to the next page (if there is one) in a container leaf listing.
Syntax
<X-FC-CONFERENCE-LIST-NEXT>

X-FC-CONFERENCE-LIST-PREV

Creates a link to the previous page (if there is one) in a container leaf listing.
Syntax
X-FC-CONFERENCE-LIST-PREV

X-FC-CONFERENCE-LIST-START

Used to control paging in container leaf listings.
If the [FirstItem] argument is present, the first item on the page is set to the value of that argument. If the argument is absent, then the tag returns the current first item.
Syntax
X-FC-CONFERENCE-LIST-START [FirstItem]
Top

Calendaring Tags

These tags work only in calendar views.

Note

These tags do not work in list mode.

X-FC-CALENDAR-ITEM

Outputs data about a specific item in a calendar view or the Today list.

Syntax

•       <X-FC-CALENDAR-ITEM Index DataField [Format]>
        Outputs data about the Index(th) item in the Today list (zero based). The total number of items in the list can be discovered using <X-FC-CALENDAR-ITEM-COUNT>
•       <X-FC-CALENDAR-ITEM Day.Index DataField [Format]>
        Outputs data about the Index(th) item in on Day (both zero based). The total number of items in the list can be discovered using <X-FC-CALENDAR-ITEM-COUNT>

The possible values for the optional Format argument vary depending on which DataField is being requested.
The possible values of the DataField argument, and their associated formats are:
START
The overall start date of this calendar item. Format options as a date.
REPEATSTART
If the calendar item is a repeating event, then this is the start date of this specific instance. Format options as a date.
DURATION
Duration of this calendar item. Format options as a time period.
BUSY
The busy state of this calendar item. Format as an enumeration (BUSY, TENTATIVE, OUTOFOFFICE, FREE). No STRING format available.
CONFLICT
This is 1 if the item is a conflict and 0 otherwise. No formatting options.
CONTINUED
This is 1 if the item is a continuation from a previous day, 0 otherwise. No formatting options.
OVERDUE
This is 1 if the item is overdue, 0 otherwise. No formatting options.
TODO
This is 1 if the item is a task, 0 otherwise. No formatting options.
FOREIGN
This is 1 if the item is not a native calendar item (for example, a message dragged onto the calendar), 0 otherwise. No formatting options.
COLOR
The colour of this calendar item. Format options as a colour.
STATUS
If this is a task, this contains the current status. Format options as an enumeration (NOTSTARTED, COMPLETED, INPROGRESS, WAITING, DEFERRED). A STRING format is available.
REMINDER
Reminder type of the current item. Format options as an enumeration (NONE, OWNER, PARICIPANTS) A STRING format is available.
REPEATTYPE
Repeat type of the current item. Format options as an enumeration (NONE, DAILY, WEEKLY, MONTHLY, YEARLY, WEEKDAYS, WEEKENDS, BIWEEKLY, BIMONTHLY, QUARTERLY, MONTHSAMEWEEKDAY). A STRING format is available.
SUBJECT
Subject of the current item. An HTML format is available.
COLUMN[Data]    Same syntax, options and formatting options as X-FC-ITEM.

X-FC-CALENDAR-ITEM-COUNT

Outputs the number of items on a given day in a calendar view, or in the "Today "list.
Syntax

• <X-FC-CALENDAR-ITEM-COUNT>

Outputs the number of items in the Today list

• <X-FC-CALENDAR-ITEM-COUNT Day>

Note

Day is zero based.

X-FC-CALENDAR-ITEM-URI

Outputs the URL of an item in a calendar view.
Syntax

• <X-FC-CALENDAR-ITEM-URI Index>

Outputs the URL of the Index(th) entry in the "Today" list. The number of items in the list can be determined using the <X-FC-CALENDAR-ITEM-COUNT>

• <X-FC-CALENDAR-ITEM-URI Day.Index>

Outputs the URL of the Index(th) entry on the Day(th) day on the calendar.

Note

Both Index and Day are zero based. So in a daily view, Day is always 0. On the daily view you still have to specify "0" to differentiate it from the "Today" view).
Top

Directory listing tags

These tags work only in Directory listing templates.

X-FC-DIRECTORY-MATCH-RESULT

Returns an integer that indicates the status of a directory search:
Value Meaning

-1      Search has not commenced
0       Search failed to find any matching directory entries
1       Search found an exact match in the directory
2       Search matched multiple directory entries

Syntax
X-FC-DIRECTORY-MATCH-RESULT

X-FC-DIRECTORY-ITEM-EMAIL-ADDRESS

Returns the entry's email address.
Syntax
X-FC-DIRECTORY-ITEM-EMAIL-ADDRESS

X-FC-DIRECTORY-ITEM-EMAIL-HREF

if the user is logged in
Returns a link to a preaddressed send form
otherwise
returns a mailto link for the entry
Syntax
X-FC-DIRECTORY-ITEM-EMAIL-HREF
Top

Form tags

Used in all forms templates.

X-FC-BODY

Outputs the body of the current form.

Syntax

<X-FC-BODY[FORMAT=(WML|HTML|PLAIN)][ESCAPED][MAX=nnnn]>
Arguments

FORMAT=HTML adds <img> and <a> tags and uses style sheets and other display formatting tags where appropriate
FORMAT=WML outputs the body in a manner compatible with WAP/WML enabled devices.

FORMAT=PLAIN outputs the body with no formatting.

FORMAT=ESCAPED escapes all quotes, double-quotes, line breaks, and backslashes, appropriate for use with Javascript variables.

FORMAT=MAX=nnnn specifies the maximum number of bytes of the body to be output. This is useful for WML and handheld device browsers, which have limited content capacity.

X-FC-DATE

Returns the Date the current message was sent. If the message is unsent, returns the date last modified.
Syntax

<X-FC-DATE [Format]>

The Format argument may be used to control the output format of the date, see Date formats to modify the date display.

X-FC-FORM-ENABLED

If the current object is editable
returns 1
otherwise
0
Syntax
X-FC-FORM-ENABLED

X-FC-RECIPIENT

Accesses members of a forms recipient list(s).
Syntax
<X-FC-RECIPIENT List.Index DATA[DataColumn] [Format]>
Arguments

List
the recipient List type (TO, CC, BCC, FROM)

This can also be represented as n integer (0 == TO, 1 == CC, 2 == BCC, 3 == FWD or FROM).
Index
the index of the recipient to access.
The number of recipients in a given list can be determined using <X-FC-RECIPIENT-COUNT>.
The DATA[DataColumn] and Format arguments behave the same as in X-FC-ITEM.

X-FC-RECIPIENT-COUNT

Output the number of recipients of the specified type. If no type is specified, outputs the total number of recipients.
Syntax
<X-FC-RECIPIENT-COUNT [RecipientType]>
Arguments
RecipientType must be one of To, Cc, Bcc or Fwd.
These types can also be referred to numerically as To == 0, Cc == 1, Bcc == 2, and Fwd == 3.
Top

Date formats

Use date formats to modify the date display for the DATE_LOCAL, DATE_GMT, AND LAST_MODIFIED tags. You can use the following arguments on the timefmt variable:

code %a outputs the abbreviated weekday name
code %A outputs the full weekday name
code %b outputs the abbreviated month name
code %B outputs the full month name

code %c outputs the fixed format date and time (Mon, 22 Feb, 99 3:15pm)
For the long date and time, use %#c. (Monday, 22 February, 1999 12:43:54 AM).

code %d outputs the day of the month as a decimal number (01-31)

                      To remove any leading zeros, use %#d.
code %H outputs the hour in 24-hour format (00-23)
                      To remove any leading zeros, use %#H.
code %l outputs the hour in 12-hour format (01-12)
                      To remove any leading zeros, use %#l.

code %j outputs the day of the year as decimal number (001-366)

To remove any leading zeros, use %#j.

code %m outputs the month as decimal number (01-12)

To remove any leading zeros, use %#m.

code %M outputs the minute as decimal number (00-59)

To remove any leading zeros, use %#M.
code %N outputs the seconds since Jan 1, 1970

code %p outputs the locale's a.m./p.m. indicator for a 12-hour clock
code %S outputs the second as decimal number (00-59)

To remove any leading zeros, use %#S.

code %U outputs the week of the year as decimal number (00-51, Sunday = first day of the week)

To remove any leading zeros, use %#U.

code %w outputs the weekday as decimal number (0-6, Sunday = 0)

To remove any leading zeros, use %#w.

code %W outputs the week of the year as decimal number (00-51, Monday = first day of the week)

To remove any leading zeros, use %#W.

code %x outputs the fixed format date representation (22 Feb, 99)
For the long date, use %#x (22 February, 1999).

code %X outputs the time representation for locale

code %y outputs the year without century as decimal number (00-99)
code %Y outputs the year with century as decimal number

code %z outputs the time zone name or abbreviation

code %Z outputs the numeric version of timezone (if available) in the form +/-HHMM (-0400, where 0000 is GMT)

code %% outputs the percent sign
Top

Related topics
Internet Services script global constants

Internet Services script commands
Internet Services script functions