home *** CD-ROM | disk | FTP | other *** search
Wrap
<html> <head> <STYLE> body{ font-size : medium; } td { font-size : medium; } </STYLE> </head> <body bgcolor="silver" text="maroon"> <h1><div align="center">Help for configuring Flash Form Input</div></h1> <br><br> <A name="General"><div align="center"><font color=blue size=6> General Entry Help</font></A><br> <table width="100%" border=1> <tr><th align="left" text="Red" width="10%"> <A name="InstanceName"><font color=black>Instance Name:</font></A></th><th align="middle" valign="top" width="20%"><font color=red>(Use)</font></th> <th align="left" width="70%" valign="top"> This is the name that you want to call the current node that you are working with.</th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be unique from all other nodes in your workspace. <LI>Value can contain any alphanumeric characters.</LI> </OL> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>Required.</LI> </OL> </th></tr> <!-- <tr><th align="left"> <A name="PathToHelpFile"><font color=black>Path To Help File:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> This is the path to the help file that will be displayed when the user clicks the "Help" button on your object.</th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be a currently existing file on your hard drive. <LI>Value must be a valid path, either relative(\subdir\yourfile.txt) or absolute(c:\yourdir\yourfile.txt).</LI> </OL> </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>This help file is only displayed if the <A href="#NativeHelp">native Help</A> output signal is not active.</LI> <LI>See <a href="#PathToHelpContentFile">Path To Help Content File</a>. </OL> </th></tr> <tr><th align="left"> <A name="PathToHelpContentFile"><font color=black>Path To Help Content File:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> This is the path to the content file that your help file needs.(ie for XML content support) </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be a currently existing file on your hard drive. <LI>Value must be a valid path, either relative(\subdir\yourfile.txt) or absolute(c:\yourdir\yourfile.txt).</LI> </OL> </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If your help file needs a content file, then it must be indicated here. If it is not, during runtime your help file will not know where it's content file is.</li> <LI>This value is not required.</li> <li>The content file will usually be an XML file, but is not restricted to this.</li> </OL> </th></tr> <tr><th align="left"> <A name="HelpOptionString"><font color=black>Help Option String:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> An option parameter to be passed when displaying the help file.</th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>This value is a PerformAction command to apply to the Help File upon display.</li> </OL> </th></tr> --> </table> <br><br> <A name="Outputs"><div align="center"><font color=blue size=6>Outputs Help</font></A><br><br> <table width="100%" border=1> <tr><th align="left" colspan="3"> Embedded Flash Signals</th></tr> <tr><th align="left" width="10%"> <A name="OutputInstance"><font color=black>Output Signal Name:</font></A></th><th width="20%" align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" width="70%" valign="top"> This is what the actual signal will be known as, both internally and externally to the worknode. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be unique from all other output signals from the current object. <LI>Value must not be "cancel" or "help".</LI> </OL> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>Values are case sensitive.</LI> </OL> </th></tr> <tr><th align="left"> <A name="OutputName"><font color=black>Flash Embedded Button ID:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> The unique ID that is given to the button <font color=Yellow>inside</font> the Flash code that is going to be displayed to the user. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be unique. </OL> </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>The Flash Button ID is the value that is passed in the first parameter from each call to "fscommand" in your button actions.</LI> </OL> </th></tr> <tr><th align="left"> <A name="ReleaseGUI"><font color=black>Release GUI:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> Whether or not to release the GUI upon firing of signal. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If Yes is selected, then your displayed output will be closed down once the associated signal is fired AND another GUI oriented object "claims" the GUI. <LI>If No is selected, then it is the WorkFlow Editor programmers responsibility to release the GUI at a later time.</LI> </OL> </th></tr> </table> <br><br> <A name="Reporting"><div align="center"><font color=blue size=6>Reporting Help</font></A><br><br> <table width="100%" border=1> <tr><th align="left" colspan="3"> Outputs</th></tr> <tr><th align="left" width="10%"> <A name="OutputReportPath"><font color=black>Report Path:</font></A></th><th width="20%" align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" width="70%" valign="top"> The path in the report file where you want your result value to be placed when this output is fired from the worknode. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If you don't want anything to be reported for the specified output, make sure this field is empty.</li> <LI>The value in <a href="#ValueIfFired">Value if Fired</a> is placed in this path in the report when the specified output is fired.</LI> </OL> </th></tr> <tr><th align="left"> <A name="ValueIfFired"><font color=black>Value if Fired:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> The text string that is placed in the <a href="#OutputReportPath">Report Path</a> when the specified output signal is fired. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None. </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>Value can be any text string.</LI> </OL> </th></tr> <tr><th align="left"> <A name="ReportingCurrentOutputs"><font color=black>Current Outputs:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> This Select Box Lists all of the currently active outputs that you can attach reporting to. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None. </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>You must select an item in this list in order to update an Outputs Reporting.</LI> </OL> </th></tr> </table> <table width="100%" border=1> <tr><th align="left" colspan="3"> Inputs</th></tr> <tr><th align="left" width="10%"> <A name="InputReportPath"><font color=black>Report Path:</font></A></th><th width="20%" align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" width="70%" valign="top"> The path in the report file where you want your the resulting input value to be placed once the worknode fires an output signal. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If you don't want anything to be reported for the specified output, make sure this field is empty.</li> <LI>The value entered by the user in the desired Input field is placed in the Report Path specified.</LI> </OL> </th></tr> <tr><th align="left"> <A name="ReportingCurrentInputs"><font color=black>Current Inputs:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> This Select Box Lists all of the currently active inputs that you can attach reporting to. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None. </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>You must select an item in this list in order to update any Inputs Reporting.</LI> </OL> </th></tr> </table> <br><br> <A name="Display"><div align="center"><font color=blue size=6>Display Help</font></A><br><br> <table width="100%" border=1> <tr><th align="left" colspan="3"> Display</th></tr> <tr><th align="left"> <A name="MethodFile"><font color=black>Flash Swiff File Path:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> The path to the flash swiff file to displayed to the user. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be a currently existing file on your hard drive. <LI>Value must be a valid path, either relative(\subdir\yourfile.txt) or absolute(c:\yourdir\yourfile.txt).</LI> </OL> </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If no file path is provided, then nothing will be displayed to the user.</LI> </OL> </th></tr> <tr><th align="left" text="Red" width="10%"> <A name="DisplayContentFilePath"><font color=black>Flash Content File Path:</font></A></th><th align="middle" valign="top" width="20%"><font color=red>(Use)</font></th> <th align="left" width="70%" valign="top"> The path to a file that is needed by your display file. Usually an XML file. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be a currently existing file on your hard drive. <LI>Value must be a valid path, either relative(\subdir\yourfile.txt) or absolute(c:\yourdir\yourfile.txt).</LI> </OL> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> None. </OL> </th></tr> <tr><th align="left"> <A name="PerformAction"><font color=black>Perform Action:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> If specified, the given swf file will have the specified PerformAction called upon loading of the swf file. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be a valid PerformAction within your Flash File.</li> </OL> </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If nothing is entered here, then the swf file will begin at the first frame of your first scene.</li> <LI>To see an example of how PerformActions work, go to <a href="http://virtualtruck/FrontDoor/Download/Flash5%20Help%20and%20Utilities/">http://virtualtruck/FrontDoor/Download/Flash5%20Help%20and%20Utilities/</a></li> <LI>This value applies to <a href="#MethodFile">Flash Swiff File Path</a>.</li> </OL> </th></tr> <table width="100%" border=1> <tr><th align="left" colspan="3"> Embedded Variables</th></tr> <tr><th align="left" width="10%"> <A name="VarKey"><font color=black>Embedded Flash Variable Name:</font></A></th><th width="20%" align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" width="70%" valign="top"> Unique flash variable within the given swiff file. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be unique from all other Embedded Variable Keys inside the worknode.</LI> </OL> </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>Example values could be "_root.myobject.myvariable", or "_root.myvariable". </OL> </th></tr> <tr><th align="left"> <A name="DictPath"><font color=black>Dictionary Entry To Substitute:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> Value in Global Dictionary to substitute in place of <A href="#VarKey">Embedded Flash Variable Name</A>. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If value does not exist in dictionary, then nothing will be displayed.</LI> <LI>Dictionary value can be any type except RawBinary or NoType.</LI> <LI>If Dictionary entry is a list, then the value specified in <a href="#VarKey">Embedded Flash Variable Name</a> will be amended with the index of the given value in the list. (i.e. If Embedded Flash Var Name is "Todd" and you specify a dictionary path that is a list with 3 elements, then the first element will be placed in the flash variable "Todd0", the second in "Todd1", and the third in "Todd2".)</LI> <LI>If the Dictionary entry is a list, a special variable will be created in your Flash that specifies the number of items there are in the list. The special variable's name is your Embedded Flash Var Name with "NumOf" amended to the end of it. (i.e. If you specify as your Flash Embedded Variable, "Todd", then the special variable created would be "ToddNumOf").</li> </OL> </th></tr> </table> <br><br> <A name="Inputs"><div align="center"><font color=blue size=6>Flash Inputs Help</font></A><br><br> <table width="100%" border=1> <tr><th align="left" width="10%"> <A name="FlashInputID"><font color=black>Flash Input ID:</font></A></th><th width="20%" align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" width="70%" valign="top"> Embedded flash variable to set the <A href="#DictionaryPath">Global Dictionary Path</A> value to upon any output signal being fired. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> <OL> <LI>Value must be given in the flash representation of the variable. (ie "_root.myobject.myvariable", NOT just "myvariable") <LI>If variable is an input field, then the HTML field in Window>Panels>Text Options must not be selected in your Swiff file. </OL> </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>Example values could be "_root.myobject.myvariable", or "_root.myvariable". <LI>Duplicate values can be entered with different paths to write the same value to seperate paths at once. </OL> </th></tr> <tr><th align="left"> <A name="DictionaryPath"><font color=black>Global Dictionary Path:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> Path to the value in Global Dictionary to substitute in place of the embedded flash value in <A href="#FlashInputID">Flash Input ID</A>. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>If value does not exist in dictionary, then the path will be created.</LI> </OL> </th></tr> <tr><th align="left"> <A name="ValueType"><font color=black>Value Type:</font></A></th><th align="middle" valign="top"><font color=red>(Use)</font></th> <th align="left" valign="top"> The type to expect in the embedded flash variable specified in <A href="#FlashInputID">Flash Input ID</A>. </th> </tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Restrictions)</font></th> <th align="left" valign="top"> None </th></tr> <tr><th></th><th align="middle" valign="top"><font color=red>(Notes)</font></th> <th align="left" valign="top"> <OL> <LI>Value checking must be done within the provided flash file, if the value is specified to be a Double and it is actually a String, the desired response will not be acheived.</LI> </OL> </th></tr> </table> </DIV></DIV></DIV> </body> </html>