Variables for Workflows

Transcription

1 Variables for Workflows January 2012 TIBCO provides the two-second advantage

2 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 LICENSE.PDF) 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. This document contains confidential information that 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. TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Foresight Archive and Retrieval System, TIBCO Foresight HIPAA Validator Desktop, TIBCO Foresight Instream, TIBCO Foresight Operational Monitor, TIBCO Foresight Studio, and TIBCO Foresight Transaction Insight are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. 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. 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. Please see Licensing_Foresight_Products.pdf for licensing details. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential

3 Contents How variables are used... 3 Types of variables... 6 Automator built-in variables... 7 System global variables... 9 Scope... 9 List of Foresight-supplied system global variables Changing system global variables from within Studio Changing system global variables from the command Line Changing system global variables with a text editor WorkflowGlobals.xml format Individual Component Properties Using Consecutive Variables Annotated XML File Example Variables for Workflows 1

4 Variables for Workflows 2

5 How variables are used Foresight provides variables that make it easier to define workflows. Workflows with variables are more portable than if literal values are used. 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 Studio. Variables for Workflows 3

6 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 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:\Foresight\InStream\bin in the example above. Variables for Workflows 4

7 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 7. 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: Variables for Workflows 5

8 Types of variables These types of variables are available for use in workflow XML files. All are casesensitive. Type of Variable Editable by User? How Defined Use in See page Automator Built-in Variables No Programmed into Automator. Values are assigned as Automator processes each component. In any component in any workflow run by Automator. 7 When using these in a Studio parameter field, surround them with % to identify them as builtin variables. System Global Variables Yes In WorkflowGlobals.xml in Foresight s Systems directory. You can view and edit these in Studio with File Edit Globals. This is particularly handy when moving a workflow. Any workflow in the system where WorkflowGlobals.xml is located: 9 When using these in a Studio workflow parameter or a Studio component, surround them with # to identify them as system global variables. Individual Component - Properties Yes By a property in an individual XML workflow component. Edit the XML file, or, from within Studio, open the Model System Component Templates edit component Property tab. When using these in a 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. 23 Variables for Workflows 6

9 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 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 Foresight FSCOMPUTERNAME FSCOUNT FSDATETIMESTAMP FSERRORDIR FSIN FSIN1 FSIN2 FSIN3 FSIN4 Name of the computer on which the workflow is running. Example: FSSUPP01 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. Current date and time: YYYYMMDDHHMMSS Path to this component s Error directory. Example: C:\Foresight\Systems\Tutorial\Workflows\1.0\ myworkflow\responsegen_1\error\ 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:\Foresight\Systems\Tutorial\Workflows\1.0\ myworkflow\responsegen_1\process\file2.dtl 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:\Foresight\Systems\Tutorial\Workflows\1.0 \myworkflow\docsplitter_1\process \Myfile.dtl FSIN2 will be the path to a file with type edi: C:\Foresight\Systems\Tutorial\Workflows\1.0 \myworkflow\docsplitter_1\process \Myfile.edi Variables for Workflows 7

10 Automator built-in variables supplied by Foresight FSINDIR FSINDRIVE FSINEXT FSINFILE FSINPATH FSOUTDIR FSPROCDIR FSSEQNUM FSSYSROOTDIR FSWORKFLOW FSWORKFLOWDIR Path to the component s In directory, without the filename: Example: C:\Foresight\Systems\Tutorial\Workflows\1.0\ myworkflow\responsegen_1\in\ The drive where the component s In directory is located. Example: C: Extension of the file, including the preceding dot, when Input Connection Type is SingleFileIn. Example:.txt Filename of the file to be processed, without extension. Example: myfile Path to the component s In directory, including the filename. Example: C:\Foresight\Systems\Tutorial\Workflows\1.0\ myworkflow\responsegen_1\in\myfile.dtl Path to this component s Out directory. Example: C:\Foresight\Systems\Tutorial\Workflows\1.0\ myworkflow\responsegen_1\out\ Path to this component s Process directory. Example: C:\Foresight\Systems\Tutorial\Workflows\1.0\ myworkflow\responsegen_1\process\ Places the literal FSSN before FSCOUNT. It evaluates to FSSNx, where x = FSCOUNT. Path to the system under the Studio directory. Example: C:\Foresight\Systems\Mysystem\ Name of the current executing workflow. Not the directory - just the workflow name itself. Example: InStreamDemoSystem Path to the workflow: C:\Foresight\Systems\FTPdown\Workflows\1.0\ FTPdown Variables for Workflows 8

11 System global variables Important When using these variables, you will need to execute the workflow with Automator version 7.1 or later. Foresight has predefined some system global variables for Foresight Studio and TIBCO Foresight Transaction Insight users. Values assigned by Editable? Surround with Example usage Studio, Transaction Insight Yes # %Dir% = "#FSINSTREAMROOTDIR#\Example" You can edit the values of the 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. Variables for Workflows 9

12 List of 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. This example is set up for Windows: If you copy the system to UNIX, you would simply replace the _W highlighted above with _U. Use caution when changing the _U or _W setting in the FS_OSD variables below. They are being used by Foresight components. Variables for Workflows 10

13 System global variables supplied by Foresight Variable FS_OSD_ADDEX FS_OSD_ADDEX_U FS_OSD_ADDEX_W FS_OSD_ARCHVRBAT FS_OSD_ARCHVRBAT_U FS_OSD_ARCHVRBAT_W FS_OSD_DELETEALL FS_OSD_DELETEALL_U FS_OSD_DELETEALL_W FS_OSD_DELETEATTACH FS_OSD_DELETEATTACH_U FS_OSD_DELETEATTACH_W FS_OSD_DELETEBM FS_OSD_DELETEBM_U FS_OSD_DELETEBM_W FS_OSD_DELETEDDE FS_OSD_DELETEDDE_U FS_OSD_DELETEDDE_W FS_OSD_DELETEDTL FS_OSD_DELETEDTL_U FS_OSD_DELETEDTL_W FS_OSD_DELETEEDI FS_OSD_DELETEEDI_U FS_OSD_DELETEEDI_W FS_OSD_DELETEFF FS_OSD_DELETEFF_U FS_OSD_DELETEFF_W FS_OSD_DELETEFSIN FS_OSD_DELETEFSIN_U Intended meaning as used in Foresight-supplied component templates Add the file extension specified by %FileExtension% to the next file. Name of the TIBCO Foresight Archive and Retrieval System batch file archiver.sh archiver.bat Delete all files from the current component s Process directory without confirmation. Used by Gen275 workflow to clean up after running Command that deletes leftover files with extension BM from DSIDENTSPLIT. Used by Gen275 workflow to clean up after running Delete all files with type dtl from the current component s Process directory without confirmation. Deletes all files with type edi from the current component s Process directory without confirmation. Deprecated. Was used by older version of FFTranslator.xml. Deprecated. Was used by older version of FFTranslator.xml. Deprecated. Was used by older version of FFTranslator.xml. Deletes single file referenced by single file variable FSIN. Variables for Workflows 11

14 System global variables supplied by Foresight Variable FS_OSD_DELETEFSIN_W FS_OSD_DELETEGM FS_OSD_DELETEGM_U FS_OSD_DELETEGM_W FS_OSD_DELETETXT FS_OSD_DELETETXT_U FS_OSD_DELETETXT_W FS_OSD_EDIWRAPDEL FS_OSD_EDIWRAPDEL_U FS_OSD_EDIWRAPDEL_W FS_OSD_EDIWRAPRENAMECMD FS_OSD_EDIWRAPRENAMECMD_U FS_OSD_EDIWRAPRENAMECMD_W FS_OSD_FORCEFAIL FS_OSD_FORCEFAIL_U FS_OSD_FORCEFAIL_W FS_OSD_GEN275BAT FS_OSD_GEN275BAT_U FS_OSD_GEN275BAT_W FS_OSD_GENERICDELETE1 FS_OSD_GENERICDELETE1_U FS_OSD_GENERICDELETE1_W FS_OSD_GENERICDELETE2 FS_OSD_GENERICDELETE2_U FS_OSD_GENERICDELETE2_W FS_OSD_GENERICDELETE3 FS_OSD_GENERICDELETE3_U FS_OSD_GENERICDELETE3_W FS_OSD_GENERICRENAME Intended meaning as used in Foresight-supplied component templates Command that deletes leftover GM files from DSIDENTSPLIT component. Deletes files with extension TXT. Deletes the filename.in.ext file created by EDIWrap. EDIwrap component name.. Used in TPARouter to make the component realize there was a failure in TPARouter itself. Used by Gen275 workflow to run Gen275 Deletes what it finds in the component template property Parm1. Deletes what it finds in the component template property Parm2. Deletes what it finds in the component template property Parm3. Renames what it finds in the component template property Parm1 to Parm2. Variables for Workflows 12

15 System global variables supplied by Foresight Variable FS_OSD_GENERICRENAME_U FS_OSD_GENERICRENAME_W FS_OSD_INPUTFOLDERMOVE FS_OSD_INPUTFOLDERMOVE_U FS_OSD_INPUTFOLDERMOVE_W FS_OSD_INSTREAMMOVE FS_OSD_INSTREAMMOVE_U FS_OSD_INSTREAMMOVE_W FS_OSD_ISERRORSERRCMD FS_OSD_ISERRORSERRCMD_U FS_OSD_ISERRORSERRCMD_W FS_OSD_ISERRORSMOVECMD FS_OSD_ISERRORSMOVECMD_U FS_OSD_ISERRORSMOVECMD_W FS_OSD_ISERRORSNOERRCMD FS_OSD_ISERRORSNOERRCMD_U FS_OSD_ISERRORSNOERRCMD_W FS_OSD_MOVETOERROR FS_OSD_MOVETOERROR_U FS_OSD_MOVETOERROR_W FS_OSD_OUTPUTFOLDERMOVE FS_OSD_OUTPUTFOLDERMOVE_U FS_OSD_OUTPUTFOLDERMOVE_W FS_OSD_REMOVEEXTCMD FS_OSD_REMOVEEXTCMD_U FS_OSD_REMOVEEXTCMD_W Intended meaning as used in Foresight-supplied component templates Move without confirmation all files in the directory specified by property %Directory% with extension specified by %FileExtension% to the component s Process directory. Rename all files in the component s Process directory to file type edi. Places this text in the log: Return Code Is Error Condition Move all files in the component s Process directory to the location identified by the property %BadDirectory%. Display this message in the log: No Errors in EDI/DTL files Move all files from the current component s Process directory to its Error directory Move all files from the current component s Process directory to the location specified by the %Directory% property In the component s Process directory, remove the current file s extension Variables for Workflows 13

16 System global variables supplied by Foresight Variable FS_OSD_RENAMECMD FS_OSD_RENAMECMD_U FS_OSD_RENAMECMD_W FS_OSD_RENAMEDTSCMD FS_OSD_RENAMEDTSCMD_U FS_OSD_RENAMEDTSCMD_W FS_OSD_RENAMEMATCHEDBAD FS_OSD_RENAMEMATCHEDBAD_U FS_OSD_RENAMEMATCHEDBAD_W FS_OSD_RENAMEMATCHEDBAT FS_OSD_RENAMEMATCHEDBAT_U FS_OSD_RENAMEMATCHEDBAT_W FS_OSD_RENAMEMATCHEDGOOD FS_OSD_RENAMEMATCHEDGOOD_U FS_OSD_RENAMEMATCHEDGOOD_W FS_OSD_RENAMESHUFFLER FS_OSD_RENAMESHUFFLER_U FS_OSD_RENAMESHUFFLER_W FS_OSD_RENAMEUNIQUECMD FS_OSD_RENAMEUNIQUECMD_U FS_OSD_RENAMEUNIQUECMD_W FS_OSD_RM_MTAPARM Intended meaning as used in Foresight-supplied component templates In the component s Process directory, rename the files specified by the property %FromName% to the name specified by the property %ToName% Add an underscore and a date-timestamp (_YYYYMMDDHHMMSS) to the current file in the Process directory, just before the extension Example: Before: After: File1.edi File1_ YYYYMMDDHHMMSS.edi Deprecated. Was used by an older version of DSIDENTSPLIT to rename a bad split filename to its original. 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. Deprecated. Was used by an older version of DSIDENTSPLIT to rename a good split filename to its original. Used by FFShuffler and EDIShuffler components to give the file a temporary filename until finished shuffling. 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. To address for from ReportMailer Variables for Workflows 14

17 System global variables supplied by Foresight Variable FS_OSD_RM_MTAPARM_U FS_OSD_RM_MTAPARM_W FS_OSD_RMBAT FS_OSD_RMBAT_U FS_OSD_RMBAT_W FS_OSD_SFE_MTAPARM FS_OSD_SFE_MTAPARM_U FS_OSD_SFE_MTAPARM_W FS_OSD_SFEBAT FS_OSD_SFEBAT_U FS_OSD_SFEBAT_W FS_OSD_TIMATCHERBAT FS_OSD_TIMATCHERBAT_U FS_OSD_TIMATCHERBAT_W FSALERTEREXENAME FSARCHIVERBINDIR FSARCHIVERCONFIGDIR FSARCHIVERJAVADIR FSAUTOBINDIR Intended meaning as used in Foresight-supplied component templates Identifies ReportMailer file (bat or sh) To address for from ScanForErrors Identifies ScanForErrors file (bat or sh) 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 AlertProcessor executable Path to Foresight Archive and Retrieval System s Bin directory with a trailing slash. Examples: Windows C:\Foresight\Archiver\4.0.0\Bin\ Unix /u05/home/snoopy/foresight/archiver/4.0.0/bi n/ Path to Archive s bin directory without a trailing slash Examples: Windows C:\Foresight\Archiver\4.0.0\Bin Unix /u05/home/snoopy/foresight/archiver/bin Path to Archive s Java directory with a trailing slash Examples: Windows C:\Foresight\Archiver\4.0.0\Java\ Unix /u05/home/snoopy/foresight/archiver/ 4.0.0/Java/ Automator s Bin directory Variables for Workflows 15

18 System global variables supplied by Foresight Variable FSAUTOJAVADIR FSAUTOROOTDIR FSDATASWAPPEREXENAME FSDOCSPLITTEREXENAME FSEDIWRAPEXENAME FSFORESIGHTAUTOMATORDIR FSIMPORTEREXENAME FSINSTREAMBINDIR FSINSTREAMEXENAME FSINSTREAMJAVADIR FSINSTREAMROOTDIR FSISERRORSEXENAME FSISFILEIDEXENAME FSMETAUPDATEREXENAME FSPROJECTDIR FSREPORTMAILEREXENAME FSRESPGENEXENAME FSSCANERRORSEXENAME FSSHUFFLEREXENAME FSTIBINDIR FSTIJAVADIR FSTIMATCHEREXENAME FSTIUTILITIESEXENAME FSTPAROUTEREXENAME Intended meaning as used in Foresight-supplied component templates Automator s Java directory Automator s Root directory DataSwapper executable DocSplitter executable EDIWrap executable Directory containing ForesightAutomator.exe Importer executable The directory containing the Instream executable Name of the Instream executable with no extension Instream s Java directory The high-level Instream directory Example: c:\foresight\instream ISErrors executable Executable name of FSFILEID. Executable name of the MetaUpdater. The Foresight Systems directory Examples: Windows Unix c:\foresight\systems /u05/home/snoopy/foresight/systems Deprecated. Use FS_OSD_RMBAT instead. Executable name for RespGen Deprecated. Use FS_OSD_SFEBAT instead. Executable name for Shuffler. The Transaction Insight bin directory for a specific environment Example: c:\foresight\transactioninsight\3.3.0 \ Environments\Demo\bin Directory where TI jar files go. Defaults to a directory named java under TI s environment directory. Name of the TIMatcher executable. Defaults to TIMatcher. TIUtilities executable TPARouter executable Variables for Workflows 16

19 System global variables supplied by Foresight Variable FSTRANSEXENAME FSVERSION FSVHEXENAME Intended meaning as used in Foresight-supplied component templates Translator executable Windows Unix Instream version Example: Translator.exe Translator ValiaditonHighlighter executable Variables for Workflows 17

20 Changing system global variables from within 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 Studio. 1. From Studio, choose File Edit Globals. 2. Edit as desired. Note: If the path contains spaces, surround it with double quotes. To do this Change variable or value Do this Click it twice slowly and type the new value. Keep in mind that Foresight-supplied variables have been used for particular purposes in 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. Variables for Workflows 18

21 Delete a row Click its first column and press your Delete key: 3. Click Save. Variables for Workflows 19

22 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: Variables for Workflows 20

23 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 action filename variable <value> Where: action 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 filename variable value Path and filename of WorkflowGlobals.xml. The variable s name. 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:\foresight\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. Variables for Workflows 21

24 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:\foresight\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 Studio are ID and Value. Others are ignored. Element Meaning Used in XML File? Used in Studio Interface? Id Variable name. Value Value for the variable. DefaultValue Description EditType PrependValue AppendValue NotUsedValue Required DisplayAsPassword DisplayInGrid SelectionList Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Currently ignored by Studio Variables for Workflows 22

25 Individual Component Properties Recommendation: Use the component editor as described in ForesightStudio.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: Variables for Workflows 23

26 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: Variables for Workflows 24

27 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:\foresight\systems\demoinbound\workflows\1.0\automator\instream\process\file123.edi" FSPROCDIR FSINFILE 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> Automator Built-in variables Properties <Param>C:\Foresight\TransactionInsight\3.1.0\HVInStr eam\ 6.0.0\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> Variables for Workflows 25

28 TIBCO Software Inc., Foresight Group 655 Metro Place South Suite 900 Dublin OH Phone: (614) Fax: (614) Web: