The Action Environment

Every Action is executed with a collection of Environment Variables preset with information about the event that triggered the Action. An Action may also modify some of these variables (see Setting Environment Variables for Subsequent Use). The following list of variables will be preset:

This is the Unix-style pathname (using forward slashes, even on Windows systems) to the file that initiated the Action.

This is the HTML path to the file in $FILENAME as it would appear in the navigation bar of a Xinet window.

This is also the path to the file in $FILENAME, but in a format suitable to create a link in the body of an e-mail.

Allows you to specify the name of a parent folder.

If a Value Trigger initiates the Action, this is the user who made the data field change. When a Date Trigger initiates the Action, this user will be DateTriggerUser.

This is the file type information from the Macintosh resource for the file that has the associated Data Field. You can see this information about the file using /usr/etc/appletalk/kats on the Unix command-line, or on Windows systems, using C:\Program Files\Xinet\FullPress\kats.

This is the creator information from the Macintosh resource for the file that has the associated data field. You can see this information about the file using kats on the command-line as described above.

The name of the Action currently being executed.

The Action Setting name for the configuration used to run the Action.

This Action is an environment variable which is ONLY set when an action fails and ONLY for the Notify action. If the Notify action is “email”, then it is executed. Use this Action for special cases for error notification emails only.

This Action is always set for a chain of actions. When executed in a trigger set with a series of Actions, these will be the preceding Action and Action names. If there is no preceding Action, these will be blank strings.

This Action is an environment variable which is ONLY set when a action fails and ONLY for the Notify action. If the Notify action is “email”, then it is executed. Use this Action for special cases for error notification emails only.

This Action is always set for a chain of actions. When executed in a trigger set with a series of Actions, these will be the preceding Action and Setting names. If there is no preceding Action, these will be blank strings.

The name of the Trigger Set being used to run this Action. This may not be set if there is no Trigger Set involved.

If the Action was triggered by a keyword change, the name of that keyword. Otherwise, this variable will be a blank string.

If the Action was triggered by a keyword change, the Xinet Keyword ID for that keyword. Otherwise, this variable value will be 0.

The Desktop Comment associated with FILENAME, if it has one.

The install path to Xinet software (/usr/etc on Unix systems). Mostly useful on Windows systems.

If the Action was triggered by any Annotation event, one of the following strings describing the type of Annotation will be assigned to the variable: Text, Rect, Stamp or Sketch.

If ANNOTATIONTYPE = Text, this environment variable will be set and contain the actual text of the Annotation (not text from Annotation Notes, however). If ANNOTATIONTYPE =Stamp, the variable will contain a text representation of the stamp (the raw value from the database), again excluding any Annotation Note text.

All keywords that have values assigned for the file may also be used as variables in the Action, for example:

KEYWORD<number>_NAME=<keyword name from Xinet>
KEYWORD<number>_VALUE=<keyword value from Xinet>

The keyword numbers can be associated with their names by viewing the Data Field information in the Xinet GUI’s Database, Data Fields page. The ID column is the keyword number. For example, if you have a Boolean Data Field named on or off that has an ID of 60, then the variables to show the name and value of this field would be $KEYWORD60_NAME and $KEYWORD60_VALUE, respectively.