tibco foresight® studio® variables for workflows

TIBCO Foresight® Studio®

Variables for Workflows

Software Release 9.1

August 2020

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR

BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON

FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT

LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE

AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS

NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED

DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)

OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT,

THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT

TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN

AGREEMENT TO BE BOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDER SEPARATE SOFTWARE

LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH, THESE SOFTWARE ITEMS ARE NOT

COVERED BY THE TERMS OF YOUR AGREEMENT WITH TIBCO, INCLUDING ANY TERMS CONCERNING

SUPPORT, MAINTENANCE, WARRANTIES, AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY

AT YOUR OWN DISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDING

TO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THE FOREGOING DISTINCTIONS

BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced

in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, TIBCO Foresight Archive and Retrieval System, TIBCO Foresight Instream,

TIBCO Foresight Studio, TIBCO Foresight Translator, and TIBCO Foresight Transaction Insight are either registered

trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.

Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

All other product and company names and marks mentioned in this document are the property of their respective owners

and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating system platforms for a specific

software version are released at the same time. Please see the readme.txt file for the availability of this software version on

a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,

INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A

PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE

PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW

EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE

PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY

OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY

RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer to TIBCO's Virtual

Patent Marking document (https://www.tibco.com/patents) for details.

Copyright © 2004-2020. TIBCO Software Inc. All Rights Reserved.

https://www.tibco.com/patents

Variables for Workflows 1

Contents How Variables are Used ........................................................................................ 2 Types of Variables ................................................................................................. 5 Environment Variables ........................................................................................... 6 Automator “built-in” variables ................................................................................. 7 System global variables ......................................................................................... 9

Scope ................................................................................................................ 9 List of TIBCO Foresight-supplied system global variables ............................. 10 Changing system global variables from within Foresight Studio .................... 17 Changing system global variables from the command line ............................ 20 Changing system global variables with a text editor ....................................... 20 WorkflowGlobals.xml format ........................................................................... 21

Individual Component Properties ......................................................................... 22 Using Consecutive Variables ............................................................................... 23 Annotated XML File Example .............................................................................. 24


How Variables are Used

TIBCO Foresight provides variables that make it easier to define workflows. Workflows

with variables are more portable than literal values.

You can see them in TIBCO Foresight® Studio®’s workflow parameters, where they are

an alternative to explicit information.

Example 1: Component’s Task tab using variables

This Foresight® Studio® task runs TIBCO Foresight® Instream® validation. When the

workflow executes this task, the command line will be put together by substituting in the

values for each variable. Variables are always surrounded by % or # (depending on the

type of variable) in parameter fields within Foresight Studio.


The variables surrounded by % are local to this component template. They are called

properties, and they are defined on the component’s Property tab:

The variables that affect a whole implementation are defined in WorkflowGlobals.xml and

can be edited from within Foresight Studio with File | Edit Globals.

#FSINSTREAMBINDIR# is used in the Instream.xml component’s HVInStream task. You

can see in the System Global Variables list that this is set to C:TIBCO64/instream/9.1\bin\

in the example above.


Example 2: Workflow schedule parameters using a variable

This workflow contains an InputFolder that uses the Automator built-in variable

%FSSYSROOTDIR% and adds a subdirectory under it. These pre-defined variables are

listed on page 6.

You can also use system global variables in the workflow, surrounded with #. These are

listed on page 10. This component uses the system global variable #FSPROJECTDIR#

and adds a subdirectory under it:


Types of Variables

These types of variables are available for use in workflow XML files. All are case-

sensitive.

Type of Variable Editable

by User?

How Defined … Use in … See

page

…

Environment

Variables

Yes Usually, by installation

programs

6

Automator “Built-in”

Variables

No Programmed into

Automator.

Values are assigned as

Automator processes each

component.

When using these in a

Studio parameter field,

surround them with % to

identify them as built-in

variables.

In any component in any

workflow run by Automator.

6

System Global

Variables

Yes In WorkflowGlobals.xml in

Foresight’s Systems

directory.

You can view and edit

these in Foresight Studio

with File | Edit Globals.

This is particularly handy

when moving a workflow.


Foresight Studio workflow

parameter or component,

surround them with # to

identify them as system

global variables.

Any workflow in the system

where WorkflowGlobals.xml

is located:

9

Individual

Component -

Properties

Yes By a property in an

individual XML workflow

component.

Edit the XML file, or, from

within Foresight Studio,

open the Model System |

Component Templates |

edi t component | Property

tab.


Foresight Studio parameter

field, surround them with %

to identify them as

properties.

A specific component in a

specific workflow.

The Property tab has a

Display on Grid option that

controls whether this property

will be listed in the

parameters when editing the

workflow.

22


Environment Variables

Environment variables supplied by Foresight

Variable Points to … Used by …

FSAUTOROOT Path to ForesightAutomator executable

Example:

ForesightAutomator\bin

Automator

FSMAINROOT TIBCO Foresight root directory

Example: C:\TIBCO64\fsp-studio\<n.n>\

This is the parent of the FSAUTOROOT directory

Foresight Service

Automator

FSROOT TIBCO Foresight root directory

Example: C:\TIBCO64\fsp-studio\<n.n>\

This is the parent of the FSAUTOROOT directory

Automator

FSSERVICEROOT Path between FSMAINROOT and Foresight

Service directory up to but not including "bin".

Example:

ForesightService

Foresight Service combines FSMAINROOT,

FSSERVICEROOT and bin to find its ini file.

Example: "C:\TIBCO64\fsp-studio\<n.n>\

ForesightService".

Foresight Service

FSTRANSLATORINI Used on UNIX installations to point TIBCO

Foresight® Translator to its install directory.

Foresight® Translator

FS_INSTREAMUIDDIR A directory that contains state and nodeid files,

thereby ensuring that FSUIDs will be unique.

(See FSUID_and_AppDocs.pdf, Ensuring

Unique FSUIDs section.)

Instream®

FSTIUTILITIESINI TIBCO Foresight® Transaction Insight®’s bin

directory.

(See TIUtilities.pdf, Command Line – Unix setup

section, provided with Transaction Insight.)

TIUtilities

FSIMPORTERINI Transaction Insight®’s bin directory.

(See AIX_ReadMe.txt - section B1.

CONFIGURING IMPORTER section)

TI Importer

FSINSTREAMINI Used on UNIX installations to point Instream to its

install directory.

Instream


Automator “built-in” variables

These variables ship with Foresight Studio and Transaction Insight.

Values

assigned by

…

Editable? Surround

with …

Example usage

Automator as

it runs

No % cmd /c "copy %FSPROCDIR%\result.txt

c:\results\*.*"

They are used in TIBCO Foresight-supplied workflow components. You can use them in

your own components or in workflow parameters, but not in file selection lists.

Automator built-in variables supplied by TIBCO Foresight

FSCOMPUTERNAME Name of the computer on which the workflow is running.

Example: FSSUPP01

FSCOUNT A counter that increments by 1 each time FSCOUNT is encountered in the

component’s task. Resets to 0 each time Automator starts:

0 First time the counter executes

1 Second time the counter executes

2 Third time the counter executes

See the Task tab for the RenameUniquely component template for an

example.

FSDATESTAMP Current date in CCYYMMDD format

FSDATETIMESTAMP Current date and time: YYYYMMDDHHMMSS

FSERRORDIR Path to this component’s Error directory.

Example: C:\TIBCO64\Systems\Tutorial\Workflows\1.0\

myworkflow\ResponseGen_1\Error\

FSIN Path to the component’s Process directory, plus the filename and

extension of the current file. Used with FileAvailable on the Trigger tab.

Example:

C:\TIBCO64\Systems\Tutorial\Workflows\1.0\

myworkflow\ResponseGen_1\Process\File2.dtl

FSIN1

FSIN2

FSIN3

FSIN4

Path to the component’s Process directory, plus name of the file listed in

the Trigger parameters. Used with MultilFileAvailable on the Trigger tab.

Example: If the Trigger tab lists this for parameters:

In 2 dtl

edi

Then FSIN1 will be the path to a file with type dtl:

C:\TIBCO64\Systems\Tutorial\Workflows\1.0

\myworkflow\DocSplitter_1\Process \Myfile.dtl

FSIN2 will be the path to a file with type edi:

C:\TIBCO64\Systems\Tutorial\Workflows\1.0

\myworkflow\DocSplitter_1\Process \Myfile.edi


Automator built-in variables supplied by TIBCO Foresight

FSINDIR Path to the component’s In directory, without the filename:

Example:


myworkflow\ResponseGen_1\In\

FSINDRIVE The drive where the component’s In directory is located.

Example: C:

FSINEXT Extension of the file, including the preceding dot, when Input Connection

Type is SingleFileIn.

Example: .txt

FSINFILE Filename of the file to be processed, without extension.

Example: myfile

FSINPATH Path to the component’s In directory, including the filename.

Example:


myworkflow\ResponseGen_1\In\myfile.dtl

FSOUTDIR Path to this component’s Out directory.

Example:


myworkflow\ResponseGen_1\Out\

FSPROCDIR Path to this component’s Process directory.

Example:

C:\TIBCO64\fsp-

studio\9.1\Systems\Tutorial\Workflows\1.0\

myworkflow\ResponseGen_1\Process\

FSSEQNUM Places the literal FSSN before FSCOUNT. It evaluates to FSSNx , where x

= FSCOUNT.

FSSYSROOTDIR Path to the system under the Foresight Studio directory.

Example:

C:\TIBCO64\fsp-studio\9.1\Systems\Mysystem\

FSTIMESTAMP Current time in HHMMSS format.

FSWORKFLOW Name of the current executing workflow. Not the directory - just the

workflow name itself.

Example:

InStreamDemoSystem

FSWORKFLOWDIR Path to the workflow:

C:\ TIBCO64\fsp-

studio\9.1\Systems\FTPdown\Workflows\1.0\FTPdown


System global variables

Important

When using these variables, you will need to execute the workflow with Automator

version 7.1 or later.

TIBCO Foresight has predefined some system global variables for Foresight Studio and

Transaction Insight users.

Values

assigned by

…

Editable? Surround

with …

Example usage

Foresight

Studio,

Transaction

Insight

Yes # %Dir% = "#FSINSTREAMROOTDIR#\Example"

You can edit the values of the TIBCO Foresight-supplied variables, or add your own

variables.

Scope

The same system global variables apply to an entire implementation. They cover all

systems listed by Foresight Studio.

In this example, you can use variables in WorkflowGlobals.xml in Inbound837I and

InStreamDemoSystem:

They are stored in a file called WorkflowGlobals.xml. They can be used in any workflow

in any system in the directory where WorkflowGlobals.xml resides.


List of TIBCO Foresight-supplied system global variables

To make things easier to port your workflow to another server, the system variables that

start with FS_OSD have three variations. The one actually being used in workflows and

component templates does not have a _U or _W appended to the end.

Example

The _W appendix is the Windows setting.

The _U appendix is the UNIX setting.

IMPORTANT: Do not change the _U or _W setting in the FS_OSD variables unless

instructed to do so by TIBCO Foresight. They are being used by TIBCO Foresight

components.

This example is set up for Windows:

If you copy the system to UNIX, you would simply replace the _W highlighted above with

_U.


System global variables supplied by TIBCO Foresight

Variable Intended meaning as used in TIBCO Foresight-

supplied component templates

FS_OSD_ADDEX Add the file extension specified by %FileExtension% to

the next file.

FS_OSD_ADDEX_U Unix version

FS_OSD_ADDEX_W Windows version

FS_OSD_ARCHVRBAT Name of the TIBCO Foresight® Archive and Retrieval

System batch file

FS_OSD_ARCHVRBAT_U archiver.sh

FS_OSD_ARCHVRBAT_W archiver.bat

FS_OSD_DELETEALL Delete all files from the current component’s Process

directory without confirmation.

FS_OSD_DELETEALL_U Unix version

FS_OSD_DELETEALL_W Windows version

FS_OSD_DELETEBM Command that deletes leftover files with extension BM

from DSIDENTSPLIT.

FS_OSD_DELETEBM_U Unix version

FS_OSD_DELETEBM_W Windows version

FS_OSD_DELETEDTL Delete all files with type dtl from the current component’s

Process directory without confirmation.

FS_OSD_DELETEDTL_U Unix version

FS_OSD_DELETEDTL_W Windows version

FS_OSD_DELETEEDI Deletes all files with type edi from the current

component’s Process directory without confirmation.

FS_OSD_DELETEEDI_U Unix version

FS_OSD_DELETEEDI_W Windows version

FS_OSD_DELETEFF Deletes all files with type txt (flat file) from the current

component’s Process directory without confirmation.

FS_OSD_DELETEFF_U Unix version

FS_OSD_DELETEFF_W Windows version

FS_OSD_DELETEFSIN Deletes single file referenced by single file variable FSIN.

FS_OSD_DELETEFSIN_U Unix version

FS_OSD_DELETEFSIN_W Windows version

FS_OSD_DELETEGM Command that deletes leftover GM files from

DSIDENTSPLIT component.

FS_OSD_DELETEGM_U Unix version

FS_OSD_DELETEGM_W Windows version





FS_OSD_DELETETXT Deletes files with extension TXT.

FS_OSD_DELETETXT_U Unix version

FS_OSD_DELETETXT_W Windows version

FS_OSD_EDIWRAPDEL Deletes the filename.in.ext file created by EDIWrap.

FS_OSD_EDIWRAPDEL_U Unix version

FS_OSD_EDIWRAPDEL_W Windows version

FS_OSD_EDIWRAPRENAMECMD EDIwrap component name.

FS_OSD_EDIWRAPRENAMECMD_U Unix version.

FS_OSD_EDIWRAPRENAMECMD_W Windows version

FS_OSD_FORCEFAIL Used in TPARouter to make the component realize there

was a failure in TPARouter itself.

FS_OSD_FORCEFAIL_U Unix version

FS_OSD_FORCEFAIL_W Windows version

FS_OSD_GENERICDELETE1 Deletes what it finds in the component template property

Parm1.

FS_OSD_GENERICDELETE1_U Unix version

FS_OSD_GENERICDELETE1_W Windows version


Parm2.




Parm3.



FS_OSD_GENERICRENAME Renames what it finds in the component template

property Parm1 to Parm2.

FS_OSD_GENERICRENAME_U Unix version

FS_OSD_GENERICRENAME_W Windows version

FS_OSD_INPUTFOLDERMOVE Move without confirmation all files in the directory

specified by property %Directory% with extension

specified by %FileExtension% to the component’s

Process directory.

FS_OSD_INPUTFOLDERMOVE_U Unix version

FS_OSD_INPUTFOLDERMOVE_W Windows version





FS_OSD_INSTREAMMOVE Rename all files in the component’s Process directory to

file type edi.

FS_OSD_INSTREAMMOVE_U Unix version

FS_OSD_INSTREAMMOVE_W Windows version

FS_OSD_ISERRORSERRCMD Places this text in the log:

Return Code Is Error Condition

FS_OSD_ISERRORSERRCMD_U Unix version

FS_OSD_ISERRORSERRCMD_W Windows version

FS_OSD_ISERRORSMOVECMD Move all files in the component’s Process directory to the

location identified by the property %BadDirectory%.

FS_OSD_ISERRORSMOVECMD_U Unix version

FS_OSD_ISERRORSMOVECMD_W Windows version

FS_OSD_ISERRORSNOERRCMD Display this message in the log:

No Errors in EDI/DTL files

FS_OSD_ISERRORSNOERRCMD_U Unix version

FS_OSD_ISERRORSNOERRCMD_W Windows version

FS_OSD_MOVETOERROR Move all files from the current component’s Process

directory to its Error directory

FS_OSD_MOVETOERROR_U Unix version

FS_OSD_MOVETOERROR_W Windows version

FS_OSD_OUTPUTFOLDERMOVE Move all files from the current component’s Process

directory to the location specified by the %Directory%

property

FS_OSD_OUTPUTFOLDERMOVE_U Unix version

FS_OSD_OUTPUTFOLDERMOVE_W Windows version

FS_OSD_RE_PARM1 Deprecated. Use FS_OSD_REMOVEEXT_SOF instead.

FS_OSD_RE_PARM1_U Unix version

FS_OSD_RE_PARM1_W Windows version

FS_OSD_REMOVEEXT_SOF In the component’s Process directory, remove the safe

output folder.

FS_OSD_REMOVEEXT_SOF_U Unix version

FS_OSD_REMOVEEXT_SOF_W Windows version

FS_OSD_REMOVEEXTCMD In the component’s Process directory, remove the current

file’s extension

FS_OSD_REMOVEEXTCMD_U Unix version





FS_OSD_REMOVEEXTCMD_W Windows version

FS_OSD_RENAMECMD In the component’s Process directory, rename the files

specified by the property %FromName% to the name

specified by the property %ToName%

FS_OSD_RENAMECMD_U Unix version

FS_OSD_RENAMECMD_W Windows version

FS_OSD_RENAMEDTSCMD Add an underscore and a date-timestamp

(_YYYYMMDDHHMMSS) to the current file in the Process

directory, just before the extension

Example:

Before: File1.edi

After: File1_ YYYYMMDDHHMMSS .edi

FS_OSD_RENAMEDTSCMD_U Unix version

FS_OSD_RENAMEDTSCMD_W Windows version

FS_OSD_RENAMEMATCHEDBAD Rename the bad splits from DSIDENTSPLIT back to their

original filenames, but with extension . bad.

FS_OSD_RENAMEMATCHEDBAD_U Unix version

FS_OSD_RENAMEMATCHEDBAD_W Windows version

FS_OSD_RENAMEMATCHEDBAT Calls a Java application RenameMatched.jar to rename

the good and bad splits from DSIDENTSPLIT back to their

original filenames, but with extension good or bad.

FS_OSD_RENAMEMATCHEDBAT_U Unix version

FS_OSD_RENAMEMATCHEDBAT_W Windows version

FS_OSD_RENAMEMATCHEDGOOD_U Unix version

FS_OSD_RENAMEMATCHEDGOOD Rename the good splits from DSIDENTSPLIT back to

their original filenames, but with extension . good.

FS_OSD_RENAMEMATCHEDGOOD_W Windows version

FS_OSD_RENAMESHUFFLER Used by FFShuffler and EDIShuffler components to give

the file a temporary filename until finished shuffling.

FS_OSD_RENAMESHUFFLER_U Unix version

FS_OSD_RENAMESHUFFLER_W Windows version

FS_OSD_RENAMEUNIQUECMD Add a unique number to the current file in the Process

directory, just before the extension.

The number is 0 the first time it executes, 1 the second

time, etc. It resets to 0 each time Automator starts.

FS_OSD_RENAMEUNIQUECMD_U Unix version

FS_OSD_RENAMEUNIQUECMD_W Windows version





FS_OSD_RM_MTAPARM “To” address for e-mail from ReportMailer

FS_OSD_RM_MTAPARM_U Unix version

FS_OSD_RM_MTAPARM_W Windows version

FS_OSD_RMBAT Identifies ReportMailer file (bat or sh)

FS_OSD_RMBAT_U Unix version

FS_OSD_RMBAT_W Windows version

FS_OSD_SCENARIODETECTORBAT Identifies Scenario Detector file (bat)

FS_OSD_SCENARIODETECTORBAT_U Unix version

FS_OSD_SCENARIODETECTORBAT_W Windows version

FS_OSD_SFE_MTAPARM “To” address for e-mail from ScanForErrors

FS_OSD_SFE_MTAPARM_U Unix version

FS_OSD_SFE_MTAPARM_W Windows version

FS_OSD_SFEBAT Identifies ScanForErrors file (bat or sh)

FS_OSD_SFEBAT_U Unix version

FS_OSD_SFEBAT_W Windows version

FS_OSD_TIMATCHERBAT Name of script file that runs TIMatcher in the current

environment. Will automatically be one of

FS_OSD_TIMATCHERBAT_U or

FS_OSD_TIMATCHERBAT_W

FS_OSD_TIMATCHERBAT_U Unix version

FS_OSD_TIMATCHERBAT_W Windows version

FSALERTEREXENAME AlertProcessor executable

FSARCHIVERBINDIR Path to Foresight® Archive and Retrieval System’s Bin

directory with a trailing slash.

Examples:

Windows

C:\TIBCO64\Archiver\5.2\Bin\

Unix

/u05/home/snoopy/Foresight/Archiver/5.2/Bi

n/

FSARCHIVERCONFIGDIR Path to Foresight Archive and Retrieval System’s bin

directory without a trailing slash

Examples:

Windows

C:\TIBCO64\Archiver\5.2\Bin

Unix

/u05/home/snoopy/TIBCO64/Archiver/5.2/Bin





FSARCHIVER_IMPORTER_DBCONN Connection string to the Foresight Archive and Retrieval

System database

Example:

Windows DRIVER={SQL Server};SERVER=localhost;

DATABASE=ArchiveDemo;UID=sa;PWD=uehs8e7evo

FSARCHIVERJAVADIR Path to Foresight Archive and Retrieval System’s Java

directory with a trailing slash

Examples:

Windows

C:\TIBCO64\Archiver\5.2\Java\

Unix

/u05/home/snoopy/TIBCO64/Archiver/

5.2/Java/

FSAUTOBINDIR Automator’s Bin directory

FSAUTOJAVADIR Automator’s Java directory

FSAUTOROOTDIR Automator’s Root directory

FSDATASWAPPEREXENAME DataSwapper executable

FSDOCSPLITTEREXENAME DocSplitter executable

FSEDIWRAPEXENAME EDIWrap executable

FSFORESIGHTAUTOMATORDIR Directory containing ForesightAutomator.exe

FSIMPORTEREXENAME Importer executable

FSINSTREAMBINDIR The directory containing the Instream® executable

FSINSTREAMEXENAME Name of the Instream executable with no extension

FSINSTREAMJAVADIR Instream’s Java directory

FSINSTREAMROOTDIR The high-level Instream directory

Example:

c:\TIBCO64\InStream\<n.n>

FSISERRORSEXENAME ISErrors executable

FSISFILEIDEXENAME Executable name of FSFILEID.

FSMETAUPDATEREXENAME Executable name of the MetaUpdater

FSPROJECTDIR The Foresight Systems directory

Examples:

Windows C:\TIBCO64\fsp-studio\9.1\Systems

Unix /u05/home/snoopy/TIBCO64/Systems

FSREPORTMAILEREXENAME Deprecated. Use FS_OSD_RMBAT instead.

FSRESPGENEXENAME Executable name for RespGen





FSSCANERRORSEXENAME Deprecated. Use FS_OSD_SFEBAT instead.

FSSHUFFLEREXENAME Executable name for Shuffler.

FSTIBINDIR The Transaction Insight bin directory for a specific

environment

Example:

c:\TIBCO64\TransactionInsight\5.2\

Environments\Demo\bin

FSTRANSBINDIR The Transaction Insight bin directory for a specific

environment

Example:

c:\TIBCO64\TransactionInsight\5.2\

Environments\Demo\bin

FSTIJAVADIR Directory where TI jar files go. Defaults to a directory

named java under Transaction Insight’s env ironment

directory.

FSTIMATCHEREXENAME Name of the TIMatcher executable. Defaults to

TIMatcher.

FSTIUTILITIESEXENAME TIUtilities executable

FSTPAROUTEREXENAME TPARouter executable

FSTRANSEXENAME Foresight Translator executable

Windows Translator.exe

Unix Translator

FSVERSION Instream version

Example: 9.1

FSVHEXENAME ValidationHighlighter executable

Changing system global variables from within Foresight Studio

You should not have to change the following settings unless you are moving a workflow

to another server. Use caution when changing them, and consider contacting TIBCO

Foresight support first.

If you edit the value of a system global variable, the value is overwritten with the current default

TIBCO Foresight value when you reinstall or upgrade Foresight Studio.

If you create your own variable, the variable and its corresponding value are retained when you

reinstall or upgrade Foresight Studio.


The easiest way to see and change the list of system global variables is within Foresight Studio.

1. From Foresight Studio, choose File | Edit Globals.

2. Edit as desired.

Note: If the path contains spaces, surround it with double quotes.

To do this … Do this …

Change variable or value Click it twice slowly and type the new value. Keep in mind that

TIBCO Foresight-supplied variables have been used for

particular purposes in TIBCO Foresight-supplied workflow

components.

To use variables in the Value column:

Automator built-in variables – surround with %

Other System Global Variables – surround with #

Add a new variable Click the Variable or Value field in the bottom row slowly and

type the new value.

Delete a row Click its first column and press your Delete key:


3. Click Save.

Example

We add a system global variable INDIR:

The resulting lines in WorkflowGlobals.xml are:

We can now use INDIR in a component template or in a workflow schedule parameter:


Changing system global variables from the command line

GlobalWriter.exe is a command-line program in Automator’s Bin directory. It lets you:

Add a new system global variable

Change the value of an existing system global variable

Clear the value from a system global variable

Delete system global variables

Its format is:

GlobalWriter act ion f i l ename var iable <va lue>

Where:

act ion Specifies the action to take:

Action Switch Command Format and Example

Change or add variable -e GlobalWriter -e filename variable value

Clear variable -c GlobalWriter -c filename variable

Delete variable -d GlobalWriter -d filename variable

Show help -h GlobalWriter -h

f i l ename Path and filename of WorkflowGlobals.xml.

var iable The variable’s name.

value The variable’s value.

Example

This command adds variable INDIR to WorkflowGlobals.xml and assigns it the value “c:\files\in.” If

INDIR already exists, its value will be changed to “c:\files\in.”

GlobalWriter -e C:\TIBCO64\fsp-studio\9.1

\systems\workflowglobals.xml INDIR c:\files\in

Changing system global variables with a text editor

From a text editor, edit WorkflowGlobals.xml in Foresight’s Systems directory.


WorkflowGlobals.xml format

WorkflowGlobals.xml contains a Property element describing each Automator System

variable.

This is the definition for a variable called FSPROJECTDIR:

<Property>

<Id>FSPROJECTDIR</Id>

<Value>C:\TIBCO64\fsp-studio\<n.n>\systems</Value>

<DefaultValue />

<Description />

<EditType>TextEntry</EditType>

<PrependValue />

<AppendValue />

<NotUsedValue />

<Required>False</Required>

</Property>

You can edit an existing Property element or add new ones.

The only elements in this file that are used by Foresight Studio are ID and Value. Others

are ignored.

Element Meaning Used in

XML

File?

Used in

Foresight Studio

Interface?

Id Variable name.

Value Value for the variable.

DefaultValue Currently ignored by Foresight Studio

Description Currently ignored by Foresight Studio

EditType Currently ignored by Foresight Studio

PrependValue Currently ignored by Foresight Studio

AppendValue Currently ignored by Foresight Studio

NotUsedValue Currently ignored by Foresight Studio

Required Currently ignored by Foresight Studio

DisplayAsPassword Currently ignored by Foresight Studio

DisplayInGrid Currently ignored by Foresight Studio

SelectionList Currently ignored by Foresight Studio


Individual Component Properties

Recommendation: Use the component editor as described in TIB_fsp-

studio_<n.n>_usersguide.pdf.

There is no list of individual component properties, since they can be defined and used

as needed in an individual XML component file.

These are defined with a Property element in the XML file.

This example Property element sets up a property called ReportExtension that contains

the value xml.

Another element in the same file (usually the Task element) uses the property:


In the workflow, this property can be edited up under the component’s parameters:

Using Consecutive Variables

When two variables are used consecutively:

If they are Automator built-in variables or properties (delimited with %), a slash is

automatically inserted between them when Automator evaluates them.

If they are system global variables (delimited with #), you are in charge of inserting the

slashes.

Example

This component editor task has two consecutive Automator built-in variables:

In the corresponding XML file, it will look like this:


When this component runs, this line will include a slash between the two variables.

Notice the slash that was automatically inserted between the two consecutive variables in

this example:

-i"C:\TIBCO_HOME\Systems\DemoInbound\Workflows\1.0\Automator\InStream\Process\File123.edi"

When using a variable with a literal value before or after it, type the slashes:

<Value>%INDIR%/837</Value>

Annotated XML File Example

You can see variables in the workflow XML component files.

This is a section of the InStream.xml file that ships with Transaction Insight’s Automator

demo workflow. It uses both Automator variables and local variables. Items surrounded

by percent signs are variables. When this component runs, the current variable values

are substituted in.

<Task>

<Id>HVInStream</Id>

<Type>Executable</Type>

<SuccessCode>100</SuccessCode>

<Param>C:\\TIBCO_HOME\\TransactionInsight\5.2.0\HVIn

Stream\9.1\Bin\HVInStream.exe</Param>

<Param>-i"%FSPROCDIR%%FSINFILE%.edi"</Param>

<Param>-o"%FSPROCDIR%%FSINFILE%"</Param>

<Param>%Guideline%</Param>

<Param>%SetupFile%</Param>

<Param>%UseTableFileServer%</Param>

<Param>-r</Param>

<Param>-a</Param>

</Task>

Earlier in the same InStream.xml file, the properties were defined by a Property tag. This

example defines the value in the Guideline variable as PDSA837I and puts -g in front of it

when Automator builds the command line to run Instream.

<Property>

<Id>Guideline</Id>

<Value />

<DefaultValue>PDSA837I</DefaultValue>

<Description>Guideline to use for validating.</Description>

<EditType>TextEntry</EditType>

<PrependValue>-g</PrependValue>

<AppendValue />

<NotUsedValue />

<Required>False</Required>

</Property>

FSPROCDIR FSINFILE

Properties

Automator

Built-in

variables

tibco foresight® studio® variables for workflows

Documents