User Guide
User Guide
Engineous Software, Inc. retains all ownership rights to the iSIGHT-FD computer program and its
documentation. Use of iSIGHT-FD software is governed by the license agreement accompanying your
original media. The iSIGHT-FD source code is a confidential trade secret of Engineous Software, Inc. You
many not attempt to decipher, decompile, develop, or otherwise reverse engineer iSIGHT-FD software, or
knowingly allow others to do so.
No part of this document may be reproduced or transmitted in any form or by any means, electronic or
mechanical, for any purpose, without the express written permission of Engineous Software, Inc.
Engineous Software, Inc. provides this publication “as is” without warranty of any kind, either expressed
or implied, including but not limited to the implied warranties or conditions of merchantability or fitness
for a particular purpose. In no event shall Engineous Software, Inc. be liable for any loss of profits, loss of
business, loss of use or data, interruption of business, or for indirect, special, incidental, or consequential
damages of any kind, even if Engineous Software has been advised of the possibility of such damages
arising from any defect or error in this publication or in the iSIGHT-FD software.
Engineous Software, Inc. may revise this publication at any time without notice. Some states or
jurisdictions do not allow disclaimer of express or implied warranties in certain transactions; therefore,
this statement may not apply to you.
Windows is either a registered trademark or trademark of Microsoft Corporation in the United States and/
or other countries.
Red Hat and RPM are either a registered trademark or trademark of Red Hat, Inc.
Sun and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc.
All other product names mentioned herein are the trademarks of their respective owners.
3
Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
What is iSIGHT-FD?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
The iSIGHT-FD Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Design Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Runtime Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Command Line Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Contacting Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
United States and North America . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Japan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Korea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Germany . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
United Kingdom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
France . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1 iSIGHT-FD Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
What is an iSIGHT-FD Model?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Understanding the Parts of iSIGHT-FD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Accessing the Preferences Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Setting Gateway Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Setting Additional Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Setting Component Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
C Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Preface
This book is your guide to creating and using models in iSIGHT-FD via the Design
Gateway, as well as using the iSIGHT-FD Examples, and the iSIGHT-FD
documentation. Read on to find out more about iSIGHT-FD and how to use this book.
What is iSIGHT-FD?
iSIGHT-FD is a service-oriented product development environment, which provides an
open, flexible means to incorporate existing analysis and design tools/methods and
make them available to others. It also provides a common, standard way to model your
analysis and design process in conjunction with your product data.
Design Gateway
This interface is the main iSIGHT-FD interface. It allows you to create models,
manipulate components, and perform other functions associated with model design and
development. For more information on this interface, see Chapter 2 “Using the Design
Gateway Interface”.
Runtime Gateway
This interface allows you to control execution and view results. It lets you create
graphs and tables, view parameter information, and resubmit models for execution. For
more information on the Runtime Gateway, see the iSIGHT-FD Runtime Gateway
Guide.
Components
Components are used as building block for models. Excel, Data Exchanger, and
Optimization are examples of some of the components that Engineous Software has
developed and can be included with iSIGHT-FD. You can also develop your own
components to use within the iSIGHT-FD environment. For more information on using
Engineous-provided components, see “Using Components” on page 109. For more
information on creating custom components, refer to the iSIGHT-FD Development
Guide.
Appendix C “Glossary”
Other Documentation
iSIGHT-FD Development Guide
Typographical Conventions
This book uses the following typographical conventions:
Convention Explanation
italics Introduces new terms with which you may not be familiar,
and is used occasionally for emphasis.
bold Emphasizes important information. Also indicates button,
menu, and icon names on which you can act. For example,
click Next.
UPPERCASE Indicates the name of a file. For operating environments
that use case-sensitive filenames (such as UNIX), the
correct capitalization is used in information specific to
those environments.
Also indicates keys or key combinations that you can use.
For example, press the ENTER key.
monospace Indicates syntax examples, values that you specify, or
results that you receive.
monospaced Indicates names that are placeholders for values that you
italics specify. For example, filename.
Convention Explanation
forward slash / Separates menus and their associated commands. For
example, Select File / Copy means that you should select
Copy from the File menu.
The slash also separates directory levels when specifying
locations under UNIX.
vertical rule | Indicates an “OR” separator used to delineate items.
brackets [ ] Indicates optional items. For example, in the following
statement: SELECT [DISTINCT], DISTINCT is an
optional keyword.
Also indicates sections of the Windows Registry.
braces { } Indicates that you must select one item. For example, {yes |
no} means that you must specify either yes or no.
ellipsis . . . Indicates that the immediately preceding item can be
repeated any number of times in succession. An ellipsis
following a closing bracket indicates that all information in
that unit can be repeated.
Mouse Conventions
This action... Means to...
Click Point to an object with the mouse pointer and momentarily
press the left mouse button.
Double-click Press the left mouse button twice.
Right-click Momentarily press the right mouse button.
Drag Press and hold the left mouse button while dragging item(s)
to another part of the screen.
SHIFT+Click Click an object to select it; then, press and hold the SHIFT
key. Click another object to select the intervening series of
objects.
CTRL+Click Press and hold the CRTL key; then, click a selection. This
lets you select or deselect any combination of objects.
Keyboard Conventions
Select menu items by using the mouse or pressing ALT+ the key letter of the menu
name or item.
Supported Platforms
For complete details on the supported platforms for iSIGHT-FD v2.5, refer to the
following website:
http://www.engineous.com/iSIGHT-FDv2.5platforms.pdf
Screen captures
Copies of logs
Japan
Telephone
Calling from within Japan 045.477.3300
Calling from outside Japan 81.45.477.3300
E-mail [email protected]
Korea
Telephone 82.2.3473.5784/5785
Germany
Telephone 49.(0)89.580.088.60
United Kingdom
Telephone 44.115.8759301
France
Telephone 33.0.1.46.91.83.56
If you have suggestions for improvement, or wish to point out specific errors, please
send your comments to:
Documentation Suggestions
Engineous Software
2000 CentreGreen Way, Suite 100
Cary, NC 27513
Name
Title
Company
Address
Telephone number
Email address
1 iSIGHT-FD Overview
This chapter provides a brief overview of the iSIGHT-FD system, including models
and the parts of iSIGHT-FD. It is divided into the following sections:
These characteristics are stored in a compressed XML file. This file contains
references to components and configuration/instance information (properties and
parameters) for specific use of each component. Additionally, relationships among the
components are also stored in the XML file.
iSIGHT-FD Design Gateway. This interface is the main iSIGHT-FD interface, and
allows you to create and manipulate models.
Library. This interface allows you to access components (which might not be
currently available on the Design Gateway) and published models.
This chapter describes the usage of the main iSIGHT-FD interface, the Design
Gateway, and some of the options that can be accessed when using it. It is divided into
the following sections:
When you start an iSIGHT-FD interface, the Logon dialog box appears, allowing you
to determine your session environment.
Standalone. This option, available at any time whether you have access to an ACS
in the FIPER environment or not, connects you to the local Library on your current
machine, and does not establish a connection with an ACS. This connection profile
is provided, by default, with iSIGHT-FD and does not need to be created.
FIPER ACS Connection. This option connects you to an ACS in the FIPER
environment, and provides access to a remote Library. It also requires you to enter
your user name (user ID) and password, if security is enabled on the ACS.
If you do not see a connection profile that corresponds to the correct ACS machine,
you can create the necessary connection profile as described in “Creating an ACS
Connection Profile,” on page 667.
Note: Although you may have multiple connection profiles defining connections to
multiple systems acting as an ACS, you can only actually connect to one ACS at a
time.
For more information on configuring an ACS, refer to the FIPER Installation and
Configuration Guide that matches your ACS combination.
• Windows: <isight-fd_install_directory>\bin\win32
• UNIX/Red Hat Linux: <isight-fd_install_directory>/bin
When executing from the command prompt, you can also use several
command line arguments. For more information, see “Using Available
Command Line Options,” on page 31.
The Logon dialog box appears.
2. Select the connection profile desired from the corresponding drop-down list. For
more information on connection profiles, see “Understanding Connection
Profiles,” on page 28.
Note: If you are using the software for the first time, a message may appear about
publishing components to the Library. You must click Yes. You will not see this
message the next time you start the Design Gateway. Also, you will not see this
message if you are connecting to an ACS in the FIPER environment.
The Design Gateway appears. In the following example, no model has been
specified.
Note: At start-up, you can have iSIGHT-FD load the last model you had open in
the Design Gateway. For more information on setting this option, see “Setting
Preferences,” on page 40.
Menu Bar. The menu bar contains numerous options for the construction and
manipulation of a model. For a complete list of menu options, see “Menu
Options,” on page 672.
Toolbar. The toolbar consists of the row of buttons that allow you to create
models, save models, execute models, and access your Library. For a complete list
of toolbar options, see “Toolbar Buttons,” on page 680.
Model Selector. This option, and the corresponding Model Properties button,
allows you to choose which loaded model you are viewing in the Design Gateway
and allows you to set properties for the selected model. It is part of the Model
Explorer. For more information, see “Selecting and Editing Models Using the
Model Explorer,” on page 64.
Model Explorer. This area displays the components that make up your model. You
can use this area to switch between components. For example, when you are
viewing the Parameters tab, you can change which component’s parameters you
are currently viewing using the Model Explorer.
Component Palette. This area stores icons representing access to components that
can be directly added to your model. The Drivers tab and Activities tab appear by
default, and contain Engineous-supplied components. You may add custom tabs to
this area (as described in “Adding Tabs,” on page 38).
Component Title Bar. This area contains the name of the component currently
being viewed, as well as buttons for altering or executing the component. For more
information on using these buttons, see “Component Title Bar Buttons,” on
page 681.
Canvas. This area exists on the Workflow (Workflow tab canvas) and Dataflow
(Dataflow tab canvas) tabs, and displays a graphic version of your model workflow
and dataflow.
Message Bar. This area displays error messages from Model Validation and other
status information. For more information, see “Using the Message Bar,” on
page 555.
Log Button. This button opens the Log Viewer dialog box, which allows you to
view the Design Gateway log file. For more information, see “Accessing the Log
File,” on page 558.
1. Click the Design Gateway Component Palette tab that will hold the new
component icon.
The Library dialog box appears. Your Library’s appearance (specifically, the
directory structure) will most likely differ slightly from the one shown below.
3. Navigate to the folder that contains the component you want to add.
4. Click the component to select it. The component is highlighted. In the following
example, the Script component has been selected.
Click the Add to Palette button at the bottom of the Library dialog box. The
component is added to the tab you selected in step 1. You can move the Library
dialog box to verify that the component was added to the Design Gateway.
Click the Add button on the toolbar at the top of the dialog box. The
component is added to the tab you selected in step 1. You can move the Library
dialog box to verify that the component was added to the Design Gateway.
Drag and drop the component from the Library dialog box to the desired tab on
the Design Gateway. You may need to move the Library dialog box to see the
location where you want to drop the component.
Note: For additional information on using the Library dialog box, see “Using the
Library Interface,” on page 533.
In the following example, the Script component has been added to the Activities
tab.
For more information on using components, see “Using Components,” on page 109.
1. Verify that the tab containing the component you want to manipulate is selected;
then, right-click the component icon. A menu appears.
2. Select one of the following options:
Copy To. This option reveals a submenu, which allows you to select which tab
will receive a copy of the component icon.
Move To. This option reveals a submenu, which allows you to select which tab
will receive the component icon. The component is removed from the previous
tab.
Remove. This option removes the component icon from the tab. It still remains
in the Library, and can be added at a later time.
Adding Tabs
To add a new tab:
1. Click the <New> tab. The Create New Tab dialog box appears.
Note: You can also right-click on a tab to create a new tab. For more information,
see “Manipulating Tabs,” on page 39.
2. Type the name of the new tab in the text box; then, click OK. The new tab is added
to the iSIGHT-FD Design Gateway immediately to the left of the <New> tab.
In the following example, a new tab called “Custom” has been created.
Manipulating Tabs
Once a tab is added to the Design Gateway, it can be manipulated in numerous ways
including, but not limited to, changing its name, adding a new tab, or moving an
existing tab.
Rename Tab. This option allows you to change the name of the existing tab.
Add New Tab. This option is the same as clicking the <New> tab as described
in “Adding Tabs,” on page 38. Once the tab is named, it is inserted to the left
of the <New> tab, at the end of the tab list.
Insert New Tab. This option is similar to the Add New Tab option. However,
instead of adding the tab to the end of the tab list, it adds it to the immediate
left of the tab that was right-clicked in step 1.
Move Tab to. This option allows you to move the tab to a location specified by
the submenu that appears. The submenu options are based on the number of
tabs you currently have on your Design Gateway, as well as the location of the
tab selected for moving.
Delete Tab. This option deletes the selected tab. You must confirm the option
by clicking OK on the Delete Confirmation dialog box.
Setting Preferences
The preferences allow you to set certain default behaviors in the Design Gateway and
for select components.
Note: The same preferences are also available from the Runtime Gateway. Any change
to the preferences accessed from either the Design Gateway or the Runtime Gateway
impacts the other interface. For more information on the Runtime Gateway, refer to the
iSIGHT-FD Runtime Gateway Guide.
“Accessing the Preferences Dialog Box,” on page 41 describes how to access the
Preferences dialog box, which lists all available preference options.
1. Select Preferences from the Edit menu. The Preferences dialog box appears.
“Setting Gateway Preferences,” on page 42. This section describes the options
that effect the Gateway (Design and Runtime) including the working directory,
parameter settings, and execution options.
General preferences
Parameter options
Execution
Sounds
2. Verify that FIPER Gateway is selected on the left side of the dialog box; then, set
the following options as desired:
Working Directory. You can specify your default directory, which will be the
default directory when you save or open a component.You can type the full
path directly into the corresponding text box, or you can navigate to the
directory using the Browse... button.
Show dialog when components are added to the palette. When this option is
selected, a verification dialog box appears every time a component is added to
the Design Gateway from the Library. For more information on using the
Library, see “Using the Library Interface,” on page 533.
Default Browser. This option allows you to set the location for your system’s
default web browser. The browser is used for viewing iSIGHT-FD’s online
help. You can type the full path to the browser directly into the corresponding
text box, or you can navigate to the directory using the Browse... button.
Create sub directories under model execution directory. When this option
is selected, sub directories are created under the model execution directory
specified in Model Properties. The default is true. For more information on
setting the model execution directory, see “Setting Model Properties,” on
page 65.
3 Click Parameters on the left side of the dialog box; then, set the following options
as desired:
Auto copy child parameters to parent. When activated, any parameter added
to a child component (a component within a process component) is
automatically added to the parent component. For example, if a Calculator
component is added within a Monte Carlo component, and a parameter is
added to the Calculator component, the parameter is automatically added to the
Monte Carlo component as well.
Type, Value, and Mode drop-down lists. When changes are made to a
parameter that is mapped to/from other parameters, iSIGHT-FD can
automatically adjust the corresponding attributes of the mapped parameters to
maintain consistency. For example, if you change a parameter's datatype from
Real to String, any mappings to/from other Real parameters would be invalid
until those parameters were also changed to Strings. You may also want
corresponding changes made when a value is changed or the mode is changed.
Preferences are available for whether you want iSIGHT-FD to always
automatically make the changes to mapped parameters, never automatically
make the changes (forcing a manual change), or to prompt you before
automatically making changes to allow you to abort the changes.
Show File type encoding on the Files tab. This option allows you to display
the type of encoding used when reading/writing a file parameter. The
information appears on the Design Gateway Files tab. You specify the type of
coding when you create a file parameter. For more information, see “Using
File Parameters,” on page 579.
How many digits ... Specify how many digits will appear after the decimal
point in real numbers. Changing the setting alters the example that appears
immediately below the option, showing you exactly how the numbers will
appear.
4. Expand the Execution folder on the left side of the dialog box; then, click the
General option.
Minimize the Design Gateway on job submission. When you execute your
model, the Design Gateway is minimized on your screen, leaving only the
Runtime Gateway visible. For more information on the Runtime Gateway,
refer to the iSIGHT-FD Runtime Gateway Guide.
Default Runtime Logging Level. This setting allows you to determine what
information is sent to your iSIGHT-FD log file. Components create different
levels of log messages. You can define the minimum log information setting
(Debug), and you will receive information on that particular level, and all other
levels above it.
that the local machine CPU is not overwhelmed by more work than it can
handle at any given time. If the local machine is a multi-processor machine, it
is very possible that you will want to increase this value to allow more work to
be done in parallel, resulting in the job being completed more quickly.
6. Click Parameter Selection on the left side of the dialog box; then, set the largest
number of parameters that will appear on the Runtime Gateway History and
Parameter tabs using the Max# of parameters text box. You can also specify
whether or not file parameters will appear on these two tabs using the Show File
Parameter option.
Note: You can add any parameters to those tabs at a later time using the Configure
button, which is located on both tabs. For more information, refer to the
iSIGHT-FD Runtime Gateway Guide.
7. Click Sounds on the left side of the dialog box; then, set the actions that you want
to play a sound.
8. Click OK to close the dialog box.
Approximations
File Directories
Mail Server
Local Results Database
Permissions (default settings)
2. Click Approximations; then, specify the default technique that will always be
selected when using the Approximation Wizard. This option does not set the
default technique for the Approximation component.
3. Click File Directories on the left side of the dialog box; then, define the symbolic
names and actual local directory names for the Design Gateway.
The “Shared File System” feature of iSIGHT-FD allows iSIGHT-FD to adjust how
it references a shared file. This adjustment is necessary due to the fact that Shared
or Network file systems are often named differently on different machines. Instead
of using an absolute path, which will be incorrect on some machines, this option
allows the file to be referenced as a path relative to a “Symbolic Root Directory”.
On each machine, the symbolic root directory is set to the location where that
machine mounts the shared file system. Each time the file is referenced by the
Design Gateway, the local symbolic root value is used to build the absolute path to
the file that is appropriate for that machine.
For more information on this option, see “Component Execution with File
Parameters,” on page 580.
4. Click Mail Server on the left side of the dialog box; then, set the following options
as desired. These options are related to the Mail component. If you specify this
information here, it will automatically be added to any Mail component that you
use (so you don’t have to manually enter it each time you use the component).
You can clear the contents of your database at any time by clicking the Clear all
data... button.
Important: This button deletes all tables from the current database and should be
used with caution.
For more information on the other database settings that are available, refer to the
iSIGHT-FD Getting Started Guide.
6. Click Default Permissions on the left side of the dialog box. The Default
Permissions options appear. These permissions are specifically for use with an
ACS in the FIPER environment. For more information, see “Understanding FIPER
Permissions Options,” on page 668.
DOE
Excel
Monte Carlo
Optimization
OS Command
Word
This chapter describes how to use the Design Gateway to create models, including
creating workflows, adding components, and executing. It is divided into the following
sections:
You will not always use every step. However, they are presented here for easy
reference.
This option creates a new model, with a parent level Task component. You can
also use the empty model that automatically appears in the Design Gateway.
Proceed to step 6.
The Root Component Selection dialog box appears, allowing you to choose the
parent level component from a list of components.
3. (optional) Type the name of the model in the Model Name text box. You can
specify the model name at any time as described in “Setting Model Properties,” on
page 65.
5. The new model is created in the Design Gateway. If you specify a name for the
model in step 3, the model name appears in the Model Selection area on the left
side of the interface. In the following example, a DOE component has been
selected as the parent component, and no model name has been defined.
1. Select Open from Disk... from the Design Gateway File menu. The Open dialog
box appears.
1. Select Open from Library... from the Design Gateway File menu.
Note: You can also drag-and-drop models from the Library into the Design
Gateway. However, you must access the Library in a different manner from the
menu option described in the previous step. For more information, see “Moving
Objects to the Design Gateway (Drag-and-Drop),” on page 535.
2. Navigate to the model you want to use; then, click it to select it. If you cannot
locate the correct model, verify that you are connected to the proper Library, or
contact the individual who published the model for more information.
In the following example, the I-beam example model has been selected.
4. (FIPER ACS environments only) Click the Edit Permissions... button to view the
access permissions for the selected object. For more information on permissions,
see “Setting Object Permissions,” on page 545.
5. Click Open. The model is loaded into the Design Gateway.
However, not all components are automatically added to the Component Palette. Some
Engineous-supplied components, as well as any custom components you create, are
stored, at first, in the Library. These components can be easily added to your Design
Gateway’s Component Palette for use in models. For more information, see “Adding
Components to the Design Gateway,” on page 33.
you can use submodels. For more information on these options, see “Copying Model
Information,” on page 86.
Note: You cannot change components that are referenced (either from the current
model or separate referenced models). For more information on these referencing
options, see either “Copying Model Information,” on page 86 or “Using Referenced
Models,” on page 101.
2. Highlight Change To in the menu that appears; then, click the New... option. The
Select New Component dialog box appears, listing the new component options.
Note: If you have already changed the component at least once, the menu that
appears will list the old component setting(s), if you told iSIGHT-FD to save these
old components (see step 4 below), and an option to edit the setting(s) list.
3. Select the component that will replace the existing component. If you are changing
a process component, only process components are listed. At the same time, if you
are changing an activity component, only activity components are listed. You
cannot change a process component into an activity component, or vice versa.
Copy existing parameters to new component. Select this option if you’d like
to carry over all parameters from the old component to the new component you
are about to create.
Delete existing component. Select this option if you want the existing
component permanently removed and replaced with this new component. If
you do not select this option, the existing component will be retained, and you
can change back to it at any time.
5. Click OK. You are returned to the Workflow tab, and the process component has
been changed.
You can repeat this step as many times as necessary, replacing components any number
of times. However, each time you replace a component, the old component selection
appears on the Change to menu (unless you selected to delete the old component in
step 4 above).
You can edit the list of old component settings by selecting the Edit List... option on
the Change to menu. The Edit Surrogates dialog box appears, allowing you to delete
components that you don’t want appearing on the Change to menu.
Note: You can also drag-and-drop a new component from the Component Palette
directly onto an existing component. This action opens the Specify Action dialog box,
which allows you to determine how the component will be used. You can change the
existing component, encapsulate the existing component inside of the new component,
or add the new component as a child component of the existing component. For more
information on encapsulation, see “Encapsulating Components,” on page 82.
1. Set up the component using its editor. For more information, see Chapter 4 “Using
Components”.
2. Define parameter information for the component (see Chapter 9 “Defining and
Mapping Parameters” for more information).
3. Set graph and table information prior to execution or after execution. For more
information, see “Using the Graph Templates Tab,” on page 106.
Note: Several options are available if you right-click components on the Dataflow tab.
These options are the same as those available on the Workflow tab. For more
information, see “Right-Click Menu Options,” on page 681.
The Dataflow tab canvas is displayed. The example below shows the Spring
Samples model in the <isight-fd_install_directory>\examples\models\generic
directory.
. This button allows you to show or hide the grid that appears behind the
information on the Workflow and Dataflow tabs. By default, the button is
depressed, which displays the grid.
. This button allows you to show or hide the file parameter mappings
displayed on the Dataflow tab. By default, the button is depressed, which
means the associated mappings are displayed.
. This button allows you to show or hide the parameter mappings (non-file
parameters) displayed on the Dataflow tab. By default, the button is depressed,
which means that the associated mappings are displayed.
Note: You can have both parameter buttons depressed (activated) at the same time.
However, you cannot turn off (raise) both options. One must always be active.
If desired, you can manually define the dataflow using the Dataflow Link
button .
Saving a Model
To save a model, simply perform one of the following actions:
Select Save from the File menu to save the model with its current name. If the
model is new, and you have not yet specified a name, a dialog box appears asking
for this information. You can also click the button on the Design Gateway
toolbar to save your model.
Select Save As... from the File menu to save the model with a new name. The
model is saved.
Saving a Component
To save a component:
2. Select Save As from the menu that appears; then, specify the name and location for
the component. The component is saved.
Note: Components are saved as model files (*.zmf), and, once reopened, are displayed
by themselves in the Design Gateway. For information on using a saved component to
create a model, see “Encapsulating Components,” on page 82.
Note: If you are connected to an ACS in the FIPER environment, you can also
manipulate and control model execution using the Command Line Client. The
Command Line Client is a simple, text-based interface that provides access to most
functions of the FIPER ACS. For more information on using this interface, see
Chapter 10 “Using the Command Line Client”.
The button on the Design Gateway toolbar can be used to execute either the
entire model or the selected component. Clicking the button itself executes the
model. Clicking the arrow next to the button allows you to determine if the model
or the component is executed, or if you want to use the configure and run options.
For more information on the configure and run options, refer to the iSIGHT-FD
Runtime Gateway Guide.
The button on the Component Title Bar can be used to execute the selected
component in the workflow. Clicking the button itself executes the component.
Clicking the arrow next to the button allows you to use the configure and run
options. For more information on the configure and run options, refer to the
iSIGHT-FD Runtime Gateway Guide.
Note: Selecting and executing the root component (the top-level component) runs
the entire model, and is, in essence, the same as using the button described
above.
Right-click a component in workflow; then, point to Run and select one of the two
options that appear. This menu option behaves the same way as the button
described above. You can either immediately execute the selected component or
use the configure and run options. For more information on the configure and run
options, refer to the iSIGHT-FD Runtime Gateway Guide
Note: Selecting and executing the root component (the top-level component) runs
the entire model, and is, in essence, the same as using the button described
above.
Viewing Results
Results of a model execution can be viewed using the iSIGHT-FD Runtime Gateway.
The following main options are available from this interface:
For more information on viewing model execution results, refer to the iSIGHT-FD
Runtime Gateway Guide.
Note: You can also use the Windows menu on the Design Gateway toolbar to switch
between loaded models.
2. Select the model you wish to view. The model information appears on the Design
Gateway. Remember, only models that have been loaded into iSIGHT-FD appear
on this list. For more information on opening models, see “Opening an Existing
Model,” on page 54.
1. Verify that the currently loaded model is the one whose properties you wish to edit.
If not, select the correct model using the Model Explorer.
2. Select Model Properties from the Design Gateway Edit menu, or click the
button adjacent to the Model Selector. The Model Properties dialog box appears.
This dialog box is divided into three tabs: General, Publish Info, and Execution.
Model Name. This represents both the name of the model as it will appear on
the Model Selector and how it will be named when published to the Library.
Click the Use all root component parameters check box to expose all of the
listed parameters.
Clear (if necessary) the Use all root component parameters check box; then,
individually select the parameters that will be exposed from the list at the
bottom of the dialog box.
5. Click the Execution tab; then, set the following options, as desired:
Model Run Directory. Enter the directory in which all work items should
execute. If a directory is entered at the model level, iSIGHT-FD will check to
see if any components in the model have their execution directories explicitly
set. If any are found, a dialog box appears prompting you to override that
setting with the model level setting.
If you specify a model run directory, the Create sub directories option
becomes accessible. Select this option to create sub directories under the
execution directory. The default value for this option can be changed in the
Preferences options. For more information, see “Setting Gateway
Preferences,” on page 42.
Use a fixed seed. The seed can be fixed by clicking this check box and
specifying the seed manually in the corresponding text box. If this check box is
not activated, the seed is determined randomly.
Double-click a component to open its editor. For more information, see Chapter 4
“Using Components”.
Left-click a component to select it; then, left click the component again. A cursor
appears allowing you to rename the component. You can also right-click the
component and select the Rename option.
Note: If the component you want to add is not displayed on the Component Palette,
you need to add it from the Library. For more information, see “Adding Components to
the Design Gateway,” on page 33.
To create a workflow:
2. Click the Monte Carlo component icon; then, drag it until it is over the proper
place in the workflow. The workflow arrow is highlighted when the component is
placed on top of it.
4. Click the Activities tab; then, repeat the drag and drop process with the Excel
component icon, placing it on the workflow arrow beneath the Monte Carlo
component.
Note: This step assumes that you have set your Design Gateway to view the
To disable a component:
2. Select Disable from the menu that appears. The component appears grayed out in
the workflow.
3. To enable the component, right-click on the component; then, select Enable from
the menu.
1. Click the Workflow Link button to the left of the Workflow tab canvas. When
2. Click the component that will be the “from” component; then, drag your mouse
pointer to the “to” component. An arrow appears along the path of your mouse
pointer.
3. Click the “to” component. The Workflow tab canvas is reconfigured to show a
connection between the two components.
1. Verify that the model you want to configure is loaded into the Design Gateway.
The following example shows the I-Beam example which can be found in the
following directory:
<isight-fd_install_directory>\examples\models\generic
2. Right-click the section of the workflow that you want to set conditions for; then,
select Edit Condition from the menu that appears.
Always execute. This setting is the default. The workflow will always be
executed. Proceed to step 7.
Never execute. This option stops the workflow from being executed. The rest
of the workflow is still executed. Proceed to step 7.
Conditionally execute. This option allows you to specify parameter
information for controlling the workflow. Proceed to the next step.
4. Select a parameter from the drop-down list. You can select any output parameter,
in/out parameter, or output file parameter.
6. Determine whether you want the right side of the condition to be a constant or a
parameter using the corresponding radio buttons; then, type the constant in the text
box or select the parameter from the drop-down list that appears.
Note: If you set up a conditional, and that condition fails, the rest of the workflow
is not executed.
7. (optional) Customize the label for the workflow altering the text string in the
Label text box. The specified label will appear below the workflow arrow on the
Design Gateway Workflow tab.
Be aware of the following actions that automatically populate this text box:
If you select the Never execute option in step 3, the text string Don’t execute is
added to the Label text box. You can change this label, if desired.
8. Click OK. You are returned to the Design Gateway, and your condition is labeled
(if applicable).
In the following example, a conditional workflow has been set up after the
Calculator component called Condition1.
Pausing a Workflow
It is possible to pause your workflow execution at a certain point to review specific
data. If the data is satisfactory (by the means that you define), you can then have the
workflow execution continue. iSIGHT-FD provides a component for this functionality
- the Pause component. Simply add this component to the point in your workflow
where you want the execution pause to occur. For more information on using this
component, see “Using the Pause Component,” on page 393.
In the following procedure, a sample parallel workflow is created using the I-Beam
example from the <isight-fd_install_directory>\examples\models\generic directory.
Note: The I-Beam example includes workflow annotations. The workflow annotations
are hidden for clarity in the following examples. For more information on workflow
annotations, see “Adding Annotations to the Workflow,” on page 80.
Note: You can view an existing parallel workflow in an actual sample problem by
viewing the AirplaneSizingDOE.zmf file in your
<isight-fd_install_directory>\examples\models\generic directory.
1. Verify that the model you want to configure is loaded into the Design Gateway.
Again, the following example shows the I-Beam example.
In this example, you will create a parallel workflow within the Compute all Beam
Elements Loop component.
2. Click the Activities tab on the Design Gateway; then, drag any component into the
area below the Loop component and above the Calculator and Script components
in the subflow.
In the following example, an Excel component has been added to the canvas.
Now you need to create the actual parallel workflow for this new component.
3. Click the Workflow Link button on the left side of the Workflow tab.
4. Click the Start icon to the left of the Calculator icon in the Loop component
subflow.
5. Drag your mouse pointer to the newly added Excel component; then, click the
Excel component.
6. Click the Workflow Link button; then, click the Excel component.
7. Drag your mouse pointer to the Stop icon to the right of the two Script icons in
the Loop component subflow; then, click the Stop icon.
9. (optional) Set any conditions for the new workflow. For more information, see
“Setting Conditional Workflow Options,” on page 71.
The annotations are saved with the model. If a model is copied, the annotations are also
copied. The annotations can be viewed (or hidden) from the Runtime Gateway.
However, they cannot be edited or removed from this interface. For more information
about the Runtime Gateway, refer to the iSIGHT-FD Runtime Gateway Guide.
3. Enter the information that will be displayed in the large Note text box.
4. To change the background color of the annotation, select a color from one of the
three tabs in the Color area: Swatches, HSB, and RGB.
View a large annotation: Double-click the annotation to view the text in the
Annotation Editor dialog box. Since there is a limit to the amount of
information the annotation can display directly on the Workflow tab, this
option allows you to view the information in its entirety.
Edit an existing annotation: Double-click the annotation to launch the
Annotation Editor dialog box. Change the annotation, as desired; then,
click OK. The annotation is updated.
To Remove the annotation: Select the annotation; then, click the button to
the left of the workflow. You can also use the Delete key on your keyboard.
To Hide all of the annotations, click the button to the left of the workflow.
Clicking the button again brings the annotations back into view.
Encapsulating Components
The process of encapsulating components allows you to put existing workflow
components into a new process component. For example, if you’ve configured an
Excel component, and you now want to place that component into a new DOE
component, you can accomplish this task using encapsulation.
Note: You can also drag-and-drop a component from the Component Palette onto an
existing component to encapsulate it.
To encapsulate a component:
1. Select the component or components on the Workflow tab canvas that you wish to
encapsulate.
2. Verify that the Excel component is selected (the component that will be
encapsulated); then, select Encapsulate from the Edit menu.
Note: You can also right-click the component to be encapsulated and select
Encapsulate from the menu that appears.
3. Select the process component that you wish to contain the existing component or
components; then, click OK. The new process component is added to the
Workflow tab canvas, and the existing component is moved within the new
component. In the following example, an Optimization component has been
selected to encapsulate the existing Excel component.
. This button controls how process components are displayed. When activated,
the child components contained in a process component are displayed below the
parent component. When deactivated, only the parent process component is
displayed. You must double-click on the parent component to display its contents.
Note: This display feature only affects process components below the main
component. For example, the main Task component displays its child components.
However, a Monte Carlo component within the main task would need to be
double-clicked to display its components.
. This button represents the typical usage setting when using the canvas, and
allows you to select components and workflow arrows. You should use this button
when you are working in a different mode, and wish to return the mouse pointer to
its default setting. For example, if you were zooming in on the canvas using the
dynamic zoom button , and you have achieved your desired zoom factor and
want to select a component, click this button. The mouse pointer is reset to .
. This button (Pan) allows you to pan the canvas. When clicked, the mouse
pointer changes, and clicking a part of the canvas “grabs” it. Any mouse
movement after the “grab” relocates the canvas.
. This button is a dynamic zoom. If you click this button, and then click inside
the canvas, the mouse pointer changes to a magnifying glass. Moving the pointer
down zooms in on the canvas, while moving the pointer up zooms out on the
canvas.
. This button zooms in on the canvas, using the current center of the canvas as
the focal point (the center is the midpoint on the canvas, not the midpoint based on
your current workflow).
. This button zooms out from the canvas, using the current center of the canvas
as the focal point (the center is the midpoint on the canvas, not the midpoint based
on your current workflow).
. This button fits your workflow to the current size of the canvas. It achieves this
goal either by shrinking or expanding the workflow, based on the size of the
workflow and the size of the canvas.
. This button resets all scaling and zooming to their original position.
. This button (Airplane View) allows you to easily navigate large models that
don't completely fit in the Workflow tab canvas. When clicked, a zoomed out view
of the model workflow appears in a small window. You can pan around the entire
model (as described in the previous option) inside of this window.
. This button allows you to add annotations to the current workflow. For more
information about working with annotations, see “Adding Annotations to the
Workflow,” on page 80.
. This button deletes the selected annotation from the current workflow.
. This button allows you to hide or show the annotations that appear on the
current workflow.
. This button allows you to show or hide the grid that appears behind the
information on the Workflow and Dataflow tabs. By default, the button is
depressed, which displays the grid.
You can also reference published models in your current model. For more information,
see “Using Referenced Models,” on page 101.
“Using Submodels,” on page 90. This option is useful if you plan on creating a
referenced component and adding it to multiple places in your model, but you
don’t know the exact place where you will add the copies.
“Understanding the Impact of Referencing on the Model,” on page 99. This section
describes changes to your workflow that occur when referencing components or
using submodels.
This option is useful if you are making single-use copies of components, and the copies
need to contain the essence of the original component, but must not affect the original
when they are changed in any way.
1. Right-click the component that you want to copy; then, select Copy from the menu
that appears.
Note: You can also click the Copy button on the toolbar.
2. Right-click the workflow arrow that represents the location for the copied
component; then, select Paste Copy from the menu that appears.
Note: You can also click the Paste Copy button on the toolbar.
A copy of the component is added to the workflow. In the following example, the
component labeled Compute a, ix, iy was copied to the Loop component subflow.
No other changes are made to the workflow by iSIGHT-FD. Any changes made to
either component will not be reflected in the other component. If you want to
create a copy of the component that links the two components, automatically
updating one when changes are made to the other, see “Creating Reference Copies
of Components,” on page 88.
Note: If you wish to reference a component numerous times, and you don’t yet know
all of the places in your model where you will use the referenced component, it is
recommended that you make the component a submodel explicitly. This process
creates a submodel using the component, but it does not automatically reference the
component in the workflow. Basically, you are simply getting it ready for future use.
For more information, see “Using Submodels,” on page 90.
1. Right-click the component that you want to copy; then, select Copy from the menu
that appears.
Note: You can also click the Copy button on the toolbar.
2. Right-click the workflow arrow that represents the location for the copied
component; then, select Paste Reference from the menu that appears.
Any changes made to either component are made to the other component. If you
want to create a copy of the component that created a non-referenced copy of the
component, see “Creating Independent Copies of Components,” on page 86.
Notice also that a new item labeled Submodels has been created in the Model
Explorer on the left side of the Design Gateway. Expanding this item reveals that it
contains the referenced component.
Using Submodels
Submodels are portions of the current model that are designated for use in other parts
of the model. This designation allows a single instance of a component to be easily
used in numerous places in your workflow. Any changes made to the original
component(s) that comprises the submodel are automatically seen everywhere that the
submodel is used. For example, if you create a submodel of a Calculator component
and reference it in three different places in your model, a change to the component in
any of the locations is reflected in each of the other locations. This option is useful if
you know you want to use a component in many different places in your workflow, but
you do not yet know where all the instances will reside. For instructions on creating a
submodel, see “Creating a Submodel” on this page.
You can create submodels using either process or activity components. If you create a
submodel of a process component, all of the components that are contained within its
subflow are included, and changes to these subflow components are reflected in all
locations that this subflow references. For example, if you create a submodel of a Loop
component that contains a Calculator component, changes to either of the components
are reflected in all referenced instances.
When you add submodels to your workflow, you typically insert a Reference
component into your workflow in the desired location, and then specify the submodel
to be referenced using the component editor. This option gives you the ability to update
parameter values within the Reference component. For more information, see “Adding
Submodels Using the Reference Component Editor,” on page 93.
However, you can quickly add submodels, without using the Reference component
editor. This option allows you to quickly add submodels to your workflow if no
parameter changes are necessary within the Reference component editor. The
Reference component is automatically configured. For more information, see “Adding
Submodels Using the Model Explorer,” on page 96.
Creating a Submodel
Before you can use a submodel in your model, you must first create the submodel,
specifying which existing components will be included. In general, when process
components are made into submodels, they also contain all of the activity components
in their subflow. When an individual activity component is made into a submodel, only
that particular activity component is included. You cannot create a submodel that
contains multiple activity components without using a process component.
To create a submodel:
1. Right-click the component that you want to make a submodel; then, select Make
Submodel from the menu that appears. A reference component is added at the
location of the component, and a dotted line runs from below the Reference
component to the original component. In the following example, a Data Exchanger
component has been made into a submodel.
At this point, your model and its workflow are basically unchanged. You have
simply designated the selected component for future use as a referenced
component.
2. Proceed to one of the following sections for information on using the submodel
within your model:
Note: iSIGHT-FD can be made to automatically add and configure the Reference
component. For more information, see “Adding Submodels Using the Model
Explorer,” on page 96.
1. Verify that the submodel you wish to use is listed in the Submodels node in the
Design Gateway Model Explorer. If you need to create the submodel, see
“Creating a Submodel,” on page 91.
2. Drag and drop the Reference component icon from the Component Palette to the
desired location in your workflow. If the Reference component is not currently on
your component palette, you must add it from the Library (as described in “Adding
Components to the Design Gateway,” on page 33).
4. Click the Choose Model... button. The Select Reference Model dialog box
appears.
5. Expand the Internal Submodels directory on the left side of the dialog box; then,
select the submodel you want to use.
For more information on the other options available with the Select Reference
Model dialog box, see “Using the Reference Component,” on page 401.
6. Click the Select Model button. You are returned to the Reference component
editor, and submodel parameter information is now displayed at the bottom of the
editor.
7. Update the parameter values or file information, as desired. For more information
on parameters used in this component, see “Understanding the Impact of
Referencing on the Model,” on page 99.
8. Click OK.
You are returned to the Design Gateway, and the Reference component and the
selected submodel now appear in the workflow.
1. Right-click the submodel you want to add in the Model Explorer on the left side of
the Design Gateway; then, select Copy from the menu that appears.
2. Right-click the workflow arrow that represents the location for the submodel; then,
select Paste Reference from the menu that appears.
Note: You can also create a non-referenced (independent) copy of a submodel. For
more information, see “Adding Non-Referenced Copies of Submodels” on this
page.
1. Right-click the submodel you want to add in the Model Explorer on the left side of
the Design Gateway; then, select Copy from the menu that appears.
2. Right-click the workflow arrow that represents the location for the submodel; then,
select Paste Copy from the menu that appears.
Note: You can also click the Paste Copy button on the toolbar.
The Reference component is used for all internal model referencing, including
referenced copies of components and submodels. The Reference component can
also be used to reference models published in your Library and models in partner
Libraries when using an ACS in the FIPER environment with the B2B option. For
more information, see “Using the Reference Component,” on page 401.
For more information about using individual components, see “Using Components,”
on page 109.
Click the component; then, click the Component Properties button on the
Component Title Bar.
Right-click the component on either the Workflow tab or in the Model Explorer;
then, select Properties from the menu that appears.
Double-click the component icon on the Workflow tab or in the Model Explorer.
Click the component; then, select Component / Editor from the Design Gateway
View menu.
Click the component; then, click the Component Editor button on the
Component Title Bar.
Right-click the component on either the Workflow tab or in the Model Explorer;
then, select Edit from the menu that appears.
For more information component editors and the options they contain, see Chapter 4
“Using Components”.
Overview
iSIGHT-FD has the ability to capture an organizations’ best practices in the form of
process models. These models can be stored, versioned, and reused to build larger
processes. Process models can encapsulate known and tested design processes, and
then be easily reused (referenced) in other processes without in-depth understanding of
the process details. This concept is known as the “encapsulation” of processes (not to
be confused with the Encapsulation option available in iSIGHT-FD).
You can also reference portions of the current model for use within that model (as
opposed to referencing the entire model). For more information, see “Copying Model
Information,” on page 86.
Internal. This type of references involves sub-parts (submodels) of the model being
reused within the model itself.
External. This type of reference specifies a model and version in the Library. The
external model is distinct from the local model. The external model must have
been published to the Library before it can be configured as a reference in the local
model.
configured by the ACS administrator. A federated reference must name the partner,
model library name, and version. Note that federated references name models
which do not exist in the local users Library - they exist only at the partner site. For
more information on FIPER federation, refer to the FIPER Federation (B2B)
Guide.
1. Add a Reference component to your model, at the point in your workflow where
you want the referenced model analyzed. If the Reference component is not
available on your Design Gateway, you need to add it from the Library as
described in “Adding Components to the Design Gateway,” on page 33.
2. Configure the Reference component to use the desired reference model. For more
information on using this component, see “Using the Reference Component,” on
page 401. Once the referenced model is defined, your workflow is updated to show
the model, if and only if you have the proper permissions. Federated (B2B)
references do not show the referenced model’s workflow. For more information on
how referenced models effect your workflow, see “Understanding the Impact of
Referenced Models On Your Workflow” on this page.
3. View the referenced model information, as desired. This action is handled using
the Reference component editor. For more information on using this editor, see
“Using the Reference Component,” on page 401.
The referenced model may retain all of its details when it appears in the local model,
including its complete subflow, root component name, parameters, icons, etc., based on
your permissions and the nature of the referenced model. You can also access the
component editors for components in the referenced model, view parameter mappings,
etc.
The Reference component takes on the same input and output parameters as the
referenced model (that is, when a referenced model is selected, the component
adds exactly corresponding input and output parameters to its own component
instance). Also, the referenced parameter names are always the referenced model
parameter names.
Note: If you do not want to use the referenced model parameter names in the local
model, you can use the Mapping tab to change the parameter setup.
The Reference component maintains a link to the referenced model by storing the
referenced model name, version, and partner ID (for B2B references) as properties.
The referenced model can be replaced by any model that has like-named
parameters at the root. In other words, the referenced model parameters are
recognized by name, so any model with the same root parameter names can be
substituted. In effect, the root parameter names of the model define its “interface”.
Any models with the same “interface” can be substituted.
In essence, you create empty graphs or tables, which are then automatically transferred
to the Runtime Gateway at execution, and populated with model data as appropriate.
Important: Graphs and tables created on this tab are saved with your model, and can
be accessed the next time the model is loaded into iSIGHT-FD. Graphs and tables
created on the Runtime Gateway are not saved with the model, and must be recreated
the next time the model is opened.
If you create a graph or tab that uses a parameter which is later deleted, you are
informed about the now invalid graph or tab in the Design Gateway Message Bar at the
bottom of the interface. Also, the graph is not generated by the Runtime Gateway
during execution.
For more information on using this tab, and on the Runtime Gateway in general, refer
to the iSIGHT-FD Runtime Gateway Guide. You can also view this information in the
Runtime Gateway online help. To access this help interface, select Runtime Gateway
from the Design Gateway View menu to open the Runtime Gateway interface; then,
select Contents from the Runtime Gateway Help menu.
4 Using Components
This chapter describes the usage of the Engineous-supplied components that are
included with a standard iSIGHT-FD installation. It is divided into the following
sections:
Introduction
Components are an essential part of model construction. Numerous components have
been developed by Engineous Software, and are included with iSIGHT-FD. These
components are accessed using the Design Gateway, but each has a different editor and
options that can be configured.
All iSIGHT-FD components can be divided into two types: process and activity.
Process components are components that are designed to contain a workflow, which is
executed some number of times depending on the component’s own specific logic,
essentially “driving” the execution of that workflow (thus, they are also sometimes
referred to as drivers or design drivers). This chapter discusses six Engineous-supplied
process components, DOE, Loop, Monte Carlo, Optimization, SDI, and Task.
The following list provides a brief overview of the components described in this
chapter. All components are activity components unless otherwise noted.
Note: The components available to you may differ slightly based on your iSIGHT-FD
license.
DOE. This component is a process component that allows you to use Design of
Experiment (DOE) techniques to improve your design.
Monte Carlo. This component is a process component that allows you to use the
Monte Carlo Quality Engineering Method (QEM) to improve your design.
Optimization. This component is a process component that provides access to
numerous optimization techniques to improve your design.
Calculator. This component allows you to define computations that are not
provided by a separate part of your model.
COM. This component provides direct access to the Windows operating system
(through COM objects).
Data Exchanger. This component allows you to move data between iSIGHT-FD
parameters and text files easily and efficiently.
Database. This component allows you to retrieve data from an existing database
and use the data inside an iSIGHT-FD model.
Excel. This component allows you to map parameters and execute macros using
information from an Excel spreadsheet.
iSIGHT File Parser. This component allows an iSIGHT-FD model to use file
parsing programs (FDL) created using the iSIGHT Advanced Parser. This feature
is mostly to aid in converting iSIGHT models into iSIGHT-FD models.
Mail. This component allows you to send e-mail messages containing parameter
information. This is often used to send a “job done” notification for a job that may
have run for many days.
Script. This component allows you to execute Java code in your model. It is used
to perform calculations that are too complex for the Calculator component, such as
those involving loops or conditional statements.
Word. This component allows you to populate Word document files (*.doc) with
the values of iSIGHT-FD parameters.
1. Select the component whose properties you want to edit; then, click the Properties
button , or select Properties from the Design Gateway View/Component menu.
The Properties dialog box appears.
This example shows an Excel component’s properties. The properties are the same
for all activity components. The dialog box is divided into five tabs: Execution,
Affinities, Icon, Description, and Details.
Note: Once open, the Properties dialog box can be toggled between different
components by selecting a new component on the Design Gateway Model
Explorer. If you want the component that is currently displayed to always be
displayed no matter what component is selected on the Model Explorer, click the
Lock check box at the bottom of the dialog box.
Delay before execution. This option allows you to set a length of time that the
component will wait before it executes. This is typically used for demos or
load testing.
Timeout. Execution of the component will stop when this time limit is
reached. If set to 0, no timeout limit is enforced. Typically, you would only set
this property if you are concerned that this component could encounter
problems during execution that would not allow it to complete and return. If it
is necessary to set this limit, it should be set to a time much greater than the
expected normal time for execution so that the component is not incorrectly
terminated.
If the model is being executed in the FIPER environment, FIPER will attempt
to execute the component on a different FIPER Station if one is available.
Maximum parallel batch size. This option sets the maximum number of
design points (subflow executions) that a process component can submit if it
supports parallel execution. If the Automatic check box is selected,
iSIGHT-FD will automatically determine the best number of executions to run
in parallel. This is the recommended setting.
If you do not select the Automatic check box, you must enter the maximum
number of design points to be run in parallel. The value must be greater than or
equal to one (1).
Note: Some process components may run fewer subflows than the maximum;
and some process components may run only a single subflow at a time. Refer
to the process component documentation for details on parallel execution
options.
3. Click the Affinities tab. This tab contains information that helps a component
running in an ACS environment find the proper FIPER Station (and in doing so, a
remote computer) for execution.
Note: The affinities for the FIPER Station are set in the station.properties
file in the FIPER installation directory. For more information on using FIPER
Stations, refer to the FIPER Installation and Configuration Guide that matches
your ACS combination.
4. Set any of the following options (in some cases, these options are automatically
set) for execution in the FIPER environment:
Operating System. Specify the type of operating system that the component
will search for when executing using the corresponding drop-down list. You
can choose either Windows or UNIX (UNIX also includes Red Hat Linux).
Name. Specify the name of the operating system that the component will
search for when executing using the corresponding drop-down list. For
example, you can specify Windows NT, Windows 2000, or Windows XP.
Note: This option is disabled if the Any option is selected from the Operating
System drop-down list.
Version. Specify the version number of the operating system/name
combination that the component will search for when executing using the
corresponding drop-down list.
Note: This option is disabled if the Any option is selected from either the
Operating System or Name drop-down lists.
Station Name. Specify the name of the machine that the component will
search for when executing.
Other. Specify any additional information that the component must search for
during execution. You can use this setting for custom keywords. Any character
string can be used. Only Stations that have this matching keyword defined as
an affinity are used during execution.
Group Name. You can define a group to execute various components (within
the same level of the model hierarchy) on the same machine simply by
specifying a name for the group. For any defined group, iSIGHT-FD will
determine which FIPER Station to execute those components on based on the
combination of all of the other affinities for all components in the group. For
example, if component A is specified to run only on Windows, component B
specifies an “Other” affinity of “CAE”, and both A and B specify the group
“groupAB”, then iSIGHT-FD will only select a FIPER Station that is running
on Windows and that says it supports “CAE” on which to execute both
components A and B. If no Station exists to support the combined affinities,
none of the components in the group will be executed and the job will fail for
this reason.
5. Click the Icon tab; then, change the default icon, if desired.
6. Click the Description tab; then, enter a text description of the component. You can
enter any desired text.
7. Click the Details tab. This tab shows you information about the component type.
The information displayed includes the component’s full name, display name,
version number, icon, and description.
8. Set the When Loading Model Use option. This option and its associated
drop-down list gives you the ability to specify which version of the component to
use, if the component has more than one published version in the Library. You can
set this option for each component in your model. When the model is reloaded, the
version of the component that is fetched from the Library is based on this setting.
The Latest Version. This option always loads the most recent version of the
component from the Library. It is the default setting.
This Specific Version. This option always loads the version specified in the
Version field (to the left of the drop-down list) when the selection is originally
made.
9. Click OK to close the dialog box and save your changes. Click Apply to save your
changes, but keep the dialog box open.
DOE
Excel
Monte Carlo
Optimization
OS Command
Word
1. From the iSIGHT-FD Design Gateway, select Preferences from the Edit menu.
The Preferences dialog box appears.
2. Expand the Components folder on the left side of the dialog box; then, select the
component whose preferences you wish to set.
For more information on this option, and all other options available with this
component, see “Using the DOE Component,” on page 122.
Default workbook close option. Determine the default behavior for the Excel
workbook that is referenced with the component. You can choose to leave the
workbook open after execution, or to close it after each job or after the full
execution of the component.
For more information on this option, and all other options available with this
component, see “Using the Excel Component,” on page 320.
For more information on this option, and all other options available with this
component, see “Using the Monte Carlo Component,” on page 158.
Scaling Method. Determine if you want to use the automatic method for handling
scaling. If this option is not selected, manual scaling is used.
For more information on this option, and all other options available with this
component, see “Using the Optimization Component,” on page 173.
Adding Interpreters
To add an interpreter:
2. Click the Add button located on the right side of the dialog box.
3. Type a name for the interpreter in the Name text box. The name is displayed in the
OS Command Type drop-down list on the OS Command component editor.
4. Type the full path to the interpreter in the Executable text box. You can also
choose the executable by clicking the Browse... button and navigating to the
interpreter.
5. Type the interpreter extension in the Extension text box. For example, Windows
batch files need to have the extension of “bat”.
6. Type any default arguments for the interpreter in the Arguments text box.
Note: During the execution of the component, the executable for the interpreter is
loaded from the OS Command preferences. If the interpreter is unavailable in the
preferences, then the executable information from the component is used. An error
message is generated if the interpreter is not found during execution of the
component.
7. Set the available options in the affinities area. These options are located in the
bottom half of the dialog box and are used to control which FIPER Stations may
execute the component when using an ACS in the FIPER environment. You can
specify the host name, operating system, software, or other information pertaining
to the component. For more information about the affinities, see “Editing
Component Properties,” on page 113.
8. Click OK to save your changes.
For more information on these options, and all other options available with this
component, see “Using the OS Command Component,” on page 377.
You can also delete or edit existing interpreters. To delete an interpreter, select the
interpreter from the list; then, click the Delete button. To edit the preferences for an
interpreter, select the interpreter from the list; then, change the appropriate
information.
Default document close option. Determine the default behavior for the Word file
that is created with the component. You can choose to leave the file open after
execution, or to close it after each job or after the full execution of the component.
Note: If you have not added the Word component to your Component Palette, this
preference option will not appear on your Preferences dialog box.
For more information on this option, and all other options available with this
component, see “Using the Word Component,” on page 430.
“Opening the Editor and Using the General Tab,” on page 124
Note: This component has default preferences which you can set based on your needs.
For more information, see “Setting DOE Component Preferences,” on page 118.
Overview
Design of Experiments is a general term that refers to any of the many formal methods
available for setting parameter values in a set of experiments. In iSIGHT-FD, a DOE
experiment is defined as an execution of the workflow defined within the DOE
component. You can use the DOE component in iSIGHT-FD for the following
purposes:
parameters you want to study (i.e., the input parameters that may impact
performance/quality)
Available Techniques
The following Design of Experiments techniques are available in iSIGHT-FD
(although all techniques listed below may not be included in your installation):
For more detailed information on these techniques, see “DOE Reference Information,”
on page 692.
Note: Techniques can be added to the DOE component by publishing new “DOE
Technique” plug-ins to the Library. For more information, refer to the iSIGHT-FD
Development Guide.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Component Editor dialog box appears.
The editor is divided into four tabs: General, Factors, Design Matrix, and Post
Processing. The General tab allows you to select a technique, set technique
options, and set general DOE execution options (see step 2). The Factors tab
allows you to select factors to study for your design. The Design Matrix tab
provides options for viewing and modifying the generated design matrix. The Post
Processing tab allows you to specify actions taken after running your set of
experiments. The options available on each of these tabs are defined in greater
detail in the following sections.
2. Select the desired technique using the DOE Technique button. The technique’s
options appear in the Technique Options area, and information about the technique
appears in the Technique Description area on the right side of the editor.
Note: You can set default behavior for this option using the component preferences
as described in “Setting DOE Component Preferences,” on page 118.
4. Set the options for your technique as desired in the Technique Options area. For
more information on these options, see “Setting Technique-Specific Options,” on
page 138; then, return to this section.
5. Set the following options in the Execution Options area of the General tab:
Execute DOE design points in parallel. If selected, all of the design points
defined by the design matrix will be submitted for execution simultaneously.
You may need to clear (deselect) this option if components within the DOE
subflow have license limitations or other requirements that mandate only one
execution at a time.
Action when design point fails. If a design run fails during execution of the
DOE technique, you can choose to have iSIGHT-FD ignore the failed run, fail
the entire execution, retry the failed run (a specific number of times), or
replace the failed run by re-executing with a specified percentage modification
of the failed run.
6. Click the Advanced Options... button. The Advanced Execution Options dialog
box appears.
Execute designs in random order. Select this option if you want the design
points defined by the design matrix to be executed in random order.
Read response values from file (don’t execute subflow). Select this option if
you do not want the DOE component to actually execute an iSIGHT-FD
subflow for each design point, but to instead read the response values for each
design point from a specified file. You can locate the file using the Browse...
button. The format of the file must be a first row with parameter names and
each subsequent row containing the values for the parameters for that design
point. This feature is useful for when you have a complete data set (input and
output values) already compiled and simply want to use DOE as a
post-processing tool. This capability is more directly accessible using the Data
File technique and selecting the File contains responses option. For more
information on this technique, see “Setting Technique-Specific Options,” on
page 138.
Allow the following to be turned off by parameters. This option allows you
to de-activate (turn off) the selected types of design parameters (factors,
responses) using input parameters to the DOE components. If this option is
selected, boolean input parameters will be created in an Active Factors/Active
Responses aggregate under the Mapped Options and Attributes aggregate
parameter. The parameters are selected by default. If any of the parameters are
not selected at runtime, then those design parameters will not be used during
execution.
The tab presents a table of available input parameters to select as factors to study,
along with columns for attributes to specify for each factor. The attributes to
specify are determined by the DOE technique being used.
2. Select the parameters you want to define as factors to study by clicking the check
box that corresponds to the parameter. To add all the selected parameters as factors,
click the Check button at the bottom of the tab. If no parameters are selected, you
will be prompted to add all parameters as factors. To deselect all the parameters,
click the Uncheck button. Note that arrays and aggregates themselves cannot be
selected. You must open them (click the ) and select scalar members.
3. Change any of the default values, which are provided for all attributes for a
selected factor, as desired.
Although each technique defines the appropriate set of attributes for a factor, the
following set of attributes are common among many of the techniques.
# Levels. This attribute is the number of levels at which you wish to study the
factors. A change to this attribute will automatically readjust the Levels for
this factor.
Levels. This attribute is a space-separated list of the levels at which to study
the factor. The related attributes are updated once you click in a different cell.
Lower/Upper. These attributes are lower/upper levels for the factor. A change
to one of these attributes will automatically calculate new levels evenly
distributed between the Lower and Upper values.
Baseline. This attribute is the value to be used for converting Levels into
values when the Relation is “%” or “diff.”
4. Select the Update factor baselines to current values when executing option at
the bottom of the tab if you want the baseline values updated to the current
parameter values before executing. If iSIGHT-FD previously modified a
parameter, this option allows for automatic updating of the baseline of all factors to
the current parameter values in iSIGHT-FD, prior to executing the DOE technique,
which will re-adjust the values to be studied appropriately. The default is to have
this option deactivated, retaining user-defined settings. This option is useful if the
DOE technique is executed after another element of the workflow that might
change the parameter values (for example, after an Optimization component), so
that the DOE study can be performed around the new design point.
Note: You can also set variable options using the Edit... button at the bottom of the
editor. For more information, see “Editing Attributes for Multiple Parameters,” on
page 137.
This tab displays the design matrix generated for the technique selected (“Opening
the Editor and Using the General Tab,” on page 124) and the factors selected and
attributes specified on the Factors tab (“Using the Factors Tab,” on page 127).
2. (Optimal Latin Hypercube technique only). Click the Generate button to create
your design matrix. This ability to manually generate your matrix is present since
this process can take a significant amount of time.
The Design Matrix Generation Status dialog box appears, showing you how the
matrix generation is progressing.
Note: If you do not manually generate the design matrix in the component editor, it
will automatically be generated as part of the execution.
4. (Orthogonal Arrays technique only) Click the Options... button to display any
options available for generating the design matrix. When using Orthogonal Arrays,
the factors are automatically assigned to columns in a way that minimizes
confounding with interaction effects. Preference is given to factors in the order
they were defined.
5. Select how you want the design matrix displayed using the Show button. You can
display the design matrix as values (the actual values to be set at execution) or
levels (the level number as generated by the technique algorithm).
6. Perform any of the following actions, as desired, to manipulate the design matrix:
Deactivate a single design point. Click any row number to deactivate that
design point so that it will not be executed (a icon appears). You can also
click the button at the top of the design matrix, or right-click the design
matrix and select the Skip selected design point(s) option from the menu that
appears.
Deactivate all design points. To deactivate all design points in the design
matrix, highlight all of the design points and click the button. You can also
right-click the design matrix and select Skip all design points from the menu
that appears.
Note: Deactivating design points is useful when it is known that a specific set
of values in the design matrix represents a design that cannot be evaluated for
whatever reason.
Activate a design point. To activate a design point that has been set to be
skipped, click the icon that represents the design point. The row number
reappears. You can also click the button at the top of the design matrix, or
right-click the design point and select Activate selected design point(s) from
the menu that appears.
Activate all design points. To activate all of the design points in the design
matrix, highlight all of the design points and click the button. You can also
right-click the design matrix and select Activate all design points from the
menu that appears.
Copy the design matrix. This option copies the design matrix to the clipboard
so that is can be pasted elsewhere (for example, in a text file). This option can
be accessed using the Copy button above the design matrix or by
right-clicking the design matrix and selecting Copy design matrix from the
menu that appears.
Save the design matrix. Saves the design matrix to a file. This option can be
accessed by clicking the Save button above the design matrix or by
right-clicking the design matrix and selecting Save... from the menu that
appears.
2. Select the output parameters you want to define as responses by clicking the check
box that corresponds to the parameter. To add all the selected parameters as
responses, click the button at the bottom of the tab. If no parameters are
selected, you will be prompted to add all parameters as responses. To deselect all
Note: You can also set response options using the button at the bottom of the
editor. For more information, see “Editing Attributes for Multiple Parameters,” on
page 137.
Write experiment data to a file. This option allows you to write all of the
DOE run data to the specified file after execution. Use the Browse... button to
specify this file. Click the Output file parameter ’DOE Results.Data Set’
check box to also provide this data as an output file parameter (called “Data
Set”) in the DOE Results output parameter.
5. Click OK to close the editor and save your changes. Click Apply to save your
changes, but keep the editor open.
3. Click the value in the Value column for the technique option whose value you
want to map. The value is highlighted.
4. Right-click the value; then, select the Map this value to a parameter option. The
Select a Parameter dialog box appears prompting you to enter the name of a
parameter to which you want to map.
5. Type a name for the parameter (by default, the technique option name is used);
then, click OK.
Once mapped, an icon appears next to the technique option’s value. You can
click this icon to view or change the parameter name. You can also right-click on
the setting again to remove the mapping.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
7. Right-click one of the following execution options in the bottom left corner of the
editor:
Execute subflow only once (you need to click the Advanced Options... button
to gain access to this option)
The Select a Parameter dialog box appears prompting you to enter the name of a
parameter to which you want to map.
9. Type a name for the parameter (by default, the execution option name is used);
then, click OK. Once mapped, an icon appears next to the execution option.
You can click this icon to view or change the parameter name. You can also
right-click on the setting again to remove the mapping.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
10. Click Apply to save your changes; then, proceed to step 15.
11. Determine if you want to map a factor or response attribute; then, click the
appropriate tab on the component editor.
If you want to apply the mapping to only the selected parameter, select the
Map <Attribute_Name> to a parameter for selected option.
If you want to apply the mapping to all the parameters, select the Map
<Attribute_Name> to a parameter for all option.
An icon appears next to the attribute’s value. You can click the icon to view or
change the parameter name.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
Note: You can remove these mappings at any time. Simply right-click the
appropriate parameter attribute; then, select the Remove mapping of
<Attribute_Name> to a parameter for selected or Remove mapping of
<Attribute_Name> to a parameter for all option, depending on how you
originally mapped the attribute.
14. Click OK to close the component editor and return to the Design Gateway.
15. Click the Parameters tab.
16. Locate the new aggregate parameter called Mapped Attributes and Options
parameter; then, click the icon to expand the parameter.
The new parameters appear, which will be mapped into the appropriate
attributes/options at the beginning of execution.
1. Select the parameters you want to add/remove/edit on either the Factors or Post
Processing tab.
To add all the selected parameters as factors, click the Check button ( button
on the Post Processing tab) at the bottom of the tab. If no parameters are selected,
you will be prompted to add all parameters as factors. To deselect all the
parameters, click the Uncheck button ( button on the Post Processing tab).
2. Click the Edit... button ( button on the Post Processing tab) at the bottom of
the component editor. The Edit dialog box appears. In the following example, a
parameter on the Factors tab is being edited.
3. Update the listed values, as desired. Only options with defined values appear on
this dialog box.
4. Click OK. The values are updated for all the parameters that were selected.
Alpha. The Lower and Upper levels specify the two levels at which a 2-level
full-factorial study is performed. The center point is also studied. The Alpha
option is a ratio defining two other points (also known as “star points”) at
which to study the given factor. For example, Alpha set to 0.25 indicates the
factor is to be studied at points 1/4 of the way from the baseline to the lower
and upper levels. Alpha set to 1.6 indicates the factor is to be studied 50%
beyond the lower and upper levels. For example, Lower = 5, Upper = 20,
Baseline = 10, and Alpha = 0.25 results in Levels = {5, 8.75, 10, 12.5, 20}.
Return to step 5 on page 125 for information on using the other options and tabs on the
DOE component editor.
File. The first step in setting Data File technique options is to select the file
that you want to use with the technique. Click the button to specify the file
that contains the values you want to use. The Configure File Parameter dialog
box appears. Select the file to be used. If you want the current file contents to
be used, set the type to InModel, otherwise select File or URL and provide the
appropriate path information. You can also specify a file that data will be
written to. For more information on using file parameters, see “Using File
Parameters,” on page 579.
Contains Levels. Select this check box if your data file contains levels instead
of actual values. If this is selected, additional factor attributes will be available
(Lower, Upper, Relation, Baseline) to define how to calculate values from the
levels.
Transposed. Select this check box if you want to use a data file in which each
row represents a set of values for the parameter whose name is the first item in
that row (thus, the file is “transposed” from the standard format in which each
column represents a parameter and its values). A transposed data file must
have the parameter name as the first item in the row (enclosed in quotes if
spaces exist), and each row must have the same number of values in it.
Use Header Row. Select this check box if your data file has a header row
containing the factor names.
Header Row. Specify which row contains the names of your factors by
entering its corresponding number.
Data Starts on Row. Specify the row in your file where the data begins by
entering its corresponding number. If you are using a header row, the specified
row must be greater than the header.
File contains responses. Select this option if you do not want the DOE
component to actually execute an iSIGHT-FD subflow for each design point,
but to instead read the response values for each design point from a specified
file. The format of the file must be a first row with parameter names and each
subsequent row containing the values for the parameters for that design point.
This feature is useful for when you have a complete data set (input and output
values) already compiled and simply want to use DOE as a post-processing
tool.
Column. If you have specified not to use a header row to find factors in the
file, you must provide the column number for each factor.
Return to step 5 on page 125 for information on using the other options and tabs on the
DOE component editor.
Return to step 5 on page 125 for information on using the other options and tabs on the
DOE component editor.
Note: A fixed seed can also be set and used for the entire model. If a fixed seed
is set for the model and also defined separately in DOE, then the one in DOE
will be used. If a fixed seed is set for the model and this option is not selected,
then the sequence of random numbers will be based on the model’s random
seed (and thus is still reproducible). For information on setting a fixed seed,
see “Setting Gateway Preferences,” on page 42.
Factor tab options: None
Return to step 5 on page 125 for information on using the other options and tabs on the
DOE component editor.
Max Time to Optimize (minutes). Enter the maximum amount of time (in
minutes) that the component can optimize. Once this time limit is reached, the
optimization stops.
Use a fixed seed. The seed can be fixed by clicking this check box and
specifying the seed manually in the corresponding text box. If this check box is
not activated, the seed is determined randomly.
Note: A fixed seed can also be set and used for the entire model. If a fixed seed
is set for the model and also defined separately in DOE, then the one in DOE
will be used. If a fixed seed is set for the model and this option is not selected,
then the sequence of random numbers will be based on the model’s random
seed (and thus is still reproducible). For information on setting a fixed seed,
see “Setting Gateway Preferences,” on page 42.
Factor tab options: None.
Return to step 5 on page 125 for information on using the other options and tabs on the
DOE component editor.
The Orthogonal Array technique allows you to select one of the following options
from the Array drop-down list to specify the array size (and thus, the resolution) to
use for the experiment:
Only those arrays that are appropriate for the current number of factors (and
number of levels) will appear in this list.
Note: The Orthogonal Array technique will allow you to specify a mixed number
of levels for the factors, and will automatically use the appropriate array to
accommodate your settings, possibly modifying the basic structure of the array to
ensure orthogonality. You can always manually choose a larger array, if desired.
Return to step 5 on page 125 for information on using the other options and tabs on the
DOE component editor.
Run baseline point. Select this option if you want an additional point to be
executed in which all factors are set to their Baseline values. Including a
baseline design point allows for the Parameter Study technique to be used
exactly as a simple finite differencing technique for sensitivity calculations
(i.e., the effective difference caused by each factor is independently varied by
some small difference from a baseline design).
Return to step 5 on page 125 for information on using the other options and tabs on the
DOE component editor.
For. This loop type is used to execute subflows while continuously incrementing
the value of a selected parameter.
For Array. This loop type is used to execute subflows for each element of one or
more arrays, and accumulate subflow results into one or more arrays.
For Each. This loop type is used to execute subflows while iterating through a list
of values for a selected parameter.
While. This loop type is used to execute subflows as long as a specified condition
is met.
Do Until. This loop type is used to execute subflows until a condition is satisfied.
The number of executions is not constant.
Important: This component is subject to certain limitations. You should review these
limitations before attempting to create a loop. For more information on these
limitations, see “Understanding Loop Limitations,” on page 157.
The available loop types differ in the way the conditions are expressed. This section
describes the options available for each type of loop.
1. Double-click the component icon to start the component editor. For more
information on inserting components, and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The selected parameter's value is altered during every run from a starting value
(the From option) to a final value (the To option) incremented in steps with a
specified value (the Increment option).
4. Select Parameter or Constant using the From button; then, based on your
selection, either select a parameter using the corresponding drop-down list, or enter
a constant in the adjacent text box. This setting represents your starting value.
Note: If you choose to select a parameter, the button appears. Click the button
to add a new parameter.
5. Select Parameter or Constant using the To button; then, based on your selection,
either select a parameter using the corresponding drop-down list, or enter a
constant in the adjacent text box. This setting represents your final value.
Note: If you choose to select a parameter, the button appears. Click the button
to add a new parameter.
6. Select Parameter or Constant using the Increment button; then, based on your
selection, either select a parameter using the corresponding drop-down list, or enter
a constant in the adjacent text box.
The Increment value, if the Constant option is selected, can be either a positive
value or a negative value. Zero (0) is not a valid value for this option.
Note: If you choose to select a parameter, the button appears. Click the button
to add a new parameter.
7. Click the Action when a run fails drop-down list to determine the action
iSIGHT-FD should take if a subflow fails. If Fail Loop is selected, the Loop
component will fail when the subflow fails. If Ignore run and Continue is
selected, the run continues after a failed subflow. This option applies to both
parallel and sequential execution.
8. Set the Execute all iterations in parallel option using the corresponding check
box. If selected, all of the subflows will be submitted for execution simultaneously
(in parallel). If not selected, the subflows are executed one after the other
(sequentially).
9. Select OK to close the editor, save your changes, and return to the Design
Gateway.
Note: For information on how parameters other than the arrays behave for
sequential and parallel For loops, see “Understanding Parallel Loop Execution,” on
page 156.
1. Double-click the component icon to start the component editor. For more
information on inserting components, and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
2. Click the Loop Type button; then, select the For Array option.
The editor is updated to show the loop’s options.
3. Select an array parameter using the Array Parameter drop-down list, or create a
new array parameter using the button.
4. Select the mapping direction of the array parameter using the corresponding
button. The following options are available:
From subflow. The value the scalar variable is copied into an element of the
array after the subflow runs. This setting is the default for an output array
parameter.
5. Select the subflow parameter using the Subflow Parameter drop-down list, or
create a new scalar parameter using the button.
6. Click the button to add your selection to the table in the center of the editor.
The loop will iterate through these values.
Note: You can delete an item from the table by selecting the item and clicking the
button.
By default, the loop will execute once for each element of the first array. If there is
only one array, or all of the arrays are the same size, this is an obvious behavior. If
there are several arrays and arrays have different sizes, the loop will execute once
for each element of the smallest array. The extra elements in the other arrays are
not used or modified.
If you wish to set the number of loops, see step 11.
7. (optional) Repeat step 3 through step 6 for additional arrays. There is no limit to
the number of arrays that can be mapped by one For Array loop.
8. Click the Design Matrix button to view the values that will be used for each
subflow run.
Only the input and in/out mappings are shown. The first column is the run number,
and the other columns are the values of the scalar subflow variables for that run.
9. Click OK to close the dialog box and return to the Loop component editor.
10. Click the Action when a run fails drop-down list to determine the action
iSIGHT-FD should take if a subflow fails. If Fail Loop is selected, the Loop
component will fail when the subflow fails. If Ignore run and Continue is
selected, the run continues after a failed subflow, but the run is ignored and no
results are returned for it. This option applies to both parallel and sequential
execution.
11. Click the Limit the number of loops check box if you want to limit the number of
loops. You would normally use this option if some earlier step in the workflow
filled in only part of the array(s) and you want to process only those parts.
The number of times the loop runs can be set to a constant or the value of an input
integer parameter. Once you have clicked the check box, you can use the
corresponding drop-down list to select a constant or parameter, and then fill in the
constant value or the name of the input parameters. You can use the button to
create a new parameter as the loop limit. Only input integer parameters are
allowed.
12. Set the Execute all iterations in parallel option using the corresponding check
box. If selected, all the subflows will be submitted for execution simultaneously
(in parallel). If not selected, the subflows are executed one after the other
(sequentially).
13. Select OK to close the editor, save your changes, and return to the Design
Gateway.
Note: For information on how parameters other than the arrays behave for
sequential and parallel For Array loops, see “Understanding Parallel Loop
Execution,” on page 156. The output arrays are correctly assigned values from the
subflow for both sequential and parallel execution.
Note: In the subflow of a For Array loop, the array index being processed can be
obtained from the parameter “Run #”. You will need to adjust for the fact that the
run counter starts at 1, but the array indexes start at 0. It may be convenient to
include a calculator component in the subflow with the following expression:
N = Run-1
then, map parameter “Run #” in the loop to parameter “Run” in the calculator.
Note: Array parameters can vary in size at runtime. If a resizable input or in/out
array is used in a For Array loop, the actual size at runtime will be used to
determine the number of loops. If a resizable output array is used, its size will be
adjusted at runtime to match the number of loops.
The value list contains any set of values, which are not necessarily evenly spaced.
String and Boolean data types can also be used, not just Integers and Reals.
1. Double-click the component icon to start the component editor. For more
information on inserting components, and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
2. Click the Loop Type button; then, select the For Each option.
The editor is updated to show the loop’s options.
3. Select a parameter using the Parameter drop-down list, or create a new parameter
using the button.
Note: Parameters of type Real, Integer, String, and Boolean can be used in a For
Each loop.
The selected parameter's value is altered during every run from the values list
specified. This values list is determined in the next step.
4. Select Parameter or Constant from the button in the middle of the editor; then,
based on your selection, either select a parameter using the corresponding
drop-down list, or enter a constant in the adjacent text box.
Note: All values in the list must match the data type of the selected iteration
parameter. For example, a parameter of type Boolean will only accept boolean
values.
5. Click the button to add your selection to the Values List in the center of the
editor. The loop will iterate through these values.
Note: You can delete an item from the Values List by selecting the item and
clicking the button.
6. Repeat step 4 and step 5 for each item you want to add to the Values List.
7. Use the Up button and Down button to rearrange the information in the
Values List, if necessary.
8. Click the Action when a run fails drop-down list to determine the action
iSIGHT-FD should take if a subflow fails. If Fail Loop is selected, the Loop
component will fail when the subflow fails. If Ignore run and Continue is
selected, the run continues after a failed subflow. This option applies to both
parallel and sequential execution.
9. Set the Execute all iterations in parallel option using the corresponding check
box. If selected, all of the subflows will be submitted for execution simultaneously
(in parallel). If not selected, the subflows are executed one after the other
(sequentially).
10. Select OK to close the editor, save your changes, and return to the Design
Gateway.
Note: For information on how parameters other than the arrays behave for
sequential and parallel For Each loops, see “Understanding Parallel Loop
Execution,” on page 156.
1. Double-click the component icon to start the component editor. For more
information on inserting components, and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
2. Click the Loop Type button; then, select the While option.
The editor is updated to show the loop’s options.
Now you need to create an expression to add to the Conditions area (at the bottom
of the editor) using constants, parameters, or both. This component will execute
the subflows as long as the expression evaluates to true.
Complex expressions can also be created using Logical AND and OR expressions.
Furthermore, the grouping of logical conditions is supported.
3. Select a parameter using the Parameter drop-down list, or create a new parameter
using the button.
4. Click the Condition button; then, select your desired condition from the list that
appears.
5. Select Parameter or Constant from the button below the Condition button; then,
based on your selection, either select a parameter using the corresponding
drop-down list, or enter a constant in the adjacent text box.
6. Click the button to add your selection to the Conditions area in the center of
the editor.
Note: You can delete a condition from the Conditions area by selecting the
condition and clicking the button.
7. Repeat step 3 through step 6 for each condition you want to add to the Conditions
area.
8. In the Conditions area, click the AND/OR column for any condition except the
first one listed; then, select AND or OR from the menu that appears based on the
type of condition you are creating. By default, once a second condition is added to
the list, the AND operator is selected.
Your conditional expression may never be satisfied in some cases. In such cases,
you can limit the number of iterations by setting the value for maximum iterations.
1. Double-click the component icon to start the component editor. For more
information on inserting components, and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
2. Click the Loop Type button; then, select the Do Until option.
Now you need to create an expression to add to the Conditions area (at the bottom
of the editor) using constants, parameters, or both. This component will execute
the subflows until the expression evaluates to true.
Complex expressions can also be created using Logical AND and OR expressions.
Furthermore, the grouping of logical conditions is supported.
3. Select a parameter using the Parameter drop-down list, or create a new parameter
using the button.
4. Click the Condition button; then, select your desired condition from the list that
appears.
5. Select Parameter or Constant from the button below the Condition button; then,
based on your selection, either select a parameter using the corresponding
drop-down list, or enter a constant in the adjacent text box.
6. Click the button to add your selection to the Conditions area in the center of
the editor.
Note: You can delete a condition from the Conditions area by selecting the
condition and clicking the button.
7. Repeat step 3 through step 6 for each condition you want to add to the Conditions
area.
8. In the Conditions area, click the AND/OR column (the first column) for any
condition except the first one listed; then, select AND or OR from the menu that
appears based on the type of condition you are creating. By default, once a second
condition is added to the list, the AND operator is selected.
The conditional expression may never be satisfied in some cases. In such cases,
you can limit the number of iterations by setting the value for maximum iterations.
10. Click the Maximum number of iterations check box; then, set the number of
maximum iterations in the corresponding text box.
11. Select OK to close the editor, save your changes, and return to the Design
Gateway.
When the iterations are run sequentially, each iteration sees the value of in/out
parameters as they are updated by previous iterations. When the iterations are run in
parallel, all iterations see the value the in/out parameter had when the Loop component
started, ignoring any changes made by other iterations. For example, assume a For
Loop that increments parameter i from 1 to 5, and has an in/out parameter n initially set
to 0. The subflow consists of a calculator that evaluates the expression: n = n+i.
If the loop is run sequentially, n will take on the values 1, 3, 6, 10, and 15 at the end of
each iteration. The final value of n is 15. If the iterations are run in parallel, each
subflow sees the input value of n as 0, so the output values are 1, 2, 3, 4, and 5, and the
final value of n is 5.
The component does not allow the selection of other parameter types (other than
the selected parameter type) for expression formation or value substitution. For
example, a For Each loop that has a condition parameter is of type Real does not
allow selection of a parameter of type Integer as one of its values. It can only select
another parameter of type Real.
Proper loop execution requires that the parameters (iteration parameter in For and
For Each loops, and condition parameters in While and Do Until loops) are
properly mapped between the parent loop and its subflows. After creating a new
loop component, make sure that the mappings are created correctly.
In order for While and Do Until loops to function properly, all parameters that are
used in the conditions and that are expected to change their values during iterations
must be of mode Input/Output. In this case their value will be preserved from one
iteration to another by the loop component. For example, when creating a While
loop with the condition (N < 10), and a calculator in the subflow with the
expressing N=N+1, you must ensure that parameter N is of mode Input/Output in
both the loop component and the calculator component. If this is not done,
parameter N’s value will always be reset back to the initial value at every
execution of the calculator, and the loop will end up executing infinitely or until it
reaches the maximum number of iterations.
For all loops except For Array, the values of all output or in/out parameters after
the loop finishes are taken from the last iteration (highest run number, not the last
iteration to finish). Only the output array(s) of a For Array loop allow the values of
other iterations to be mapped to subsequent components.
Note: This component has default preferences which you can set based on your needs.
For more information, see “Setting Monte Carlo Component Preferences,” on
page 118.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The editor is divided into three tabs: General, Random Variables, and Responses.
The General tab offers setup options, and options related to the sampling
technique. The Random Variables tab allows for the selection and configuration of
the random variables. The Responses tab allows for the selection and configuration
of the response parameters.
2. Click the Sampling Technique button; then, select the technique you want to use
from the drop-down list that appears. The sampling technique’s options appear
directly below the Sampling Technique button, and information about the
technique appears in the Sampling Technique Description area on the right side of
the editor. Sampling techniques in the Monte Carlo component are implemented as
“plug-ins”. As such, they are extendable by creating new plug-ins for new
sampling techniques. For more information, refer to the iSIGHT-FD Development
Guide.
Note: You can set default behavior for this option using the component preferences
as described in “Setting Monte Carlo Component Preferences,” on page 118.
Simple Random Sampling. This method is the default selection, and is the
most commonly used sampling method. Sample points for simulation are
generated randomly and independently.
For more detailed information on these sampling techniques, see “Monte Carlo
Reference Information,” on page 699.
3. Set the following options in the Sampling Technique Options area, which vary
based on your selected sampling technique:
Use a fixed seed. The seed can be fixed by clicking this check box and
specifying the seed manually in the corresponding text box. If this check box is
not activated, the seed is determined randomly.
Execute Monte Carlo sample points in parallel. Select this option if you'd
like the sample points defined by the Monte Carlo simulation to be executed in
parallel. Note that the convergence check interval may limit the number of
sample points that are executed in parallel to batches that are the size specified
for this convergence check interval.
After execution, reset to mean value point and run. With this option
selected (default), after execution of all Monte Carlo simulation points, the
random variables will be set to their mean values and the Monte Carlo subflow
will be executed one additional time. In this case, the Monte Carlo parameters
(inputs and outputs) will be left at the values calculated for this “mean value
point”. If this option is not selected, the Monte Carlo parameters after
execution will be left at the values associated with the last (random) Monte
Carlo simulation point.
Note: You can map these settings to parameters. For more information, see
“Mapping Options and Attributes to Parameters,” on page 166.
5. (optional) Click the Advanced Options... button; then, set either of the following
options:
Execute subflow only once. If selected, the subflow executes only one time.
This is useful in models that need to turn the driver logic on/off parametrically.
This option is also helpful in debugging the process.
Note: You can map this setting to a parameter. For more information, see
“Mapping Options and Attributes to Parameters,” on page 166.
Allow the following to be turned off by parameters. This option allows you
to de-activate (turn off) the selected types of design parameters (random
variables, responses) using input parameters to the Monte Carlo components.
If this option is selected, boolean input parameters will be created in an Active
Random Variables/Active Responses aggregate under the Mapped Options
and Attributes aggregate parameter. The parameters are selected by default. If
any of the parameters are not selected at runtime, then those design parameters
will not be used during execution.
6. Click the Random Variables tab. The contents of the tab appear.
7. Select the parameters you want to use as random variables by clicking the check
box that corresponds to the parameter. To select all parameters, click the
button at the bottom of the tab. If no parameters are selected, you will be prompted
to add all parameters as random variables. To deselect all the parameters, click the
button.
Once you select a random variable, its name is displayed in the Distribution
Information area, and the rest of the tab is activated.
8. Set any of the following options, some of which vary based on your distribution
selection:
Click the Distribution button to set the probability distribution option for the
random variable. Like sampling techniques, random variable distributions are
implemented as “plug-ins” used by the Monte Carlo component. They are
extendable by creating new “plug-ins” for new distributions.
• Normal
• Triangular
• Uniform
• Weibull
Note: For more information on these distribution options, see “Understanding
Distribution Types,” on page 702.
Mean. This distribution parameter represents the measure of central tendency
of a random variable. Its default setting is the current value of the parameter.
Note: You can map this setting to a parameter. For more information, see
“Mapping Options and Attributes to Parameters,” on page 166.
Coeff. of Variation. This distribution parameter is the value of the standard
deviation divided by the mean for the random variable. The default value
is 0.1.
appear for Lower and Upper, referring to the lower tail and the upper tail.
Specify the location at which the distribution is to be truncated. Values of the
distribution below the Lower truncation value and above the Upper truncation
value will not be sampled. The distribution preview graphs are updated to
display the effects of truncation.
Note: You can use the button to edit the information for multiple random
variables. For more information, see “Editing Attributes for Multiple Parameters,”
on page 172.
9. Review the preview graphs on the right side of the tab. These graphs are
automatically updated based on changes made to the selected random variables
distribution properties. A legend below the graph explains the color coding. The
graphs display the following information:
Probability Density. This graph shows the actual shape of the selected
distribution with regard to the probability density function.
Cumulative Distribution. This graph shows the actual shape of the selected
distribution with regard to the cumulative distribution function.
10. Set the Update random variable mean values to current parameter values
before execution option. This option, at the bottom of the tab, allows for
automatic updating of mean values of all random variables to the current parameter
values in this component, prior to executing the Monte Carlo component. The
default is to have this option deactivated, and to retain settings. If you want to
automatically change the settings to the current point when the Monte Carlo
component is executed, click this check button to activate it. This option is useful
if the Monte Carlo component is executed after another component, and parameter
values are taken from the previous component.
Lower Limit. If a response value is specified in the Lower Limit column for a
response, the probability of response values greater than that lower limit will
be calculated and reported after all simulations are complete.
Upper Limit. If a response value is specified in the Upper Limit column for a
response, the probability of response values less than that upper limit will be
calculated and reported after all simulations are complete.
Note: If both Lower and Upper limits are specified the Total probability
between the limits is also reported. This response probability can be used to
characterize the reliability of that response with respect to remaining between
the limits. The total probability of failure with respect to the specified limits
can be determined by subtracting the total probability from one.
Note: When you move your mouse pointer over or click a specific column, the
graph that represents that value is outlined on the right side of the tab. The graph
not only gives you a visual aid, but provides text information about the individual
settings.
Note: You can also set response options using the Edit... button at the bottom of
the editor. For more information, see “Editing Attributes for Multiple Parameters,”
on page 172.
14. (optional) If desired, map any of these response attributes to parameters. For more
information, see “Mapping Options and Attributes to Parameters” on this page.
15. Click OK to close the editor and save your changes. Click Apply to save your
changes, but keep the editor open.
3. Click the value in the text box for the technique option whose value you want to
map. The value is highlighted.
4. Right-click the value; then, select Map this value to a parameter option. The
Select a Parameter dialog box appears prompting you to enter the name of a
parameter to which you want to map.
5. Type a name for the parameter (by default, the technique option name is used);
then, click OK. Once mapped, an icon appears next to the technique option’s
value. You can click this icon to view or change the parameter name. You can also
right-click on the setting again to remove the parameter name.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
7. Right-click any of the following execution options in the bottom left corner of the
editor:
Execute subflow only once (you need to click the Advanced Options... button
to gain access to this option)
8. Select the Map this value to a parameter option. The Select a Parameter dialog
box appears prompting you to enter the name of a parameter to which you want to
map.
9. Type a name for the parameter (by default, the execution option name is used);
then, click OK.
Once mapped, an icon appears next to the execution option. You can click this
button to view or change the parameter name. You can also right-click on the
setting again to remove the mapping.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
10. Click Apply to save your changes; then, proceed to step 18.
13. Type a name for the parameter (by default, the Standard Deviation option name is
used); then, click OK. Once mapped, an icon appears next to the tuning
parameter’s value. You can click this icon to view or change the parameter name.
You can also right-click on the setting again to remove the parameter name.
14. Click Apply to save your changes; then, proceed to step 18.
If you want to apply the mapping to only the selected parameter, select the
Map <Attribute_Name>to a parameter for selected option.
If you want to apply the mapping to all the parameters, select the Map
<Attribute_Name> to a parameter for all option.
An icon appears next to the tuning parameter’s value. You can click this icon
to view or change the parameter name.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
Note: You can remove these mappings at any time. Simply right-click the
appropriate parameter attribute; then, select the Remove mapping of
<Attribute_Name> to a parameter for selected or Remove mapping of
<Attribute_Name> to a parameter for all option, depending on how you
originally mapped the attribute.
18. Click OK to close the component editor and return to the Design Gateway.
To select all parameters, click the button (Check button on the Responses
tab) at the bottom of the tab. To deselect all the parameters, click the button
(Uncheck button on the Response tab).
2. Click the button (Edit... button on the Response tab) at the bottom of the
component editor.
The Edit dialog box appears. In the following example, a parameter on the
Random Variables tab is being edited.
3. Update the listed values, as desired. Only options with defined values appear on
this dialog box.
4. Click OK. The values are updated for all the parameters that were selected.
Note: All of the algorithms listed above may not be included in your installation,
depending on your license.
The list of available optimization algorithms includes the best algorithms from several
major classes of optimization algorithms, such as gradient-based numeric techniques,
direct search techniques, and exploratory techniques. This approach assures that most
of the needs of the optimization design engineer area are covered by this Optimization
component.
For detailed information on each of these techniques, as well as their parameters, see
the remaining topics in this section.
Note: This component has default preferences which you can set based on your needs.
For more information, see “Setting Optimization Component Preferences,” on
page 119.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The dialog box is divided into four tabs: Technique, Design Variables, Constraints,
and Objectives. The Technique tab is specific to the technique you decide to use
(see step 2). The three remaining tabs are used for specifying parameters as design
variables, constraints, and objectives, as well as setting their corresponding
attributes.
2. Click the Optimization Technique button; then, select the technique you want to
use from the drop-down list that appears. The technique’s tuning parameters
appear directly below the Technique button, and information about the technique
appears in the Technique Description area on the right side of the editor.
Note: You can set the default selection for the optimization technique using the
component preferences as described in “Setting Optimization Component
Preferences,” on page 119.
3. Set the following execution options, if available, in the Execution Options area:
Execute in parallel. This option controls how the design points will be
executed during optimization. (This option is not available for all techniques.)
If selected, design points will be executed in parallel, in small batches. The
size of the batch depends on the number of selected Design Variables for
numerical techniques or the size of the population for exploratory techniques.
Note: You must define all upper and lower bounds (or allowed values) for all
design variables when this option is selected. If some design variables do not
have bounds, you will not be able to use this option.
You can set default selection for this option using the component preferences
as described in “Setting Optimization Component Preferences,” on page 119.
Note: You can map these settings to parameters. For more information, see
“Mapping Options and Attributes to Parameters,” on page 183.
4. (optional) Click the Advanced Options... button; then, set either of the following
options:
Execute subflow only once. If selected, the subflow executes only one time,
and constraints, objectives, and penalty values are calculated. This is useful in
models that need to turn the driver logic on/off parametrically. This option is
also helpful in debugging the process.
Allow the following items to be turned off by parameter. This option allows
you to disable some design parameters at runtime by using parameters. When
this option is selected, a set of special “switch” variables are created. By
changing the values of these special variables, you can disable their
corresponding design parameters.
6. Set the tuning parameter values for your technique in the Optimization Technique
Options area.
Note: You can map tuning parameter settings to parameters. For more information,
see “Mapping Options and Attributes to Parameters,” on page 183.
For more information on these options, see one of the following sections:
The list of parameters on this tab includes all parameters of modes Input and
In/Out from the Optimization component, and also parameters of the same modes
from the subflow components, if they are not mapped to any parameters of the
Optimization component.
8. Perform any of the following actions, which vary based on your model design:
You can also select all of the listed variables (including array elements) using
the Check button at the bottom of the tab.
Specify the lower bound for the variables in the corresponding column. This
setting is required if you are using the automatic scaling component
preference. For more information, see “Setting Optimization Component
Preferences,” on page 119.
Note: This column is not available for Multi-Island Genetic Algorithm, since
the initial design point is not used by this algorithm.
Warning: The initial values of the variables will be overridden at the
execution time if the Optimization component is a child component of another
process component (for example, a Task component). Therefore, to change the
initial values of variables, you must change the corresponding parameter
values in the parent (Task) component.
Warning: Changing initial values of variables essentially changes their values
in the main Design Gateway window. These changes are immediate and cannot
be reversed by clicking Cancel on the Optimization Component editor.
Specify the upper bound for the variables in the corresponding column. This
setting is required if you are using the automatic scaling component
preference. For more information, see “Setting Optimization Component
Preferences,” on page 119.
Type a comma separated list of allowed values in the Allowed Values column.
If you enter allowed values, the lower and upper bounds are erased, and vice
versa. Entering a list of allowed values creates a discrete variable, and tells the
Optimization component that only these values can be used during
optimization. The optimization algorithm will view this variable as an integer
parameter with the range of values 0,1,2,...,N-1, where N is the length of the
allowed values list.
Set the scale factor for the variable in the corresponding column. Scale factors
are used to bring variable values to the same order of magnitude to improve the
efficiency of the optimizers.
Note: This column does not appear if you use the automatic scaling component
preference. For more information, see “Setting Optimization Component
Preferences,” on page 119.
(Multi-Island Genetic Algorithm technique only) Set the value in the Gene
Size column. This value controls the number of bits N in all genes used for
encoding the value of each variable. Every bit of the gene can change its value
between 0 and 1. The total number of possible combinations in every gene is
then 2^N. This number of combinations determines the minimum change in
the value of any design variable during all genetic operations - take the
allowed range of values for a design variable, and divide it by the total number
of combinations. To increase the minimum change in design variable values
(i.e., to decrease the number of possible bit combinations when the allowed
range of design variable values is small), decrease the gene size.
Note: You can also set variable options using the Edit... button at the bottom of the
editor. For more information, see “Editing Attributes for Multiple Parameters,” on
page 187.
9. (optional) If desired, map any of these variable attributes to parameters. For more
information, see “Mapping Options and Attributes to Parameters,” on page 183.
10. Click the Constraints tab. The constraints for your problem are displayed.
The list of parameters on this tab includes all parameters of mode Output from the
Optimization component, and also parameters of mode Output from the subflow
components, if they are not mapped to any parameters in the Optimization
component. When any subflow parameter is selected as a constraint, a
corresponding parameter is created in the Optimization component.
11. Perform any of the following options, which vary based on your model design:
Set the lower and upper bound of a constraint in the corresponding columns.
Set the constraint’s scale and weight factors in the corresponding columns.
Scale factors are used to bring constraint values to the same order of
magnitude to improve the efficiency of the optimizers. Weight factors are used
to change the importance of various constraints.
Note: You can also set constraint options using the Edit... button at the bottom of
the editor. For more information, see “Editing Attributes for Multiple Parameters,”
on page 187.
12. (optional) If desired, map any of these constraint attributes to parameters. For more
information, see “Mapping Options and Attributes to Parameters,” on page 183.
where LB is the lower bound value, UB is the upper bound value, T is the target
value, Parm is the parameter value, W is the weight factor, and S is the scale factor.
13. Click the Objectives tab. The contents of the tab appear.
The list of parameters on this tab includes all parameters of mode Output from the
Optimization component, and also parameters of the same modes from the subflow
components, if they are not mapped to any parameters in the Optimization
component. Also, design variables (selected on the Variables tab) are included in
the list of parameters.
14. Perform any of the following actions, which vary based on your model design:
Set the objective’s scale and weight factors in the corresponding columns.
Note: You can also set objective options using the Edit... button at the bottom of
the editor. For more information, see “Editing Attributes for Multiple Parameters,”
on page 187.
15. (optional) If desired, map any of these objective attributes to parameters. For more
information, see “Mapping Options and Attributes to Parameters,” on page 183.
16. Click OK to close the editor and save your changes. Click Apply to save your
changes, but keep the editor open.
3. Click the value in the Value column for the tuning parameter whose value you
want to map. The value is highlighted.
4. Right-click the value; then, select the Map this value to a parameter option. The
Select a Parameter dialog box appears prompting you to enter the name of a
parameter to which you want to map.
5. Type a name for the parameter (by default, the technique option name is used);
then, click OK.
Once mapped, an icon appears next to the technique option’s value. You can
click this icon to view or change the parameter name. You can also right-click on
the setting again in order to remove the mapping.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
7. Right-click any of the following execution options in the bottom left corner of the
editor:
Execute in parallel
Re-execute optimum design point
Use automatic variable scaling
Execute subflow only once (you need to click the Advanced Options... button
to gain access to this option)
The Select a Parameter dialog box appears prompting you to enter the name of a
parameter to which you want to map.
9. Type a name for the parameter (by default, the turning parameter name is used);
then, click OK. Once mapped, a button appears next to the execution option.
You can click this button to view or change the parameter name. You can also
right-click on the setting again to remove the mapping.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
10. Click Apply to save your changes; then, proceed to step 15.
11. Determine if you want to map a variable, constraint, or objective attribute; then,
click the appropriate tab on the component editor.
Note: If there is no value defined for the attribute, the menu does not appear. You
must first create the attribute by typing a value and pressing the ENTER key.
If you want to apply the mapping to only the selected parameter, select the
Map <Attribute_Name> to a parameter for selected option.
If you want to apply the mapping to all the parameters, select the Map
<Attribute_Name> to a parameter for all option.
An icon appears next to the tuning parameter’s value. You can click this icon
to view or change the parameter name.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as special aggregate parameter.
Note: You can remove these mappings at any time. Simply right-click the
appropriate parameter attribute; then, select the Remove mapping of
<Attribute_Name> to a parameter for selected or Remove mapping of
<Attribute_Name> to a parameter for all option, depending on how you
originally mapped the attribute.
14. Click OK to close the component editor and return to the Design Gateway.
16. Locate the new aggregate parameter called Mapped Attributes and Options
parameter; then, click the icon to expand the parameter. The new parameters
appear.
1. Select the parameters you want to edit on either the Variables, Constraints, or
Objectives tab.
To select all parameters on a particular tab, click the Check button at the bottom of
the tab. To deselect all the parameters, click the Uncheck button.
The Edit dialog box appears. In the following example, a parameter on the
Variables tab is being edited.
3. Update the listed values, as desired. Only options with defined values appear on
this dialog box.
4. Click OK. The values are updated for all the parameters that were selected.
optimum. Increasing the value up from 1.0 will activate the rapid parameter
temperature reduction. Reducing the value down from 1.0 will greatly extend the
time required to reduce parameter temperature for convergence. Use quenching
only if you want to considerably speed up or slow down the convergence of the
algorithm. The type of value is real. The default value is 1.0. Other possible values
are 0.
Relative Rate of Cost Quenching. Cost quenching is a process of rapid reduction
of the cost temperatures and in effect overrides the slow annealing process and
turns it into a fast quenching process. Using quenching considerably reduces the
acceptance probability, reducing the chances of finding a global optimum and
greatly increasing the chances of convergence to a local optimum. Increasing the
value up from 1.0 will activate the rapid cost temperature reduction. Reducing the
value down from 1.0 will greatly extend the time required to reduce cost
temperature for convergence. Use quenching only if you want to considerably
speed up or slow down the convergence of the algorithm. The type of value is real.
The default value is 1.0. Other possible values are 0.
Max Number of Failed Designs. Maximum number of consecutive design
analysis failures before the algorithm terminates. Due to the random nature of the
algorithm, it is possible to generate designs that cannot be handled by the analysis
code(s). Such occasional failures are ignored by the ASA algorithm. If the failures
become persistent, the algorithm will stop executing. The type of value is integer.
The default value is 5. Other possible values are 1.
Reanneal Cost Function. When the algorithm comes to a stagnation point, it may
be beneficial to re-start the annealing process again using the best design point
found so far. If this option is set to yes, ASA algorithm will employ several criteria
Min Ratio of Accepted Designs for Reannealing. When the ratio of the number
of accepted designs to the number of generated designs reaches this value,
reannealing of parameter and/or cost function temperatures will be performed, if
allowed by the previous options. The type of value is real. The default value is
1.0E-6. Other possible values are 0.
Penalty Base. The ASA algorithm evaluates the goodness of a design point using
the combined value of the objective function and penalty function. When
calculating the penalty function of the design, Penalty Base can be used for all
designs that violate at least one constraint. This allows the technique to better
differentiate feasible designs with a slightly higher objective function from
infeasible designs with a slightly lower objective function.
Penalty Multiplier. This parameter is used to increase or decrease the effect of the
total constraint violations on the measure of the design goodness. The default value
is 1000.0.
Failed Run Penalty Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Failed Run Objective Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Use fixed random seed. If this option is selected, the random number generator
used by the optimization algorithm is seeded using the specified fixed seed value.
All executions of the Optimization component will use exactly the same sequence
of random numbers and, therefore, will produce exactly the same design points.
This arrangement is useful for debugging the optimization process when it is
necessary to reproduce the same sequence of design points.
If this option is not selected, the random number generator is seeded by using the
clock time at the moment of execution.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Max Iterations. This parameter sets the maximum number of iterations you want
the optimizer to run. An iteration, in this technique, includes the following actions.
Starting with the current base point, each design variable is perturbed up or down
(cost: one or two runs per variable), and any improvements are saved. The
accumulated change is used to determine the next base point. The default value is
10.
Max Evaluations. This parameter sets the maximum number of evaluations. The
default is 100.
Relative Step Size. This parameter determines the initial step size during the
design perturbations as a fraction of the parameter value (i.e., if a design variable
has a starting value of 1.0 and Relative Step Size is 0.5, the initial perturbation will
be 0.5). The default value is 0.5.
Step Size Reduction Factor. This parameter sets the step size reduction factor. It
should be set to a value between 0.0 and 1.0. Larger values give greater probability
of convergence on highly nonlinear functions, at a cost of more function
evaluations. Smaller values reduce the number of evaluations (and the program
running time), but increase the risk of nonconvergence. The default value is 0.5.
Termination Step Size. This parameter sets the termination step size. When the
algorithm begins to make less and less progress on each iteration, it checks this
parameter. If the step size is below Termination Step Size, the optimization
terminates, and returns the current best estimate of the optimum. Larger values of
Termination Step Size (e.g., 1.0E-4) have a quicker running time, but a less
accurate estimate of the optimum. Smaller values of Termination Step Size (e.g.,
1.0E-7) have a longer running time, but a more accurate estimate of the optimum.
The default value is 1.0E-6.
Max Failed Runs. This parameter is used to set the maximum number of failed
subflow evaluations that can be tolerated by the optimization technique. If the
number of failed runs exceeds this value, the optimization component will halt
execution.
Failed Run Penalty Value. This parameter represents the value of the Penalty
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Failed Run Objective Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Max Iterations. This parameter sets the maximum number of design iterations
you want the optimizer to run. The type of value is integer. The default value is 10.
Other possible values are 1.
Rel Step Size. This parameter sets the value of the relative gradient step size for
LSGRG2 when calculating gradients by finite differencing. The absolute step
value is calculated by LSGRG2 as follows:
dx = (1+x)*GradientStepSize
where x is the current value of a design variable. Note that, for small values of x,
GradientStepSize becomes the absolute value of the step (when x = 0). For large
values of x, GradientStepSize becomes the relative step size (when x >> 1). In
general, the best value for GradientStepSize is sqrt(eps), where eps is the relative
error in the computed function values (simcode outputs), such as if function values
are available to full double precision (eps=1e-16), GradientStepSize should be
about 1e-8. The type of value is real. The default value is 0.0010. Other possible
values are 0.
Convergence Iterations. This parameter sets the number of iterations used in the
convergence check (see definition of Convergence Epsilon above). The type of
value is integer. The default value is 3. Other possible values are 1.
Binding Constraint Epsilon. This parameter sets the value of the threshold for
binding constraints. If a constraint is within this epsilon of its bound, it is assumed
to be binding. This parameter may have a strong effect on the speed of the
optimization convergence. Increasing it can sometimes speed convergence (by
requiring fewer Newton iterations during a one-dimensional search), while
decreasing it occasionally yields more accurate solution, or gets optimization
moving if the algorithm gets “stuck.” Values larger than 1e-2 should be treated
cautiously, as should values smaller than 1e-6. The type of the value is real. The
default value is 1.0E-4. Other possible values are 0.
Phase 1 Objective Ratio. This parameter sets the ratio of the true objective value
to the sum of constraint violations to be used as the objective function during the
so-called Phase 1 of optimization. LSGRG2 uses the Generalized Reduced
Gradient method, which is designed to work in the feasible domain. If the initial
design is not feasible, the first step is to obtain a feasible point from which
feasibility is maintained thereafter. This is known as Phase 1 of optimization with
LSGRG2. The Phase 1 objective function is the sum of the constraint violations
plus, optionally, a fraction of the true objective. This optimization phase terminates
either with a message that the problem is infeasible or with a feasible solution. If
an infeasibility message is produced, the program may have become stuck at a
local minimum of the Phase 1 objective (or too large a part of the true objective
was incorporated), and the problem may actually have feasible solutions. The
suggested remedy, if you suspect that this is so, is to choose a different starting
point (or reduce the proportion of the true objective) and try again. The default
value is 1.0. Other possible values are 0.
Max Failed Runs. This parameter is used to set the maximum number of failed
subflow evaluations that can be tolerated by the optimization technique. If the
number of failed runs exceeds this value, the optimization component will halt
execution.
Failed Run Penalty Value. This parameter represents the value of the Penalty
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Failed Run Objective Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Max Number of Iterations. An iteration consists of two phases. In the first phase,
a plausible search direction is computed from the gradient of the objective function
and constraints at the current design point. In the second phase, new designs are
evaluated along the selected direction (cost: one run per design) until no
improvements are found, or until a constraint is violated. The two phases are
repeated until the specified convergence requirements are met. This option
controls how many of these pairs of phases will take place. The type of value is
integer. The default value is 40.
Relative Gradient Step. This parameter sets the relative finite difference step size
to be used by the optimizer, when calculating gradients using finite difference
techniques. The default value is 0.01 (1 percent).
Min Abs Gradient Step. This parameter sets the smallest (minimum) absolute
value of the finite difference step when calculating gradients. It prevents a step
from being too small when a parameter value is near zero. The default value is
0.001.
Failed Run Penalty Value. This parameter represents the value of the Penalty
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Failed Run Objective Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Elite Size. Number of best individuals carried over from the parent generation to
the child generation in each subpopulation. The type of value is integer. The
default value is 1. Other possible values are 0.
Max Failed Runs. This parameter is used to set the maximum number of failed
subflow evaluations that can be tolerated by the optimization technique. If the
number of failed runs exceeds this value, the optimization component will halt
execution.
Failed Run Penalty Value. This parameter represents the value of the Penalty
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Failed Run Objective Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Default Variable Bound (Abs Val). This value will be used as the upper and
lower bound for all variables without bounds. For lower bound, this value will be
multiplied by -1 (negative value). It is important for MIGA to have bounds for all
variables because the algorithm works by dividing the range of each variable into a
very large number of steps.
Use fixed random seed. If this option is selected, the random number generator
used by the optimization algorithm is seeded using the specified fixed seed value.
All executions of the Optimization component will use exactly the same sequence
of random numbers and, therefore, will produce exactly the same design points.
This arrangement is useful for debugging the optimization process when it is
necessary to reproduce the same sequence of design points.
If this option is not selected, the random number generator is seeded by using the
clock time at the moment of execution.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Crossover Type. This parameter controls the type of crossover operation - one
point crossover or two point crossover. The default value is 1. Other possible value
is 2.
Crossover Rate. This parameter controls the probability of crossover operation for
each individual in every generation during execution of NCGA algorithm. The
type of value is real. The default value is 1.0. Other possible values are 0 and
1.0.
Use Optimal Mutation Rate. This parameter controls whether or not NCGA will
use the optimum mutation rate value calculated internally. The default value is true
(yes). Other possible value is false (no).
Mutation Rate. This parameter specifies the probability of mutation for each
individual. The type of value is real. The default value is 0.01. Other possible
values are 0 and 1.0.
Gene Size. This parameter controls the size of the gene used to represent each
individual. The type of value is integer. The default value is 20. Other possible
values are 1 and 63.
files can get extremely large, so they are not stored with the run results by default.
Select this option if you want to store the log with the run results (as a file
parameter) for later viewing.
Use initialization file. This parameter controls whether or not the algorithm will
use a data file for the initial generation. The default value is false (no). Other
possible value is true (yes).
Initialization File. This parameter specifies the name of the data file to be used for
initial generation.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Max Iterations. This parameter sets the maximum number of design iterations
you want the optimizer to run. The type of value is integer. The default value is 10.
Other possible values are 1.
Termination Accuracy. This parameter sets the termination criterion for NLPQL.
The stopping algorithm of NLPQL uses several alternative convergence checks,
with the main convergence parameter based on the Karush-Kuhn-Tucker necessary
optimality condition and the complementary slackness. Termination accuracy is
applied in such a way that the scale of the objective and constraint parameters has
little or no effect on the convergence check.
The accuracy of the gradients calculation must be considered when selecting the
value of Termination Accuracy. If the simcode outputs are accurate up to 8-10
digits, and the calculated gradients have at least 7 accurate digits, then the
recommended value for Termination Accuracy is 1.0E-7. If the gradient’s accuracy
Rel Step Size. This parameter sets the relative finite difference Step size for the
creation of the linear model. The type of value is real. The default value is 0.0010
(0.1 percent). Other possible values are 0.0.
Min Abs Step Size. This parameter sets the minimum absolute finite difference
Step for the creation of the linear model. The type of value is real. The default
value is 1.0E-4. Other possible values are 0.0.
Max Failed Runs. This parameter is used to set the maximum number of failed
subflow evaluations that can be tolerated by the optimization technique. If the
number of failed runs exceeds this value, the optimization component will halt
execution.
Failed Run Penalty Value. This parameter represents the value of the Penalty
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Failed Run Objective Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Population Size (even value). This parameter controls the number of individuals
in each generation during execution of the NSGA-II algorithm. The type of value
is integer. The default value is 50. Other possible values are even integers 6 and
100.
Number of Generations. This parameter controls the number of generations to be
analyzed by the NSGA-II algorithm. The type of value is integer. The default value
is 100. Other possible values are 1 and 1000.
Use fixed random seed. If this option is selected, the random number generator
used by the optimization algorithm is seeded using the specified fixed seed value.
All executions of the Optimization component will use exactly the same sequence
of random numbers and, therefore, will produce exactly the same design points.
This arrangement is useful for debugging the optimization process when it is
necessary to reproduce the same sequence of design points.
If this option is not selected, the random number generator is seeded by using the
clock time at the moment of execution.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
Maximum allowable job time (hr). This parameter represents the time that
Pointer has to complete a job. Pointer will use all the time you give it, even if it
finds the global optimum early on. The longer it is stuck without finding an
improvement, the more radical changes it will try. Accepts a real input greater than
0.0. The default value is 1.0.
Average analysis time (sec). This parameter is the average wall clock time it takes
to run a single simulation, including all iSIGHT-FD-related overhead (for file
parsing, etc.) Pointer takes the ratio of allowable job time and average simulation
time to estimate how many simulations it will be able to do and adjusts its search
strategy accordingly. Accepts a real input greater than 0.0. The default value is 1.0.
Topography type. The default value is nonlinear. The following options are
available:
linear. This option assumes that objectives and constraints are linear
combinations of the design variables.
smooth. Indicates that the function is differentiable everywhere and contains
no discrete steps, but could still contain multiple local minima.
rough. Indicates that the function is not necessarily smooth, but only contains
small scale discontinuities or noise.
discontinuous. Indicates that the design space could contain large scale
discrete steps, and points where the function is not differentiable.
nonlinear. The only assumption made is that objectives and constraints are not
linear combinations of the design variables (i.e., the problem is not a linear
one).
unknown. No assumptions have been made about the nature of the design
space.
Failed Run Penalty Value. This parameter represents the value of the Penalty
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Failed Run Objective Value. This parameter represents the value of the Objective
parameter that is used for all failed subflow runs. The default value is 1.0E30.
Use fixed random seed. If this option is selected, the random number generator
used by the optimization algorithm is seeded using the specified fixed seed value.
All executions of the Optimization component will use exactly the same sequence
of random numbers and, therefore, will produce exactly the same design points.
This arrangement is useful for debugging the optimization process when it is
necessary to reproduce the same sequence of design points.
If this option is not selected, the random number generator is seeded by using the
clock time at the moment of execution.
Return to step 7 on page 178 for information on using the other tabs on the
Optimization component editor.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
“Creating Models Using the Design Gateway,” on page 49.
The Component Editor dialog box appears.
The editor is divided into four tabs: General, Design Variables, Random Variables,
and Responses. The General tab offers execution options and a description of SDI.
The Design Variables tab allows for the selection and configuration of the design
variables. The Random Variables tab allows for the selection and configuration of
the random variables. The Responses tab allows for the selection and configuration
of the response parameters.
Analyze Design. This mode simply performs a Monte Carlo simulation around
the current design point (current parameter values), varying only random
variables.
Note: The Design Variables tab is not displayed when Analyze Design is
selected.
3. Set the following execution options, if available:
Number of SDI Steps. Specify the number of new designs chosen and new
sample sets executed. Each step produces a new “best” design point unless no
improvement (no points closer to the target) greater than the Termination
Threshold Distance is identified. The default is five steps.
Number of Samples per Step. Specify the number of Monte Carlo samples to
be performed at each SDI iteration. The samples are taken across the
distributions of the random variables and local range of the design variables.
Since the goal is to find a design closer to the targets, not to calculate response
statistics, a large sample set is not necessary. The default is 16 samples.
Execute sample points in parallel. Select this option of you’d like the sample
points for each SDI step or the complete sample set in Analyze Design mode to
be executed in parallel.
Note: The number of CPUs available may limit the number of sample points
that are actually executed in parallel.
Use a fixed seed. The seed can be fixed by clicking this check box and
specifying the seed manually in the corresponding text box. If this check box is
not activated, the seed is determined randomly.
Note: You can map the values of these settings (with the exception of Use a fixed
see) to a parameter. For more information, see “Mapping Options and Attributes to
Parameters,” on page 166.
4. (optional) Click the Advanced Options... button; then, set either of the following
options:
Execute subflow only once. If selected, the subflow executes only one time.
This is useful in models that need to turn the driver logic on/off parametrically.
This option is also helpful in debugging the process.
Note: You can map this setting to a parameter. For more information, see
“Mapping Options and Attributes to Parameters,” on page 166.
Allow the following to be turned off by parameters. This option allows you
to de-activate (turn off) the selected types of design parameters (design
variables, random variables, responses) using input parameters to the SDI
component. If this option is selected, boolean input parameters will be created
in an Active Design Variables/Active Random Variables/Active Responses
aggregate under the Mapped Options and Attributes aggregate parameter. The
parameters are selected by default. If any of the parameters are not selected at
runtime, then those design parameters will not be used during execution.
7. Select the parameters you want to use as design variables by clicking the check
box that corresponds to the parameter. To select all parameters, click the Check
button at the bottom of the tab. To deselect all the parameters, click the Uncheck
button.
8. Specify the lower and upper bounds and initial value for each design variable.
Unlike optimization, SDI requires lower and upper bounds for each design
variable. The sample ranges at each step for SDI are determined by the range of the
design variable, the number of steps, and the current value of the design variable.
The initial value of the design variable is the current value of the parameter by
default. The default bounds are +/- 10% of the initial value.
Note: You can also set variable options using the Edit... button at the bottom of the
editor. For more information, see “Editing Attributes for Multiple Parameters,” on
page 220.
9. (optional) If desired, map the lower and upper bound variable attributes to
parameters. For more information, see “Mapping Options and Attributes to
Parameters,” on page 166.
11. Select the parameters you want to use as random variables by clicking the check
box that corresponds to the parameter. To select all parameters, click the
button at the bottom of the tab. To deselect all the parameters, click the
button.
Once you select a random variable, its name is displayed in the Distribution
Information area, and the rest of the tab is activated.
12. Set any of the following options, some of which vary based on your distribution
selection:
Click the Distribution button to set the probability distribution option for the
random variable. Like sampling techniques, random variable distributions are
implemented as “plug-ins” used by the SDI component. They are extendable
by creating new “plug-ins” for new distributions.
Note: You can map this setting to a parameter by right-clicking it and selecting
Map this value to a parameter. The Select a Parameter dialog box appears,
allowing you to name the parameter. The parameter is then viewable on the
Parameters tab (inside of the Mapped Attributes and Options aggregate
parameter). Once mapped, a icon appears next to the option, which you
can click to view or change the parameter name. You can also right-click on
the setting again to remove the mapping. For more information, see “Mapping
Options and Attributes to Parameters,” on page 216.
Coeff. of Variation. This distribution parameter is the value of the standard
deviation divided by the mean for the random variable. The default value
is 0.1.
appear for Lower and Upper, referring to the lower tail and the upper tail.
Specify the location at which the distribution is to be truncated. Values of the
distribution below the Lower truncation value and above the Upper truncation
value will not be sampled. The distribution preview graphs are updated to
display the effects of truncation.
Note: You can also set variable options using the button at the bottom of the
editor. For more information, see “Editing Attributes for Multiple Parameters,” on
page 220.
13. Review the preview graphs on the right side of the tab. These graphs are
automatically updated based on changes made to the selected random variables
distribution properties. A legend below the graph explains the color coding. The
graphs display the following information:
Probability Density. This graph shows the actual shape of the selected
distribution with regard to the probability density function.
Cumulative Distribution. This graph shows the actual shape of the selected
distribution with regard to the cumulative distribution function.
14. Set the Update random variable mean values to current parameter values
before execution option. This option, at the bottom of the tab, allows for
automatic updating of mean values of all random variables to the current parameter
values in this component, prior to executing the SDI component. The default is to
have this option deactivated, and to retain settings. If you want to automatically
change the settings to the current point when the SDI component is executed, click
this check button to activate it. This option is useful if the SDI component is
executed after another component, and parameter values are taken from the
previous component.
16. Select the output parameters you want to use as responses by clicking the
corresponding check boxes. To select all parameters, click the Check button at the
bottom of the tab. To deselect all the parameters, click the Uncheck button.
Target. Specify the desired goal target value for all responses that define
performance of the system. The SDI process will attempt to move the design
towards the specified targets.
Note: The target is not needed when the execution mode is “Analyze Design”.
Additionally, for highly correlated responses, a target should only be defined
for one response in the correlated set so as not to over determine the problem.
Target Type. Select the type of the reponse goal for all responses with a Target
value defined (Target Type is required when a target value is entered). The
Target Type determines how the distance from the target is calculated and how
the SDI iterations proceed.
Upper Limit. If a response value is specified in the Upper Limit column for a
response, it will be used to assess penalty on the calculation of the distance
from the target. For all design points with response value above the upper
limit, the distance will be penalized, effectively removing the design point
from consideration as a new best design. Also, the probability of response
values less than the upper limit will be calculated and reported after all
simulations are complete.
Note: If both Lower and Upper limits are specified, then the Total probability
between the limits is also reported.
Percentile. If a percentile value (a value between 0 and 1) is specified in the
Percentile column for a response, the response value corresponding to that
percentile of the resulting response distribution will be reported after all
simulations are complete.
Note: You can also set response options using the Edit... button at the bottom of
the editor. For more information, see “Editing Attributes for Multiple Parameters,”
on page 220.
18. (optional) If desired, map any of the response attributes to parameters (with the
exception of Target Type). For more information, see “Mapping Options and
Attributes to Parameters” on this page.
19. Click OK to close the editor and save your changes. Click Apply to save your
changes, but keep the editor open.
3. Click the value in the Value column for the execution option whose value you
want to map. The value is highlighted.
Note: You can also map the Execute subflow only once option. Click on
Advanced Options... to access this option.
4. Right-click the value; then, select the Map this value to a parameter option. The
Select a Parameter dialog box appears prompting you to enter the name of a
parameter to which you want to map.
5. Type a name for the parameter (by default, the execution option name is used);
then, click OK. Once mapped, an icon appears next to the execution option.
You can click this button to view or change the parameter name. You can also
right-click on the setting again to remove the mapping.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
8. Right-click in the Standard Deviation text box; then, click Map this value to a
parameter.
Note: Standard Deviation is the only random value attribute that can be mapped.
The Select a Parameter dialog box appears prompting you to enter the name of a
parameter to which you want to map.
9. Type a name for the parameter (by default, the Standard Deviation attribute name
is used); then, click OK. Once mapped, an icon appears next to the tuning
parameter’s value. You can click this icon to view or change the parameter name.
You can also right-click on the setting again to remove the parameter name.
10. Click Apply to save your changes; then, proceed to step 14.
11. Determine if you want to map a Design Variable or a Response attribute; then,
click the appropriate tab on the component editor. In the example below, a Design
Variable is being mapped.
If you want to apply the mapping to only the selected parameter, select the
Map <Attribute_Name>to a parameter for selected option.
If you want to apply the mapping to all the parameters, select the Map
<Attribute_Name> to a parameter for all option.
An icon appears next to the variable’s value. You can click this icon to view or
change the parameter name.
The parameter(s) you have just created will appear in the Design Gateway
Parameters tab as a special aggregate parameter.
Note: You can remove these mappings at any time. Simply right-click the
appropriate parameter attribute; then, select the Remove mapping of
<Attribute_Name> to a parameter for selected or Remove mapping of
<Attribute_Name> to a parameter for all option, depending on how you
originally mapped the attribute.
14. Click OK to close the component editor and return to the Design Gateway.
16. Locate the new aggregate parameter called Mapped Attributes and Options
parameter; then, click the icon to expand the parameter. The new mappings
appear.
1. Select the parameter(s) you want to edit on the Design Variables, Random
Variables or Responses tab.
To select all parameters, click the Check button at the bottom of the tab. To
deselect all the parameters, click the Uncheck button.
The Edit dialog box appears. In the following example, a parameter on the
Random Variables tab is being edited.
3. Update the listed values, as desired. Only options with defined values appear on
this dialog box.
4. Click OK. The values are updated for all the parameters that were selected.
This component also grants access to the Task Plan feature, which allows you to apply
a design driver or sequence of design drivers to a workflow of analysis tools. Access to
this feature is based on your iSIGHT-FD license. For more information, contact your
Engineous Software representative.
Task component with Task Plan feature: Chapter 5 “Using the Task Plan Feature”
Depending on your iSIGHT-FD license, you either have a single option or numerous
options available with this component. The single option is Fast Path execution.
This option, when selected, will ensure that the Task component executes without
being dispatched to a FIPER Station when the Gateway is connected to an ACS in the
FIPER environment. When the Task is simply used to create a hierarchical structure in
your model, this option allows you to avoid the sometimes unnecessary overhead
incurred by dispatching it to another machine to execute.
Note: If file parameters are defined for the Task, this option cannot be enabled since
the files must be processed.
This component also grants access to the Task Plan feature, which allows you to apply
a design driver or sequence of design drivers to a workflow of analysis tools.
Access to the Task Plan feature is based on your iSIGHT-FD license. Contact your
Engineous Software representative for more information. If your license grants access
to this feature, see Chapter 5 “Using the Task Plan Feature” for usage information.
For detailed information on each of these techniques, as well as their parameters, see
the remaining parts in this section.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The editor is divided into six tabs: Technique, Data File, Parameters, Technique
Options, Error Analysis Options, and View Data.
Note: The Technique Options tab is hidden if you choose the RBF Model option
because RBF Models do not have any technique options.
2. Verify that the Technique tab is selected; then, choose the technique you want to
use from the Approximation technique drop-down list. Information about the
technique appears in the Technique Description area.
The Data File type is Sampling Points by default. You may also use a previously
saved coefficients data file from another approximation with the same number of
input and output parameters. Proceed to one of the following sections:
5. Type the name and path of the data file directly into the corresponding text box, or
click the Browse... button and navigate to the file with data for approximation
construction. The file must contain parameter names on the first line, and data
points on each line after that.
6. After entering the data file, determine how iSIGHT-FD will handle the file using
one of the following options:
Static file. When this option is selected, the data in the file never changes.
iSIGHT-FD will read it once and save in memory for future use. However, if
the contents of the file change, you can instruct iSIGHT-FD to re-read the file
using the Re-read File button.
Dynamic file. When this option is selected, the data in the file can change.
iSIGHT-FD will read it every time before initialization. If you are executing
using an ACS in the FIPER environment, the file must be accessible via the
absolute path or shared file system.
File parameter. When this option is selected, iSIGHT-FD will create a file
parameter in the component, which can be mapped to receive data from
another file parameter at the time of execution.
8. Select Coefficients Data from the Data File Type drop-down list.
9. Type the name and path of the data file directly into the corresponding text box, or
click the Browse... button and navigate to the file with data for approximation
construction.
Note: If you use a coefficients data file, the Technique Options tab is not available.
10. Click Apply to save your changes.
This tab allows you to set the list of input and output parameters of the
approximation by selecting them from the list of available parameters. If you
previously created parameters for this component using either the Design Gateway
or this editor, the parameters will appear in the two lists on this tab. You can add
new parameters to your component by scanning the first line of the data file.
2. Click the Scan... button.
All parameter names found on the first line of the data file are displayed in the
table on this dialog box. You can select any number of parameters to be used as
inputs or outputs. You do not have to select all of the parameters in the data file.
3. Determine if the parameters will be input or output parameters using either of the
following options, as desired:
4. Click OK.
You are returned to the Parameters tab, and the selected parameters are displayed
as specified (input or output).
5. Verify that the correct parameters are selected for use with your approximation.
You can choose individual parameters, or use the Check button to use all of the
listed input or output parameters.
Proceed to “Setting Technique Options,” on page 231 if you are using the
Response Surface Model technique and wish to define specific options. This
tab is not available is you selected the Coefficient Data option on the Data File
tab. For more information on where to set this option, see “Selecting the
Technique and Specifying the Data File,” on page 223.
Proceed to “Setting Error Analysis Options,” on page 234 if you wish to set a
particular option (other than the default) for the error analysis.
Proceed to “Viewing Coefficients Data,” on page 236 if you wish to view the
approximation’s internal coefficient data.
Click OK to close the editor.
If you are using the RBF Model technique, proceed to “Setting Error Analysis
Options,” on page 234.
1. Click the Technique Options tab. The contents of the tab appear.
2. Set the Polynomial Order option. This option controls the order of the
polynomials used by the Response Surface Model. The following options are
available:
Linear. This option makes all outputs linear functions with respect to inputs.
This option is recommended if you want to study first order (linear) effects of
the inputs on the outputs.
Quadratic. If this option is selected, the polynomials for all outputs will
contain linear terms, as well as all quadratic terms and all two-way interactions
of the inputs. This option is the recommended choice unless you know that the
outputs are either linear or highly non-linear with respect to the inputs.
Quadratic polynomials also behave well in optimization.
Cubic. If this option is selected, the polynomials for all outputs will contain, in
addition to all linear and quadratic terms, all pure cubic terms. No three-way
interactions are included. Cubic polynomials require more design points in the
data file. They are recommended only for highly non-linear output functions,
when it is known that quadratic polynomials do not provide an accurate
approximation of the outputs.
Quartic. If this option is selected, the polynomials for all outputs will contain,
in addition to all linear and quadratic terms, pure cubic terms and pure 4-th
order terms. No three-way or four-way interactions will be included. The same
recommendations that apply to cubic polynomials also apply to quartic ones.
In practice, it is rarely necessary to use quartic polynomials. Cubic and quartic
polynomials may inhibit the optimization process by creating numerous false
local minima.
If you want to use term selection for your approximation, proceed to step 4.
If you do not want to use term selection for your approximation, proceed to
“Setting Error Analysis Options,” on page 234.
4. Set the Select the following number of best terms from polynomial option.
Click the corresponding check box if you want to activate the polynomial term
selection; then, specify the number in the adjacent text box. If this option is
selected, iSIGHT-FD will perform polynomial term selection and select the
specified number of best terms.
Note: This value must be lower than the total number of polynomial terms
displayed at the top of the tab (to the right of the Polynomial Order button) and
higher than zero. You can use Term Selection to remove some polynomial terms
with low significance, which can improve reliability of your approximation.
5. Select one of the following options from the Term selection method drop-down
list:
Here are exact output values, are approximate output values, n is the
number of design points used for RSM.
Stepwise(Efroymson). This method of polynomial term selection starts with
the constant and then adds polynomial terms one at a time so that the fitting
errors of the RSM are minimized at every step. A new term is added if the
following condition is satisfied:
After adding a new term, iSIGHT will examine all selected terms and will
delete one or more terms for which the following condition is satisfied:
The latter two values can be controlled using the text boxes that appear under
the Term Selection Method menu when Stepwise (Efroymson) is selected:
• F-ratio to drop term. This is the maximum value of F-ratio to drop a
polynomial term from RSM.
• F-ratio to add term. This is the minimum value of F-ratio to add a new
polynomial term to RSM.
Two-At-A-Time Replacement. This method of polynomial term selection
starts with the constant and then adds polynomial terms one at a time so that
the fitting errors of the RSM are minimized at every step. After adding a new
polynomial term, iSIGHT-FD will consider all possible replacements for 1 or 2
of the selected terms that can reduce the fitting errors further. Then the best
replacement combination is found and the terms are replaced and the next best
term is selected and added. The process is repeated at every step until the
maximum number of terms is selected. This method has a better chance of
finding the best approximation than the two previous methods, but it is more
expensive computationally.
2. Select one of the following from the Error Analysis Method drop-down list:
Cross-Validation. This method selects a subset of points from the main data
set, removes each point one at a time, re-calculates co-efficients, and compares
exact and approximate output values at each removed point. Proceed to step 6.
3. Type the name and path of the data file directly into the corresponding text box, or
click the Browse... button and navigate to the file with data for approximation
construction. The file must contain parameter names on the first line, and data
points on each line after that.
4. After entering the data file, determine how iSIGHT-FD will handle the file using
one of the following options:
Static file. When this option is selected, the data in the file never changes.
iSIGHT-FD will read it once and save in memory for future use. However, if
the contents of the file change, you can instruct iSIGHT-FD to re-read the file
using the Re-read File button.
Dynamic file. When this option is selected, the data in the file can change.
iSIGHT-FD will read it every time before initialization. If you are executing
using an ACS in the FIPER environment, the file must be accessible via the
absolute path or shared file system.
5. Proceed to step 8.
6. In the text box, type the number of points from the total number of sampling points
you want to use for cross-validation error analysis.
7. Click the Use a fixed random seed for selecting points check box and specify a
seed value to use for the random generator when determining the set of sample
points to be executed. This option allows you to reproduce the approximation with
the same set of points later, if desired.
Note: You may see a message stating that changes have been made to your
configuration. Click Yes to save the changes.
If the approximation is not initialized upon opening this tab, your tab will appear as
shown above. If your approximation is initialized, internal data appears on the tab,
as shown after step 2 below.
Click the Save Data... button if you want to save the internal approximation
data to a file. Specify the name and location of the file using the Select File
dialog box that appears.
Click the Clear Data button if you want to reset your approximation (clear all
internal data from the approximation); then, click Yes to verify the data
removal. The approximation will become uninitialized, and the initialization
message and button reappear on the tab. Return to step 2 to initialize the
approximation again.
Click the Error Analysis... button to open the Approximation Error Analysis
tool. The Error Analysis button is only available if error analysis was
performed on the approximation. For more information on using this interface,
see “Analyzing Approximation Errors,” on page 520.
Click the Visualize... button to open the Approximation Viewer tool. For more
information on using this interface, see “Visualizing an Approximation,” on
page 495.
4. Click OK to close the editor and save your changes. Click Apply to save your
changes, but keep the editor open.
Creating a Calculation
To use the Calculator component:
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
Parameters list. This area, on the bottom left half of the dialog box, contains a
list of available parameters. You can select parameters from this area to use in
your expressions. You can use the drop-down list at the top of the area to
determine what parameters are displayed in the list. All parameters are
displayed by default.
Calculator buttons. These buttons, in the middle of the bottom half of the
dialog box, are arranged to resemble a standard calculator.
Functions list. This list, on the bottom right half of the dialog box, contains a
list of functions that may be helpful in defining your expressions. You can use
the drop-down list at the top of the area to determine what functions are
displayed in the list. Also, if you place your mouse pointer over a function,
information about the function is displayed in a pop-up tool tip.
Status bar. This item, at the bottom of the dialog box, just above the OK
button, displays messages associated with using the Calculator component.
2. Enter your calculations by typing the calculation in the expression text box or by
using any of the following methods:
Note: Array variables can also be used with statistical functions. For more
information, see “Using Array Parameters,” on page 243.
To insert a function call: Double-click a function in the Functions list to add it
to the Expression text box. You can also select the item and click the Add
button.
4. Once the calculation is finalized, you can choose one of the following options, if
desired:
Click the Calculate Now button to execute the calculation and display the
result at the bottom of the dialog box, unless an error exists in the expression.
To view a more detailed result, click the Show Results button next to the result
or double-click the result itself to open the Calculation Results dialog box.
Click OK to close this dialog box.
Click the Clear button to remove all of the contents in the Expression text box;
then, click Yes to verify the action.
If an array parameter already exists, and you enter an array element that is outside the
bounds of the existing array parameter, you will be prompted to confirm the recreation
of the array parameter when OK or Apply is clicked.
You can only pass one array parameter, such as sum(arr1). You can pass multiple
scalar variables, such as sum(s1,s2,s3,…).
Only arrays of numeric datatype (real, integer) are available for use in calculations.
Only the following statistics functions are supported when using arrays:
absSum - the sum of the absolute values of all elements in the array
absMax - the maximum of the absolute values of all elements in the array
absMin - the minimum of the absolute values of all elements in the array
Understanding Limitations
The following limitations exist for variables used in Calculator component
expressions:
Using array variables: For more information on the limitations associated with
array variables, see “Using Array Parameters,” on page 243.
Get COM object property. This option allows you to set an iSIGHT-FD parameter
value from a COM object property value.
Set COM object property. This option allows you to set a COM object property
value from an iSIGHT-FD parameter value.
COM object method / function execution. This option allows you to execute
functions provided by the COM object and map the return values to iSIGHT-FD
parameters.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
2. Type the COM object name in the COM Object text box. You must know the
name of the object you are going to use. There is currently no way to browse the
set of registered COM objects for selecting.
3. Specify the operation you want to perform using the Operation button:
4. Specify the property to get in the corresponding text box; then, select the
iSIGHT-FD parameter whose value you want to set from this property from the
Parameter to set return value to drop-down list or specify a new parameter using
the button. For more information on creating parameters, see “Creating New
Parameters,” on page 566.
5. Click the button to add the new operation to the list in the Operations area.
8. Select the iSIGHT-FD parameter to set the return value to from the corresponding
drop-down list.
Note: You can create a new parameter in which to store this value using the
button. For more information on creating parameters, see “Creating New
Parameters,” on page 566.
If you select Constant: Specify the constant in the text box below the
drop-down list; then, click the button. The argument is added to the small
list in the Arguments area.
If you select Parameter: Select the parameter you want to use from the second
drop-down list, or create a new parameter using the button; then, click the
button. The argument is added to the small list in the Arguments area.
Use the buttons in the Arguments area to rearrange the order of the
arguments.
11. Click the button at the bottom of the left side of the editor. The specified
operation is added to the list in the Operations area.
If you are using the Set option, the editor appears as shown below.
13. Specify the COM property to set in the corresponding text box.
14. Specify whether you are setting the COM property from an iSIGHT-FD parameter
value or from a constant using the Value to set to drop-down list; then, select the
parameter from the drop-down list or type the value of the constant in the text box.
Note: You can create a new parameter in which to store this value using the
button. For more information on creating parameters, see “Creating New
Parameters,” on page 566.
15. Click the button to add the new operation to the list in the Operations area.
16. (optional) Click Apply at any time to save your changes. Repeat the appropriate
previous steps to add more operations as desired.
17. Use the and buttons in the Operations area to specify the order of the list of
operations.
Note: You can delete an operation by highlighting it and clicking the button
below the operations list.
The Data Exchanger can process multiple files at one time, allowing data to be copied
directly from one file to another, or to use a read-only file to look up reference data.
Data can be read from and written to the same file when necessary. General
programming commands written in Java can be inserted between the data exchanger
actions in order to perform a calculation, loop over multiple data items, and even to
recover from processing errors.
The Data Exchanger is most frequently used to prepare input files for external
programs and to extract data from program output files. It can be used by itself in an
iSIGHT-FD workflow, and is also included as part of the Simcode component. The
Simcode component consists of an input Data Exchanger to prepare input for the
command, an OS Command to execute the command, and an Output Data Exchanger
to extract data from the program's output files. One advantage of the Simcode
component is that the files are prepared, processed, and read in the same step, avoiding
any need to transfer files over the network during distributed processing.
The information about the Data Exchanger Component is divided into the following
main sections:
Toolbar
The toolbar located at the top of the editor displays buttons for most of the actions
available from the right-click menus. Some actions can be accessed only from the
toolbar.
. Opens a Find dialog to search for a string in the data source (file).
. Marks a location in a General Text region. Searches for the currently selected
text, or prompts for a search string if no text is selected. For more information, see
“Creating Markers,” on page 298.
. Inserts a For Loop action. For more information, see “Using the For Loop
Editor,” on page 302.
. Edits full Java source of the actions. Opens a text area where the full Java text
of all the actions is displayed. You can edit this Java code, including cut/copy/paste
using the standard keyboard actions. When the edit dialog is closed, the Java code
is split into actions and re-executed.
The first entry in the list is always a comment (cannot be deleted or edited). The
purpose of this comment is to select it in order to insert an action before all the other
actions.
The currently selected statement is shown with a blue background. This is the
statement associated with the last parameter or highlight clicked, and is the
statement associated with the Swipe editor. Almost any selection anywhere in the
editor changes the currently selected statement.
Note: Multiple actions may be selected by holding the SHIFT key and clicking or
holding the CTRL key and clicking in the Actions List. The only actions you can
take when multiple actions are selected is to delete the action by clicking the
button or cut/copy the actions using CTRL-X or CTRL-C.
The point where new actions will be inserted is indicated with a red line. New
statements are inserted between existing actions. Selecting an action in the list sets
the insertion point to be just after that action. Selecting parameters or highlights
does not change the insertion point.
The next action to be executed is indicated with a blue arrow in the right margin.
This arrow is only visible when single-stepping through the actions.
Right-clicking an action displays a menu that allows you to edit, cut, copy, or delete the
action(s). If you cut/copy an action, there will also be a Paste entry for re-inserting the
action(s). You can also cut/copy/paste actions with the standard keyboard actions:
CTRL-X, CTRL-C, and CTRL-V.
There is also a Run to this statement entry that is useful when debugging the actions.
Selecting this entry single-steps the list of actions until the current statement is at or
after the selected action.
Executing Actions
Typically, an action is executed as soon as it is inserted. Changing the value of a
parameter that is used in the Data Exchanger causes the whole list of actions to be
re-executed.
There are controls at the bottom of the Actions List for controlling execution. The
controls include the following:
. Stops execution. This button is only enabled when actions are being executed.
. Executes only the next action (the one with the blue arrow).
. Resets the program and sets the Next Action arrow to the top of the list. You
have to reset the actions before you can single-step.
It can be useful to reset the list of actions and step through them one at a time to see
what each action does. When single-stepping, read or calculation actions will
immediately update the value of the affected parameter. You can also step through a
Loop to see what happens each time through.
You must select text from the file and then a parameter in order to define a read or write
action. The action is executed as soon as it is created: the value of the parameter is
updated with the text read, or the file is updated with the parameter value written,
allowing you to see how the file and parameters will look when the Data Exchange is
run.
The text is highlighted in various colors to indicate how the text is to be processed. The
following color scheme is used:
Yellow: sub-sections of the current section. If you format part of a file as a table
and click outside the table, the table will be yellow and the rest of the file will be
white.
Gray: the area outside of the currently selected section. If you format part of a text
file as a table and then select the table, the table will be white and everything
outside the table will be gray.
Clicking in a green or pink highlighted area selects the read or write action and the
parameter.
The area selected determines the actions that are available. All actions except Load
Sample File and Edit Format are also available on the toolbar.
Load Sample File. Loads a new data file to test how the parsing instructions will
act on it.
Edit Section Details. Changes the details of how the section (or whole file) is
parsed. This is mostly used to change the delimiters that separate words.
Edit Selected Statement. Edits the currently selected statement. This is usually a
read or write statement. If no read/write is selected, then it can be the section.
Edit Format. Allows you to set a format to control how a number is printed.
Find (General text format only). Opens a find dialog to search for text.
Marker (General text format only). Opens a find dialog to search for a string, and
remembers where it was found. This marker can then be used as an anchor for
subsequent read/write operations.
Insert Read. Creates a read action. This action works in the same manner as the
read button on the command bar. If a read action is currently selected, this
action converts the read into a write action.
Insert Write. Creates a write action. This action works in the same manner as the
write button on the command bar. If a write action is currently selected, this
action converts the write to a read action.
New Section. Creates a new section from the currently selected text.
The background of the parameter area changes to indicate the status of the parameter:
White: the box is empty or contains the name of an existing, unused parameter.
Yellow: the box contains the name of a new parameter that does not exist yet.
Green: the box contains an existing parameter that is being read from the file.
Pink: the box contains an existing parameter that is being written to the file.
Also, buttons are present that allow you to create a read or write operation.
The button for the default operation for this file is highlighted with a black border.
Read is the default operation for files that are being read (“Output parse”), and Write is
the default operation for files being written (“Input parse”). The current operation (read
or write of a parameter) can be removed by clicking the Unbind button .
The swipe area is always displayed. You can hide it by clicking the down arrow located
below the Parameter Read/Write area.
Changes to text fields in the swipe area do not take effect until after you press the
ENTER key on your keyboard.
This list contains all parameters for the Data Exchanger, all parameters for the simcode
the data exchanger is part of, and also all parameters from the parent and sibling
components that could be mapped to this component. Using a parameter from a parent
or sibling component automatically maps it to the data exchanger component when the
editor is closed.
Clicking the icon in the Op (operation) column is a shortcut to read or write that
parameter. The button cycles through the available options. You cannot delete the
parameter binding by simply using the operation column, you must use the right-click
menu or click the Unbind button in the Parameter Read/Write area.
Right-clicking a parameter opens the standard Parameter menu, with entries for editing
the parameter details, and cut/copy/paste parameters options.
You can also use the List of Parameters to create new parameters (the button), add
You can change the name, mode, value, or data type of an existing parameter by
clicking in the appropriate cell of the List of Parameters table.
The List of Parameters behaves similarly to the Parameters tab on the main Design
Gateway interface. However, you cannot select multiple parameters on the Data
Exchanger editor. Additionally, parameters do not appear on the Parameters tab until
the OK or Apply button on the Data Exchanger editor is clicked.
Status Bar
The status bar at the bottom of the interface displays various messages about the status
of the Data Exchanger editor. General progress messages are in gray, and warning
messages, especially about invalid data during a read, are in yellow. Error messages are
in red (or pink).
Note: When the Full Java Code view is open and there is an error in the Java code, the
error message is displayed on the Status Line of the main editor interface. Because of
this, when you open the Java Code view, you should position it above the editor
interface so the status line is still visible.
Note: The Javadocs that are shipped with iSIGHT-FD are located in the javadocs folder
in the iSIGHT-FD installation directory.
This interface is accessed by clicking the New Section Format button in the
Parameter Read/Write area. It allows you to adjust the selection, and then apply a
formatter to the selection. For more information on this wizard, see “Changing the
Format of a Section of a Data Source,” on page 281.
Understanding Terminology
Two terms are used throughout this component description to describe actions taken by
the user of the component. Both of these terms are used when describing the
highlighting of data in the Data Source area. These terms are:
swipe. This action involves highlighting data by clicking your mouse button,
dragging it across the desired data, and then releasing the mouse button. The
behavior of swiping text depends on the current section format. For the General
Text format (the most common one), swiping across several columns selects
exactly those characters (fixed column, fixed length). Swiping down selects
multiple whole lines. For the Vector format, a swipe selects multiple elements of
the vector. For the Table format, a swipe may select all or part of a row, a column,
or a sub-table.
click. This action involves placing your mouse pointer on a particular location in
the Data Source area and clicking the button a set number of times (single-clicking,
double-clicking, and triple-clicking). For the General Text format, a single click
selects the current word or item, a double-click selects the current word, and a
triple-click selects the whole line. For all other formats, a click selects the current
item and double and triple-clicks have no additional effect.
Note: For the general text tool, selecting a word with a click and selecting
characters with a swipe results in very different behaviors. When a word is
selected, the data will be located at runtime by counting the number of words from
the beginning of the line, no matter how long those words may be. When
characters are selected, the characters at exactly those positions on the line will be
used - if something earlier on the line became longer, the data will no longer fit
within the swipe. It is not recommended that you swipe characters of text except
when reading or writing data to be processed by a FORTRAN formatted read or
write operation. The Swipe Details area tells you if the data was selected by word
or by characters.
2. Click the large button in the center of the dialog box to begin the process of
defining a data source.
The Exchanger Wizard appears with the Select File screen displayed.
Note: The Exchanger Wizard is different for the input and output parses of the
Simcode component, even though the rest of the Data Exchanger editor is the same
for Data Exchanger and Simcode components.
3. Determine how the file is to be used. The following two options are available:
Read a File (proceed to step 4). This is used to read data from a file output by
an external program, and is sometimes called an Output Parse because an
output file is being read.
Write to File (proceed to step 7). Writes parameter values to a file that will be
used as Input to an external program. This is sometimes referred to as an Input
Parse.
4. Specify the sample file that will be used in the Sample file to use when designing
Data Exchange text box. You can type the name of this file directly, or navigate to
it using the Browse... button. This file must already exist.
5. Specify the name of the file to read at runtime in the second text box. Simply enter
the name of the file. If you browsed to the file in step 4, this text box is
automatically filled using the name of the specified file. Instead of typing a file
name, you can select an existing file parameter. The file specified by the parameter
will be used.
Note: If you type the name of a file, an Input file parameter is created that
references the named file. This file parameter can be mapped from an earlier
component in the workflow that produces the file.
6. Proceed to step 9.
7. (optional) Specify the template file to update. The Template file is optional; if no
template is given, the Data Source area will initially be blank. The whole file will
be created by writing parameter values.
Note: An Input file parameter is created for the Template file. This parameter has
the same name as the file being written, with “Tmpl” appended. While the
template file is usually fixed, it is possible to map another file parameter to the
Template file parameter, allowing the Template to vary at runtime.
8. Specify the file to write at runtime, or select an existing file parameter. If you
browsed to the file in step 7, this text box is automatically filled using the name of
the specified file.
Note: If a file name was typed, an Output file parameter is created. The parameter
name is the same as the name of the file being written, but with periods converted
to underscores. This file parameter can be mapped to subsequent components in
the workflow. For the Input Data Exchanger of a Simcode component, only one
file parameter is created, since the OS Command part of the simcode directly reads
the file from the working directory. In this case, the file parameter has the same
name as the sample file, and has mode input.
9. Set the encoding option using the corresponding drop-down list. This option
allows you to explicitly specify the encoding the file parameter is to use when
converting between bytes and characters. In a Locale (a system setting that
includes the language, number formats, and character set in use) that uses
multi-byte characters (Japanese, Chinese, Korean), there is a default encoding used
to convert bytes into characters. Most text files will be written using this encoding,
but sometimes it is necessary to specify this encoding. For additional information
on encoding, refer to the iSIGHT-FD Development Guide.
Note: This setting is visible only if the Show File Type Encoding option on the
Files tab is selected on the Parameters preference dialog. For more information
about this option, see “Setting Gateway Preferences,” on page 42.
Select the general layout of the text in the file. The following options are available:
General Text. This format is for text with no particular structure. Fields are
located by searching for words or phrases. For more information on using this
format option, see “Using the General Text Format Option,” on page 285.
Table. This format is for tables and lists of numbers. Fields are addressed by
row number (line) and column number. This option can be used with files in
any format as long as the line numbers never change; the number of entries on
each line does not have to be the same. The cells in the table may be separated
by delimiters (usually space or comma), or the table columns can be defined
by absolute character position (sometimes useful for reading packed
FORTRAN formatted data). The Table format allows whole columns, rows
and arrays to be read into Array parameters in one operation. For more
information on using this format option, see “Using the Table Format Option,”
on page 293.
Vector. This format is for data organized as a list of values separated by spaces
or punctuation. Fields are numbered sequentially through the whole section.
The Vector format allows one-dimensional arrays to be read in one operation.
The values can span multiple lines. This option is often used for FORTRAN
list-directed input. For more information on using this format option, see
“Using the Vector Format Option,” on page 296.
11. Select the option that is best suited to the file you are using; then, perform one of
the following options:
For General Text, Table, and Vector formats: Click Finish. The file is
displayed in the Data Source area as a new tab. Proceed to the section that
describes the usage of the format you selected (these sections are identified in
the previous step of this procedure).
For the Name Value format: Click Next. The Name/Value format requires
additional configuration, but allows all items to be automatically read into
similarly named parameters.
12. Select the delimiter that you want to use for your file.
Once a selection is made, the highlighted information in the Sample Text area is
updated, if necessary. The name fields are highlighted in orange, and the value
fields in green.
Note: The wizard attempts to select the best delimiter automatically. For this
reason, the highlighted screen often appears immediately after clicking the Next
button from the File Format screen (step 11).
Verify that only the data you want is included in the Value field. Sometimes it
is necessary to use a multi-character delimiter (such as “:=”) to make sure that
the right data is in the values.
Empty lines and lines that do not have the delimiter are ignored.
13. Click Next. The Map Item Names to Parameters screen appears. This screen
allows all of the entries in the Name/Value file to be automatically read or written
to/from parameters with the same name as the Name field of the item.
14. Edit the parameter information, as desired. The following options are available:
Select parameters that will be read from or written to using the Op column.
You can select or de-select individual parameters by clicking the Op column
for that parameter, or you can select all of the listed parameters using the Read
All or Write All buttons. You can also clear the selection of every parameter
using the Clear All button.
If the file is open for reading, the Op column toggles between Read and
No Operation (an empty box). If the file is open for writing, you have the
option to read or write the item, and the Op column toggles through the
sequence Write ( ), Read, and No Operation.
Note: Changing the name of a parameter does not change the name of the
name/value field it will be read from or written to.
When writing, you can change the initial value of the parameter by editing the
Value column of the table.
Change the mode of a parameter (the available options are Input, Output,
In/Out, and Local).
Change the type setting of the parameter. The Wizard guesses at the data type
based on the data in the Template or Sample file. This is sometimes wrong: If
the sample file contains a number without a fractional part, the Wizard guesses
it is of type Integer, when it perhaps should be type Real.
If the value is not a single number or word, the Wizard assumes it is text data and
selects the data type String. Often such entries actually contain a number followed
by a comment, or a vector of numbers. Such items can be handled by creating a
General Text or Vector section on top of the value. For now, de-select the
name/value item by clicking in the Op column until it is blank. The read/write for
that item will have to be set up later using the main Data Exchanger editor. For
additional information on setting parameter information, see Chapter 9 “Defining
and Mapping Parameters”.
15. Click Finish. The file is loaded into the Data Exchanger component.
16. Proceed to one of the following sections:
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Component Editor dialog box appears, and the existing data exchanger
program is loaded. The program is executed, displaying the data sources in tabs in
the Data Source area. The code insertion point is left at the end of the program, the
last section referenced is selected in the Data Source area, and the Swipe Details
area (if open) shows the selection details for this section. The GUI is left as it was
after the last read or write was created. This controls the selected parameter, the
contents of the Swipe Details panel, and the selected File tab.
Note: If the program is no longer correct (usually because a parameter used by the
program has been deleted), the Java code view (described on page 284) will open,
and the first error will be highlighted in pink.
In general, the data and parameter selections are independent, and can be selected in
either order. See below for some special-case details, however. The read or write
button is not enabled until both a Parameter and some Data have been selected. There
are several shortcuts for creating Read or Write operations to speed up the process.
These are described in detail below.
The same parameter can be read or written more than once. While reading into a
parameter several times is rarely useful, writing the same value in multiple places is
often required. To write the same parameter value more than once:
The process for creating a Read or Write is slightly different depending on whether the
parameters are created before the Data Exchanger editor is opened (Top Down) or are
created by the Data Exchanger editor (Bottom Up).
Note: A file opened as read-only supports only read operations, not write operations. In
this case, the Write button is disabled on the editor, and it is not a selectable option in
the Op column in the Parameter List area. On the other hand, a file opened for writing
supports both read and write operations.
Important: The Parameter List will show all parameters that belong to the Data
Exchanger component itself, the Parent component of the Data Exchanger, and any
Sibling components that are before or after the Data Exchanger in the workflow. When
a parameter from the Parent or Sibling components is read or written, a parameter with
the same name is created in the Data Exchanger component and the appropriate
parameter mappings are created. The parameters and mappings are not created until the
OK or Apply button on the editor is clicked. If the Cancel button is clicked, no
parameters are created and all work done since the editor was opened is discarded. To
create a top-down data exchange:
1. Select some data in the data source viewer using one of the following methods:
Triple-clicking. The triple-click action selects the entire line that currently
contains the cursor.
Swiping. This option allows for the selection of an item or a range of data. The
selected item or range is displayed in the Swipe Details area at the bottom of
the editor.
2. (optional) Adjust the swipe details. For more information on using the swipe
details options, see one of the following sections:
3. Select the parameter to represent the data using one of the following methods:
Select a parameter from the Parameter drop-down list or type the name of an
existing parameter.
Click a parameter in the Parameter List area. The parameter name appears in
the Parameter text box.
Note: If the chosen parameter is already used in a read or write statement, the
selected data will be un-selected and the Data Source area will be scrolled to
show where the parameter is used. In this case, it is necessary to select a
parameter and then select the data.
Type the name of an existing parameter in the Parameter text box. You can
type the name of a scalar parameter, the name of an aggregate member, or the
name of an array element. For more information, see “The Parameter
Read/Write Area,” on page 257.
4. Apply the new read or write statement using one of the following methods:
Click the Read or Write button adjacent to the Parameter text box.
Right-click in the Data Source area; then, select Insert Read or Insert Write
from the menu that appears.
Click in the Parameter box and press the ENTER key on your keyboard.
Click the Op column in the parameter list until the desired option appears.
This option defaults to read-only for a read-only data source, and toggles from
write to read for read/write data sources. The correct default operation is
always initially displayed.
Note: This procedure only works if the parameter has not been previously used in a
Read or Write operation. If the parameter has already been used, clicking on the
Op column will select the location originally read/written, and then attempt to
change a write to a read (a read is not changed). To create a second read/write for a
parameter already used once, you must:
Select the parameter from the Parameter List or the drop-down list in the
Parameter Read/Write area.
Return to step 1 to define more data source information using this shortcut
method.
This type of data exchange assumes that no parameters exist, and the parameters will
be created as the data exchange program is created. The Data Type and Default Value
of the parameter (as well as the size of an Array parameter) is determined by
examining the data that was selected.
1. Select some data in the data source viewer using one of the following methods:
Single-clicking on the Word (General Text format) or item (Table, Vector,
Name/Value formats).
Triple-clicking. The triple-click action selects the entire line that currently
contains the cursor.
Swiping. This option allows for the selection of an item or a range of data. The
selected item or range is displayed in the Swipe Details area at the bottom of
the editor (if it is displayed).
2. (optional) Adjust the swipe details. For more information on using the swipe
details options, see one of the following sections:
Type the name of the parameter in the Parameter text box. The parameter text box
will switch to a yellow background to indicate that this is the name of a new
parameter.
You cannot create an array by typing the name of an array element (for example,
x[5]). If you attempt to do so, a warning message will be displayed in the Status
Line. If you need to create an array, click on the Create Parameter button ( )
below the Parameter List and fill out the Create Parameter dialog.
Note: When using the Table or Vector tool, you can create an entire array by
selecting multiple numbers and typing a parameter name into the Parameter text
box.
Shortcut: Normally you would click in the Parameter text box before typing the
parameter name. This step is not necessary. Instead, after clicking in the Data
Source area, press the TAB key to move to the Parameter text box. Even pressing
the TAB key is optional; if you start typing after clicking or swiping in the Data
Source area, the cursor will automatically jump to the Parameter text box.
3. Apply the new read or write statement using one of the following methods:
Click the Read or Write button adjacent to the Parameter text box.
Press the ENTER key on your keyboard after typing a new name in the
Parameter text box. This option uses the default read/write operation for the
exchanger.
The parameter is created and selected, the read or write is created, the statement is
executed, and the data is highlighted. Note that only one mouse click (to select the
data) and one extra keystroke (the ENTER key) is required to create the parameter
and read or write it. Of course, this is in addition to typing the parameter name.
4. Adjust the Parameter settings. The parameter is created using default settings
based on the type of operation (read or write) and the selected data. The
fundamental rules are:
If the operation is a READ, the parameter has mode OUTPUT; if the operation
is a WRITE, the parameter has mode INPUT.
If one word, cell, or item is selected, the parameter is Scalar. If multiple values
are selected with the Table or Vector formats, an Array parameter is created.
The size of the array will exactly match the size of the selection. See “Using
the Table Format Option,” on page 293 below for more information.
The data type is selected to match the type of data selected. If the selection
includes only one block of digits (and leading or trailing spaces), the data type
is Integer. If the selection looks like a real number (-99.99e-99]), the data type
is Real. In all other cases the data type is String.
Note: Selecting data such as “12 34” will use the data type String, not an array
of 2 integers as you might hope.
The initial value of the parameter is the same as the selected data (with leading
and trailing spaces removed).
After creating the read or write, you can edit the parameter settings in the
Parameter List. The setting most likely to need changing is the Data Type, though
sometimes the Mode may need to be changed to INOUT.
To edit the parameter settings, click in the Name, Value, Mode, or Type column to
enable editing (for the name or value) or to show a drop-down list of choices
(Value and Type).
To change the operation from a write to a read, click in the Op column of the
Parameter list, or click the Read button next to the Parameter name box.
Note: You can change the size of an array parameter (or make any other change to
any parameter) by right-clicking on the parameter and selecting Properties from
the menu.
Note: You can also update a read/write statement, including setting the format and
selecting a different parameter, by using one of the following methods:
Right-click in the Actions or Data viewer; then, select Edit Selected Statement
1. Select a read or write operation by clicking on the parameter in the parameter list,
or by clicking on the highlighted data (pink or green) in the Data Source area.
Clicking on a Parameter scrolls the Data Source area so the first read or write of
the Parameter is visible. The data read or written (already highlighted in green or
pink) is then emphasized by a blue border.
Clicking on Read or Write data similarly highlights the data with a blue border.
The associated parameter is then selected in the Parameter List.
In either case, the details of the Data selection are displayed in the Swipe Details
area.
Click the Op column in the Parameter to toggle between read and write
operations. Again, this only works if the Data Source is open for Writing.
Right-click the Op column in the Parameter List; then, select Read Parameter
or Write Parameter from the menu that appears.
1. Select the Read or Write by clicking on the highlight in the Data Source area or by
clicking on the Parameter in the Parameter List.
2. Edit the Swipe details in the Swipe Details area. Any change to the swipe location
will immediately be displayed as a blue box in the Data Source area. The Read or
Write operation will not be updated until you press ENTER in the Swipe Details
area.
The most common reason to change the Swipe Details is to alter the search string used
to locate the data in the General Text format. For more information, see “Using the
General Text Format Option,” on page 285.
2. Right-click on the data highlight or action; then, select Edit Selected Statement
from the menu that appears. The Write Parameter dialog box appears.
Note: If you selected a read statement, then the Read Parameter dialog box
appears.
The dialog box is divided into three tabs: Parameter, General Text Swipe, and Edit
Read/Write Format.
General Text Swipe. Allows you to edit the swipe information. The swipe
information is different for each section format. For more information on
editing the swipe information, see “Adjusting a Basic Swipe,” on page 287.
Edit Read/Write Format. Allows you to change how the data is formatted.
For more information, see “Formatting Numbers During a Write Operation”
on this page.
Right-click on the highlight in the Data Source area and select the last menu item
Remove Read/Write Instruction from the pop-up menu.
Select the read/write action in the Actions List, then click the button on the
toolbar.
Select the read/write action; right-click, then select Delete Statement.
Note: Deleting a parameter using the button below the Parameter List will also
remove all read/write instructions involving that parameter.
1. Select the Write operation by clicking on the Pink highlight in the Data Source area
or by selecting the Parameter in the Parameter List, or by selecting the action in the
Actions List. If you select the Parameter, verify that the correct Write operation is
selected; it will be surrounded by a blue line.
2. Right-click on the Highlight in the Data Source area or on the action in the Actions
List. Select the menu item Edit Format from the pop-up menu. This will open the
Edit Read/Write Format dialog box.
Note: Do not select the menu item Edit Section Details; its function is described
below. You can also access the Editor format dialog by double-clicking the action
to open the Read/Write editor, and then clicking the Format tab.
3. Select the type of format from the pull-down on the Edit Read/Write Format
dialog box. The following types of formats are supported:
C printf: Enters a C-language printf format string that contains one format
specifier (“%4d”, “%5.2f”, or “%12.5e”). Extra characters before or after the
format specifier are included in the output.
Note: Setting a write format when writing an Array using the Vector or Table
format, the output format is applied separately to each element of the array.
While it is possible to set a format on a Read operation, doing so almost never works as
desired and is strongly discouraged.
To format a section:
1. Select the data to be formatted in the Data Source area. Usually this involves
selecting several lines. This can be done easily by dragging the mouse down the
page. You can also select multiple lines by clicking on the first line and
shift-clicking on the last line.
2. Click the New Section Format button . The New Section Format Chooser
Wizard appears.
3. Select the new format from the Formats area. The General Text, Table, and Vector
formats do not have any additional options to set. The Name/Value option has
additional options that can be defined. For more information on these options, see
“Using the Name Value Format Option,” on page 292.
4. Click Finish. The wizard is closed, and a new format is colored white in the Data
Source area. You can now insert Read and Write statements using the new format.
5. Proceed to one of the following sections, based on the type of statement you are
creating in the section:
1. Select the data to be updated in the Data Source area, or click a bound parameter in
the Parameter List to select the corresponding data.
2. Right-click the Data Source area; then, select Edit Section Details from the menu
that appears. The Edit Section Format dialog box appears. It is divided into three
tabs.
Note: This dialog box differs (the tab contents are altered) based on the current
format selected.
3. Edit the details used to construct the format using the first tab. This step is most
often used to change the delimiters between elements.
4. Click the Advanced tab; then, set the mode to either RANDOM or
SEQUENTIAL. The default is always RANDOM. Using SEQUENTIAL mode
on large files is more efficient, but may interfere with how the editor operates.
5. Click the third tab. This tab changes the file if the top-level section (the whole file)
is selected. If a sub-section is selected, this tab lets you update the boundaries of
the section.
There are tabs at the top of the Data Source area for each data source. Selecting a tab
will switch the display to that data source. Selecting a tab also displays the section of
that data source that was most recently used.
Once the correct data source is selected, you can navigate by clicking on the data.
The current section is always highlighted in white. Any sub-sections are highlighted in
yellow. Read and Write statements are colored in green/pink. Any text outside the
current section (in a parent section) is highlighted in gray. Clicking a yellow highlight
will move the focus to the sub-section, turning the yellow area white, and the previous
white area gray. Clicking the gray area will navigate to the parent section, turning the
gray area white and the previous white area yellow.
The full Java source code is generated and displayed in this dialog box, and the
code can be edited directly.
2. Edit the code, as desired. You can copy and paste text between this dialog box and
an external Java development tool using the standard keyboard commands
(CTRL-X, CTRL-C, and CTRL-V).
3. Click OK to save your changes and close the dialog box. The Java code is checked
for errors while it is being saved. If there are any errors, the first error is
highlighted in pink, a description of the error is displayed on the status bar at the
bottom of the Data Exchanger editor, and the Java Source Code dialog will not
close. You must either correct the error, or click Cancel to discard all changes.
New basic swipe. This type of swipe involves highlighting a portion of text in your
file and then mapping it to a parameter. It does not involve the usage of the Swipe
Details section of the Data Exchanger component. For more information, see
“Performing a Basic Swipe” on this page.
Adjust a basic swipe. This type of swipe requires the use of the Swipe Details area,
and involves only one line in your file (whether it is the whole line or only part of
the line). For more information, see “Adjusting a Basic Swipe,” on page 287.
Advanced swipe of a group of lines. This type of swipe requires the use of the
Swipe Details area, and involves using more than one line in your text file. For
more information, see “Performing an Advanced Swipe,” on page 289.
1. Click or swipe the desired data in the text file. For more information on the
differences between these two ways to select data, see “Understanding
Terminology,” on page 261.
2. Specify the parameter that will correspond to this information from the text file
using one of the following methods:
Use the Parameter drop-down list (to the right of the Parameter text box) to
select an existing parameter.
3. Click the Read or Write button (based upon the usage you specified for the file in
“Creating a New Data Exchanger Program,” on page 262). The parameter is added
to the Parameter List on the right side of the component editor.
1. Verify that the General Data Swipe appears near the bottom of the editor. If not,
click on the down arrow button located under the Parameters Read / Write area.
2. Click the parameter in the Parameter List that is bound to the swipe that you want
to update. The swipe information appears in the General Data Swipe area.
3. Select one of the following options from the first drop-down list:
Find. This option allows you to locate a specific string in the data. If you need
to locate a string, proceed to step 4.
Line. This option allows you to specify the information to be highlighted. If
you have located the information, proceed to step 6.
4. Perform the following steps to locate data using the Find option:
Select String or Regexp (Regular Expression) from the drop-down list in the
center of the General Data Swipe area. Regular expressions are a way to
specify patterns that match similar strings. For example, the regular expression
‘a *b’ matches an ‘a’, zero or more spaces, and a ‘b’. A detailed description of
regular expressions can be found in the Java 1.4 Manual pages for class
java.util.regex.Pattern, in the Perl language manual, or in any of a number of
books on Regular Expressions.
Set the Offset Lines option. This option allows you to tell the component to
add lines before or after the location of the found data. Negative numbers
select a line before the matched line, while positive numbers select a line after
the matched line.
Add text to the Find text box. Once a text string is added to this text box, the
matching item in the text file is automatically highlighted.
You can adjust where the search starts with the From drop-down list. There are
three options:
• Start of File. Starts the search from the beginning of the file. This is the
default.
• Current. Starts the search from where the last read/write occurred. This
can be much more efficient when working near the end of a large file. Be
aware of where the statement will be inserted in the list of actions – the
“last read or write” is the last one before the new statement – which can be
an unexpected value if the insertion point is not at the end of the list of
actions.
• End of File. Starts the search backwards from the end of the file.
5. Select Line from the drop-down list. The line number of the data appears. It is
automatically updated, based on the results of the Find operation. Normally, the
line number is relative to the start of the file, but you can specify a line number as
an offset from the current location or as a negative offset from the end of the file.
6. Verify that the correct line is highlighted. You can change the line number in the
Line text box, if necessary. You can also enter an expression or click the
expression button to open an expression editor. The matching item in the text
file is automatically highlighted.
7. Refine the selected data using the following options from the drop-down list at the
bottom of the General Data Swipe area:
Whole Line. This option highlights the entire line in the file that contains the
information specified.
Word #. This option highlights the specified word number in the text file. The
count is based on the number of words from the left margin.
Character. This option highlights the characters in the specified range, which
is specified in the corresponding text boxes.
3. Select Line or Find from the drop-down list, based on how you want to specify the
area in the text file where your swipe fill begins. Selecting Line allows you to
specify a particular line in the file, enter an expression, or open an expression
editor. Selecting Find allows you to specify a group of characters as the starting
point.
4. Perform one of the following actions, based on the selection you made in step 3.
If you selected the Line option, enter the number of the line you want to mark
the beginning of your swipe. You can also enter an expression or click the
expression button to open an expression editor.
If you selected Find, select String or RegExp (regular expression) from the
adjacent drop-down list; then, enter the text you wish to start from in the
corresponding text box. You can also enter an offset, which is the number of
lines before or after the search string to start the section.
5. Click the End subtab; then, use the options to set where your swipe will end. These
steps are similar to those described in step 3 and step 4, however, it is slightly more
complex. While a Start search starts from the beginning of the file, an End search
starts from the line selected by the Start tab. The start line # option is from the start
of the file. The End line # option is from the start line (0 = 1 line, 1 = 2 lines).
3. Type a new parameter name in the Parameter text box, or select an existing
parameter from the drop-down list. If you create a new parameter, it is added to the
Parameter List on the right side of the dialog box. If you choose an existing
parameter, the parameter is highlighted in the list.
4. Click Apply to save your changes.
Only one item can be read/written at a time. You can also apply a section format to the
value of a Name/Value item. It is particularly useful to use the Vector format in order to
read an array from the value.
Note: It is not currently possible to write new entries into a Name/Value section. You
can only read or write the value of an existing name/value item.
The Table format is useful in that it can read/write a whole (one dimensional or
two-dimensional) array at once. A new parameter is created having as many elements
as the swipe. To read/write an existing array, you must have a swipe exactly as large as
the array parameter or the parameter must be resizable. For more information on
resizable arrays, see “Using Parameters,” on page 564.
The format can read/write a cell (scalar), a whole or portion of a row or column (a one
dimensional array), or a sub-table (a two dimensional array).
1. Type a parameter name in the Parameter text box, or select an existing parameter
from the drop-down list.
2. Set the table swipe coordinates. The first two text boxes represent the starting point
for the swipe. The second two text boxes represent the ending point for the swipe.
The end is left empty to indicate the swipe has a length of one in that dimension.
Leaving the column field blank in the start coordinates highlights the entire
referenced row. Similarly, leaving the start row field blank selects the entire
column.
Blank rows are not highlighted if selected using the table swipe coordinates.
3. Click the Read button or Write button , based on the type of data
exchange you are performing.
If your selection covers more than one cell in a table and you type a new parameter
name, the parameter is created as an array as big as the swipe. You can select a cell of
the table by clicking in it. Triple-clicking will select a whole row. You can select a row,
column, or sub-table by dragging the mouse from one end to the other (for a sub-table,
drag from one corner to another).
Note: When selecting a column by dragging, what matters is which word on the line
you start and end the drag in, not what character position on the line. If the widths of
the columns vary a great deal, it may be difficult to end the drag in the same relative
column as it started in. When you release the mouse button after dragging a column,
the blue selection highlight will shrink to just the selected column(s). If too many
columns are selected, adjust the selection using the Table Swipe details panel.
4. Click the Fixed Columns tab. The contents of the tab appear.
5. Type in the column boundaries in the text box; then, click OK. Note that the
numbers are the character position on which each column ends. The example
shown above creates four columns, each five characters wide:
The Vector format is similar to the Table format in that it can read/write a whole (one
dimensional) array at once. In both formats, a new parameter is created having as many
elements as the swipe. To read/write an existing array, you must have a swipe exactly
as large as the array parameter, or the array must be resizable.
1. Type a parameter name in the Parameter text box, or select an existing parameter
from the drop-down list.
2. Enter the swipe start and end point. The points are highlighted as you enter the
information.
Each item is considered a cell, and the count is made from left to right, and from
top to bottom.
3. Click the Read button or Write button , based on the type of data
exchange you are performing.
1. Verify that the correct data source is loaded in the Data Source area.
3. Enter the text string you want to search for in the text box; then, click Next. The
string, if found in the data source, is highlighted in orange in the Data Source area.
4. Perform one of the following actions:
Click Next to locate the next instance of the specified text string.
Click Close to close the Find dialog box and return to the Data Exchanger
editor.
The General Text format uses the search string as the Find target for swipes as long as
the swipe is close to the find string (currently within ten lines). To set the search target
for the general text tool to a string on the screen, select the text to use as the search
target; then, click on the Find button , or right-click and select Find from the pop-up
menu.
Creating Markers
Markers are used to search for a string, and to remember where the string was found.
Then, the marker can be used as an anchor for subsequent read/write operations. There
are two ways to create a marker.
To create a marker:
1. Select a General Text section; then, click the button on the toolbar.
2. Enter the variable name, the section to search, a string to search for, and where to
begin the search.
3. Click OK.
or
1. Select some text on the line where you want the marker.
Using Markers
If you simply click on a word in a General Text section that is after a marker, the word
will be located at runtime as a certain number of lines after the marker.
You can also select a marker from the From drop-down list on the General Text Swipe
editor, when in Line mode (not in Find mode).
Note: If you are using markers, there is little reason to use the FIND mode of the
General Text swipe editor, since the Markers handle searching.
. For. Creates a For Loop. For more information, see “Using the For Loop
Editor,” on page 302.
. While. Create a While loop. An editor opens for specifying the condition to
test at the start of each loop. This is identical to the editor for an If statement.
. Java. Adds arbitrary Java code as an action. When you click OK, the Java
code is checked for errors. Note that a single block of Java code could be split into
multiple actions.
Click the button on the toolbar to open the Calculation Editor. The Edit Calculation
dialog box appears.
The Calculator editor is similar to the Calculator component. For more information
about the Calculator component, see “Using the Calculator Component,” on page 239.
There are a few differences that include the following:
The Calculator component uses lists and buttons whereas the Calculation editor
uses menus to keep the dialog smaller.
A Data Exchanger calculation can contain multiple statements, but there must be a
semicolon after each statement (except the last). The Calculator component allows
one statement per line even without semicolons.
The Calculation Editor allows full Java statement syntax, including expressions as
subscripts of arrays, and calling methods on parameters (which are type
com.engineous.sdk.vars.Variable). This includes Java auto increment/decrement
operators (++ and --) and the operation assign operators, such as ‘i +=1;’.
Subscripts of array parameters can use either Java notation ‘arr[i][j]’ or FIPER
syntax ‘arr[i,j]’.
In the Calculation editor, an array parameter can be resized either by calling the
‘array.setDimSize(size)’ method or with the ‘resize(array,size)’ function. It is not
currently possible to change the size of an array in the Calculator component.
Note: The same calculation editor dialog is used for IF and WHILE statements, and to
enter expressions for row and column numbers in the Vector and Table tools. The only
difference is that a calculation must contain assignment statements, whereas the other
uses must be an expression that does not assign the value to a parameter.
Increment the value of an integer parameter ‘i’. All of the following are equivalent:
i++
i+=1
i=i+1
Set an element of array parameter ‘array’ to a complex expression. The subscript is
one less than the integer parameter ‘i’.
Change the size of array ‘outArray’ to be twice as large as the array ‘inArray’:
2. Click the appropriate tab: Simple or Advanced. The tab selected controls the
statement. Switching tabs tries to convert from the simple form to the advanced
form (always works) or from advanced to simple (only works in a restricted subset
of cases).
Simple. The Simple tab allows you to edit a parameter, initial value, final
value, and increment (similar to the For Loop component). This is the basic
‘for i = 1 to 10 by 1’ type loop.
Advanced. The Advanced tab allows you to edit the initialization, condition,
and update expressions. This is the complete Java (or C or C++): ‘for (i =
1, j = 10; xx[i]; i++, j--)’ For loop.
3. Click the button at the end of each text box to open a calculation editor. The
editor can be used to build an expression for the corresponding text box based on
parameters, operators, and functions. A line of instructions at the top of the
calculation editor indicates the type of expression expected (e.g., assignment,
integer value, logical condition).
4. Click OK to save your changes and return to the editor.
Filtering Parameters
To alter the view of the parameters in the Parameter List:
2. Set the check buttons, as desired. Activating a check box causes the corresponding
parameters to be shown in the Parameter List.
3. Click OK. You are returned to the Data Exchanger editor, and your Parameter List
is updated.
1. Click the tab that corresponds to the data source that you want to delete. The
contents of the data source appear in the Data Source area.
Right-click anywhere in the Data Source area; then, select Delete Selection
from the menu that appears.
Keep in mind the following actions that will occur when you use the Delete/Close
options in the Data Exchanger component:
The button/Close Data Source menu option always close the current data
source.
The button/Delete Statement menu option delete a data source, section, or other
action depending on the selection.
The Delete Section option (accessed by right-clicking in the Data Source area)
deletes the current section, or the data source if the current section is the data
source.
Deleting a section also deletes all read and write statements inside that section, and
closing a data source deletes all sections, reads, and writes in that data source.
Deleting an 'if', 'while' or 'for' action ONLY deletes the selected action and the
associated end indicator “}”. Any other statements that were inside the block are
left in place. To delete an 'if', 'for' or 'while' action and everything inside it, you
must select all the actions by clicking on the start action and shift-clicking on the
end indicator.
Actions can be moved into or out of a loop or if block by using the cut/paste
feature.
Allows you to define templates in the Design Gateway that determine which
values are read and written during runtime.
Writes the values obtained during execution back to the database, allowing the
component to act as an interface to any database.
Database-Specific Settings
Depending on the database you are using, the following changes need to be made in
order to use the Database component. For more information, refer to your database
documentation or contact your local database administrator.
MS Access
Oracle
The Database component is a general usage database. If you use a special Oracle
datatype such as CLOB, you need to put the ojdbc14.jar file in the Oracle
directory. You also need to add this file with the full path to the iSIGHT-FD class
path. For more information on adding the file, see “Modifying the iSIGHT-FD
Class Path,” on page 307.
DB2
If you are trying to connect to a remote DB2 database, you need to select the
following driver from the driver drop-down list when connecting to a database
using iSIGHT-FD:
com.ibm.db2.jcc.DB2Driver
You also need to add the following files with the full path to the iSIGHT-FD
class path. For more information on adding the files, see “Modifying the
iSIGHT-FD Class Path,” on page 307.
• db2jcc.jar
• db2jcc_license_cisuz.jar
• db2jcc_license_cu.jar
SQL Server
If you are trying to connect to a Microsoft SQL Server database, you need to
download the following file:
• msbase.jar
• mssqlserver.jar
• msutil.jar
You need a valid user name and password.
Modifying on Windows
To modify the iSIGHT-FD class path:
1. Using a text editor, open the fiperenv.bat file, which is located in the
bin\win32 sub-directory in your iSIGHT-FD installation directory.
3. Add the full class path after set DBJars=. Do no enter a space after the equal
sign. The following is an example:
setDBJars=C:\oracle\ora92\jdbc\lib\ ojdbc14.jar;
C:\Program Files\IBM\SQLLIB\java\db2jcc.jar
Limitations
The following known limitations should be noted prior to using the Database
component:
The component only allows you to interact with the database tables. No other
database objects are available. Furthermore, the component does not support
procedure executions.
The datatypes supported are as follows: string, text, varchar, int, double, float, and
decimal.
The variable name must start with a non-numeric character. For example, a
parameters named “3var” is invalid. Instead, the variable should be called “var3”
or just “variable.” Any iSIGHT-FD variable that does not conform to this format is
not displayed in the available list of parameters.
A variable that contains a space in its name must be surrounded by single quotes in
the expression. For example, a parameter called variable one would have to be
entered in the expression as 'variable one'.
Connecting to a Database
To start using the Database component, you must first connect to the database.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Database Component Editor screen appears as shown below.
Once you specify the type of database, the options necessary for a connection
are activated. If the options listed below are not accessible then they are not
needed.
Service/Database Name. Enter the appropriate service name, depending on
the database.
Host Name/Instance Name. Enter the name of the host machine to which the
component should connect.
Port. Enter the port number to which the component should connect.
Class name. Enter the class name that is included in the driver file. The class
name must match the driver file.
4. Click Connect.
The type of database and the service/database name are displayed at the top of the
editor. The database tables in the schema are show on the left side of the editor.
“Viewing Data and Mapping Parameters,” on page 312 describes how to view
the table data, and how to map the data to iSIGHT-FD parameters.
2. Select a table; then, click the Show Data button. The data from the selected
table is displayed.
The right side of the editor shows the selected columns with all the rows of the
table.
A icon represents the primary key of the table. This column cannot be
mapped.
If multiple columns and rows are selected with the same datatype, an aggregate
or array variable is created.
If multiple columns and only one row are selected with the same datatype, an
aggregate or array variable is created.
If multiple columns and only one row are selected with different datatypes, an
aggregate or multi scalar variable is created.
If only one column and multiple rows are selected, an array variable is created.
5. Determine how you want to map your parameters. The following options are
available:
To map individual parameters manually, by selecting data in the corresponding
table, proceed to step 6.
To map parameters based on existing column information, proceed to step 10.
6. Specify the iSIGHT-FD parameter that will be mapped to the selected data using
one of the following techniques:
The parameter mapping is added to the table at the bottom of the editor.
The table at the bottom of the editor displays the various parameters created. The
columns in the table show the parameter name, mode of the parameter, the table
from which the rows are selected, column names, and the query formed by the
selected rows.
Note: You can remove an existing mapping by selecting it in the table at the
bottom of the editor; then, click the button.
10. Select the data you wish to map from the database table. You can select individual
cells, or you can select an entire column by clicking on the column’s header.
12. Select the appropriate parameter attribute; then, click OK. The data is mapped and
added to the table at the bottom of the editor.
14. Select the data you wish to map from the database table. You can select individual
cells, or you can select an entire column by clicking on the column’s header.
15. Click the button. The Column and value dialog box appears.
To select a parameter: Select Parameter from the drop-down list to the right
of a text box; then, select a parameter from the list of parameters that appears
in the corresponding text box.
17. Click OK to return to the editor. The data is mapped and added to the table at the
bottom of the editor.
Note: The name iSIGHT-FD assigns to the new mapping (e.g., $D, $I) cannot be
edited.
Note: You can remove a record from the database by selecting a cell in the
database table row; then, click the button.
18. Return to step 5 if you want to map additional parameters, or click OK to save the
changes and close the editor. Click Apply to save the changes without closing the
editor.
Note: A SQL exception will be thrown at runtime if you entered invalid values into
the database. The exception appears in the runtime log.
Modifying Queries
You can modify a query formed by mapping the row data to a parameter.
1. Select the mapping whose query you want to edit from the table at the bottom of
the editor.
2. Click the Edit button in the bottom right corner of the editor.
The text of the query is displayed in the Modify Query area at the top of the dialog
box. Each query is broken into independent parts and displayed on a single line.
You can select a line and modify the corresponding query accordingly.
Remove a line from the query by clicking it; then, click the Remove from
Query button.
Select any query at the top of the dialog box; then, click the buttons provided
at the bottom of the Modify Query area to insert the corresponding text.
These buttons help you to form the query string and are listed below:
• (
• AND
• OR
• NOT
• )
• WHERE
Use the ORDER BY button to list the query in ascending or descending order.
Use the option in the Add where clause area to create a Where clause
connecting the column names and a constant or parameter, depending on the
selection from the corresponding drop-down list. Once created, add the clause
to the query by clicking the Add to Query button.
Determine the number of rows the query should fetch in the corresponding text
box.
Review the updated query in the Final Query area at the bottom of the dialog
box. This area is for viewing purposes only and is not editable.
4. (optional) Click the Check Query button to verify the correctness of the query in
terms of syntax. If any syntax mistakes are found, a dialog appears with the
message “The query is incorrect”.
5. (optional) Click the Manual Edit button to manually edit the query. A warning
message appears, stating that this option is at your own risk.
Important: This procedure is not supported, and any problems caused by manual
query editing cannot be remedied by Engineous Software. Use with option with
extreme caution.
6. Click OK to save the query and close the editor. The editor will not close if the
query is incorrect. Instead, an error message appears. You are returned to the
Database component editor.
parameter mapping
macro execution
Note: This component has default preferences which you can set based on your needs.
For more information, see “Setting Excel Component Preferences,” on page 118.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
Once the editor is opened, you need to specify an Excel workbook with which to
interact.
Note: If a message appears regarding the existence of Named Cells, this means that
iSIGHT-FD has detected that the workbook contains names/tags associated with
certain cells, an indication that these might be items of importance. In this case,
you can do some instant parameter mapping. Click Yes to map the parameters now.
Click No to map them manually at a later time or to not map them at all. For more
information on mapping these parameters manually, and on this option in general,
see “Named Cells/Ranges Mapping,” on page 328.
You can load multiple workbooks into the editor using the method described in
step 2 and step 3. The Current Workbook button allows you to switch between
workbooks.
To remove a workbook, select it using the Current Workbook drop-down list; then,
click the button. Once you confirm your desire to delete the workbook, it is
removed from the editor, and any mappings defined to/from that workbook are also
removed.
4. Click the Store workbook in the model check box if you’d like the workbook
saved as part of the iSIGHT-FD model file. This option may be useful if you wish
to allow this component to be distributed for execution on any Windows machine
without requiring that the workbook file exist on that machine.
Once the workbook has been loaded, you can map parameters or set macro
information.
Mapping Parameters
There are three different ways to map iSIGHT-FD parameters to and from an Excel
workbook using the Excel component editor:
Direct cell mapping. This type of mapping allows you to select a single cell to
map to or from an iSIGHT-FD scalar parameter or array element, or to select a
range of cells to map to/from an iSIGHT-FD array parameter of the same size. For
more information, see “Direct Cell Mapping,” on page 324.
Name-Value mapping. This type of mapping allows you to select a 2-by-n or
n-by-2 region of cells that represent name-value pairs and automatically define
mappings using those names. For more information, see “Name-Value Mapping,”
on page 326.
2. Determine the name for the mapped parameter using one of the following
methods:
To map a new iSIGHT-FD parameter, type the name of the new iSIGHT-FD
parameter in the Parameter text box. You can also click the button to
define a new parameter in more detail.
3. Select the mapping direction. The following two options are available:
The mapping is added to the list at the bottom of the editor. The parameter mode,
type, and value are set automatically. In the following example, we mapped the
value from a parameter to the cell A3.
Note: You can delete a listed mapping by selecting it and clicking the Remove
Mapping button .
Name-Value Mapping
To quickly define mappings for ranges that contain names and values in adjacent cells:
1. Select the range of workbook cells that you want to map, which contains both the
names for the parameters you are mapping and the associated values. The selected
range must contain either 2 rows or 2 columns, with the names of the parameters
assumed to be in the left or top cells.
2. Select the mapping direction. The following two options are available:
Note: You can delete a listed mapping by selecting it and clicking the Remove
Mapping button . You can also sort the listed mappings by clicking the column
heading of the column that you want to sort by. Sorting the listed mappings does
not affect the order of execution of those mappings, which is controlled on the
Advanced tab as described in “Using Advanced Options,” on page 330.
4. Verify that the mapping direction is set properly for each parameter as described in
step 2. If it is not, you can change the mapping direction using the drop-down
menu provided in the Action column for that mapping.
If you have just loaded an Excel workbook, and the Named Cells Found dialog
box appeared, click Yes.
If you are working with an already loaded Excel file and want to invoke the
Named Cells/Ranges dialog, click the button.
2. Select the named cells that you would like to be automatically mapped. You can
choose a single mapping, multiple mappings, or all mapping using the Select All
button.
3. (optional) Change the default action of the mappings by selecting a new action
using the button; then, click the Change button.
4. Click OK. The new mappings are listed at the bottom of the Excel editor.
Important: If no macros are present in the workbook you loaded into the Excel
component editor, all macro options are disabled.
3. If applicable, set the available macro options. If no macros are present in the
workbook you loaded into the editor, the macro options are disabled.
b. Specify the macro arguments using the Arguments button. Note that you can
supply arguments as either constants or iSIGHT-FD parameter values.
The macro is added to the list on the right side of the tab.
4. If necessary, modify the action execution order using the and buttons below
the Action Execution Order list.
5. Click the Save Excel file after execution check box if you’d like changes that
were made to the Excel file during execution to be saved. You can type the path
and file name into the corresponding text box, or you can click the Browse...
button and navigate to the file. By default, the current path and file name are
automatically added to the text box.
6. Click the File Parameter button if you’d like to include the file as an
output file parameter from the Excel component. This button toggles between a
depressed (active) and raised (disabled) position. By default, it is disabled.
7. Click the Show Excel during execution check box at the bottom of the tab if you
want Excel to be visible when you execute your model.
8. Click the Close workbook check box if you want Excel to close the opened
workbook (when not selected, Excel and the workbook remain open after the
model is executed); then, use the corresponding drop-down list to determine when
Excel should close. The following options are available:
when job completes. This option closes the workbook after the entire
iSIGHT-FD execution is completed.
after each execution. This option closes the workbook after each execution of
Excel. Excel may be executed numerous times during a single job.
Note: You can set default behavior for this option using the component preferences
as described in “Setting Excel Component Preferences,” on page 118.
9. Click the Re-use open workbook of same name check box if you want the
component to use the same workbook that was open for a previous component in
the model. This option allows you to modify (or extract data from) the same
workbook. If this option is not selected, which is the default, each component will
open its own copy of the workbook.
These steps are not necessary if you are executing using the standard iSIGHT-FD
desktop (Standalone) execution.
1. Click the Start button; then, click the Run... option. The Run dialog box appears.
3. Click Component Services on the left side of the dialog box. Folder options
appear on the right side of the dialog box.
5. Double-click the DCOM Config folder. The contents of the folder appear.
6. Right-click the Microsoft Excel Application icon; then, select Properties from
the menu that appears.
8. Click the Customize radio button in the Launch and Activation Permissions area;
then, click the Edit... button. The Launch Permission dialog box appears.
9. Click the Add... button. The Select Users, Computers, or Groups dialog box
appears.
10. Type the necessary username (be sure to include the computer/domain name) in the
Enter object names to select text box.
11. Click the Check Names button to verify that the username you entered is valid.
You can also search for the name using the Advanced... button.
12. Click OK. You are returned to the Launch Permission dialog box, and the
username you entered now appears in the list at the top of the dialog box.
13. In the Permission for <username> area; click the following check boxes in the
Allow column:
Local Launch
Local Activation
14. Click OK. You are returned to the Microsoft Excel Application Properties dialog
box.
15. Click OK. You are returned to the Component Services dialog box.
17. Proceed to “Starting the Editor and Adding Workbooks,” on page 320 for
information on using the component.
For additional information on iSIGHT, refer to the iSIGHT User’s Guide. This guide is
included on the iSIGHT 9.0 CD. The iSIGHT component is only supported in iSIGHT
9.0.5 or higher. Engineous recommends that you have iSIGHT 9.0 installed to use this
component.
The iSIGHT component does not guarantee support for execution when the
temporary execution directory contains spaces, semicolons (;), or ampersands (&).
While many iSIGHT description files are known to execute properly when
directories contain spaces, all combinations of options have not been tested. On
Windows, the default temporary directory for iSIGHT-FD execution is in the
“Documents and Settings” directory, which contains spaces. For information on
how to change this directory setting, see “Changing the iSIGHT-FD Default
Execution Directory,” on page 348.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Component Editor dialog box appears.
Important: If instead of the editor you receive a message stating that iSIGHT 9.0
must be installed to use the iSIGHT component, iSIGHT is not currently installed
in the system path. You must install iSIGHT 9.0 in the system path for iSIGHT-FD
to use this component.
2. Click the Browse... button to select the description file you want to use. The Select
Description File dialog box appears.
3. Select the description file you want to use; then, click Open.
The description file’s parameters are displayed. This example is using the
beamMin.desc file.
4. (optional) Click the Edit... button to set the description file’s file parameter
settings. The description file information is saved as an iSIGHT-FD file parameter
so that it can be mapped from one component to another. For more information on
these settings, see “Setting Input File Parameter Information,” on page 342. For
more information on parameter mapping, see “Mapping Parameters,” on page 624.
5. Use the iSIGHT Run Mode button to set the desired run mode. For more
information on these modes, refer to the iSIGHT User’s Guide.
6. Select the parameters that you want to expose as iSIGHT-FD parameters in your
model by clicking the corresponding check boxes. You can select all user-defined
parameters in a list using the Select All button at the bottom of the column.
8. Specify the support files for iSIGHT in the area on the left side of the tab using any
of the following options:
To add a file, click the button. The file parameter wizard appears, which
helps you specify the support file you need. After it is specified, the file is
displayed on the tab. For more information on using this wizard, see “Creating
File Parameters,” on page 585.
To delete a file, select the file you want to delete; then, click the button.
You can select multiple files to delete at once.
To change a file’s settings, select the file whose information you wish to alter;
then, click the Edit... button. The Configure File dialog box appears. The
settings for each support file are saved as an iSIGHT-FD file parameter so that
they can be mapped from one component to another. For more information on
these settings, see “Setting Input File Parameter Information,” on page 342.
For more information on parameter mapping, see “Mapping Parameters,” on
page 624.
9. Specify the files to be read from iSIGHT in the area on the right side of the tab:
To add a file, click the button. The file parameter wizard appears, which
helps you specify the support file you need. After it is specified, the file is
displayed on the tab. For more information on using this wizard, see “Creating
File Parameters,” on page 585.
To delete a file, select the file you want to delete; then, click the button.
You can select multiple files to delete at once.
To change a file’s settings, select the file whose information you wish to alter;
then, click the Edit... button. The Configure File dialog box appears. The
settings for each output file are saved as an iSIGHT-FD file parameter so that
they can be mapped from one component to another. For more information on
these settings, see “Setting Output File Parameter Information,” on page 346.
For more information on parameter mapping, see “Mapping Parameters,” on
page 624.
10. Click the Description File tab. The description file is shown in MDOL format.
Retry iSIGHT license check ... times, at intervals of .... This option allows
you to set the component to check for an available iSIGHT license after a
specific number of minutes or seconds. You would want to set this option
when the number of iterations exceeds the number of licenses you have. For
example, if you wish to run an iSIGHT component inside of a DOE
component, and the task will run 200 iterations but you only have 10 licenses,
the task run may fail because you have run out of licenses. You can avoid this
problem by retrying the license check, which allows you to take advantage of
iSIGHT’s 10x parallelism instead of having the job run sequentially.
Show iSIGHT during execution. This option is useful only for demos and
gaining access to iSIGHT’s Oversight graphics application after a run. It
allows you to set whether or not iSIGHT appears when the component is
executed. Do not use this option unless you set the affinities to run the job on
your workstation.
Close iSIGHT after execution. This option allows you to specify whether or
not you want to keep iSIGHT open after execution, if you have set iSIGHT to
be shown during execution. Do not use this option unless you set the affinities
to run the job on your workstation.
Reinitialize iSIGHT for each execution. This option is useful for ensuring
that data from previous runs does not influence the next run. It allows you to
update parameter information from the previous execution prior to the next
execution of the component.
This section is divided into the following parts, based on the type of file parameter you
are using:
Note: If you are not sure as to the type of file parameter you are using, refer to the text
and graphic at the top of the Configure File dialog box. It discusses the parameter type
and shows a graphic representation of how the parameter is used.
1. Access the Configure File dialog box by clicking one of the Edit... buttons on the
component editor. These buttons are available adjacent to the Description File text
box and on the Support Files tab.
The Source area configures the source of the data. For a mapped input file
parameter, this information is overridden by parameter mapping. It may still be
convenient to configure a data source, just in case the user runs this component
alone (not as part of a larger workflow).
2. Click the Location drop-down list; then, select one of the following four options
for the data source:
<None>. The data source is not configured. This setting is the default for new
input file parameters. Having no configuration is normal for a file that will be
mapped from another component in the workflow. If such a file parameter is
not mapped, or the component is run by itself, the component receives an
empty file.
File. The data is stored in a regular file on the file system. You can click the
Browse button to select the file.
In addition to the usual controls for navigating directories and selecting files,
the radio buttons in the Path Options area allow you to select how the file
should be referenced. The following options are available:
• Absolute path. This option is used to locate the file, which works for local
execution and when the file is on a shared drive that is mounted on the
same place on all computers. This option is the default.
• Runtime directory. This option indicates that the directory containing the
file is to be ignored and the file will be found in the runtime working
directory. This setting is rarely useful for input file parameters.
• Shared file system. This option is used when the file is on a shared file
system that is mounted in different places on different machines. For more
information, see “Using the Shared File System,” on page 581.
In Model. The contents of the file will be stored inside the iSIGHT-FD model.
iSIGHT-FD takes care of transferring the data to where the component is being
executed. This option is the most convenient because it eliminates any
concerns about shared file systems or parallel execution. Model files, however,
are limited in size. Generally in-model files should not be larger than a few
hundred thousand characters (about 2000 lines). The absolute limit is
dependent on the amount of available memory, but is usually around 5 MB.
Click the Reload From... button to select the file to be copied into the model,
or to re-load a modified file into an existing model.
URL. Allows you to specify a file residing on a server. All forms of URLs
supported by Java may be used, though http: is the most common form. You
may specify the amount of time to wait for the server to respond, or “0” to wait
until the underlying protocol times out. Note that a URL type file parameter
with a file: URL is equivalent to a File-type file parameter.
3. Click the Preview… button (at the bottom of the Read From area) to display the
contents of the selected file. For In Model file parameters, the contents of the file
can be edited from the Preview dialog box; for other types it cannot be edited.
4. Specify the file type using the corresponding drop-down list. You can specify a file
as Binary or Text.
5. (For Text files only) Click the Encoding drop-down list; then, specify the
encoding to use when converting between bytes and characters. In a Locale (a
system setting that includes the language, number formats, and character set in
use) that uses multi-byte characters (Japanese, Chinese, Korean), there is a default
encoding used to convert bytes into characters. Most text files will be written using
this encoding, but sometimes it is necessary to specify this encoding. For
additional information on encoding, refer to the iSIGHT-FD Development Guide.
6. Select one of the following options from the Destination area of the Files tab.
These options allow you to choose where the data will be put while the component
runs:
Fixed file name. This option should be used if the component expects its input
in a specific place. Fill in the file name in the text box provided, or browse to
the file you want. Normally, this will be a simple file name with no path,
indicating a file in the runtime working directory. An absolute path may be
used in the odd case of a program that demands that its input be in a specific
directory, though such a file parameter is not safe for parallel or distributed
execution.
Automatic. This option is used most often. When activated, the iSIGHT-FD
system assigns a name to the file and passes that name to the component.
7. Click OK to save your changes and return to the component editor.
1. Access the Configure File dialog box by clicking the Edit... button on the Support
Files tab, below the Output Files list.
The Configure File dialog box appears.
As for Input file parameters, the bottom of the Files tab for an Output file
parameter has Read From and Write To areas.
2. Specify the file information in the File name text box. The name specified is the
name the file will have in the working directory during component execution.
Usually this is a simple file name, indicating that the file will be written to the
runtime working directory.
An absolute path can be used in the odd case of a program that insists on writing its
output to a specific directory, though such a file parameter is not safe for
distributed or parallel execution.
This text box may be left blank. However, iSIGHT-FD will assign a name for the
output file and pass that name to the component during execution.
3. Specify the file type using the corresponding drop-down list. You can specify a file
as Binary or Text.
4. (For Text files only) Click the Encoding drop-down list; then, specify the
encoding to use when converting between bytes and characters. In a Locale (a
system setting that includes the language, number formats, and character set in
use) that uses multi-byte characters (Japanese, Chinese, Korean), there is a default
encoding used to convert bytes into characters. Most text files will be written using
this encoding, but sometimes it is necessary to specify this encoding. For
additional information on encoding, refer to the iSIGHT-FD Development Guide.
5. In the Destination area, specify where the data will be put after the component
finishes running. The following three options are available in this area:
iSIGHT File Manager. iSIGHT-FD takes care of storing the contents of the
file as part of the run results. This option is the simplest one, and it is the
default. There is, however, a limit to the size of a file saved this way; usually
the limit is around 4 MB. The data is physically stored in the Run Results
database.
Specific location. The data is copied from the working directory to the
specified location. This setting must be an absolute path, since there is no
concept of a “working directory” after the component finishes executing. The
file name substitutions described in “Substitutions in File Names,” on
page 582 can be used to file the data in locations of your choice. If there are no
substitutions, the same file will be written by every run and the model is not
safe for parallel execution.
Note: If the File Name text box in the Read From area is left empty and the
Specific location option is selected, the data will not be written to the runtime
working directory. Instead, the absolute path described in the Write To area
will be passed to the component, and the component can write the data directly
to the specified location. This option is more efficient for very large output
files, though it can be difficult to configure for parallel and distributed
execution.
None. The data is not copied after the component executes. Instead, the
absolute path to the Read From area is stored in the results database. If the
Read From name is a simple file name (not an absolute path), the data is
written to the working directory, which is normally deleted after the
component finishes executing. In this case, the file is effectively discarded
after the component executes, and cannot be mapped to subsequent
components or viewed from the Runtime Gateway.
If the Read From name is an absolute path, the component will presumably
write to this location and iSIGHT-FD will pass the location on to subsequent
components. This behavior is equivalent to the case of the note under the
Specific Location option above; the component writes directly to an absolute
path and iSIGHT-FD never copies the data.
6. Click OK to save your changes and return to the component editor.
Edit the iSIGHT-FD startup file (fiperenv) as described below (based on your
operating system):
Note: If you are submitting your job to run through an ACS in the FIPER environment,
the temporary directory you see at design time has no bearing upon the temporary
directory that exists at runtime. The runtime directory is determined by the individual
FIPER Station installations. You will receive warnings for each execution of the
iSIGHT component if it executes on a FIPER Station whose temporary directory
contains spaces. For more information on using FIPER Stations, refer to the FIPER
Installation and Configuration Guide that matches your ACS combination.
Currently, the iSIGHT File Parser component only allows you to make use of the
Advanced Parser in iSIGHT. File Description Command (FDC) files and the
instruction segments of description files can be used to move data between iSIGHT-FD
parameters and files.
This section explains how to make use of pre-existing parses and how to edit them.
While it is possible to create new parses with this component, this feature is not
covered, in detail, in this section. For more information regarding the workings of the
FDC files, refer to the iSIGHT User’s Guide.
Type Chooser. This area, in the top left corner of the editor, determines the mode of
the parse (input or output). Any bi-directional code is handled internally and does
not have to be specified.
Actions. This group of buttons, in the upper right corner of the editor, provides the
basic commands available to the user to produce, edit, and test the parse.
Necessary Files. This area, on the left side of the editor and divided into tabs,
displays the files that are required and constitute the parse. These files can be
selected or created, edited, or viewed.
iSIGHT-FD Parameters. This area, on the right side of the editor, displays a list of
the parameters that the component deems necessary for the parse. The parameters
are placed into the component so that iSIGHT-FD has access to them.
Understanding Terminology
A simcode consists of a flow of parameters into an input parser the produces a file that
is the input for an OS Command component that has a file as output that is used by the
output parse to return parameters back to iSIGHT-FD. The following terminology for
individual parse types is used with iSIGHT-FD:
Template. The file, used with input parses, that indicates the format for the
produced file.
Input FDC. The file, used with input parses, that describes how the parameters
should be written to the produced file.
Produced. The file that is better known as the input file, because it is the file that is
created by the parse that is used as the input for some other component (typically
OS Command in iSIGHT-FD).
Input Parameters. The parameters whose values come from iSIGHT-FD and are
placed into the produced file.
Output. The file, used with output parses, that was produced by another component
(typically OS Command in iSIGHT-FD) and that is used as input for the current
parse.
Output FDC. The file, used with output parses, that describes how to get the
parameters from within the output file.
Output Parameters. The parameters whose values come from the output and are
brought into iSIGHT-FD.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The wizard is the first thing to appear when you open the editor of a newly added
component. The initial screen presents you with three choices to determine how
you will import or create your parse.
2. Determine how you want to obtain your FDC file. The following options are
available:
Create a new FDC via an editor. Proceed to “Creating a New Parse using
iSIGHT’s Advanced Parser,” on page 362 for more information on using this
option.
You can also use the component editor itself to create or import a parse. For more
information, see “Using the Component Editor to Create a Parse,” on page 363.
1. Access the component wizard and select the appropriate option as described in
“Opening the Editor and Determining Usage,” on page 352.
2. Click Next.
3. Click the Browse button; then, specify the description file that contains the parse
you want to use.
4. Click Next. The Select a FDC from the list below screen appears.
Within description files are segments where entire parses are defined. After
selecting a description file, you are given the names of the parses within the
description file and their contents.
5. Click the parse you want to use on the left side of the screen. Information about the
parse is displayed on the right side of the screen.
The wizard uses the description file to fill in the component as best as it can. Also,
any files listed are provided, and the component will attempt to determine all of the
necessary parameters.
6. Click Finish.
Click the Launch Advanced Parser button to open the iSIGHT Advanced
Parser interface. For more information, see “Creating a New Parse using
iSIGHT’s Advanced Parser,” on page 362.
Click the Preview Parse button to view the parse, if you are working with an
input parse. If all of the necessary information is present (FDC file, template,
parameters with desired values, etc.) then the Produced tab displays what the
file would look like for the parse. If a produced file is not specified, the parse is
still previewed, however, you are warned that you need to specify the file
before execution.
If you are working with an input parse, and all the necessary information is
present (the “output” file is populated with the desired values/info, FDC file,
as well as the parameters that you expect to get back from the parse), then the
preview enters the values of the parameter table.
Manually alter the parse or its parameter settings. For more information, see
“Updating an Imported Parse,” on page 364.
1. Access the component wizard and select the appropriate option as described in
“Opening the Editor and Determining Usage,” on page 352.
Input. An input parse takes the variables and their values in iSIGHT-FD and
makes use of the FDC instructions to produce a file that is used as an input for
a particular program. If this parse is bi-directional, it will also make changes to
the variables values.
Output. An output parse takes the output file of a particular program and
makes use of the FDC instructions to extract the iSIGHT-FD variables and
their values. If this parse if bi-directional, it will also make use of some
variables and their values in iSIGHT-FD.
4. Click Next. The Select the FDC from a file screen appears.
5. Click the Browse button; then, specify the FDC file you want to use.
Information about the parse appears on the right side of the screen.
6. (optional) Edit the parse by clicking the Edit check box and changing the parse, as
desired; then, click the Save button.
7. (Input parses only) Click Next. The Select a Template from a file screen appears.
The template file is optional when writing an FDC, but is still very common and
should be included if available.
8. (Input parses only) Click the Browse button; then, specify the FDC file you want
to use. Information about the file appears on the right side of the screen.
9. Click Next. The Select the “Input/Output File” from a file screen appears. The
exact title of this screen varies depending on the type of parse you selected in
step 3.
10. Click the Browse button; then, specify the output file you want to use. Information
about the file appears on the right side of the screen.
11. (optional) Edit the output file by clicking the Edit check box and changing the file,
as desired; then, click the Save button.
Click the Launch Advanced Parser button to open the iSIGHT Advanced
Parser interface. For more information, see “Creating a New Parse using
iSIGHT’s Advanced Parser,” on page 362.
Click the Preview Parse button to view the parse, if you are working with an
input parse. If all of the necessary information is present (FDC file, template,
parameters with desired values, etc.) then the Produced tab displays what the
file would look like for the parse. If a produced file is not specified, the parse is
still previewed, however, you are warned that you need to specify the file
before execution.
If you are working with an input parse, and all the necessary information is
present (the “output” file is populated with the desired values/info, FDC file,
as well as the parameters that you expect to get back from the parse), then the
preview enters the values of the parameter table
Manually alter the parse or its parameter settings. For more information, see
“Updating an Imported Parse,” on page 364.
1. Access the component wizard and select the appropriate option as described in
“Opening the Editor and Determining Usage,” on page 352.
2. Click Next. If you have iSIGHT installed on your system, the iSIGHT file parser is
available screen appears.
3. Determine the type of parse you want to create (input or output) using the options
near the bottom of the screen.
4. Click Finish to launch the iSIGHT Advanced Parser. Once you have completed the
new parse, it will be added to the iSIGHT-FD File Parser component. For more
information on using the iSIGHT Advanced Parser, refer to the iSIGHT User’s
Guide that was included with your iSIGHT media.
Once you select the FDC file, the component tries to determine all the parameters
that are necessary, but, just like when using the wizard, it is a good idea to make
sure that the parameters needed are present.
Note: It is possible to create a new parse by either using the simple text editors on the
left side of the editor. Also, you can start the iSIGHT Advanced Parser, if it is available
on your local machine (using the Launch Advanced Parser button).
Update the parameter information on the right side of the editor by either adding
new parameters, deleting existing parameters, or adding new members to
aggregate parameters. You can also sort the parameter information by clicking the
column headings. For more information on using parameters, see “Using
Parameters,” on page 564.
Manually change parse information directly in the text boxes on the left side of the
editor. Click the Edit check box near the bottom of the editor and make your
changes; then, click the Save button.
Click the Launch Wizard button to open the wizard, which helps guide you
through importing a parse. For more information, see “Importing an Existing
Parse,” on page 353.
Click the Launch Advanced Parser button to open the iSIGHT Advanced Parser
interface. For more information, see “Creating a New Parse using iSIGHT’s
Advanced Parser,” on page 362.
Click the Preview Parse button to view the parse, if you are working with an input
parse. If all of the necessary information is present (FDC file, template, parameters
with desired values, etc.) then the Produced tab displays what the file would look
like for the parse. If a produced file is not specified, the parse is still previewed,
however, you are warned that you need to specify the file before execution.
If you are working with an input parse, and all the necessary information is present
(the “output” file is populated with the desired values/info, FDC file, as well as the
parameters that you expect to get back from the parse), then the preview enters the
values of the parameter table
Building a Simcode
As of the current release of iSIGHT-FD, there is not “all-in-one” simcode support for
iSIGHT File Parses. For this reason, a simcode must be manually built in your model.
To accomplish this task, you must create an input parse, a command (using the OS
Command component), and an output parse as shown below.
Once you create this arrangement, you need to create two mappings in order for the
model to work. First, you must map the produced file of the input parse to the input file
of the OS Command component. Second, you must map the output file of the OS
Command component to the output file of the output parse (remember it’s an input to
the parse, it’s just called an “output file”). Once these basic steps are complete, you can
configure the driver as necessary for the given model.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
2. Enter the name of the mail server in the Mail Server text box; then, type the
sender’s address in the From text box.
Note: You can automate this step by specifying the information in the iSIGHT-FD
Preferences. Once specified, the Mail Server and From text boxes are
automatically populated when the Mail component editor is accessed. For more
information on setting these preferences, see “Setting Preferences,” on page 40.
4. Add e-mail addresses to the recipients list. You can use the three common e-mail
recipient specifications: To, Cc, and Bcc. You may also use commas to separate
multiple recipients on a single line.
Note: You can click the To text label to access the Cc and Bcc options.
5. Type a text message in the large text box.
7. Select the parameter from the Parameter to insert drop-down list at the bottom of
the component editor.
8. Place the cursor in the message body at the location where you’d like the
parameter information to be displayed; then, click the button. The name of the
parameter is added to the message body.
The parameter value will be displayed in place of the parameter name in the
recipient’s e-mail.
Note: If you wish to add multiple parameters in the format “name = value” to the
message body, click the button; then, select the parameters that you want to add
using the Select Parameter dialog box. Click OK when your selection is complete.
9. Repeat step 7 and step 8 for each parameter you wish to send.
Note: The e-mail will be sent once the component is executed, whether
independently or within the model. If you want to send the e-mail immediately
while in the editor, click the Send Now button .
11. Click the Attachment tab ; then, perform one of the following actions:
To add a file from a disk as an attachment, click the button and navigate to
the file. Note that a file parameter will be created for the selected file.
Note: To remove an attached file parameter, select it; then, click the button.
Specifically, iSIGHT-FD will look for the following system environment variables to
add them to the system path to ensure that the necessary MATLAB files can be found
at execution time:
If these system environment variables are not defined, the locations noted above must
already be on the system path in order for the component to work properly.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Component Editor dialog box appears.
The MATLAB component allows for actions to be defined in any one of three
phases:
Initialize. Actions that will be executed only the very first time that this
component executes within a job (model execution). This phase is useful for
when you need to initialize/create a variable or load some functions into the
MATLAB session and only need it done one time at the very beginning.
Execution Order. Actions that will be executed every time this component
executes.
Finalize. Actions that will be executed only when the MATLAB session is
shutting down. Since the component can be configured to leave MATLAB
open after the job completes, these actions might not get run at the end of the
job, but may instead be invoked later when iSIGHT-FD is cleaning up
persistent components.
The standard usage is simply to define actions in the Execution phase. By default,
the MATLAB component will start with three pre-defined actions in the Execution
phase to represent the most common usage:
Input Mappings for defining mappings from iSIGHT-FD parameter values to
MATLAB variables.
Commands for defining the command to execute.
Note: These default actions are simply provided for convenience and can be
deleted or renamed as desired. They are empty to start with and the details of each
of these must be filled out as needed.
Now you can define additional actions.
2. Click the tab that corresponds to the phase for which you need to create actions.
3. Click the Add Action button . The Action Type Selection dialog box appears.
4. Click the button that corresponds to the action type (Mapping or Command) that
you want to create; then, click OK. A new action of the specified type will be
created and displayed in the actions table.
The actions table presents the following information for each action:
Use?. Specifies whether or not this action should be executed. This option
allows you to leave your actions defined, but turn them on and off as desired.
5. Use the and arrows located below the table to change the order of the
6. (Optional) Edit the details of any action by selecting it in the actions table and
using the panel displayed on the right side of the component editor. You can use
this panel to configure the properties of the action. Proceed to the following
sections for details on how to edit actions:
7. Click the Show MATLAB during execution check box if you do not wish to have
MATLAB running in the background. When checked, MATLAB is launched and is
viewable during the execution of your model.
Note: If you clear this check box (telling iSIGHT-FD to hide MATLAB during
execution), but you have instructed MATLAB to produce a plot, the plot will still
appear during execution.
8. Click the When to close MATLAB drop-down list to choose when MATLAB
should close; then select one of the following options:
Never. The component will never attempt to close the MATLAB session. It
must be closed manually.
When job completes. The MATLAB session will remain open and be re-used
during the entire duration of the job (model execution) and will be closed after
the job completes.
After each execution. A new MATLAB session will be started, used, and shut
down every time this component executes.
9. Click OK to save all changes and close the editor.
Defining Mappings
Mapping actions are how iSIGHT-FD passes information to and retrieves information
from MATLAB. A single mapping action can (and typically does) involve mapping
more than just one parameter to/from MATLAB. All that is required to define a
mapping is to specify the iSIGHT-FD parameter and the MATLAB variable name
involved in the mapping.
1. Set up an action type as described in “Starting the Editor and Adding Actions,” on
page 369.
2. Select the Mapping action for which you want to define the mappings in the
actions table on the left side of the editor. An area for defining the mappings
appears on the right side of the editor.
Note: You can edit the name used to identify the Mapping action in the Mappings
text box at the top of this panel.
3. Select an existing iSIGHT-FD parameter from the drop-down list above the
Mapping table or type the name of a new parameter in the text box to create the
entry directly.
Note: By default, if you type in the name of a new parameter, a scalar parameter of
type “real” will be created. If you want to define a new parameter that is something
other than a scalar “real” parameter, click on the button to create a new
iSIGHT-FD parameter.
The arrow pointing from the parameter icon to the MATLAB icon
represents a mapping from the iSIGHT-FD parameter to the
MATLAB variable.
The arrow pointing to the parameter icon from the MATLAB icon
represents a mapping to the iSIGHT-FD parameter from the
MATLAB variable
5. Click the button to add a parameter. The new parameter is added to the table
as shown below.
A row appears in the Mapping table with the iSIGHT-FD parameter, the mapping
arrow, and the name of the MATLAB variable. By default the name of the
MATLAB variable is the same as the name of the iSIGHT-FD parameter with the
exception that spaces are replaced with “_”. You can modify the name of the
MATLAB variable as needed directly in the table.
If an entire iSIGHT-FD array parameter (as opposed to just a single element of the
array) is selected, the entire contents of the array are mapped to the MATLAB
variable (for mappings defined to MATLAB) or set from the MATLAB variable
(for mappings defined from MATLAB). If the iSIGHT-FD array parameter is
defined as “resizable”, mappings from a MATLAB variable are automatically
adjusted the size of the array to match the size of the MATLAB variable (mappings
to a MATLAB variable will send the entire contents based on the current array
parameter size).
Defining Commands
While defining Mappings allows you to pass information to/from MATLAB, the
Commands are what allow you to invoke the desired functions within MATLAB.
Commands can simply be typed directly in or loaded from a MATLAB M-Script file.
Note: The MATLAB component will automatically set the current directory in the
MATLAB session to be the working directory for the component. If you want it set to
some other directory, you will need to provide an explicit “cd” command in your set of
MATLAB commands. Additionally, a variable called “ESI_MATLAB_rundir” is
automatically set in the MATLAB session to allow you to refer to the working
directory of the component, if necessary.
1. Set up an action type as described in “Starting the Editor and Adding Actions,” on
page 369.
2. Select the Command action for which you want to define the specific commands in
the actions table on the left side of the editor.
An area for defining the commands appears on the right side of the editor.
Note: You can edit the name used to identify the Command action in the
Command text box at the top of this panel.
3. Either type commands directly into the large text box on the right side of the editor
or click the Open... button to load the commands from an existing MATLAB
M-Script file.
Note: The commands loaded from an M-Script file will be whatever the contents
are at that point in time. They will not be re-loaded at any point later if that file is
modified.
Important: You must check for syntactical errors in the given commands.
iSIGHT-FD will not check for proper syntax before execution.
Note: This component has default preferences which you can set based on your needs.
For more information, see “Setting OS Command Component Preferences,” on
page 119.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
2. Proceed to one of the following sections, based on the tab you need to use:
Basic tab. This tab allows you to specify the command and argument, and any
I/O redirection. It can also be used to set affinities to control which FIPER
Stations the command is executed on when using an ACS in the FIPER
environment. For more information on the options on the Basic tab, see
“Setting Basic Options,” on page 379.
Advanced tab. This tab allows you to set conditions which indicate that the
program has failed. You can also direct standard output or standard error to the
job log, and indicate that a failed run should be retried. For more information
on the options on the Advanced tab, see “Setting Advanced Options,” on
page 385.
Required Files tab. This tab is used to specify the files that must be placed in
the working directory before the command is run, and the files to save from the
working directory. When the component is part of a Simcode component, it
also lists the files passed by the input and output file parses. For more
information on the options on the Required Files tab, see “Setting Required
Files Options,” on page 388.
Grid tab. This tab is used to access the Grid Adapter. This tab appears only if a
LSF grid adapter license is found. Currently, only the LSF grid adapter is
supported. The Grid Adapter allows OS Command and Simcode components
to submit command-line simcode runs to an LSF v6.1 grid via bsub. For more
information on the Grid Adapter, see “Setting Grid Adapter Options,” on
page 389.
Single line commands and arguments. For more information about single line
command options, see “Setting Single Line Command Options” on this page.
Multi line (shell) scripts. For more information on the multi line options, see
“Setting Multi Line Script Options,” on page 382. The OS Command preference
page lists the available interpreters, and allows you to add interpreters. For more
information about the OS Command preferences, see “Setting OS Command
Component Preferences,” on page 119.
Note: You can type a simple command name, such as “nastran,” if you know
the program is already on the PATH of the FIPER Station. Otherwise, you must
enter the full path to the executable.
3. Type the rest of the command line following the program name. The syntax used
for the command line is a subset of that used by the Microsoft Windows Command
line (cmd.exe) or the UNIX Borne Shell (sh):
Use < to supply standard input to the program from a file. Follow the < with
the name of the file, or by inserting a file parameter (see the example below).
A space between the < and the file name is optional.
Use > to direct standard output of the program to a file. If standard output is
not redirected, it is lost.
Use 2> to redirect the standard error stream to a file. By default, standard error
is also sent to the job log.
Use 2>&1 to redirect standard error to the same file as standard output. This
setting is only useful if standard output is also redirected into a file.
Note: Other shell or cmd.exe punctuation such as “|” (pipe), “&&” or “;” (multiple
commands), and “&” (background) are not supported.
For example, to run the program myprog with arguments a and b c d, reading
input from the file sample.txt and writing output to the file bar.txt, the
command line would look like:
myprog a "b c d" <sample.txt >bar.txt
4. Click the Distribute Executable check box to copy the executable file into the
model. The program name turns green to indicate the program is in the model. The
program will be copied into the working directory before the command is run. To
undistribute the executable, clear the Distribute Executable check box. If the
program has changed on disk, you can update the copy stored in the model by
clearing and then checking the Distribute Executable check box.
The Distribute Executable feature is only appropriate for small programs. Larger
programs, and programs that require a network license, must be pre-installed on
the FIPER Station.
Note: You cannot directly execute Windows built-in commands, such as DIR or
COPY. To run such commands, use the cmd command and the arguments /C and
copy. For example:
cmd /c dir dir1
5. Click the Verify Commands button to check the syntax of the command line. If
there is a syntax error (such as a missing quote or no file name after >), an error
message appears describing the problem. If the command is valid, a dialog box
pops up that shows how the command line will be interpreted - what the command
name is, where arguments are split, and any I/O redirection. The dialog box will
show the VALUE of substituted parameters, instead of their name. The Command
Preview text box, located near the top of the tab, displays how the command will
be issued during runtime. Any error in the command line will also be shown in the
Command Preview text box.
6. You may insert a parameter as an argument by selecting the parameter from the
Parameter drop-down list; then, click the Insert button . The parameter name
is added to the Arguments text box at the current cursor position and is highlighted
in green, indicating that the value will be substituted at runtime. To quickly add a
new parameter, type the parameter name in the Parameter box and click on the
button. The new parameter will have data type String, but this can be changed
on the Parameters tab on the Design Gateway.
To delete a parameter from the arguments list, click on the parameter and press the
Backspace key.
If a parameter value might contain spaces, you should put double quotes around
the parameter reference (for example, “parm 1”).
For a file parameter, the absolute path to the file is substituted into the command
line. This can be very useful for programs that expect the name of their input file
on the command line. It is not necessary to put quotes around substituted file
parameters. File names are never split, even if they contain spaces.
File parameters can be used after the I/O redirection symbols <, >, or 2> to
redirect input/output to/from the file parameter.
Note: You can create a new parameter using the button. For more
information, see “Creating New Parameters,” on page 566.
7. Set the available options in the Affinities area. These options are used to control
which FIPER Stations may execute the component when using an ACS in the
FIPER environment. You can specify the host name, operating system, software, or
other information pertaining to the component. The Affinity options behave
exactly the same as the Affinities on the Component Properties editor. For more
information on the properties, see “Editing Component Properties,” on page 113.
8. Perform one of the following options:
1. Select the appropriate interpreter from the Type drop-down list. Information for
five interpreters is provided by default: Bash, Korn Shell, C Shell, T Shell, and
Windows Batch. You can add or modify the list of available interpreters using the
OS Command Preferences. For more information about the preferences, see
“Setting OS Command Component Preferences,” on page 119.
2. Type any interpreter arguments in the Command Arguments text box. These
arguments precede the script file in the argument list for the interpreter.
Note: Any additional arguments to Windows cmd.exe must come before the
required ‘/C’ option.
3. Type any script arguments in the Script Arguments text box.
4. Edit the script in the Editor text box in the middle of the tab. All commands you
could type at the command line for the given interpreter are valid. The script you
type is passed to the interpreter as-is, after expanding any parameter substitutions.
You can remove all contents of the text box at any time using the Clear Script
button.
5. You may insert a parameter as an argument by selecting the parameter from the
Parameter drop-down list; then, click the Insert button . The parameter name
is added to the Arguments text box at the current cursor position and is highlighted
in green, indicating that the value will be substituted at runtime. To quickly add a
new parameter, type the parameter name in the Parameter box and click on the
button. The new parameter will have data type String, but this can be changed
on the Parameters tab on the Design Gateway.
To delete a parameter from the arguments list, click on the parameter and press the
Backspace key.
If a parameter value might contain spaces, you should put double quotes around
the parameter reference (for example, “parm 1”).
For a file parameter, the absolute path to the file is substituted into the command
line. This can be very useful for programs that expect the name of their input file
on the command line. It is not necessary to put quotes around substituted file
parameters. File names are never split, even if they contain spaces.
File parameters can be used after the I/O redirection symbols <, >, or 2> to
redirect input/output to/from the file parameter.
Note: You can create a new parameter using the button. For more
information, see “Creating New Parameters,” on page 566.
6. (optional) Click the Load Script... button to load a pre-existing script from a file.
7. Edit the affinities for the component. The affinities for the selected interpreter are
set to the values provided in the preferences. Changing the affinities does not affect
the preferences. For more information about the properties, see “Editing
Component Properties,” on page 113.
The Consider execution failed if area is used to determine what conditions should
indicate that the program has failed. If none of the boxes are checked, the program
will be considered to succeed no matter how it exits.
Note: If the program cannot be found, the component will always be considered to
have failed.
Return code is other than. Select this option if you want to define the return
codes for successful completion of the execution. You can type multiple return
codes separated by commas (“1,2,5” means consider return codes of 1, 2, or 5
as success), or a range of numbers separated by a colon (“0:9” means any
return code from 0 to 9 inclusive indicates success). These can be combined to
specify multiple ranges (“0:9, 21:30”). Negative return codes are also allowed
(though few programs return them). This option is deactivated by default.
There is output to the Standard Error stream. When this option is selected,
if the command produces any output to the standard error stream, the run will
be considered a failure and the rest of the workflow will be aborted. This
option is usually set for UNIX programs. This option is selected by default.
Execution takes longer than. This option allows you to set a time limit (in
seconds) after which execution is deemed to have failed. The default timeout is
300 seconds (5 minutes). A timeout of 0 means don't check runtime. This
option is a duplicate of the Timeout option on the component Properties panel.
For more information about component properties, see “Editing Component
Properties,” on page 113.
Log Standard Error. If checked, any messages the program writes to standard
error will also be logged to the job log. This option is checked by default. This
option can help you determine why the program didn't run as expected.
This option (and those below) are in addition to whether standard error is
redirected to a file, and whether output to standard error is to be considered a
sign that the program failed.
Log Standard Output. If checked, any messages to standard output will also
be sent to the job log. Using this option is not recommended, as many
programs can produce a lot of output, and log messages are relatively
expensive.
Note: Lines are logged as they are produced by the program. This
characteristic can be very useful if the program writes a couple of lines and
then executes for a long time. You can see the status messages in the job log
before the program finishes.
4. In the Retry Execution after Failure area, set the following options, as desired:
The retry options are mostly for cases where a program may fail due to an external
condition, such as a web server being down, that can be expected to correct itself in
a short time. These options are typically used to retry execution if a program fails
because all licenses are in use.
Note: The Maximum number of retries option on the Component Properties panel
is in addition to the number of retries on the OSCommand editor. The
OSCommand retries are done first (in FIPER, on the same FIPER Station), and
then the component retries (in FIPER, on a different FIPER station). For more
information about component properties, see “Editing Component Properties,” on
page 113.
5. Set the options in the X-Windows Display area. These settings allow you to
activate the UNIX X-Display interface. Click the Use X-Display check box to
activate the option; then, specify the host name in the corresponding text box. This
host name can be either a domain name (unix.development.com) or an IP address.
This option is only used for UNIX X-Windows programs that fail to run unless an
X-Windows display is available. The specified display must be available at
runtime.
6. Click OK to close the editor, or proceed to “Setting Required Files Options” on
this page.
1. Click the Required Files tab. The required files options appear.
This tab is used to list files that need to be accessible when the command is run.
Any files parsed by the Data Exchange portion of a Simcode will automatically be
listed here. The information on this tab is a duplicate of the information on the
Files tab of the Design Gateway. It is presented here as a convenience. For more
information on using the Files tab, see “Using File Parameters,” on page 579.
2. Add files needed for execution to the list in the middle of the tab using one of the
following methods, based on the file type:
If you want to add all existing file parameters from the parent task, click
the button.
Note: To delete a file, verify that it is highlighted and click the button.
3. Edit the values of the file parameters to set the type, file name, and the Read From
and Write To options for the file. You can also change the name or mode of a file
parameter, but this is rarely useful. The information on this tab is the same as the
Files tab on the Design Gateway, and is included here for convenience. Note that
the Files tab will not be updated until the OK or Apply button on the editor is
clicked. For more information on file parameters, see “Using File Parameters,” on
page 579.
4. Click OK to close the editor, or proceed to “Setting Grid Adapter Options” on this
page.
Note: It is recommended that you review the limitations listed in “Understanding Grid
Adapter Limitations,” on page 393 before using the Grid Adapter.
2. Select LSF from the Grid System drop-down list. Currently, only LSF is
supported.
Note: The grid tab will not appear if there are no grid adapters available.
If you activate this option, the script defined on the Basic tab is assumed to be a
compatible LSF script that will be spooled to the batch system and executed by
LSF as a sequence of commands. The script type must be compatible with the
target system. Additionally, on UNIX systems, the “#!...” syntax must be used
within the script to specify the script’s execution shell. The Script Type selected on
the Basic tab is ignored in this scenario.
4. Enter the following information, as desired. You can edit one or all of the values.
You can also accept the default values.
Queue. Specifies the queue where the job should run. You can obtain the
available queue names from the LSF “bqueues” command. Refer to the bsub
“-q” option on the man page.
Hosts. Lists the candidate hosts (space-separated) where the job should run.
Refer to the bsub “-m” option for more information.
Resources. Specifies the resource requirements for the LSF job. Refer to the
bsub “-R” option for more information.
If necessary, you can also set Advanced options for the LSF adapter:
5. (optional) Click the Advanced... button. The Additional Grid Options dialog box
appears.
6. Type the commands in the large text area. Enter any additional options to LSF’s
bsub using standard bsub command-line option syntax (see bsub man page). Line
breaks are ignored, so these commands can be space-separated and/or on separate
lines.
Only LSF v6.1 is supported in iSIGHT-FD 2.5. Direct and unrestricted access to
run the LSF commands is required.
If it is necessary to transfer input/output files to/from the grid, this must be done
through the “-f” advanced option (see bsub man page), if available. If it’s not
available, then another mechanism must be used.
Jobs can only be submitted under the security credentials of the job submitter in
iSIGHT-FD.
The job status will be 0 for LSF’s “DONE” status or 1 for any other LSF job status.
Fail on stdout/stderr functionality will never generate a failure if the LSF plug-in is
used, since stdout/stderr will be returned to the submitting user in an e-mail by
default (LSF’s default behavior). You can override this behavior with the LSF
advanced options on the Advanced tab. The relevant bsub options are –o, -oo, -e,
-eo.
Each of these has different options for configuring how it should behave as part of the
workflow. The options are discussed in the following sections. Also, before using this
component, be sure to review “Known Issues,” on page 401.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Component Editor dialog box appears.
2. Select one of the following options from the Action drop-down list:
Pause only. This option causes the workflow to pause and wait until the
specified criteria are met, the Continue button on the provided dialog box is
clicked, or the specified resume time expires. For more information on this
option, see “Using the Pause only Action,” on page 395.
Ask a question. This option causes the workflow to pause and a specified
question displays. The workflow is paused until the answer is provided and the
the OK button is clicked, or the specified resume time expires. For more
information on this option, see “Using the Ask a question Action,” on
page 397.
Display parameters. This option causes the workflow to pause and a specified
set of parameters displays, allowing for changes to the parameter values before
the workflow proceeds. For more information on this option, see “Using the
Display parameters Action,” on page 398.
1. Set the Show a dialog while paused option. When this option is selected, a dialog
box appears when the Pause component is executed in the workflow. The dialog
box may contain any of the following items, based on how the other options for
this action are set:
A message appears indicating the workflow has been paused.
A message about the file that must be found in the local file system (and
optionally what text it must contain) before continuing the execution, if this
option has been set. For more information on this option, see step 2.
2. Set the Resume as soon as this file exists option. When this option is selected, the
workflow pauses until the specified file exists. You can type the path and file
information directly into the corresponding text box, or you can navigate to the file
using the Browse... button. You can also define text that must exist within the file
using the option in step 3.
3. Set the Only if this text is found option. This option is activated for use if the
Resume as soon as this file exists option is selected. You can use this option to
specify text that must exist in the specified file in order for the workflow to
resume, and you can determine if the case of the text is important using the Ignore
Case check box.
4. Set the Resume as soon as email arrives option. When this option is selected, the
workflow pauses until an email from the specified email address is received. If you
only want to resume if the subject of the email contains certain text, type that text
into the Subject contains text box.
Note: Click the Mail Options button to specify the information to use to connect
to the mail server and the details of your email account.
5. See “Using the Automatic Resume and Execution Location Options,” on page 399
for information on the resume options available as well as determining where the
Pause component (and associated interface) should be executed when used in a
distributed environment (using an ACS in the FIPER environment).
1. Type the question that will be asked in the Question text box.
2. In the Possible Answers area, select one of the following options from the first
drop-down list:
User will pick from a set. Selecting this option allows you to control the
possible answers to the question, and how the answers are presented. Proceed
to step 3 for more instructions.
User will type anything. Selecting this option provides a text box for typing
an answer. Proceed to step 5.
3. Update the Specify possible answers list to correspond with your question. The
answers of “Yes” and “No” are provided by default. You can specify as many
options as necessary by clicking in the last empty row of the table to provide a new
option.
4. Determine how the answers will be selected using the Display as drop-down list.
You can specify radio buttons or a drop-down menu.
5. Specify the information for the answer parameter using the Parameter to contain
answer drop-down list. By default, a parameter called “answer” is provided. You
can change the name of the parameter directly in the corresponding text box. You
can also change the parameter’s properties, or create a new parameter, using the
button.
6. See “Using the Automatic Resume and Execution Location Options,” on page 399
for information on the resume options available as well as determining where the
Pause component (and associated interface) should be executed when used in a
distributed environment (using an ACS in the FIPER environment).
1. Select the parameters that you want displayed during execution from the list that
appears. You can select individual parameters or you can use the Select All button
to select every displayed parameter.
The list shows all of the parameters available in the current workflow. Selected
parameters have a icon in the first column of the list. Values for the selected
parameters will be presented in a separate dialog box during execution and can be
modified as a means of interactively influencing the design.
2. See “Using the Automatic Resume and Execution Location Options” on this page
for information on the resume options available as well as determining where the
Pause component (and associated interface) should be executed when used in a
distributed environment (using an ACS in the FIPER environment).
Set the Automatically resume after option. If activated, any pause in the
workflow will automatically end once the specified (after option) time limit or
clock time (at time option) is reached.
The at time option is useful for deferring execution of various parts of the
workflow until a time at which computing resources are known to be available
or a certain user is available to perform some interactive process within the
workflow. Note that if the specified time of day is already passed, the
workflow will resume immediately.
If the after option is used, the countdown time is displayed during execution
so that you will know how much time remains before it automatically resumes.
If the at time option is used, the time when the execution will resume is
displayed.
You will be able to resume the execution at any time by clicking the Continue
button on the dialog box that appears during execution.
Note: If you do not want the Pause component to automatically resume, simply
clear (uncheck) this option. Clearing this option will also set the general Timeout
option on this component to “0” (meaning it will never timeout). For more
information on component properties, see “Editing Component Properties,” on
page 113.
computer job was submitted from. The Pause component, and any
associated interface, will execute on the computer from which the job was
initially submitted. Select this option if your intent is to have the person
executing the model also be the one prompted with any questions or parameter
lists, or just to monitor the status of the pause. Since this option is the most
typical scenario, it is the default setting.
specified FIPER Station. The Pause component will execute on the computer
that serves as the FIPER Station specified in the provided text box.
any FIPER Station. The Pause component will execute on any available
FIPER Station as selected by the FIPER ACS.
Known Issues
When using the Automatically resume at time option during daylight savings
time (DST), the Pause component uses the incorrect time on Windows systems that
do not have the “Automatically adjust clock for daylight savings changes” option
enabled on the Windows Date and Time Properties dialog box.
This interface is accessed by double-clicking the clock in the system tray; then,
clicking the Time Zone tab. The option is at the bottom of the tab.
If daylight savings is in effect in the current time zone, but this Windows option is
not enabled, iSIGHT-FD uses a time value which is incorrect by one hour. This
issue affects the Pause component’s ability to resume execution at a specific time
of day.
The remote partner access feature is the primary means of enabling FIPER Federation
(Business-to-Business) capabilities. It allows you to select a model that resides at a
partner organization (which has a FIPER ACS) and insert a reference to it within your
own workflow. When this component is executed as part of your workflow,
iSIGHT-FD makes the appropriate connection to the partner FIPER ACS (which
executes the remote model), and receives the outputs from that remote execution. With
this capability, various organizations can collaborate on an overall product design by
contributing analysis and design results from their own specialty areas of
responsibility, while still maintaining the proprietary nature of their data and methods.
For more information on using FIPER Federation, refer to the FIPER Federation
(B2B) Guide. For more information on other referencing options, see “Using
Referenced Models,” on page 101.
For two FIPER-enabled organizations to collaborate, they must register each other
as “partners” so that the necessary connection protocols can be established. Partner
registration is performed as a FIPER administrator function and can be done at any
time. For more information on defining a FIPER partner, refer to the FIPER
Federation (B2B) Guide.
The remainder of this section assumes that the aforementioned prerequisites have been
met.
1. Verify that the Reference component is selected in the workflow area; then,
double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Component Editor dialog box appears.
This dialog box shows three top-level categories, which represent all the places a
model reference can be made. The first category (Internal Submodels) is a single
level that shows all the internal submodels currently defined in your model. The
root component icon and name are shown for each submodel.
Important: Submodels must be created from the Design Gateway before they can
be used within the Reference component. For more information on how to create
submodels as well as the benefits of using submodels, see “Using Submodels,” on
page 90.
The second category (FIPER Library) is a Library browser which shows models
published to the local Library. The third category (Remote Partner) shows a
two-level subtree. The first level displays all the partners known to the ACS, and
for each partner, the list of models you are authorized to use. For more information
on configuring FIPER’s federation capability, refer to the FIPER Federation (B2B)
Guide.
3. Proceed to one of the following sections, based on the type of model you want to
reference:
Referencing a Submodel
This option allows you to reference an internal submodel currently defined in your
model. Submodels must be created from the Design Gateway before they can be used
within the Reference component. For more information, see “Using Submodels,” on
page 90.
1. Access the Select Reference Model dialog box as described in “Accessing the
Component and Selecting the Reference Type,” on page 403.
2. Expand the Internal Submodels option on the left side of the dialog box. The
available submodels are listed.
Important: Submodels must be created from the Design Gateway before they can
be used within the Reference component. For more information on how to create
submodels, see “Using Submodels,” on page 90.
The submodel’s information appears on the right side of the dialog box.
4. Verify that you have selected the correct submodel; then, click the Select Model
button.
You are returned to the Reference component editor, and the selected model’s
information now appears on the editor.
5. (optional) As desired, change any values for the input and output parameters.
6. Click OK to close the editor. The submodel is added to your workflow. For more
information on submodels, see “Using Submodels,” on page 90.
2. Expand the FIPER Library option on the left side of the dialog box; then,
navigate to the location of the model you want to use (if necessary).
The model’s information appears on the right side of the dialog box.
Note: The parameters that are displayed in the model are specified using the model
properties. For more information, see “Setting Model Properties,” on page 65.
4. Verify that you have selected the correct model; then, click the Select Model
button. You are returned to the Reference component editor, and the selected
model’s information now appears on the editor.
5. (optional) As desired, change any values for the input and output parameters.
6. Click OK to close the editor. The model is added to your workflow. For more
information on how reference models are handled by iSIGHT-FD, and how the
workflow is effected, see “Using Referenced Models,” on page 101.
1. Access the Select Reference Model dialog box as described in “Accessing the
Component and Selecting the Reference Type,” on page 403.
2. Expand the Remote Partner option on the left side of the dialog box.
A list of FIPER partners that have been defined for your organization is displayed.
In the following example, the administrator had defined one partner (partner1) that
can be accessed from the local ACS.
3. Expand the partner that possesses the model you want to use. The available models
are displayed.
When a partner is selected, a remote query is made to get a list of all models on the
remote ACS that have shared attributes matching the local ACS domain and the
logged on user ID.
Note: If your FIPER environment does not yet have any partners established, the
Partners list will be empty and you will not be able to proceed. Refer to the FIPER
Federation (B2B) Guide for information on defining partners for your FIPER
environment.
The model information, including name, version, and parameters, is loaded. You
are also informed if no models are present in the Library.
Note: The parameters that are displayed in the model are specified using the model
properties. For more information, see “Setting Model Properties,” on page 65.
5. Verify that you have selected the correct submodel; then, click the Select Model
button.
You are returned to the Reference component editor, and the selected model’s
information now appears on the editor.
The inputs and outputs of the remote service are read and used to populate the
inputs and outputs of the local Reference component. The default values for inputs
were taken from the default values defined in the remote service.
6. (optional) As desired, change any values for the input and output parameters.
7. Click OK to close the editor. For more information on how reference models are
handled by iSIGHT-FD, and how the workflow is effected, see “Using Referenced
Models,” on page 101. For more information on FIPER federation capabilities,
refer to the FIPER Federation (B2B) Guide.
Note: Federated Reference models are not expanded/visible. You cannot see the
internal parts of the model (i.e., components, workflow, dataflow, parameters).
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The upper section of the dialog box lists the available parameters. The lower
section shows the script.
2. Alter parameter information displayed in the Available Parameters list, if desired.
The existing parameters for this script and for the components around it in the
workflow are displayed at the top of the editor.
the button.
The columns in the Available Parameters list show the following information:
Name. This column shows the name of the parameter and the array/aggregate
hierarchy.
Java Variable. This column shows the name that the parameter has inside of
the script. This is initially the same as the Parameter name, with punctuation
and spaces converted to underscores ( _ ). You can edit the Variable name and
change the name used in the script if you wish.
Value. This column shows the current parameter value. You can edit this entry
to change the initial value of the parameter.
Mode. This column shows the mode of the parameter (input, in/out, output, or
local). If the parameter is not used by the script, the mode the parameter has in
the model (the mode it would have if mapped to the component) is shown.
Java Type. This column shows the declared type the parameter variable will
have in the script. You can select a different type using the pull-down menu.
The available types are described in more detail below.
Note: Arrays are followed by [ ] in this column indicating that the Java
variable is an array.
3. Type your script in the Enter your Java script here text box.
The Script consists of Java statements, such as you would see inside the body of a
Java method. A surrounding Class or Method declaration is not needed or allowed.
It is not necessary to declare variables before using them. All of the parameters are
pre-declared. Other variables (such as “i” above) can be used as long as the first
reference is an assignment.
Parameters are referenced in the script by just typing their variable name (from the
Variable column). You can also insert a reference to a parameter by selecting the
parameter and clicking the button.
4. Click the Check Syntax button to verify the syntax of your script. Any messages
about the script are displayed on the status bar at the bottom of the editor. Any
syntax errors in the script are highlighted in pink. The pink error highlight won't go
away until you fix the error and click the Check Syntax button again.
Note: You can click the Details... button to get more information on a syntax error.
You can write classes in the script and create instances of them.
You can write functions using the Java method declaration syntax. For example:
int factorial(int i) {
if (i <= 0) return 1;
else return i * fact(i-1);
}
intVar2 = factorial(intVar1);
Note that a function cannot be called until after it is defined. Also, the body of the
function does not have access to global variables or parameters, only to the
function arguments. So, for example, it would be an error to try to reference
intVar1 inside the body of factorial.
Variables do not need to be declared if the first use of the variable is an assignment.
The variable is implicitly declared with the type of the right-hand expression. Thus
the statement:
s = xxx.toString();
Import statements can be interspersed with statements in the script, as long as the
Import statement occurs before the symbols it imports are used.
http://koala.ilog.fr/djava/
Real as “double”
Integer as “int”
Boolean as “boolean”
String as “java.lang.String”
The value of the parameter is copied into the Java variable before the script starts, and
the value of the Java variable is copied back into the Parameter after the script finishes
(for parameters with mode Output and In/Out only).
A Parameter can also be put into the script as a “Value” object. For example, a Real
parameter could be represented by a RealValue. Value objects have methods like
“setValue(String)” or “getAsReal()”. The advantage of a Value is that there is no need
to copy the contents out to the parameter - any change to the Value immediately
updates the associated Parameter. Value objects can also be updated inside functions,
allowing you to emulate the C-language pass-by-reference operator “&”.
A parameter can also be put into the script as a Variable object. Using the Variable
allows access to additional information beyond just the value. You can get the
parameter name, mode, data type. Members of aggregate Parameters can be accessed
in this way:
abc = AggParm.getMember("abc");
Array Parameters are added to the script as an array of the primitive type, an array of
Value objects, or an ArrayVariable.
jobLog. Used to log messages to the iSIGHT-FD job log. The standard usage is:
jobLog.logWarn("Warning - things are going wrong!");
Note: System.out and System.err are directed to the gateway.log file when an
iSIGHT-FD model is run (and to the Station log file when the model is run via
FIPER). The jobLog variable is the preferred way to report messages from a
Script.
<isight-fd_install_directory>/javadocs/com/engineous/sdk/runtime
Script Execution
The script is evaluated by statement at runtime until the last statement completes.
When the last statement completes, the Script component is considered to have
finished successfully. If any statement gets an error, or the script throws an uncaught
exception, the Script component is considered to have failed.
Resizable Arrays
Array parameters can change size at runtime. You can find the size of array parameters
by using one of the following methods:
If the Java Type is ‘double[ ]’ or ‘RealValue[ ]’, use the java .length
operator:
N= array.length;
Ncolumns= array2D.getDimSize1(2);
For more information, refer to the ArrayVariable.html file in the following iSIGHT-FD
installation directory:
<isight-fd_install_directory>/javadocs/com/engineous/sdk/vars
Limitations
The Script component cannot be used to create new parameters or to change the type of
an existing parameter.
The input data exchanger is used to update an input file (such as a NASTRAN input
deck) with values taken from parameters. The OS Command portion runs an external
program (or a script that calls multiple programs). Finally, the output data exchanger
examines the files written by the program and extracts values into parameters.
The big advantage of using the Simcode component over separate Data Exchanger and
OS Command components is that copying of the input and output files between
machines is avoided; the files are created, used, and (unless saved) discarded in one
step.
Note: This section provides a brief overview of the parts of the Simcode component
editor. For more detailed information on using the Data Exchanger component, see
“Using the Data Exchanger Component,” on page 249. For more detailed information
on using the OS Command component, see “Using the OS Command Component,” on
page 377. For more information on using the Grid Adapter, see “Setting Grid Adapter
Options,” on page 389. For more technical information on setting up a simcode,
contact your Engineous Software representative.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
The Component Editor dialog box appears.
There are three tabs at the top of the editor, one each for the Input data exchanger,
the OS Command, and the Output data exchanger. Each of these tabs also has
sub-tabs containing additional options.
2. Specify the command and arguments on the Command tab. For more information
on using this tab, see “Using the OS Command Component,” on page 377. This tab
is essentially an embedded OS Command component.
This tab is used to define the input data sources for the simcode.
4. Click the large button in the center of the dialog box to begin the process of
defining a data source.
5. Select the source of the data you want to update in the input file parse. The
following three options are available:
Write a new file from scratch. A new file will be created at runtime. Proceed
to step 12 on page 425.
Note: An Input file parameter is created for the Template file. While the template
file is usually fixed, it is possible to map another file parameter to the Template file
parameter, allowing the template to vary at runtime.
7. Enter the template file into the text box or use the Browse button to locate the file.
Store content of the template in the model. This option allows for the model
to be self-contained – it can be run even if the file is subsequently deleted.
However, the file must be explicitly re-loaded (using the Files tab on the
Design Gateway) to pick up any changes made to the file after the model is
created.
Read template from this file for every run. The model will reference the file
on disk every time the simcode executes. This option is faster, saves space for
large files, and causes the model to see any changes to the file the next time it
is run. However, it can prevent distributed execution of the model, and the
model becomes unusable if the file is deleted.
11. Select the file parameter that will provide the template data that will be updated by
the input file parse. This file parameter can already be part of the Simcode
component, or it can be an output from another component earlier in the workflow.
12. Click Next. The Select Local File Name screen appears.
13. Enter the file name or use the Browse button to locate the file. iSIGHT-FD
automatically fills in the text with the simple name of the file (the name with the
path removed). This is the name the file will have at runtime. The name defaults to
the name of the template file.
The File Format options dialog box appears. For more information on using this
dialog box, see “Creating a New Data Exchanger Program,” on page 262.
14. Click the Output tab. The contents of the tab appear.
This tab is used to read data for the output data sources for the simcode.
15. Click the large button in the center of the dialog box to begin the process of
defining a data source.
16. Enter an example of the output file format or use the Browse button to locate the
file. This file format is used when setting up the parse.
17. Enter the local file or use the Browse button to locate the file. This file is the one
that OSCommand will write to during runtime. iSIGHT-FD automatically fills in
the text with the simple name of the file (the name with the path removed). This
simple name is the name the file will have at runtime. The name defaults to the
name of the template file.
19. Select where the data will be stored after the file is parsed. The three options
available are:
Don’t store the file. The file cannot be mapped to other components.
Write to a file. You will need to enter the name of the file or use the Browse
button to locate the file.
The File Format screen appears. For more information on the File Format screen,
see “Creating a New Data Exchanger Program,” on page 262.
Additional Information
The following additional information should be noted when using the Simcode
component:
Files set up on the Required Files subtab of the Command tab are available for use
by the Input and Output tabs. Select the parameter associated with the file from the
File to Read at Runtime or File to Write at Runtime drop-down lists on the
Open Data Source wizard of the Input or Output tab.
The input files set up by the input file parse and the output files passed by the
output parse can be substituted into the command line, and can be used to redirect
standard input or output of the command.
The files are available in the drop-down parameter list as file parameters.
The absolute path to the file will be substituted into the Runtime command text
box.
1. Double-click the component icon to start the component editor. For more
information on inserting components and accessing component editors, see
Chapter 3 “Creating Models Using the Design Gateway”.
To use an existing Word document, click the Browse... button in the Starting
Document area; then, navigate to the document you want to use. Word is
started and the document is opened. When an existing document is opened, it
is copied into the system temporary directory and all modifications are made to
that document. The original document remains unchanged.
Note: Only one document can be opened using the component. When an additional
new document is created, or another existing document is opened, the previously
opened document is closed.
Important: If you manually close the Word document that was opened by the
component editor, the editor is not notified. You must click OK to close the editor
and then re-open it.
Now you need to map the desired iSIGHT-FD parameters to the Word document.
3. Highlight the area in the Word document where you want the parameter value to
appear.
Note: You can insert parameter values into a formal Word table in the document by
selecting the desired cell location(s).
5. Perform one of the following actions, based on how you want to map parameters to
the Word document:
If you want to map parameters individually and control their exact location in
the Word document, proceed to step 6.
6. Select a parameter from the Parameter to insert drop-down list in the Instructions
area.
Note: You can also create a new parameter using the button. Once created,
you can map the parameter into the Word document.
7. For scalar parameters, if you want the parameter to be inserted in the format
“<name> = <value>”, click the Insert as <name> = <value> check box.
Otherwise, only the parameter value will be inserted.
Note: You can insert the contents of a file (image files only) into the Word
document by selecting an appropriate file parameter.
8. For array parameters, specify the starting index and ending index of part of the
array that you want inserted. The parameter value for every specified element will
be inserted with a line break between each element.
9. Click the button. The parameter is mapped, and the parameter name is
displayed in the Word document in highlighted text.
10. Repeat step 6 and step 9 for each parameter you want to map.
12. Click the button. A name-value pair table is added to the Word document in
the location specified. All supported parameters in the component are listed.
13. If you want to execute any macros that are defined within the specified Word
document, perform the following steps:
b. Select a macro that you want to execute (only those that are specified to be
public will be presented).
c. Specify any arguments that must be supplied to the macro.
d. Click the button to add the macro to the list. You can also click the
button to remove a macro).
Note: Macros will be executed after any parameter mappings that have been
defined.
14. (optional) To save the updated Word document following execution, click the Also
save to disk check box in the Document Produced area; then, specify a location for
the file in the corresponding text box. You can either type a location, or navigate to
a location using the Browse button.
Note: The modified Word document will be provided as an output file parameter
from this component even if you choose not to save it to a specific location on your
disk.
15. Determine if you want the Word document visible during the model execution
using the Show Word during execution check button.
16. Click the Close Word document check box if you want Word to close the opened
document (when not selected, Word and the document remain open after the model
is executed); then, use the corresponding drop-down list to determine when Word
should close. The following options are available:
when job completes. This option closes the document after the entire
iSIGHT-FD execution is completed.
after each execution. This option closes the document after each execution of
Word. Word may be executed numerous times during a single job.
Note: You can set default behavior for this option using the component preferences
as described in “Setting Word Component Preferences,” on page 121.
Note: If you created a new document in step 2, you are asked to specify the
location on your system where the document should be saved. If you do not specify
a name and location for the new document, the file is added to the component as a
file parameter with a default name provided by the component.
During execution, the parameters mapped to the Word document are replaced by
their respective values. After execution, the Word document is provided as a
New/Modified output file parameter from this component.
These steps are not necessary if you are executing using the standard iSIGHT-FD
desktop (Standalone) execution.
1. Click the Start button; then, click the Run... option. The Run dialog box appears.
2. Type dcomcnfg in the Open text box; then, click OK. The Component Services
dialog box appears.
3. Click Component Services on the left side of the dialog box. Folder options
appear on the right side of the dialog box.
5. Double-click the DCOM Config folder. The contents of the folder appear.
6. Right-click the Microsoft Word Document icon; then, select Properties from the
menu that appears.
8. Click the Customize radio button in the Launch and Activation Permissions area;
then, click the Edit... button. The Launch Permission dialog box appears.
9. Click the Add... button. The Select Users, Computers, or Groups dialog box
appears.
10. Type the necessary username (be sure to include the computer/domain name) in the
Enter object names to select text box.
11. Click the Check Names button to verify that the username you entered is valid.
You can also search for the name using the Advanced... button.
12. Click OK. You are returned to the Launch Permission dialog box, and the
username you entered now appears in the list at the top of the dialog box.
13. In the Permission for <username> area; click the following check boxes in the
Allow column:
Local Launch
Local Activation
14. Click OK. You are returned to the Microsoft Word Document Properties dialog
box.
15. Click OK. You are returned to the Component Services dialog box.
17. Proceed to “Setting Up the Component,” on page 430 for information on using the
Word component.
This chapter describes how to use the iSIGHT-FD Task Plan feature. It is divided into
the following sections:
“Understanding How the Task Plan Affects Model Structure,” on page 440
“Accessing Task Plan Components from the Design Gateway,” on page 451
“Using Task Plan Components with the Change To Option,” on page 452
Overview
This feature allows you to easily apply a design driver (DOE, optimization, etc.) or
sequence of design drivers to the workflow that has been defined for a Task (which will
be referred to as the “analysis” workflow). This functionality, known as a Task Plan,
can be accessed via any Task component in an iSIGHT-FD workflow, and is set up
using the component's editor. Once created, you can execute the Task Plan in its
entirety, or simply execute the analysis workflow one time.
Once you create and save a Task Plan, the fundamental structure of your model is
permanently changed. You cannot remove this new structure. Even if you completely
remove the components created in the Task Plan, the structure of the model will still
exist in its new, changed state. For a more simplified presentation, the Design Gateway
hides some of the intermediate layers that exist merely to support the required model
structure. Note that even though the structure of the model has changed, you can still
execute the original workflow (the analysis workflow) by itself without the Task Plan.
This process is described in “Creating a Task Plan and Setting Execution Options,” on
page 443.
Figure 5-1. How Process Components in a Task Plan Affects the Model Workflow
Figure 5-2. How Activity Components in a Task Plan Affects the Model Workflow
1. Verify that you have created a model that contains a Task component in the proper
location for creating a Task Plan.
There are two execution options you can set directly from the Task component
editor. Both of these options have a direct impact on how your Task Plan is
executed and if it is executed at all.
To set execution options, select one of the following Task Plan execution options at
the top of the Task editor:
Execute the Analysis flow once. When this option is selected, the original
workflow of the Task (analysis flow) is executed a single time, ignoring any
Task Plan that might be defined.
Note: The Task Plan portion of the editor is not accessible when this option is
selected.
Execute the specified Task Plan. When this option is selected, the
components specified in the Task Plan are executed in the defined order, with
any process component executing the analysis workflow as its subflow.
When the Execute the specified Task Plan option is selected, the portion of the
editor for defining the Task Plan is enabled. It contains two subtabs: Task Plan and
Model View. The Task Plan tab is used to create, edit, and alter your Task Plan.
Once you have created a Task Plan and specified which components will be used
during execution, you can use the Model View tab to view the entire model
workflow layout to gain a better understanding of what components will actually
be executed. For more information on your workflow, see “Understanding How the
Task Plan Affects Model Structure,” on page 440.
The first step in creating a Task Plan is to create components that can be used in the
Task Plan. These components do not necessarily have to be added to the workflow,
but they can be added to it at any time after they are created.
3. Click one of the following buttons to add a component to the Task Plan:
The selected component is added to the Available Components list with a default
name.
Now that the component has been created, you can edit it or add it to the workflow.
Important: In its current state (in the Available Components list) the component is
not included in the workflow. However, it is saved by iSIGHT-FD and can be
configured.
4. Edit the components using the components’ editors as described in “Editing Task
Plan Components,” on page 446.
then, click the button. The component is added to the Task Plan Execution
list. You can also remove components using the button.
6. Move the components added to the Task Plan Execution list using the
buttons to create the desired Task Plan workflow. The components are executed in
the order in which they appear in this list, with the top component being executed
first.
Note You can edit, rename, or delete the component by right-clicking the
component in the Available Components and Task Plan Execution lists.
1. Click the component that you want to edit in either the Available Components list
or Task Plan Execution list. The component is selected.
2. Click the button beneath the list containing the selected component. The
component’s editor appears. You can also double-click any component in either list
to access its editor.
3. Proceed to one of the following sections, based on the component you are editing:
For any other component, see the appropriate section in Chapter 4 “Using
Components”.
1. Verify that the component you want to copy has been selected and is highlighted.
In the following example, we’ll be copying a DOE component.
Note: You can also copy components in the Task Plan Execution list using the
button at the bottom of that list. However, the copies are added to the Available
Components list. You can then move them to the Task Plan Execution list, if
desired.
3. Save your changes to the Task Plan. For more information, see “Saving the Task
Plan Configuration,” on page 450.
1. Access the Task component editor as described in “Creating a Task Plan and
Setting Execution Options,” on page 443.
3. Use the buttons on the left side of the tab, as desired, to alter the presentation of the
model layout (you cannot directly alter the actual workflow from this tab). For
more information on these buttons, see “Manipulating the Workflow Tab Canvas,”
on page 84.
Use the button to remove a component from the workflow. The component is
moved from the Task Plan Execution list to the Available Components list. You can
confirm the component’s removal using the Model View subtab. This component is
still available for later use, and can again be added to the workflow at any time.
Use the button to delete the component from the Task Plan. Deleting the
component from the Task Plan completely deletes the component and any settings you
have made to the component. However, you can still add a component of the same type
back into the Task Plan and reconfigure it.
If you click OK or Apply to save a Task Plan where no components have been added to
the Task Plan Execution list, the following warning message appears.
Click Yes to change the execution mode to execute the Analysis one time. If you click
No and leave the editor set to execute an empty Task Plan, when execution occurs the
Task component will simply complete without executing anything.
This option, when selected, will ensure that the Task component executes without
being dispatched to a FIPER Station when iSIGHT-FD is connected to an ACS in the
FIPER environment. When the Task is simply used to create a hierarchical structure in
your model, this option allows you to avoid the sometimes unnecessary overhead
incurred by dispatching it to another machine to execute.
Note: If file parameters are defined for the Task component, this option cannot be
enabled since the files must be processed.
Figure 5-3. Task Plan and the Impact on the Model Explorer
The components that make up each part of the model are listed within these
subcategories. Only Task Plan components that will be used during model execution
(those that have been added to the Task Plan Execution list) are displayed in the Model
Explorer.
You can directly access any listed component’s editor by double-clicking it on the
Model Explorer. You also have access to other options when you right-click a
component (Rename, Publish, etc.). For more information on using these options, see
“Using the Other Model Explorer Options,” on page 67.
1. Define the process components you want to use in the Task Plan; then, click OK to
close the Task component editor.
3. Right-click the component; then, select Change To from the menu that appears.
The components that you configured in the Task Plan are available in the displayed
list of components.
4. Select the component that you want to change to. The workflow changes to just
having the selected process component running the analysis task. You can change
back to the Task Plan option at any time and the contents of the Task Plan remain
intact.
In addition to the process components of a Task Plan being available using the
Change To option, any process components that had been previously defined as
available to Change To on a Task will be made available for use within the Task Plan.
This feature is the exact opposite of the functionality previously described. For
example, if you defined a model in which a DOE component ran some subflow and
then decided that you wanted to instead run a Task Plan on that subflow, you can use
the Change To option to switch the DOE component to a Task component, open the
Task component editor to define a Task Plan, and use the previously defined DOE
component within the Task Plan.
3. Right-click the component; then, select Change To from the menu that appears.
Additional options appear.
4. Click the New... option. The Select New Component dialog box appears.
5. Click the Task option; then, click OK. The original process component is replaced
with a Task component in your workflow.
6. Double-click the Task component. The Task component editor appears. Notice
that the original process component appears in the Available Components list and
can be used in your Task Plan.
Note: You can change the Task component back to the original process component
at any time using the Change To option.
This capability is available no matter how many process components you have defined
using the Change To option. All of the process components are made available within
the Task Plan editor for use in the Task Plan.
Overview
Approximations in iSIGHT-FD serve to replace a specific component during runtime
execution of a model. Approximations can also be used to gain an insight into the
behavior of the component which they approximate by examining the two-dimensional
and three-dimensional graphs in the Approximation Viewer. Approximations work by
building a simplified mathematical models for the selected component using multiple
data points. The data points for approximations can be obtained either by executing the
approximated component multiple times, or by reading a data file with previously
analyzed points. The process of building the mathematical model using data points is
called initialization. After an approximation is initialized, it can be evaluated and used
at runtime to replace the approximated component. Multiple approximations can be
created, initialized, and viewed for any iSIGHT-FD component, but only one of them
can be used at runtime. To use an approximation at runtime, you must activate it before
submitting the model for execution.
All approximations for the selected component can be accessed via the
Approximations dialog box that can be opened either from the Approximations
button on the Component Title Bar or via the right-click menu. Approximations are
created and edited using the Approximation Wizard. Details about all of the above
actions are described in the remaining sections of this chapter.
Right-click the component on the Workflow tab or the Model Explorer; then, select
Approximations from the menu that appears to access the Approximations dialog
box. This interface provides you with access to all options available with regular
approximations.
The following example shows the Approximations dialog box for the case when no
approximations exist for the selected component called Compute a, ix, iy.
Important: If you are selecting a Task Plan component, you must select the
component using the Model Explorer on the left side of the Design Gateway. These
components do not appear in the model workflow.
2. Click the New... button on the right side of the dialog box.
3. Type a custom name for the approximation in the Name of approximation text
box, if you want to change the default name.
4. Verify that the Automatic radio button is selected; then, click Next.
The Input and Output Parameters screen appears.
Note: For any inputs that are not selected, the values for these inputs will have no
effect on the outputs evaluated from the approximation. Similarly, if you do not
select one of the output parameters, its value will remain constant during execution
of the approximation.
These options let you determine the number of random sampling points that will be
used. The following options are available:
Specify a number of point in the sample points text box. This number must be
at or above the minimum required number of points specified in the text
message above the entry box.
Have iSIGHT-FD use a time limit for determining the number of points.
iSIGHT-FD will keep executing for the specified duration of time.
Note: If less than the minimum required number of points is executed, iSIGHT-FD
will continue executing sampling points until the requirement is met.
Click the Use a fixed random seed check box and specify a seed value to use
for the random number generator when determining the set of sample points to
be executed. This option allows you to reproduce the approximation with the
same set of points later, if desired.
Click the Execute design points in parallel if you want to execute your
initialization points in parallel. This option should only be used if you are
using a multi-CPU system or if you are connected to an ACS in the FIPER
environment.
8. Alter the Lower and Upper values for the listed input parameters, as desired.
These bounds will determine the design space where the random points will be
generated by iSIGHT-FD.
3. Type a custom name for the approximation in the Name of approximation text
box, if you want to change the default name.
4. Click the User Defined radio button; then, click Next. The Approximation
Technique screen appears.
5. Select the technique you want to use from the Approximation technique
drop-down list. The following options are available:
RBF Model. Radial Basis Functions (RBF) are a type of neural network
employing a hidden layer of radial units and an output layer of linear units, and
characterized by reasonably fast training and reasonably compact networks.
For more information, see “RBF Model,” on page 737.
Note: These techniques are plug-ins that have been created by Engineous Software
and included with your iSIGHT-FD installation. You can create your own
approximation technique plug-ins using the Generator. For more information, refer
to the iSIGHT-FD Development Guide.
6. Click Next. The Input and Output Parameters screen appears.
7. Determine which parameters you want to use for your approximation. You can
select or deselect individual parameters by clicking the check box in the first
column in both the Inputs and Outputs area, or you can click the Check or
Uncheck buttons to automatically select (or deselect) all of the listed parameters.
8. Perform one of the following actions, based on the approximation technique you
are using:
10. Select one of the following options from the Sampling method drop-down list:
Data File. The model uses a data file to get data for model construction.
DOE Matrix. iSIGHT-FD uses Design of Experiments (DOE) to determine
the set of points to evaluate.
11. Proceed to one of the following sections, based on your selection above:
If you have selected the Random Points sampling option, the Sampling Range
screen appears.
Note: If you selected the DOE Matrix sampling option, the Input Attributes screen
will display a table of Factor Attributes, where each input parameter of the
approximation is presented as a DOE Factor. Depending on the selected DOE
technique, the table will contain different columns. For more information about the
DOE Matrix sampling option, see “Using the DOE Matrix Sampling Method,” on
page 476.
13. (Random Points sampling method only). Determine how you want to define the
sampling region using one of the following options:
Absolute Values. This option defines the region by using absolute bounds for
each inputs parameter. You need to specify the Lower and Upper values for
each parameter in the corresponding columns.
Relative to Baseline. This option defines the region by applying relative move
limits to the baseline values in both direction. You need to specify the baseline,
move limit percentage, and minimum move limit for each parameter in the
corresponding columns.
14. Alter the Lower and Upper values for the listed parameters, as desired.
Separate data set. This method compares exact and approximate output
values for each data point. Proceed to step 17.
Cross-validation. This method selects a subset of points from the main data
set, removes each point one at a time, re-calculates coefficients, and compares
exact and approximate output values at each removed point. Proceed to
step 20.
17. Click Next. The Error Analysis Sampling Options screen appears.
18. Select one of the following options from the Sampling method drop-down list:
Data File. The model uses a data file to get data for model construction.
Depending on your choice, a different set of options appears. These options are
similar to the options set on the Sampling Options screen. For more information
about the Sampling methods, see “Using the Sampling Methods Options,” on
page 473.
19. Proceed to step 23.
21. In the text box, type the number of points from the total number of sampling points
that you want to use for cross-validation error analysis.
22. Click the Use a fixed random seed for selecting points check box and specify a
seed value to use for the random number generator when determining the set of
sample points selected for cross-validation. This option allows you to reproduce
the approximation with the same set of points later, if desired.
23. Click Finish. A message appears prompting you to initialize the approximation.
24. Perform one of the following actions:
Click No if you want to save the approximation and wait until later to
initialize. You are returned to the Approximations dialog box.
2. Select the polynomial order of the model using the corresponding drop-down list.
The following options are available:
Linear. This option is the recommended value when the outputs are known to
be linear with respect to the inputs. This option requires the smallest number of
design points for initialization, but it will produce larger errors for non-linear
output functions.
Quadratic. This option is the recommended value for most cases and provides
the best approximation performance to cost ratio. Quadratic RSM provides the
best optimization performance for smooth exact functions.
Cubic. If this option is selected, the model polynomial will have all quadratic
terms, and only pure cubic terms (i.e., no mixed interaction terms of 3rd order
are included).
This option is recommended when the outputs are highly non-linear functions
of the inputs. This option requires more design points for initialization than
Quadratic.
Quartic. If this option is selected, the model polynomials will have all
quadratic terms, only pure and cubic terms, and only pure 4th order terms (i.e.,
no interaction terms of 3rd and 4th order are included).
The same recommendations listed under Cubic apply to Quartic
approximations. Be aware that using Quartic polynomials in optimization may
create undesired local minima.
3. You can use Term Selection to remove some polynomial terms with low
significance, which can improve reliability for your approximation and reduce the
number of required design points. Perform one of the following actions:
To use Term Selection: Click the Select the following number of best terms
from polynomial check box; then, specify the number of best terms that you
want selected in the corresponding text box.
4. Select one of the following options from the Term selection method drop-down
list:
Here are exact output values, are approximate output values, n is the
number of design points used for the Response Surface Model.
After adding a new term, iSIGHT-FD will examine all selected terms and will
delete one or more terms for which the following condition is satisfied:
and can take a very long time for a large number of design points and large
numbers of inputs and outputs.
2. Select the number of points for the approximation. The following options are
available:
Specify a number of points in the sample points text box. This number must
be at or above the minimum required number of points specified in the text
message above the entry box.
Specify a time limit using the As many points as possible in option. You can
set a time limit (in second, minutes, or hours) that iSIGHT-FD will use for
determining the number of points. iSIGHT-FD will keep executing for the
specified duration of time.
Note: If less than the minimum required number of points is executed, iSIGHT-FD
will continue executing sampling points until the requirement is met.
3. Click the Use a fixed random seed check box and specify a seed value to use for
the random number generator when determining the set of sample points to be
executed. This option allows you to reproduce the approximation with the same set
of points later, if desired.
4. Click the Execute design points in parallel if you want to execute your
initialization points in parallel. This option should only be used if you are using a
multi-CPU system or if you are connected to an ACS in the FIPER environment.
5. Perform one of the following steps, based on your location in the wizard:
To complete the Error Analysis Sampling Options settings for User Defined
approximations: Return to step 23 on page 469.
2. Click the Browse... button to locate the file you want to use. The Select File dialog
box appears.
3. Locate the file; then, click the Select button. You are returned to the Sampling
Options screen, and your file appears in the large text box adjacent to the Browse...
button.
4. Specify the type of file you selected using the following options:
Static file. Select this option if the data in the file never changes. The file will
be read once and saved in memory for future use.
Note: If you later access the Approximation Wizard to view the approximation
you are creating, the Re-read File button is activated. Clicking this button
allows the wizard to scan the file for changes since it was first read and placed
into memory.
Dynamic file. Select this option if the data in the file can change. The file will
be read prior to every initialization. If you are executing on an ACS in the
FIPER environment, the file must be accessible via the absolute path or shared
file system. For more information, see “Using the Shared File System,” on
page 581.
this file parameter to receive data from another component at run time. The
approximation will then use this data for initialization.
5. Perform one of the following steps, based on your location in the wizard:
To complete the Error Analysis Sampling Options settings for User Defined
approximations: Return to step 23 on page 469.
2. Select the technique you want to use from the Technique drop-down list. The
technique’s options appear at the bottom of the screen.
3. Proceed to one of the following sections for more information on the technique
options (no options exist for the Central Composite or Full Factorial options):
4. Click the Execute design points in parallel if you want to execute your
initialization points in parallel. This option should only be used if you are using a
multi-CPU system or if you are connected to an ACS in the FIPER environment.
5. Perform one of the following steps, based on your location in the wizard:
To complete the Error Analysis Sampling Options settings for User Defined
approximations: Return to step 23 on page 469.
3. Type a custom name for the approximation in the Name of approximation text
box, if you want to change the default name.
4. Click the Previously Saved radio button; then, click the Browse... button to locate
the file you want to use. The Select File dialog box appears.
5. Locate the file; then, click the Select button. You are returned to the
Approximation Wizard, and your file appears in the large text box adjacent to the
Browse... button.
This screen shows the technique that was used in the original approximation.
Note: You cannot change the technique. If you change the technique, then the
coefficient data file is not used. Instead, a user-defined approximation is created.
This screen shows the input and output parameters that were used in the original
approximation.
Note: You cannot change the Input and Output parameters. If you change the
parameters, then the coefficient file is not used. Instead, a user-defined
approximation is created.
Cross-validation. This method selects a subset of points from the main data
set, removes each point one at a time, re-calculates coefficients, and compares
exact and approximate output values at each removed point. Proceed to
step 16.
10. Click Next. The Error Analysis Sampling Options screen appears.
11. Select one of the following options from the Sampling method drop-down list:
Data File. The model uses a data file to get data for model construction.
Depending on your choice, a different set of options appear. These options are
similar to the options set on the Sampling Options screen. For more information
about the Sampling methods, see “Using the Sampling Methods Options,” on
page 473.
12. Click Next.
If you have selected the Random Points sampling option, the Sampling Range
screen appears.
Note: If you selected the DOE Matrix sampling option, the Input Attributes screen
will display a table of Factor Attributes, where each input parameter of the
approximation is presented as a DOE Factor. Depending on the selected DOE
technique, the table will contain different columns. For more information about the
DOE Matrix sampling option, see “Using the DOE Matrix Sampling Method,” on
page 476.
13. (Random Points sampling method only). Determine how you want to define the
sampling region using one of the following options:
Absolute Values. This option defines the region by using absolute bounds for
each inputs parameter. You need to specify the Lower and Upper values for
each parameter in the corresponding columns.
Relative to Baseline. This option defines the region by applying relative move
limits to the baseline values in both direction. You need to specify the baseline,
move limit percentage, and minimum move limit for each parameter in the
corresponding columns.
14. Alter the Lower and Upper values for the listed parameters, as desired.
17. In the text box, type the number of points from the total number of sampling points
that you want to use for cross-validation error analysis.
18. Click the Use a fixed random seed for selecting points check box and specify a
seed value to use for the random number generator when determining the set of
sample points selected for cross-validation. This option allows you to reproduce
the approximation with the same set of points later, if desired.
19. Click Finish. A message appears prompting you to initialize the approximation.
Click No if you want to save the approximation and wait until later to
initialize. You are returned to the Approximations dialog box.
2. Verify that the approximation you want to edit is selected (highlighted); then, click
the Edit... button. The Approximation Wizard appears.
The wizard allows you to change any of the approximation information originally
set when the approximation was created.
3. (optional) Type a new name for the approximation in the Name of approximation
text box. This name is used to locate the approximation if you attempt to access it
at a later time.
4. (optional) Change the creation mode for the approximation using the radio buttons
on the initial wizard screen.
5. Click Next.
6. Proceed to one of the following sections for more information on all of the
available options, based on the creation mode you are using for the approximation:
7. (Initialized approximations only) If the approximation you are editing has already
been initialized, and you have not changed any parameter settings on the Input and
Output Parameters screen, then a Sampling Data Set screen appears (in addition to
the screens expected for the creation mode selected).
Note: If the approximation you are editing used error analysis, an Error Analysis
Data Set screen appears. The options are similar to the ones described here.
9. Click Finish once you have viewed the remaining wizard screens. A screen
appears allowing you to initialize the approximation.
Click No if you want to save the approximation and wait until later to
initialize. You are returned to the Approximations dialog box.
You can easily change the active approximation that is currently being used during
model execution using the Approximations dialog box.
2. Click the check box in the Activated column that corresponds to the
approximation you want to activate. If a different approximation was selected, it is
automatically unselected.
Note: You can also clear all of the check boxes in the Activated column to
deactivate all of the defined approximations. In this case, iSIGHT-FD will not use
any approximation at runtime and will execute the component.
Initializing an Approximation
You can initialize your approximation immediately after creating it, or you can
initialize it after it has been created. Approximations can also be initialized
automatically at runtime when you submit a model for execution.
3. Verify that the approximation you want to initialize is selected (highlighted); then,
click the Initialize... button.
4. Review the information on the dialog box; then, click the Initialize Now... button
to start the initialization process. If you click Close at this time you will be returned
to the Approximations dialog box.
This screen not only displays the status of the initialization (using the bar at the top
of the screen), but it also provides access to data points, error analysis points, log
messages, and coefficients data. Data points are added to the table as soon as they
are executed by iSIGHT-FD. Coefficient Data contents are displayed only after the
initialization is complete.
5. Perform any of the following actions, as desired, once the initialization completes:
Click the Error Analysis Points tab to view the values for input and output
parameters for each error analysis point.
Click the Log Messages tab to view all log messages associated with the
initialization. You can filter the log messages using the Log Filter drop-down
list. For more information on the different log levels, see “Setting
Preferences,” on page 40.
Click the Coefficients Data tab to view the resulting coefficients calculated
from generating the approximation.
Click the Save Data... button to save either your data points, error points, or
coefficient data to a text file for viewing in another program. You can only
save one set of points at a time. If you save the coefficient data, you can also
use it when created another approximation. For more information, see
“Creating an Approximation Using a Coefficient File,” on page 477.
Click the Clear Data button (and confirm the operation by clicking Yes on the
warning message that appears) to delete the current initialization data.
Click the Error Analysis... button to access the Approximation Error Analysis
dialog box. For more information on using this interface and accessing it
separate from the Approximation Wizard, see “Analyzing Approximation
Errors,” on page 520.
Click the Visualize... button to access the Approximation Viewer dialog box.
For more information on using this interface, and accessing it separate from
the Approximation Wizard, see “Visualizing an Approximation,” on page 495.
Delete existing sampling points and generate new random points after
reducing the input sampling ranges. Enter the percentage that you want to
reduce the input sampling by in the corresponding text box.
8. Click OK. If you chose one of the first two options above, the approximation is
re-initialized. If you chose the third option, the Approximation Wizard appears.
If you chose to re-initialize the approximation, return to step 5 on page 491 for
more information on the available post-initialization options.
For more information on editing the approximation using the wizard, see
“Editing an Existing Approximation,” on page 485
Notice that the Initialize... button has been replaced with the View Data... button. If
the Initialize... button is still present, then your approximation has not been
initialized. For more information, see “Initializing an Approximation,” on
page 489.
2. Click the View Data... button on the Approximations dialog box. The
Approximation Initialization dialog box appears, showing you the approximation
information.
Click the Data Points tab to view the values for input and output parameters
for each sample point.
Click the Error Analysis Points tab to view the values for input and output
parameters for each error analysis point.
Click the Log Messages tab to view all log messages associated with the
initialization. You can filter the log messages using the Log Filter drop-down
list. For more information on the different log levels, see “Setting
Preferences,” on page 40.
Click the Coefficients Data tab to view the resulting coefficients calculated
from generating the approximation.
Click the Save Data... button to save either your data points, error points, or
coefficient data to a text file for viewing in another program. You can only
save one set of points at a time. If you save the coefficient data, you can also
use it when created another approximation. For more information, see
“Creating an Approximation Using a Coefficient File,” on page 477.
Click the Clear Data button (and confirm the operation by clicking Yes on the
warning message that appears) to delete the current initialization data.
Note: If you use this option and then do not immediately re-initialize the
approximation, the Initialize... button replaces the View Data... button when
the Approximations dialog box is accessed.
Click the Error Analysis... button to access the Approximation Error Analysis
dialog box. For more information on using this interface and accessing it
separate from the Approximation Wizard, see “Analyzing Approximation
Errors,” on page 520.
Click the Visualize... button to access the Approximation Viewer dialog box.
For more information on using this interface, and accessing it separate from
the Approximation Wizard, see “Visualizing an Approximation” on this page.
Visualizing an Approximation
The Visualization option allows you to interact with an initialized approximation
model and observe, graphically, how changing the input values affects the output
values and the shape of the output function. It also provides you with both a manual
and automatic means to explore your design space using the approximation.
Note: If the model is not initialized, the visualization interface cannot be accessed. You
must first initialize the approximation to visualize it. For more information on this
process, see “Initializing an Approximation,” on page 489.
“Setting Component Input Values from the Approximation Viewer,” on page 519
2. Select the approximation you want to visualize from the list; then, click the
Visualize... button. This button is only active if the selected approximation has
been initialized. For more information, see “Initializing an Approximation,” on
page 489.
Note: You can also access this interface from the Approximation Wizard after
initialization by clicking the Visualize... button. For more information, see
“Initializing an Approximation,” on page 489.
The Approximation Viewer is divided into two tabs: Graphs and Design Search.
These tabs provide access to two distinct ways of exploring your design space
using the approximation.
3. Proceed to one of the following sections, based on how you want to explore your
design space:
To manually view your design and change values (the Graphs tab), see
“Exploring Your Design Space Manually,” on page 498.
To automatically search the design using certain criteria (the Design Search
tab), see “Searching the Design Using Specified Criteria,” on page 513.
To set the original component’s parameter values based on those set in the
Approximation Viewer, see “Setting Component Input Values from the
Approximation Viewer,” on page 519.
This tab is divided into two panels: a panel on the left that presents the inputs and
outputs of the approximation with their corresponding values, and a panel on the right
that contains the graphs for visualizing the approximation. These panels are described
in more detail below.
The left side of the Approximation Viewer displays the following information (on the
Slider View tab):
Sliders for each approximation input parameter. You can move the slider bars to
change the input values.
Value bars showing approximation output values. These values change according
to the input values you enter.
Table View tab. This tab allows you to view input and output information in a
table.
Modify Range text box. You can change the input range (lower/upper limits) by
typing a new number directly in this text box. The number represents a percentage
modification from the original range for each input.
Reset Range button. This button allows you to reset the input values and the input
range to their original values.
The right side of the Approximation Viewer displays the following information:
Graph controls for working with the large graph to the left of the graph. These
options change according to the type of graph selected (two-dimensional,
three-dimensional, or effects).
A set of drop-down lists to modify the parameters being displayed in the main
graph.
Thumbnail images of all graphs created at a given time in the Graph Palette area at
the bottom of the right side of the interface. The selected graph has a border around
it.
For more information on using the Graphs tab, proceed to one of the following
sections:
“Adjusting Input and Output Values Using the Slider View,” on page 500
“Adjusting Input and Output Values Using the Table View,” on page 502
1. Verify that the Slider View tab is selected from the bottom left corner of the
Approximation Viewer.
2. Change any input value to see the effects on the output values of the model using
one of the following methods:
Move the slider for the corresponding input. The value changes in the text box
directly above the slider. By default, the sliders allow you to change the input
value over the range of data that was used to construct the approximation.
Change the input value directly in the text box that corresponds to the desired
input. If you need to set a value outside of the range defined by the slider, you
can type the value directly into the text box above the slider.
3. Observe how the output values on the value bars change. The actual values of the
output parameters are displayed next to their names. When you change an input
value (either using the slider or directly typing a value), the selected point on the
graph corresponding to the value (highlighted blue point in 2-D graphs) also
changes.
4. (optional) Click the Set component parameters button to transfer the updated
parameter values to their corresponding parameters in the iSIGHT-FD component
for which the approximation was created. For more information, see “Setting
Component Input Values from the Approximation Viewer,” on page 519.
5. (optional) Click the Compare with actual... button to see how the approximate
design compares with the actual design. For more information, see “Comparing
Actual and Approximation Outputs,” on page 519.
2. Change any input value by entering a new value directly in the Value column of
the Inputs table. The output values will automatically change accordingly. The
values in the Name, Min, and Max columns cannot be edited.
3. (optional) Sort the columns. You can sort the data by clicking any of the column
headings. For example, clicking the Value heading will sort based on the value
data. An arrow appears in the heading that you click. Clicking the arrow allows
you to switch the sorting type between increasing and decreasing sorts.
4. (optional) Click the Set component parameters button to transfer the updated
parameter values to their corresponding parameters in the iSIGHT-FD component
for which the approximation was created. For more information, see “Setting
Component Input Values from the Approximation Viewer,” on page 519.
5. (optional) Click the Compare with actual... button to see how the approximate
design compares with the actual design. For more information, see “Comparing
Actual and Approximation Outputs,” on page 519.
When an Effects graph is created, a DOE process is performed and the normalized
effects are calculated from regression results. The DOE is performed within a local
region of the approximation (+/-10% of the total range centered around the current
selected point). The graph is only updated (a new DOE process executed) when a new
design point is selected.
Graphs are displayed on the right side of the Approximation Viewer providing a visual
representation of your approximation. They can be viewed in a number of ways, can be
altered by changing input values on the left side of the interface, and can be changed by
selecting different parameter combinations to display and modifying various graph
options.
Note: Remember that the graphs are created using values from the approximation, not
from actual values from executing the component. The actual behavior of the output
parameters of the component will be different to some degree, depending on the errors
of the approximation. To assess this difference, see “Comparing Actual and
Approximation Outputs,” on page 519.
When the Approximation Viewer dialog box is brought up for the first time, a few
initial graphs are automatically created using the first two input parameters and the first
output parameter. The main graph always shows one of the created graphs and the
thumbnails at the bottom of the dialog show all available graphs, with the selected
graph being the one that is shown in the main graph area.
The drop-down lists under the main graph allow you to change the selected parameters
for the displayed graph. You can create new graphs at any time and delete existing
ones.
1. Specify the type of graph you want to display using the Graph Type drop-down
list. The following options are available:
3-D. The graph is a three-dimensional view of the surface that shows the
values of the output parameter depending on the values of any 2 input
parameters. All input parameters except the selected two on the graph are held
constant at their current values.
Effects. The graph is similar to a DOE Pareto Plot, and shows the relative
effects of each input on an output.
2. Select the input(s) and output you wish to view on the main graph using the Input
and Output drop-down lists below the main graph area. The type and number of
drop-down lists that appear is based on the type of graph selected. For example, if
you select an Effects graph, only a single Output drop-down list appears. No input
drop-down list is available.
The main graph is automatically updated when you change the value of one of the
inputs using the sliders. The vertical dashed line on the graph marks the current
value of the input parameter in the X axis for 2D graphs. The range of all axes is
set automatically based on the minimum and maximum values of the
approximation inputs.
Reset. This button resets the ranges of input parameters and returns the graph
to its original configuration and appearance.
. This button allows you to select a point on the graph and then view the
values of input and output parameters by clicking on the graph. The
coordinates of the selected point are displayed directly below the graph itself
(the coordinates appear no matter what cursor mode you are using). Also,
when a point is selected, the input sliders and output value bars on the left side
of the interface are updated.
. This button allows you to pan a graph. Once selected, simply click the
graph and move your mouse. The graph is moved in a similar manner. This
functionality is only supported for two-dimensional graphs.
Rotation text boxes. These settings allow you to optimize the rotation by
either entering values into the X, Y, and Z text boxes, or by clicking the
buttons to increase or decrease the values of a particular axis. By changing
these values (using either method described above), the graph rotates
accordingly.
Scale text box. Scaling allows you to limit the area of the graph to a smaller
fraction of the total space defined by the minimum and maximum values of the
inputs.
4. Click the Auto-fit z-axis check box to change the behavior of the graph when you
scale the graph. When this option is selected, the Z-Axis range of the main graph
will always match the range of the displayed data. If not selected, the graph’s
Z-Axis is not modified when it is scaled.
5. Use the Axis drop-down lists below the main graph to change the current graph.
For three-dimensional graphs, the input X-Axis value and the input Y-Axis values
cannot be the same.
Note: The Y-Axis for a three-dimensional graph displays input values whereas the
Y-Axis for a two-dimensional graph displays output values.
6. Proceed to any of the following sections for more information on using the
Approximation Viewer:
7. Click OK when you are done viewing the approximation. You are returned to the
Approximations dialog box.
2. Click the button on the right side of the Graph Palette. The Create Graphs
dialog box appears.
3. Choose the type of graph you want to create (2D, 3D, or Effects) using the tabs
near the top of the dialog box.
4. Perform one of the following actions, based on the type of graph you are creating:
2D and 3D Graphs. Select the parameters that will represent each axis from
the Axis lists. Selecting multiple parameters for a single axis will create
multiple graphs. You can also click the Select All button to create a graph for
each listed parameter.
Effects Graph. Select the output parameter(s) that will be included on the
graph. You can select multiple parameters. You can also click the Select All
button to create multiple graphs simultaneously (one for each output selected).
5. Click OK. The graph is added to the selected tab in the Graph Palette.
Move a graph to another tab: Right-click the graph you want to move and select
the Move to option; then, select the new tab for the graph from the list that
appears. The graph is moved to the selected tab.
Copy a graph to another tab: Right-click the graph you want to copy and select the
Copy to option; then, select the new tab for the graph from the list that appears.
The graph is copied to the selected tab.
Create a new tab to hold graphs. Click the <New> tab. A tab is automatically
inserted to the left of the <New> tab. The new tab is named automatically and
cannot be changed.
Exporting a Graph
You can use graphs created in iSIGHT-FD in another application using the exporting
and copy functions.
Export / Export to Image. This option exports the graph to an image file
(*.jpeg, *.jpg, *.png). You will be prompted to select the file to which you
want the graph exported.
Export / Export to Text File. This option exports the graph data file to a text
file (*.txt). You will be prompted to select the text file to which you want the
graph data to be exported.
Export/ Export to Excel. (Windows platforms only) This option exports the
graph image and data to an Excel file.
Copy / Copy Image. This option copies the graph image to the system
clipboard. Once copied, you can paste the graph in another document or
imaging software by right-clicking and selecting Paste from the menu that
appears.
Copy / Copy Data. This option copies the data in the graph to the system
clipboard. Once copied, you can paste the data in another software application
by right-clicking and selecting Paste from the menu that appears.
1. Right-click on the main graph; then, select Options from the menu that appears.
The Graph Options dialog box appears.
The Data Series tab allows you to change the default settings for the shape, size,
and color of the graph ticks. The following options are available:
Symbol Shape. Changes all of the ticks on the graph. The default is a circle.
Symbol Color. Changes all the colors of the ticks on the graph. The default is
red.
Shape Size. Changes the size of the ticks. The default is 5 pixels.
Highlight Symbol Shape. Changes the highlighted symbol shape. The default
is a circle.
Highlight Shape Color. Changes the highlighted symbol shape color. The
default is blue.
Highlight Shape Size. Changes the size of the highlighted shape. The default
is 5 pixels.
The Axes tab allows you to set options for the axis (X, Y) currently selected from
the list on the left side of the tab. There are no XY and XZ gridlines for
two-dimensional graphs.
1. Click the button on the right side of the Graph Palette. The Global Preferences
dialog box appears.
Set the Graph resolution (2D) options. The default for the large
two-dimensional graph resolution is 50. Similarly, you can change the
thumbnail image (Small) resolution.
Set the Graph resolution (3D) options. The default for the large
three-dimensional graph resolution is 20. Similarly, you can change the
thumbnail image (Small) resolution.
For more information on this feature, see one of the following sections:
“Setting Your Criteria and Searching the Design” on this page
3. Select objectives or constraints for your design search using the tabs at the top of
the interface. Once selected, you can manually set the following information for
your design search:
Objectives:
• Direction. You can set whether you want to maximize or minimize the
selected objective.
Constraints:
• Lower Bound. This setting is represented by a red line in the graphs at the
bottom of the interface.
• Upper Bound. This setting is represented by a red line in the graphs at the
bottom of the interface.
• Target. This setting is represented by a green line in the graphs at the
bottom of the interface.
By default, all of the design variables are selected. However, you can alter this
setting using the Design Variables tab. The initial settings are based on the range
displayed on the Graphs tab (the initial tab displayed when the Approximation
Viewer is opened). Any changes made using the Design Variables tab are
transferred to the Graphs tab.
4. (optional) Set the search options as described in “Setting the Design Search
Options,” on page 517. These options allow you to set the Optimization technique
(and options) for the search as well as graph update options.
The search is performed, and the interface is updated to show the results of the
search.
6. Once the search is complete, perform any of the following options, as desired:
Click any point in a graph to view the corresponding point in all of the other
graphs.
Manually update the value of any design variable and add it to the existing
graphs by changing the setting in the Value column on the Design Variables
tab; then, click the Add point button. The new point you defined is added to
the graphs. You can also change the values for the Design Variables using the
sliders on the Graphs tab.
This feature is useful if you want to examine how a specific known set of input
values effects the objectives and constraints.
Note: To clear all points from the graph and return the graphs to their original
form, click the button.
If you’ve updated any of the search criteria, re-execute the search using the
Search button.
Click the Set component parameters button to transfer the updated parameter
values to their corresponding parameters in the model. For more information,
see “Setting Component Input Values from the Approximation Viewer,” on
page 519.
Click the Compare with actual... button to see how the approximate design
compares with the actual design. For more information, see “Comparing
Actual and Approximation Outputs,” on page 519.
2. Select the optimization technique that will be used for the design search from the
Technique drop-down list; then, set the technique’s tuning parameters. For more
information on selecting optimization techniques and setting their tuning
parameters, see “Configuring the Optimization Component,” on page 174.
Note: When approximations are created on Optimization components, the
Optimization technique and options defined within the Optimization component
are used for the design search by default (this setting can be modified). For all
other components, a default optimization plan is created.
3. Click the General tab; then, set the Update design space graphs during
optimization option on the General tab. If this option is selected, all graphs on the
Graphs tab are updated at each new point during the design search (optimization).
Using this option slows the process down, but can be very useful in tracking the
path of the search through the design space as opposed to just viewing the history
of values (i.e., the graphs shown on the Design Search tab).
4. Click OK to close the dialog box and return to the Approximation Viewer.
1. Click the Set component parameters button at the bottom of the Approximation
Viewer. The Set Parameters dialog box appears, informing you that the component
parameter (input) values have been updated.
2. Click OK.
You can verify that the values for the component that the approximation represents
have been modified using the Parameters tab on the Design Gateway.
To compare outputs:
1. Click the Compare with actual... button.
After executing the actual analysis (which may take some time), the Approximate
vs. Actual dialog box appears.
2. View the data and verify the accuracy of the output values.
3. (optional) Sort the data by clicking either the Approximate or Actual column
headers.
The error is calculated based on a number of sample points specifically allocated for
error analysis. These points are defined in the Approximation Wizard. For more
information, see “Creating an Automatic Approximation,” on page 458 or “Creating a
User-Defined Approximation,” on page 462, depending on how you created your
approximation.
The approximation error types, visuals, and use of the dialog box are discussed in this
section.
2. Select the approximation that you want to analyze; then, click the Error... button.
This button is only active if the selected approximation has been initialized. For
more information, see “Initializing an Approximation,” on page 489.
Note: You can also access this interface from the Approximation Wizard after
initialization by clicking the Error Analysis... button. For more information, see
“Initializing an Approximation,” on page 489.
The Approximation Error Analysis dialog box displays the following information:
A table of error values for each output parameter, with a drop-down list of
error types, and an entry box for setting the acceptable level of error for the
selected error type. Outputs with errors exceeding the acceptable level are
highlighted in red.
Note: Changing the selected error type or acceptance level on the left side of the
dialog box does not change the information displayed on the right side of the
dialog box, except for possibly highlighting the graphs of those responses that
violate the acceptance level.
3. Select the desired error type from the Error Type drop-down list. Error analysis
types are implemented as “plug-ins”. As such, they are extendable by creating new
plug-ins for new error analysis techniques. For more information on creating
plug-ins, refer to the iSIGHT-FD Development Guide.
The error analysis plug-ins currently available in iSIGHT-FD are the following:
Root Mean Square. The squared differences between the actual (workflow
execution) and predicted (approximation model execution) values for all errors
samples are averaged. The square root is then taken and the result is
normalized by the range of the actual values for each response. The value is
thus a fraction of the response data range for the error sample points.
Normalizing the error value allows the error level of different responses with
different magnitudes to be compared with respect to approximation model
quality of predictions.
4. Specify the acceptance level for the selected error type in the Acceptance Level
text box. The acceptance level defines the cutoff value for the selected error type
that distinguishes a response with acceptable fit (acceptable approximation quality)
versus a response with unacceptable fit (unacceptable approximation quality).
For the Average, Maximum, and Root Mean Square error types, low values are
desired, and so the Acceptance Level is an upper limit; reported error values
greater than the acceptance level will be flagged in red in the table of response and
in the plots as unacceptable approximation quality. The default Acceptance Level
is 0.2 for Average and Root Mean Square, and 0.3 for Maximum.
For R-Squared, high values are desired, and so the Acceptance Level is a lower
limit; reported error values less than the acceptance level will be flagged in red in
the table of response and in the plots as unacceptable approximation quality. The
default Acceptance Level for R-Squared is 0.9.
5. Verify that the Response Fit tab is selected on the right side of the interface. The
response fit plots present actual versus predicted response values for each
response. The diagonal line represents a perfect fit (predicted = actual). If all points
fall on or close to the diagonal line, the approximation model predicts well based
on the error points. If the plot background is colored red, the response error is
unacceptable based on the defined acceptance level.
The blue horizontal line mean response value determined using the actual error
sample data.
To view one response fit plot in greater detail, select the response from the
drop-down list that appears when the Show button above the plots is selected.
To return to all response plots, select All Responses from Show drop-down
list.
Double-click a response plot to enlarge that single plot, and double-click again
to return to all response plots.
8. Review the residual plots for each response. The residual plots present the
difference between the actual and predicted values for all error sample points for
each response. The horizontal blue line at 0 represents 0 residual or 0 prediction
error (predicted = actual). These plots can be used to identify outliers (points
significantly further from the blue 0 residual line) or trends in the residuals (ideally
residuals should be random, not increasing or decreasing or following a discernible
shape with increasing response values).
To view one response residual plot in greater detail, select the response from
the drop-down list that appears when the Show button above the plots is
selected. To return to all response plots, select All Responses from Show
drop-down list.
Double-click a response plot to enlarge that single plot, and double-click again
to return to all response plots.
11. Review the residual frequency plots for each response. The residual frequency
plots present the residuals (the difference between the actual and predicted values
for all error sample points for each response) as a frequency of occurrence, from 0
to the maximum residual. These plots allow the distribution of the residuals to be
reviewed (are more of the residuals close to 0 or closer to the maximum residual,
constant across the range of residuals or is there a peak, etc.).
12. Perform any of the following actions to view individual plot information:
To view one response residual frequency plot in greater detail, select the
response from the drop-down list that appears when the Show button above the
plots is selected. To return to all response plots, select All Responses from
Show drop-down list.
Double-click a response plot to enlarge that single plot, and double-click again
to return to all response plots.
14. Review the total error bar charts. The last plot tab on the Approximation Error
Analysis dialog box displays the total error for all responses in the form of a bar
chart. The data in the top graph is the same as the data presented numerically in the
response table to the left. The second bar chart (bottom) displays the standard
deviation of the errors (standard deviation of the differences between the actual
and predicted values) for all error sample points. This plot gives an indication of
the spread of the error across the sample range for each response.
The results presented in the Approximation Error Analysis dialog box - the
numerical error values from the error plug-ins and the visual representations of the
approximation error - are used to review the approximation prediction capabilities
and access the usability of the approximation model as a surrogate for the
component(s) for which it approximates.
Higher order RSM, or change to RBF approximation model type. The design
space may be more nonlinear than the selected approximation model type.
Copying an Approximation
After you have created an approximation, you can create a copy of it. The copy is a
replica of the original approximation. To copy an approximation:
2. Verify that the approximation you want to copy is selected (highlighted); then,
click the Copy button. A new approximation is created with “Copy” added to the
end of the approximation’s name.
Deleting an Approximation
If you no longer have need for an approximation that is attached to a component, you
can permanently remove it from iSIGHT-FD.
2. Verify that the approximation you want to delete is selected (highlighted); then,
click the Delete button. The name of the approximation (as it appears in the list) is
defined when the approximation is created. A warning message appears.
3. Click OK. The approximation is deleted, and is no longer accessible from the
Approximations dialog box.
This chapter describes how to use the Library to store and retrieve models and
components. It is divided into the following sections:
Overview
The Library is a repository for a set of iSIGHT-FD tool definitions used within a given
iSIGHT-FD installation, including, but not limited to, models, components, and other
plug-in information. This section provides a brief overview of the different parts of the
Library dialog box.
Query Methods
iSIGHT-FD Libraries support several content query methods. The most basic is the
fetch, which retrieves one published item by full and exact name (either a specified
version or the latest version). When connected to the FIPER environment, iSIGHT-FD
Libraries support multiple versions of a published item. When an item is published
under a given name, and an item of the same type already exists under that name, a
fresh version number is assigned to the new item (publication is disallowed if the item
is of a different type). Conversely, any specified version of a given item may be
removed from the Library (if not already removed). When a published item is fetched
from a Library, the most recent version of that item will be retrieved. Versioning is not
supported when iSIGHT-FD is run in Standalone mode.
are self-contained, and process components (e.g., Task and DOE), which may
contain and drive other components.
Data types. These hold distinct classes of iSIGHT-FD parameter values and
maintain the internal consistency of those values according to class. The basic
tool set at minimum supports numeric, logical, and textual values.
Visual tools. These implement the layout procedures of the various schemes
provided by iSIGHT-FD to present runtime data to the user in graphical or
tabular formats.
Click the Add... button on the right side of the Component Palette.
The Library dialog box appears. Your Library’s appearance will most likely differ
slightly from the one shown below, specifically the directory structure.
Navigate through the directory structure on the left side of the dialog box to
find stored items and information.
Click the Save button to save the selected item to a local file.
Click the Publish button to select a local file (*.zmf) and publish it to the
Library. You can also load the file into the Design Gateway; then, select
Publish... from the File menu.
Click the Refresh button to update the items displayed in the Library.
Click the Add button to add the selected component to the Design
Gateway’s Component Palette. You can also drag and drop the component
from the Library to a Design Gateway tab.
Click the Delete button to permanently delete the selected component from
your Library.
(FIPER ACS environments only) Click the Fetch button to get the selected
item from the current ACS and republish it to the local Library. This action
allows you to access the items in desktop (Standalone) mode from the local
Library.
Click the View Details button to open the View Details dialog box. This dialog
box contains information about the selected item, including general details, a
description, and attribute and reference details.
3. (FIPER ACS environments only) Set permissions for an object in the Library.
These permissions allow you to determine which users or groups have access to
the object. For more information, see “Setting Object Permissions,” on page 545.
4. Click Done to close the Library dialog box.
For additional information on using the Library dialog box, with regard to publishing
models, see “Publishing Objects and Setting Permissions,” on page 539.
1. Open the Library as described in “Using the Library Interface,” on page 533.
3. Click the item; then, while holding down your mouse button, drag the selected
item to the proper location on the Design Gateway (the Component Palette or the
workflow).
4. Release your mouse button when you come to the desired location. The Reference
or Copy? dialog box appears if you are adding the selected item to your workflow.
Copy. This option creates a new object on the Design Gateway that is
completely separate from the original object in the Library.
Reference. This option creates a new object on the Design Gateway that
references the original object in the Library. Any changes to the object in
either the Library or on the Design Gateway are automatically reflected in
other objects.
6. (Workflow drag-and-drop only) Click OK. The item is added to the model
workflow.
1. Click the Search tab to search the Library for a specific model.
Set the search criteria in the Search the Library for area on the left side of the
interface, as desired.
2. (FIPER ACS environments only) Click the Advanced Search button to expand
your search options.
4. When your search options are set, click the Search button to execute the search.
In the following example, a search on the keyword “beam” has returned the
I-Beam Example model.
5. (optional) Click the Keep Results check box at the bottom of the Library to save
the search results to the Library.
6. (optional) Click the View Details button to view the details of the search result.
The Version Details dialog box appears.
Note: You can remove an attribute by highlighting it and then clicking the
button.
7. Click OK to close the Version Details dialog box.
8. (FIPER ACS environments only) Click the Edit Permissions button to set
permissions for the selected Library object. For more information, see “Setting
Permissions for Specific Objects,” on page 549.
9. Click Done to close the Library dialog box.
Publishing a Model
Models can be published to your Library and then accessed at a later time. The Library
acts as a storage area for your models.
Note: If you are connected to the FIPER environment, you have access to the ACS
Library. This type of Library is accessible to anyone who can connect to the ACS, so it
also acts as a mechanism for sharing models. Also, you can get access permission
when using an ACS Library. For more information, see “Setting Object Permissions,”
on page 545.
2. Select Publish... from the Design Gateway File menu. The Publish dialog box
appears.
By default, models are published at the top level of the Library. However, you can
specify a different location in the Library.
4. Type the name of the model in the Name text box. This setting specifies how the
model name will appear in the Library. It can be different from the name specified
in the model properties. However, when the model is reloaded into the Design
Gateway, the published model name will be used in the model properties.
5. Click the Publish As... button to specify where you want the model published
inside of the Library. The Publish Model As dialog box appears.
6. Use the directory structure on the left side of the dialog box to pick the location for
your model; then, click OK.
9. Type the new location for the published file directly in the Name text box before
the model name itself. For example, if you want to create a new top-level directory
called "models", and name your model "example_model", you would type the
following in the Name text box:
models.example_model
Note: You can view your current model structure by clicking the Publish As...
button.
Your Publish dialog box should look similar to the example shown below.
10. (optional) Specify attributes for the model by typing them directly into the
corresponding columns in the Attributes area. This information is viewable to all
connected users via the View Details button on the Library dialog box. For more
information on the Library dialog box, see “Using the Library Interface,” on
page 533.
11. (optional) Alter the description of the model in the corresponding text box.
12. (FIPER ACS environments only) (optional) Set the Share this model with other
FIPER environments option. When selected, the model will be available to any
partner who can access the ACS Library using a B2B connection. For more
information on this type of environment, refer to the FIPER Federation (B2B)
Guide.
13. (FIPER ACS environments only) (optional) If a previous version of this same
model has already been published to the Library and that version is specified to be
shared with other FIPER environments (the setting in step 12), you can simply use
the same sharing information by selecting the Use environments from latest
published versions (if any) option.
14. (FIPER ACS environments only) (optional) Specify the remote FIPER ACS’s and
users who can access the model using the ACS Name and User(s) columns.
Simply type the necessary information directly into the text boxes in the columns.
15. (FIPER ACS environments only) Click Edit Permissions. The Permissions dialog
box for newly-created objects appears. For more information on setting user
permissions, see “Setting Object Permissions,” on page 545.
16. Click Publish. The file is stored in the Library, based on your current connection
(local or FIPER ACS).
You can check the Library to verify that the component was correctly published.
17. Select Library from the Design Gateway View menu, or click the Library button
on the Design Gateway toolbar.
18. Navigate to the location you specified earlier in this procedure, and notice that
model has been placed within this directory. In the following example, the model
has been placed in a new directory called "models".
1. Right-click the component you want to publish; then, choose Publish from the
menu that appears.
Notice that the Type defined by the dialog box is Model, even though you are
publishing a component. Remember, components are published as separate models
(or submodels).
The rest of the publishing process is the same as the process for publishing models.
Note: You can set default options for most objects, but then set different options for
specific objects. For more information, see “Setting Permissions for Specific Objects,”
on page 549.
2. Click the Default Permissions option on the left side of the dialog box. The
permissions options appear.
The list on the top half of the right side of the dialog box is used to define default
permissions. The bottom section is used for job permissions. For more information
on job permissions, refer to the iSIGHT-FD Runtime Gateway Guide.
Now you need to add users to the list and set their permissions.
3. Click the Add button to create a new permission. A cursor appears in the Managed
Name column.
Note: You cannot edit an existing permission setting. Instead, you need to delete it
and recreate it.
4. Enter the user name or group name whose permissions you are setting in the
Managed Name column. You’ll specify whether the name represents a user or a
group in step 6.
5. Click the Permission field; then, select the type of permission from the drop-down
list that appears. The following options are available:
ALTER. The user or group has full access to the object, including the ability
to edit the object’s permissions. The object can be fetched (copied to a local
Library), new versions of the object can be published to the Library, and any
version of the object can be deleted from the Library.
MODIFY. The user or group has all of the accessibility granted with the
ALTER option, with the exception of editing the object’s permissions.
READ. The user or group can only use the object in their local Design
Gateway. Although the model and its contents (components, workflows,
parameters, etc.) can be viewed and altered, and the model itself can be
executed, no new versions of the model can be published to the Library.
NONE. The user or group will have no access to the published object. Also,
any model that references this object cannot be used.
6. Click the Represents field; then, select if the name specified in the Managed
Name column represents an individual user or a predefined group. The following
options are available:
USER. This option allows you to specify a particular user name for the
permission you are defining. The user name should be specified in added to the
Managed Name column as described in step 4.
FIPER GROUP. This option allows you to specify a group of users to share
the permission you are defining, instead of creating a permission for each user.
The group name should be specified in added to the Managed Name column as
described in step 4.
7. Set object permissions for all other users (except for those explicitly defined) by
clicking the All other users button. The options available are the same as those
described in step 5 above. You can also specify that there is no default option for
other users.
8. Repeat step 3 through step 7 for any additional user permissions you want to
define.
9. (optional) Arrange the listed users, as desired. You can use the Up or Down
buttons to move a user up or down in the list. The selected user’s settings move up
or down one line. The order of your list is important since a user name may appear
in one or more groups (the FIPER Group option) as well as by itself. Therefore, it
is possible for a user to be assigned more than one permission for the same object.
When this multiple permission issue occurs, iSIGHT-FD uses the permission
closest to the top of the list to determine the user’s actual permission for the object.
You can also use the Delete button to remove a user from the list.
Note: You can repeat these steps to set default permissions for jobs stored in a
FIPER ACS database. For more information on jobs, the jobs database, and setting
options for a specific job, refer to the iSIGHT-FD Runtime Gateway Guide.
Note: If all of your object permissions will be the same for every object, you can set
the object permission defaults prior to publishing. Using this method, all of your
objects will have the correct permissions as soon as they are published. For more
information, see “Setting Default Object Permissions,” on page 546.
For models that have already been published. Access the Library dialog box
and locate the model as described in “Using the Library Interface,” on
page 533.
2. Click the Edit Permissions button. The Edit Permissions for Publication dialog
box appears.
Note: If you are accessing permissions directly from the Library, the dialog box
that appears is the Object Access Control List dialog box.
This dialog box is a copy of the one accessed using the Preferences dialog box,
except that the options for setting permissions for published objects have been
removed. For more information, see “Setting Preferences,” on page 40.
3. Proceed to step 3 on page 547 for details on the permission options that are
available and how to set them.
4. Click OK. Your permission settings are saved and you are returned to the Library
interface.
Click the Add... button on the right side of the Component Palette.
2. Locate the model you wish to remove; then, verify that the proper version of the
model is selected. You can view all versions by clicking the symbol next to the
initial model entry in the Library.
Important: If you only wish to delete a particular version of a model, make sure
only the version is selected, not the main entry. If the main entry of a model is
deleted, all versions are also deleted.
3. Click the Delete button ; then, click Yes to verify the deletion. The specified
model or version of the model is removed from the Library.
Warning: Use caution when completely removing published items from a Library,
especially from a shared Library. Any model that has been constructed using an item
will become unusable once that item has been removed. Removing individual versions
of a published item is safer, but not entirely free of risk.
This chapter describes how iSIGHT-FD model validation works, and the options that
are available with this tool. It also describes how to access and view the log file. It is
divided into the following sections:
Overview
iSIGHT-FD has a built-in validation framework to perform the following tasks:
Model validation can be turned off to enhance performance. However, in most cases,
the feature has little to no effect on the Design Gateway. There are rare cases where
validation can slow performance, and the feature can be deactivated if such a case
arises.
Important: This deactivation only affects work on the Design Gateway prior to
execution. Validation is still performed on the model immediately prior to execution,
and the model is not executed if any error messages are discovered.
In the following example, a DOE and Script component have been added to a default
model. The DOE Component has no factors defined, and a warning to this effect is
displayed on the Message Bar.
However, notice that the Message Bar has a button labeled “3 Warnings” This label is a
brief description of all of the issues found by the model validation process. In this
example, three warnings (or combinations of message types) were found during the
validation process. You can view all of these warnings as described in “Viewing
Multiple Messages,” on page 557.
Error messages. These types of messages represent an error condition that was
caused by the end user, operational data, or some other condition that can be
corrected. They are noted using the icon. By default, the most severe error that
currently exists in the model is shown by default. Errors take precedence over
Warning messages and Information messages with regard to appearing on the
Status Bar.
Note: The message displayed in the Message Bar is always the highest severity
message. If there are multiple messages of the same severity, the one displayed is
somewhat arbitrary.
A button to view all messages at the same time. For more information on using this
button, see “Viewing Multiple Messages,” on page 557.
The Go To! button is also available on the Design Gateway, but it is only relevant for
the error that is displayed in the Message Bar.
When a validation fails, there are cases where the fix for it is very straightforward. In
these cases, the Fix It! button is activated, and can be used to automatically fix the
message in question. In the current version of iSIGHT-FD, there are very few errors
where the fix is straightforward enough to use this feature.
To view all of the messages associated with the current model, click the Message
button on the Message Bar.
This dialog box lists all of the validation messages for the model. It also displays two
buttons that allow you to locate and fix the validation issue. For more information on
using these buttons, see “Using the Go To! and Fix It! Buttons,” on page 557.
The actual log file (gateway.log) is stored in the following location on your local
system, and can be accessed directly from this location, if desired:
You can perform any of the following tasks using the log viewer:
Click the Reset button to set the Log Severity icon back to the OK state.
This action does not clear the log file. The error messages will remain in the log
file.
Copy the text (in order to paste it into another application) using the Copy button.
You can select any part of the text you like. If no text is selected, the entire contents
of the log file are automatically copied.
Click the Email Log button to send the information to Engineous Software
technical support. The Send FIPER Gateway Log dialog box appears.
If necessary, specify your e-mail address in the From text box. You can set
iSIGHT-FD to use a default From e-mail address whenever an e-mail function is
used. For more information, see “Setting Additional Preferences,” on page 46.
Screen captures
Click the Send button. An Engineous Software representative will contact you
about your problem as soon as possible.
This chapter describes how to define parameters in iSIGHT-FD, how to use file
parameters, and how to map parameters in your model. It is divided into the following
sections:
Introduction
Parameters are manipulated using one of the three following tabs, or a combination of
these tabs: Parameters tab, Files tab, and Mapping tab.
Parameters are created and altered using the Parameters tab on the Design Gateway.
This tab is shown below.
File parameter information is controlled and specified using the Files tab. This tab is
shown below.
Parameter mapping is controlled and specified using the Mapping tab, as shown below.
Using Parameters
The process of defining parameters can be divided into the following separate tasks:
Note: Many components can create and map parameters as part of the process of
configuring the component. Sometimes it is easier to create the parameters first and
then open the component editor, but usually it is better to let the component editor
create the parameters (and files).
Name. This column displays both the user-defined name of the column and an icon
denoting its structure, which is defined as follows:
. Scalar
. Array
. Aggregate
Mode. This column displays whether the parameter in an Input, Output, In/Out, or
Local parameter.
Type. This column displays whether the parameter is a Boolean, Integer, String, or
Real.
Mapped. This column shows you whether or not the parameter has been mapped.
If the parameter has been mapped, a icon appears. For more information, see
“Mapping Parameters,” on page 624.
1. Verify that you have selected the component that will contain the new parameter
from the Model Explorer on the left side of the Design Gateway; then, click the
New button on the right side of the tab. The Add Parameter dialog box appears.
2. Type the name of the new parameter in the Name text box.
Note: The only restriction with regard to parameter names is that they cannot
contain any of the following three characters: [ (left square bracket), ] (right square
bracket), or . (period).
3. Select the structure from the corresponding drop-down list. The following options
are available:
Scalar
Array
Aggregate (if you create an Aggregate parameter, proceed to step 4; then,
proceed directly to step 10)
4. Set the mode of the parameter using the corresponding drop-down list. The
following options are available:
Input
Output
In/Out
Local
5. In the Details area, set the parameter type using the corresponding drop-down list.
The following options are available:
Boolean
Integer
Real
String
6. (Scalar parameters only) Type the initial value for the parameter into the Value
box.
7. (Array parameters only) In the Array Dimensions area, select the number of
dimensions for the parameters from the corresponding drop-down list. You can
choose between one and four dimensions.
8. (Array parameters only) Specify the value of the dimensions in the text box(es)
below the drop-down list.
9. (Array parameter only) Specify whether or not the array dimensions are resizable
using the corresponding check box. This option allows the array to be resized
during execution. All array parameters can be resized at any time using the Design
Gateway. Any array parameter that is defined as resizable is marked with an
asterisk (*) to the right of the parameters name on the Parameters tab. For more
information on using array parameters from the Runtime Gateway, refer to the
iSIGHT-FD Runtime Gateway Guide.
10. Click OK to create the new parameter. It is displayed in the Parameters tab.
1. Select the Aggregate parameter that will contain the new parameter. The Add
button becomes active on the right side of the tab.
Note: You can define all parameter properties for this new parameter with the
exception of the Mode. This setting is based on the parent parameter.
3. Select the structure from the corresponding drop-down list. The following options
are available:
Scalar
Array
Aggregate (if you create an Aggregate parameter, proceed to step 4; then,
proceed directly to step 8)
4. In the Details area, set the parameter type using the corresponding drop-down list.
The following options are available:
Boolean
Integer
Real
String
5. (Scalar parameters only) Type the initial value for the parameter into the Value
box.
6. (Array parameters only) In the Array Dimensions area, select the number of
dimensions for the parameters from the corresponding drop-down list. You can
choose between one and four dimensions.
7. Specify the value of the dimensions in the text box(es) below the drop-down list.
8. Click OK to create the new parameter. It is displayed within the parent parameter
in the Parameters tab.
Note: If you click Apply after creating a member of an aggregate parameter, the new
parameter dialog box stays open after creating the parameter. This allows you to
quickly create several members of the same aggregate parameter.
1. Click the New Group button on the right side of the Parameters tab. The Create
New Group screen appears.
2. Type the name for the parameter group in the What would you like to name the
new group? text box; then, click OK.
You are returned to the Parameters tab, and a new directory is added to the top of
the list of parameters.
Now that you’ve created the (empty) group, you can populate it with the
parameters of your choice.
4. Click the Group button on the right side of the tab; then, select the group that will
hold the parameters from the list that appears.
5. (optional) View the contents of the parameter group by clicking the icon to the
left of the group name.
Remove a parameter from a group. Select the parameter; then, select the No
Group option using the Group button.
Delete a group. Select the group; then, click the Delete button on the right side
of the tab. A message appears, asking if you want to delete the parameters in
the group along with the group. Select the appropriate option. If you chose to
keep the previously grouped parameters, they are returned to their original
location in the parameter list.
In the following procedure, the model shown below (I-Beam example) is used as an
example.
The Parameters tab for this example is shown below (with the Read I-Beam component
selected).
This dialog box contains an exact copy of the information currently displayed on
the Parameters tab. In fact, changes to the information using this dialog box are
automatically displayed on the Parameters tab. Furthermore, if you select a
different component from the Model Explorer on the left side of the Design
Gateway, both the Parameters tab and the Parameters dialog box are changed to
show the parameter information for this new component.
2. Click the Lock check box in the bottom left corner of the Parameters dialog box.
This option freezes the component parameter information being viewed in this
dialog box. The information can still be updated, however, but clicking a different
component in the Model Explorer does not change the component being displayed
in the dialog box.
The information on the Parameters tab is still dependent on the component selected
in the Model Explorer.
You can open as many Parameters dialog boxes as you wish, in order to
simultaneously view parameters for multiple components.
Sorting Parameters
You can sort parameter data on the Parameters tab in ascending or descending order by
clicking the corresponding column header. The first click sorts the column data in
Ascending order. The second click sorts the column data in Descending order. A third
click returns you to the original non-sorted option. The small arrow icons to the right of
the column headings shows you the current sorting option selected.
Note: You can also sort multiple columns of data at the same time. Simply press and
hold either the SHIFT or CTRL key on your keyboard; then, click the column headers
that correspond to the information you want to sort. When performing a multi-column
sort, the primary sort is always based on the first column clicked, secondary sort on the
second column clicked, etc.
To clear all of the sorting perform on the list of parameters, and return the list to its
original state, click the button above the parameter list.
1. Click the button above the parameter list. The Table Filters dialog box appears.
Name. This option allows you to filter the parameters based on the parameter
names.
Mode. This option allows you to filter the parameters based on the mode
(Input, Output, Input/Output, or Local).
Value. This option allows you to filter the parameters based on the values of
the parameters.
Type. This option allows you to filter the parameters based on the type
(Boolean, Integer, Real, or String).
Mapped. This option allows you to filter the parameters based on whether or
not they are mapped.
3. Click OK. You are returned to the Parameters tab, and the list of parameters is
updated based on your filter selections. Any column selected as part of your filter
options now displays a icon to the left of the column header. In the following
example, two columns (Mode and Type) have been used for filtering. Also, the text
to the right to the button tells you how many rows (parameters) match your
filter based on the total number of rows (parameters).
Remove the defined filter, and return the parameter list to its original state, by
clicking the button.
Editing Parameters
Using the Parameters tab (or the Parameters dialog box as described in “Viewing
Parameters for Multiple Components,” on page 573), you can alter many of the
settings of existing parameters. Some options available with array parameters can only
be changed by accessing the Edit Parameter dialog box, as described in the following
procedure.
Note: All changes made directly on the Parameters tab are applied by pressing the
ENTER key on your keyboard, or clicking on a different column or parameter.
1. Click the parameter whose settings you want to update. The parameter is
highlighted.
2. Change any of the following settings, as desired, directly on the Parameter tab:
Note: You can also right-click the parameter; then, select Properties from the
menu that appears. This action opens the Edit Parameter dialog box, which
provides access to the same options listed below. This action is necessary to update
array parameter dimension values or the resizable option. See step 3 below for
more information.
Click the Mode column; then, select a new mode from the drop-down list that
appears.
Click the Value column to update the value of the parameter. The value
settings differ based on the type of parameter you are working with.
Click the Type column; then, select a new type from the drop-down list that
appears.
3. (Array parameters only). Update the dimension values or the Dimensions are
resizable option. These options are only available using the Edit Parameter dialog
box, which is accessed by right-clicking the array parameter you want to update;
then, select Properties from the menu that appears.
5. Repeat step 1 and step 4 for all the parameters you want to update.
Moving Parameters
You have two main options for moving parameters from one component to another.
You can cut/copy and paste the parameter or use the Move To option to quickly change
a parameters location. All of these options are available from the menu that appears
when a parameter is right-clicked.
Deleting Parameters
To delete a parameter:
1. Verify that you have the correct component selected from the Model Explorer.
Note: No warning message appears to verify the deletion of the parameter. Be sure
that you are deleting the correct parameter.
2. Right-click the parameter you want to remove; then, select Delete Selected from
the menu that appears. The parameter is deleted.
File parameters are mapped between components in the workflow just like other
Parameters. However, what is copied is not the data itself, but information about where
the data resides. This prevents you from having to copy the data around during
execution of iSIGHT-FD models.
There is a facility to copy the contents of an input file parameter into the working
directory or any other local directory before a component runs, and to copy output files
from the working directory or other location into a file parameter after the component
runs. This allows components designed for local execution to be distributed across the
network without change. The name of the local file can be fixed if the program requires
input or output files with a specific name. Otherwise, iSIGHT-FD selects the file name
and makes it available to the component as the “value” of the file parameter.
Parameter values can be used to construct the name or path for a file parameter,
allowing results from parallel execution to be automatically filed, instead of
overwriting the same location over and over.
The locations of file parameters (and the contents for In Model files) are saved with the
other run results. The contents of a file parameter can be viewed from the iSIGHT-FD
Runtime Gateway. For more information on viewing file parameters, refer to the
iSIGHT-FD Runtime Gateway Guide.
1. The set of parameters are prepared from the default values in the model, and are
modified by any input parameter mappings.
2. The component runs using the prepared parameters, modifying the values of output
parameters.
3. The output parameter values are stored in the run results and for mapping to
subsequent components.
File parameters add several more steps to this process. There are some exceptions, but
basically:
Copying the files into the working directory allows the component to execute without
worrying about parallel or distributed execution.
File-type file parameters are a special case. If no local name is specified for a File-type
file parameter, the contents of the file are not copied into the runtime working
directory. Instead, the path to the file is passed to the component code at runtime. This
can be substantially more efficient if the file is very large. However, it can be
somewhat more difficult to configure, and will not work if the component expects the
file to have a specific name.
Shared or Network file systems are often named differently on different machines. For
example, a user's home directory might be /home/user on his UNIX workstation and
/net/host/user on other UNIX workstations. At the same time, it might be mounted as
H: on a Windows workstation, and be available as \\host\user on other Windows
machines.
The Shared File System feature of iSIGHT-FD allows iSIGHT-FD to adjust how it
references a shared file to account for these differences. Instead of using an absolute
path, which will be incorrect on some machines, the file is referenced as a path relative
to a Symbolic Root Directory. On each machine, the symbolic root directory is set to
the location where that machine mounts the shared file system. Each time the file is
referenced (by the Design Gateway, Runtime Gateway, or a FIPER Station), the local
symbolic root value is used to build the absolute path to the file that is appropriate for
that machine.
Symbolic roots are used by selecting the Shared file system radio button on the Select
File dialog box that appears when you click the Browse button on the Design Gateway
Files tab. For more information on using this tab, see “Understanding the Files Tab,”
on page 583.
Symbolic roots for the Design Gateway and Runtime Gateway are defined using the
iSIGHT-FD preferences. Symbolic root directories for FIPER Stations are set in the
Symbolic Root Directories section of the station.properties file.
{root name}. A reference to a Shared File System (see “Using the Shared File
System,” on page 581). This kind of substitution is created by the Shared file
system radio button in the Path Options area of the Select File dialog box. For
more information on accessing this dialog box, see “Using Input File Parameters,”
on page 599.
{workid}. Replaced with the unique Work Item ID (a string of letters) of this
execution of the component. You can type this into a file name or path in order to
guarantee that the name is unique.
{user}. Replaced with the name of the user who submitted the job. This kind of
substitution is only valid when the model is run on the ACS. It will cause an error
if the model is run in Standalone mode.
{var param}. Substitutes the value of a parameter into the file name or path,
where param is the name of a parameter, a reference to a member of an aggregate
parameter (aggregate.member), or an element of an array parameter (array [3,5]).
This option is most useful for string and integer parameters, but it will work with
all kinds of parameters.
File parameters must have mode Input or Output; Local and In-Out file parameters are
not supported in this release of iSIGHT-FD. Input and Output file parameters are
configured somewhat differently. Configuring each type is described later in this
section.
The central part of the Files tab is a list of all file parameters for the current component.
Tabs at the top of the Files tab let you view input or output files.
Name. The name of the file parameter. This name is separate from the name of the
file to which the file parameter points. It is the name to look for on the Mapping tab
when mapping file parameters, and is also the column heading on the Runtime
Gateway Parameters and History tabs. For more information on using the Runtime
Gateway, refer to the iSIGHT-FD Runtime Gateway Guide.
The default parameter name for a file parameter is the name of the file with any
directory names removed and the period before the file type changed to an
underscore (a period is not a valid character in parameter names).
Note: Since Input and Output file parameters are configured differently, changing
the mode of a file parameter causes some of the configuration to be lost.
Mapped. This column shows whether or not the file parameter is mapped from
another component (input) or to another component (output). The content of this
column is either yes or no. A mapped input file parameter behaves differently from
an unmapped one; the “In From” portion of the configuration is ignored for a
mapped input file, and the contents of the file parameter that is mapped to this
input parameter are used instead. Mapped and unmapped output file parameters
have basically the same behavior.
In From. (for input file parameters only) The location of the data for this file
parameter. If the input file parameter is mapped, this information is overridden by
the parameter that is mapped in to it.
Local. The name the file will have in the working directory during component
execution. It may be a specific name configured by the user, or a place-holder
(generated name) if the specific name of the file does not matter.
Out To. (for output file parameters only) The location where the data will be put
after the component executes. The various options are described “Using Output
File Parameters,” on page 603.
Safe. Displays whether or not the configuration of the file parameter is safe for
parallel execution. An output file parameter that is saved in a fixed location is not
safe for parallel execution; the multiple instances of the component will overwrite
each others data.
To the right of the parameter list are three buttons: one to create a new file parameter
using the file parameter wizard , one to add a file parameter as a member of an
aggregate parameter , and one to delete a file parameter . The last two buttons
behave the same as the buttons on the Parameters tab, except only file parameters can
be created. For more information on using these buttons, see “Using Parameters,” on
page 564. For more information on adding a new file parameter using the file
parameter wizard, see “Creating File Parameters” on this page.
Note: To add a file parameter as a member of an aggregate parameter, you must first
create the aggregate parameter on the Parameters tab, then add the file parameter on
the Files tab.
1. Click the button on the right side of the Files tab. The file parameter wizard
appears.
2. Verify that the Input radio button is selected. If you click this button with the Input
Files tab active on the File tab, this option is automatically selected.
3. Click Next. The File Parameter Structure screen appears.
Array. Creates an array of files with the given number of dimensions and the
given size. To create an array of files, click the Array button, then select the
number of dimensions and the size of each dimension. All elements of the
array will be initialized to point to the same location (as determined in the rest
of the wizard). You must manually reconfigure each element of the array to
point to a different location once the wizard finishes.
6. Select where the input parameter will get its content from prior to the component
executing. The following options are available:
Map from a file parameter in another component. If you select this option,
proceed to “Configuring a File Parameter in Another Component as the Input
Source,” on page 590.
FTP. If you select this option, proceed to “Configuring a FTP as the Input
Source,” on page 592.
URL. If you select this option, proceed to “Configuring a URL as the Input
Source,” on page 593.
Note: This screen doesn’t appear if you selected the Map from a file parameter
in another component option in the previous step. Proceed to step 10.
8. Select if the content of this file is Text or Binary using the corresponding radio
buttons.
9. Click Next.
Note: If the Show File type encoding on the Files tab option is selected on the
Parameter preferences page of the Preferences dialog, an additional page is
displayed for text files that allows you to set the file encoding. The file encoding is
only relevant if you use files containing non-latin characters. For more information
on setting preferences, see “Setting Preferences,” on page 40.
10. Select where you want the iSIGHT-FD Runtime environment to copy the file so
it’s available at runtime. The following options are available:
Fixed File Name. Copy the source file to a directory that you specify. This
directory may be in the iSIGHT-FD Runtime environment, a shared file
system, or an absolute path.
13. Click Finish. The new parameter is added to the list on the Input Files tab of the
Design Gateway Files tab.
2. Select a file parameter from which you want to map this variable. You can click the
I will map it later check box to map the parameter after it has been added to the
input parameter list on the Files tab.
1. From the Input Source screen, click the File radio button. The Input Source Data
Handler screen appears.
2. Type the file name in the corresponding text box, or use the Browse button to
locate the file. If you select the Browse button, additional radio buttons in the Path
Options area allow you to select how the file should be referenced. The following
options are available:
Runtime directory. This option indicates that the directory containing the file
is to be ignored and the file will be found in the runtime working directory.
This setting is rarely useful for input file parameters.
Absolute path. This option is used to locate the file, which works for local
execution and when the file is on a shared drive that is mounted on the same
place on all computers. This option is the default.
Shared file system. This option is used when the file is on a shared file system
that is mounted in different places on different machines. For more
information, see “Using the Shared File System,” on page 581.
1. From the Input Source screen, click the FTP radio button. The Input Source Data
Handler screen appears.
2. Enter the information about the FTP site from which you want this file parameter
to get its data:
Server. The host name of the machine from which the file will be copied.
(optional) Directory. The directory relative to the FTP base directory of the
user specified below. This directory is often different from the user’s home
directory.
User Name. The user name used to log on to the FTP server.
Password. The password for the user name used to log on to the FTP server.
1. From the Input Source screen, click the URL radio button. The Input Source Data
Handler screen appears.
.
2. Type the URL from which you want this file parameter to get its data in the
corresponding text box.
3. Enter the amount of time the system should wait for the server to respond in the
Timeout after text box. You can enter "0" to wait until the underlying protocol
times out.
4. Return to step 7 on page 588.
1. From the Input Source screen, click the In Model radio button.
2. Click the Load From... button to specify the file from which you want this file
parameter to get its data.
2. Verify that the Output radio button is selected. If you click this button with the
Output Files tab active on the File tab, this option is automatically selected.
Array. Creates an array of output file parameters. All the elements in the array
will be configured the same way (as determined by the rest of the wizard).
Unless you select the Output Destination of FIPER File Manager (see step 10),
you must manually reconfigure each element of the array to point to a different
destination once the wizard finishes.
6. Type the file name where the output source will be copied after the component
executes in the corresponding text box. This entry is usually a simple file name
with no path, indicating that the file will be in the current working directory. You
can also use the Browse button to locate the file.
8. Select if the content of this file is Text or Binary using the corresponding radio
buttons.
9. Click Next.
Note: If the Show File type encoding on the Files tab option is selected on the
Parameter preferences page of the Preferences dialog, an additional page is
displayed for text files that allows you to set the file encoding. The file encoding is
only relevant if you use files containing non-Latin characters. For more
information on setting preferences, see “Setting Preferences,” on page 40.
10. Specify the location where you want the file copied to so that the file is available
after the component's runtime directory is removed. It is recommended that the
FIPER File Manager option be selected. The choices are:
FIPER File Manager. The FIPER File Manager will store the content of the
file in the iSIGHT-FD Runtime Database. This option is recommended.
Specify Location. The location where you want the file to be placed following
execution. This file may be in the iSIGHT-FD Runtime environment, a shared
file system, or an absolute path.
None. The file will not be copied, the "Source" location will be used. If this
file is mapped to another component, it must be in a shared file system.
11. Click Next.
The Source area configures the source of the data. For a mapped input file parameter,
this information is overridden by parameter mapping. It may still be convenient to
configure a data source, just in case you want this component to run alone (not as part
of a larger workflow). There are five options for the data source, available using the
Location drop-down list:
<None>. The data source is not configured. This setting is the default for new
input file parameters. Having no configuration is normal for a file that will be
mapped from another component in the workflow. If such a file parameter is not
mapped, or the component is run by itself, the component receives an empty file.
File. The data is stored in a regular file on the file system. You can use the Browse
button to select the file.
In addition to the usual controls for navigating directories and selecting files, the
radio buttons in the Path Options area allow you to select how the file should be
referenced. The following options are available:
Runtime directory. This option indicates that the directory containing the file
is to be ignored and the file will be found in the runtime working directory.
This setting is rarely useful for input file parameters.
Absolute path. This option is used to locate the file, which works for local
execution and when the file is on a shared drive that is mounted on the same
place on all computers. This option is the default.
Shared file system. This option is used when the file is on a shared file system
that is mounted in different places on different machines. For more
information, see “Using the Shared File System,” on page 581.
In Model. The contents of the file will be stored inside the iSIGHT-FD model.
iSIGHT-FD takes care of transferring the data to where the component is being
executed. This option is the most convenient because it eliminates any concerns
about shared file systems or parallel execution. Model files, however, are limited in
size. Generally in-model files should not be larger than a few hundred thousand
characters (about 2000 lines). The absolute limit is dependent on the amount of
available memory, but is usually around 5 MB. You may use the Reload From...
button to select the file to be copied into the model, or to re-load a modified file
into an existing model.
URL. Allows you to specify a file residing on a server. All forms of URLs
supported by Java may be used, though http: is the most common form. You
may specify the amount of time to wait for the server to respond, or “0” to wait
until the underlying protocol times out. Note that a URL type file parameter with a
file: URL is equivalent to a File-type file parameter.
FTP. The FTP from which you want this file parameter to get its data. Enter the
following information:
Server. The host name of the machine from which the file will be copied.
(optional) Directory. The directory relative to the FTP base directory of the
user specified below. This is often different from the user’s home directory.
User Name. The user name used to log on to the FTP server.
Password. The password for the user name used to log on to the FTP server.
The Preview… button at the bottom of the Read From area displays the contents of the
file. For In Model file parameters, the contents of the file can be edited from the
Preview dialog box; for other types it cannot be edited.
The Type drop-down list allows you to determine whether the file parameter is a text
file or a binary file.
The Encoding drop-down list allows you to explicitly specify the encoding to use
when converting between bytes and characters. In a Locale (a system setting that
includes the language, number formats, and character set in use) that uses multi-byte
characters (Japanese, Chinese, Korean), there is a default encoding used to convert
bytes into characters. Most text files will be written using this encoding, but sometimes
it is necessary to specify this encoding. For additional information on encoding, refer
to the iSIGHT-FD Development Guide.
Note: This drop-down list only appears if you have selected the Show File Type
encoding on the Files Tab option from the Preferences dialog box. For more
information, see “Setting Preferences,” on page 40.
The Destination area of the Files tab allows you to choose where the data will be put
while the component runs. The following options are available:
Save to Database. File parameters attached to components are often used for
temporary work and it is desirable to not store the information for these files in the
iSIGHT-FD system. Each file parameter has the option to save to the iSIGHT-FD
system or not. The default is to save to the iSIGHT-FD system; however, if you
have a file attached to a component that would like to discard after the run of the
component, uncheck the “Save to DB” option in the editor for the file parameter.
The contents of the file will not be saved after the component has run.
Fixed file name. This option should be used if the component expects its input in a
specific place. Fill in the file name in the text box provided, or browse to the file
you want. Normally, this will be a simple file name with no path, indicating a file
in the runtime working directory. An absolute path may be used in the odd case of
a program that demands that its input be in a specific directory, though such a file
parameter is not safe for parallel or distributed execution.
Automatic. This option is used most often. When activated, the iSIGHT-FD
system assigns a name to the file and passes that name to the component.
As with Input file parameters, the bottom of the Files tab for an Output file parameter
has Source and Destination areas. For an output file parameter, the Read From area is
the name the file will have in the working directory during component execution.
Usually this is a simple file name, indicating that the file will be written to the runtime
working directory. An absolute path can be used in the odd case of a program that
insists on writing its output to a specific directory, though such a file parameter is not
safe for distributed or parallel execution. The File Name text box may be left blank;
however, iSIGHT-FD will assign a name for the output file and pass that name to the
component during execution.
The Write To area specifies where the data will be put after the component finishes
running. The following three options are available in this area:
FIPER File Manager. iSIGHT-FD takes care of storing the contents of the file as
part of the run results. This option is the simplest one, and it is the default. A file
saved this way is only limited in size by the amount of temporary disk space
available.
Specific location. The data is copied from the working directory to the specified
location. This setting must be an absolute path, since there is no concept of a
“working directory” after the component finishes executing. The file name
substitutions described in “Substitutions in File Names,” on page 582 can be used
to file the data in locations of your choice. If there are no substitutions, the same
file will be written by every run and the model is not safe for parallel execution.
To select a File, URL, or FTP as the destination, click the ... button. Selecting URL
as the location will create an HTTP “PUT” request that few web servers
implement.
Note: If the File Name text box in the Read From area is left empty and the
Specific location option is selected, the data will not be written to the runtime
working directory. Instead, the absolute path described in the Write To area will be
passed to the component, and the component can write the data directly to the
specified location. This option is more efficient for very large output files, though
it can be difficult to configure for parallel and distributed execution.
None. The data is not copied after the component executes. Instead, the absolute
path to the Read From area is stored in the results database. If the Read From name
is a simple file name (not an absolute path), the data is written to the working
directory, which is normally deleted after the component finishes executing. In this
case, the file is effectively discarded after the component executes, and cannot be
mapped to subsequent components or viewed from the Runtime Gateway.
Note: Files in the runtime working directory cannot be mapped to subsequent
components using the None option, even if the Keep Execution Directory property
is checked. In order to use this option with file mapping, the Read From location
must be an absolute path or a relative path on a shared file system.
The Type drop-down list allows you to determine whether the file parameter is a text
file or a binary file.
The Encoding drop-down list allows you to explicitly specify the encoding to use
when converting between bytes and characters. In a Locale (a system setting that
includes the language, number formats, and character set in use) that uses multi-byte
characters (Japanese, Chinese, Korean), there is a default encoding used to convert
bytes into characters. Most text files will be written using this encoding, but sometimes
it is necessary to specify this encoding. For additional information on encoding, refer
to the iSIGHT-FD Development Guide.
If the Read From name is an absolute path (probably including file name substitutions,
see “Substitutions in File Names,” on page 582), the component will presumably write
to this location and iSIGHT-FD will pass the location on to subsequent components.
This behavior is equivalent to the case of the note under the Specific Location option
above; the component writes directly to an absolute path and iSIGHT-FD never copies
the data.
iSIGHT-FD does not yet support secure sockets layer (HTTPS: URLs).
When a URL is used as the destination for an output file parameter, iSIGHT-FD uses
an HTTP PUT message to send the file to the web server. Most web servers do not
support PUT requests, and those that do (sometimes called WEBDAV) usually require
authentication (see above).
For detailed information on these components, see “Using Components,” on page 109.
The Data Exchanger Select File Wizard is shown below. When reading a file, the File
to Read at Runtime text box contains the name the file will have in the runtime
working directory. This box may also be used to select an existing file parameter. If a
new file parameter is created, the parameter name will be the file name with the period
converted to an underscore.
The following example shows how the wizard would look when setting up a data
exchange to read the file aero.sample.input.
The following example shows how the file parameter ends up configured on the Files
tab.
As you can see, the parameter name is aero_sample_input, the mode is input, the
parameter has not yet been mapped, and the file will be written to file
aero.sample.input in the runtime working directory when the Data Exchanger
component is executed. The contents of the original file have been saved in the
iSIGHT-FD Model, mostly to serve as a sample when setting up the data exchange.
Eventually this parameter would be mapped, overriding the In-Model contents.
When writing a file with the Data Exchanger, the configuration is a little more
complex.
The example below shows the file parameters created by the Data Exchanger.
As for a file being read, you use the Browse… button on the Wizard to select the
template file, and the name of the file being written is automatically filled in the File to
write at runtime text box. In this case, however, two file parameters are created: one for
the template file, and one for the file being written. The file parameter for the template
file is mode input and has Tmpl added to the parameter name. The template file is
usually left as is, but it could be mapped if the template changes from run to run. The
output file parameter, containing the file updated with parameter values, is almost
certainly going to be mapped to a subsequent component.
OS Command Component
Since the OS Command component runs external programs that communicate through
iSIGHT-FD files, it is almost always necessary to configure file parameters when
setting up an OS Command component. There are several different kinds of files you
may have to configure:
The Executable
The program being run may either be a standard program pre-installed on the FIPER
Stations, or it can be a program written specially for this model. In the latter case, it is
better to distribute the program with the model instead of requiring your system
administrator to pre-install it in all FIPER Stations.
2. Click the Distribute Executable check box to copy the executable file into the
model.
A file parameter is created (with the same name as the executable), and the path to
the program is replaced with a parameter substitution (in green).
The file parameter is copied into the working directory with the same name as the
original file. When the command is run, the full path to this file is passed to the
operating system (and the file is made executable on UNIX).
If the program is very large, you should change the Read From area from In Model
to File to reduce the size of the model file. Doing so, however, requires that all
FIPER Stations that are to run this program have access to the specified file
system. Alternatively, the affinities for the OS Command component could be set
so this component only runs on the one machine where this program has been
installed. If the Read From location is an absolute path, the Write To location can
be changed from Fixed file name to Automatic to avoid copying the file; instead
the absolute path of the Read From file will be passed to the operating system as
the name of the program to run.
If you have already created a file parameter in some earlier component in the
workflow, simply select the file parameter from the Parameter drop-down list; then,
click the button to add the parameter to the command line. File parameters can
also be used for I/O redirection, as in the following example.
At runtime, the absolute path to the data for the file parameter is passed as an argument
to the program or is used to set up the I/O redirection. You can click the Verify
Command buttons to view how the command will be interpreted.
If no such file parameter has already been created, you can create one using the
following procedure:
1. Type the name of the new file parameter in the Parameter text box; then, click
the button.
2. Select the correct mode (Input or Output) from the corresponding drop-down list;
then, select File from the Type drop-down list.
The default configuration for new file parameters (both Input and Output) is
sufficient if you will be mapping the parameter to/from other components. If you
need to change the configuration of these file parameters, you can do so on the
Required Files tab of the OS Command editor, or on the Files tab of the Design
Gateway, shown below.
Note: It may be easier to create files using the Files tab on the Design Gateway.
To create a file parameter using the Files tab on the Design Gateway, click the
button. The file parameter wizard appears. For information on using the wizard, see
“Creating File Parameters,” on page 585.
Note: For an input file, on the Input File Destination dialog box, select Fixed File
Name. Enter the file name or use the Browse button to locate the file.
1. From the Parameters tab, create an input String parameter called Run Name.
3. From the Files tab, create an input file parameter called In. For more information
on creating file parameters using the file parameter wizard, see “Creating File
Parameters,” on page 585.
4. On the Input File Destination dialog box, select Fixed File Name. Enter the
following in the text box:
The following example shows the configuration for file parameter In.
You can also use substitutions in the Destination Specific location for an output
parameter, in order to write the data to a file who’s name depends on parameter values.
The same works for the Read From name for an Input file parameter with a Location of
File.
Simcode Component
A Simcode component consists of an Input data exchange, an OS Command, and an
Output Data Exchange. All of the previous discussions about using files with the Data
Exchanger and OS Command components apply to the Simcode component.
The Input Wizard has one input file parameter that is (effectively) updated as it is
written into the working directory. The output parse has one file parameter that reads
from the working directory and is then discarded.
Simcode components should be set up from left to right as described in the following
procedure:
1. Set up the Input data exchange. For information about working with the Simcode
component, see “Using the Simcode Component,” on page 420. For information
about working with the Data Exchanger, see “Using the Data Exchanger
Component,” on page 249.
2. Set up the OS Command, using the files created by the Input Data Exchange, and
creating Output file parameters for all files created by the OS Command. For
information about working with the OS Command, see “Using the OS Command
Component,” on page 377.
3. Go to the Output Data Exchange and parse the output files. For information about
working with the Data Exchanger, see “Using the Data Exchanger Component,” on
page 249.
Important: Do not rename these parameters. Doing so will interfere with how the
components are configured.
This configuration creates two file parameters, one for the input document, and one to
save the updated document.
Notice that the parameter name of the saved document is always the parameter name of
the input document with Output appended, irrespective of where the file will actually
be saved.
Mail Component
The Mail component uses file parameters for attachments to the mail message. The
most common case is where the file parameters already exist in some other component
in the workflow, and it is only necessary to attach the file to the mail message using the
button.
The selected file parameters will be created for the Mail component and automatically
mapped from their original location.
Script Component
The script component itself has nothing to do with file parameters, but sometimes it is
necessary to manipulate a file from a script. File parameters are made available to the
script with type FileValueType. The main method of this type is getLocalFile(),
which returns a java.io.File object that references the same file as the file parameter.
The following images illustrate a script example.
This type of test will only work for a file parameter of type File with no local name.
Any other type of file parameter will be copied into the working directory (which will
fail before the script has a chance to run).
Assuming the file does not exist, at runtime you get the exception that the script throws
(on the Log tab of the Runtime Gateway), stating that file does not exist. For more
information on using the Runtime Gateway, refer to the iSIGHT-FD Runtime Gateway
Guide.
Other Components
The above list covers all Engineous-supplied components that can use file parameters;
however, any component can use File parameters, depending on what the component
does and how it was written. With luck, the component editor will create the file
parameters already correctly configured for use by the component. If not, “OS
Command Component,” on page 609 describes almost all of the cases that are likely to
arise.
Mapping Parameters
Mapping parameters allows you to specify how data flows between components in a
model workflow.
Note: Parameters with the same name within a given workflow are automatically
mapped to each other if certain attributes match (type, structure, input-output
relationship).
The following example shows the high-level view of the model’s parameter
mappings (the Task component is selected in the Model Explorer).
2. Select the component from the Model Explorer that contains the parameter you
want to map.
3. If necessary, change the parameters displayed using the drop-down list at the top of
the two parameter lists. These drop-down lists allow you to specify a variety of
parameter viewing combinations.
4. To map a parameter, click the parameter; then, drag the cursor to the parameter you
wish to map to. A line appears from the original parameter. When the cursor
changes to an arrow , a legal mapping is possible. As long as the cursor
appears, you cannot create a legal mapping.
5. Release your mouse button. The parameter is mapped.
6. If necessary, you can adjust the parameter settings using the Selected Parameter
areas at the bottom of each parameter list. You can use this area to alter the
parameter’s name, mode, type, and value. These sorts of changes may be helpful
when mapping your parameters. For more information on these settings, see
“Changing Parameter Settings,” on page 627.
1. Select the parameter you want to alter. The parameter’s information appears in the
Selected Parameter area at the bottom of the parameter list.
Name
Mode
Type
Value
For more information on these settings, see “Creating New Parameters,” on
page 566.
Changing Views
You can alter the mapping information that is displayed on the Mapping tab. This
option may be helpful when viewing numerous mappings, or when attempting to locate
a specific mapping.
1. Click the drop-down list in the Show/Hide options area at the bottom of the tab.
2. Select one of the following options to customize which mappings are displayed on
the tab:
All
Selected
Left to Right
Right to Left
3. Click the check boxes to show only non-file parameters or to only show file
parameters.
Deleting Mappings
To delete a mapping:
2. Right-click the mapping; then, select Delete from the menu that appears.
This chapter describes the usage of the Command Line Client, which provides a
simple, text-based interface to many functions of iSIGHT-FD in the standard desktop
(Standalone) mode and when connected to an ACS in the FIPER environment. It is
divided into the following sections:
Introduction
The Command Line Client is a console (character mode) program that provides simple
text-based access to many functions of iSIGHT-FD in the standard desktop
(Standalone) mode and when connected to an ACS in the FIPER environment.
The Command Line Client can be run in a prompting mode. With this option, the client
acts like a command shell itself, prompting for commands and only terminating when
the quit command is executed. This mode is also known as “interactive mode.”
The tool can also be run in single-command mode. In this mode, a single command
(and parameters) is supplied on the command line. The requested command is run, any
output is displayed, and the client terminates and returns control to the standard shell.
Interactive mode. This option allows you to use the Command Line Client like a
command shell. The tool is opened for as long as you wish, and as many command
can be entered as desired. You have to manually quit this mode to deactivate the
client. For more information, see “Starting the Command Line Client in Interactive
Mode,” on page 631.
2. Type fipercmd to initiate the Command Line Client. The Logon dialog box
appears.
3. Log in uses the appropriate connection profile. Some commands can only be used
when connected to an ACS in the FIPER environment. For more information, see
“FIPER Command Line Options,” on page 642.
Note: You can also set some options directly in the fipercmd.bat file (fipercmd
file on UNIX). For more information, see “Setting Other Command Line Client Logon
Options,” on page 648.
2. Type fipercmd; then, enter the command line argument that you wish to use. For
more information on the available options, see “iSIGHT-FD Command Line
Options,” on page 633 and “FIPER Command Line Options,” on page 642.
Important: You must type fipercmd for each set of arguments you execute. If you
want to avoid having to retype fipercmd numerous times (if you are executing
numerous arguments), see “Starting the Command Line Client in Interactive
Mode,” on page 631 for more information on using the tool’s interactive mode.
In interactive mode, once you’ve started the tool, you simply need to type the desired
arguments.
Command names and arguments are insensitive to upper/lower case differences. For
example, start file:model1.zmf is treated the same as
START FILE:model1.zmf. File names are case-sensitive on UNIX and
case-insensitive on Windows.
Note: Arguments that end in “...” represent those that can be used multiple times at the
same command prompt to specify multiple items. For example, the “delete” command
can specify multiple jobs: ’delete job:AAAA job:BBBB’.
format:[list|verbose|debug]
This argument allows you to define the output format of the Command Line Client.
The default setting is verbose, which prints messages about each. The list
option prints only the data requested by the command. The debug option prints
debugging-only messages useful for diagnosing software problems.
logonprompt:[yes|no]
This argument allows you to specify if the Logon dialog box appears when the
Command Line Client is executed. If you use this argument to stop the Logon
dialog box from appearing (the no option), you must specify a profile name, user
name and password using the arguments in this list. Failure to specify this
information will cause the Command Line Client to cancel the logon and exit due
to the error.
logonmode:[gui|console].
This argument allows you to specify the type of logon you want to use. The gui
option uses the Logon dialog box. This setting is the default. The console option
allows you to specify connection information at the command prompt.
Note: When the Command Line Client prompts for a password on the console, the
password is not hidden. It is visible to anyone looking at the prompt. If security is
important, use the gui mode to log into the system.
profile:<connection_profile_file_name>
This argument allows you to specify the connection profile that the Command Line
Client will use. If you specify this argument without the logonpromt:no
option, the Logon dialog box will appear with the given connection profile
pre-selected, and you’ll have to specify the user name and password for the
connection profile.
If you receive an error that the connection profile cannot be found, use a full path
to the profile. For example:
fipercmd profile:\progra~1\fiper\standalone.cpr
Note: When using iSIGHT-FD without a results database, only the start and stop
commands will work. The other commands in this group require a results database.
start. This command is used to initiate model execution. It runs the model(s) on
the ACS if you log into an ACS. If you log into a local Library (Standalone mode),
the model(s) run locally. The following sub-arguments can be used with this
argument (The file or name argument must be used with this command. You
cannot specify both; only one model can be run at a time.):
args:[parameter_name=parameter_value];[parameter_name=
parameter_value] ... Specify new values for input parameters on the command
line. If any parameter name or value contains spaces, enclose everything after
the first colon in double-quotes.
output:[file_name]. Save the results of the run to a file. All input and output
parameters of the top-level component are written to the file in name/value
format, plus comments indicating when the job was run. You may specify both
print:y and output:[file_name] for the same run.
print:y. Print the results of the run to the terminal. All input and output
parameters of the top-level component of the model are printed in the same
name/value format used by the input command.
results:[y|n]. Save all job results to your local hard drive as a series of
comma-separated values (csv) files, with one file for each component in the
model. If you do not specify a directory, your results are saved in your default
user directory, and you are notified of the location. The results for each job will
be saved in a sub-directory of this directory named with the job name (and a
unique number if several jobs have the same name).
version:[model_version]. Specify the version of the model you are opening
with the name argument. The default value is latest.
wait:n. Allows you to not wait for the job to finish. In interactive mode, you
get a new command prompt immediately and can continue to work while the
job runs. In command-line mode, when connected to an ACS in the FIPER
environment, fipercmd will exit immediately while the job runs on the
ACS. When not connected to the ACS, fipercmd will wait until the job
finishes before exiting, since the job actually runs inside the fipercmd process.
The results of the job can be retrieved later with the results command.
delete. This argument allows you to delete one or more jobs from the results
database.
Note: You can use any of the job matching criteria arguments to select the jobs to
delete. For more information, see “Job Matching Criteria Arguments,” on
page 638.
Note: You can use any of the job matching criteria arguments to select the jobs for
which to retrieve logs. For more information, see “Job Matching Criteria
Arguments,” on page 638.
This command does not currently work for jobs run locally without a results
database. Use the monitor:y option for the start command instead.
jobstatus. This argument displays job information. You can also use the short
version - jstatus.
Note: You can use any of the job matching criteria arguments to select jobs to
display. For more information, see “Job Matching Criteria Arguments,” on
page 638.
results. This argument allows you to save job results to your local hard drive.
Note: You can use any of the job matching criteria arguments to select the jobs
to save. For more information, see “Job Matching Criteria Arguments,” on
page 638.
dir:[directory_name]. Specify which directory will hold the results. It should
be used in conjunction with the results option. If this option is omitted, the
results are saved to your home directory.
Note: If the job has not finished when the results command is submitted, the
command will register a request to save the results when the job does finish. The
Command Line Client will delay exiting until all delayed requests to save results
have finished. You can cancel a save request by typing CTRL-C.
resume. This argument allows you to resume one or more paused jobs.
Note: You can use any of the job matching criteria arguments to select the jobs to
resume. For more information, see “Job Matching Criteria Arguments” on this
page.
Note: You can use any of the job matching criteria arguments to select the jobs to
cancel. For more information, see “Job Matching Criteria Arguments” on this
page.
job:[job_ID_number] ... This argument allows you to specify one or more jobs
using their ID numbers.
stat:done. Specifies all job(s) that are done.
Some sample arguments using these job matching criteria arguments include:
Publishing Commands
These arguments are used to work with objects in the Library, including publishing
objects, unpublishing (removing objects), and retrieving existing objects. The
following arguments are available:
find. This argument allows you to find Library objects. Use the following
sub-arguments to specify the object information:
publish. This argument allows you to publish a file to the Library. Use the
following sub-arguments to specify the file information:
unpublish. This argument allows you to remove a published file from the
Library. Use the following sub-arguments to specify the file information:
Miscellaneous Commands
These arguments are also available for use with iSIGHT-FD:
buildlevel. This arguments displays the version, creation date, and creation
time of the current iSIGHT-FD installation.
command. This argument starts the interactive command mode. This mode allows
you to use all Command Line Client arguments without the fipercmd prefix, and
eliminates having to log into the ACS with each command execution. In effect, you
“log into” the Command Line Client and the ACS, and can directly execute all
available arguments. When you use the interactive command mode, your default
prompt changes to the > prompt.
Note: You can exit the interactive mode using the quit command.
model. This argument allows you to get information about a model. The
information includes the input parameters that can be set with the start
input:[file_name] or start arts:PARM=VALUE commands. Use the
following sub-arguments to specify the model information:
help. This argument displays a list of all available arguments. You can also access
this list by simply typing fipercmd at the prompt. You can also use the short
version - ?.
echo. This argument echoes the rest of the command line to the terminal. It is
useful in command scripts to print progress messages.
exit. This argument closes the Command Line Client (interactive mode).
user:<user_id>. This argument allows you to specify the user that will log on to
use the Command Line Client. If you only specify this argument, the Logon dialog
box will appear, but the user name will already be defined.
user:[userID] user:[userID] ... Specifies jobs owned by one or more user IDs.
This option does not work using when connected to an ACS where security is
deactivated. Basically, if you didn’t need to log in with a user ID and password, the
user option does not work (including in desktop (Standalone) mode).
Library Commands
find. This argument allows you to find Library objects. Use the following
sub-arguments to specify the object information:
get. This argument allows you to get a Library object and save it as a file. Use the
following sub-arguments to specify the file information:
getacl. This argument allows you to get the access control list (permission
information) from a specified object in the Library. Use the following
sub-arguments to specify the file information:
getjobacl. This argument allows you to get the access control list (permission
information) for a specified job in the results database. Use the following
sub-arguments to specify the file information:
setacl. This argument allows you to set the access control list (permission
information) for a specified object in the Library. Use the following sub-arguments
to specify the permission information:
Then you need to specify the permission settings using the acl command. The
following options are available:
Permission settings. Specify the permission for the selected user or group.
• AL. Set the object’s permission to Alter.
• MO. Set the object’s permission to Modify.
• RE. Set the object’s permission to Read.
• RF. Set the object’s permission to Reference.
• NO. Set the object’s permission to None.
Group settings. Specify if the entry is a user name or FIPER group name.
• U.
• FG.
For example, to set the permission for an object called test_model for a user named
fiperacs to the permission setting of Read, you’d type the following command:
setacl name:test_model acl:fiperacs,RE,U
For more information on these permission settings and their meanings, see “Setting
Object Permissions,” on page 545.
setjobacl. This argument allows you to set the access control list (permission
information) for a specified job in the results database. Use the following
sub-arguments to specify the permission information:
Permission settings. Specify the permission for the selected user or group.
• AL. Set the object’s permission to Alter.
• MO. Set the object’s permission to Modify.
• RE. Set the object’s permission to Read.
• NO. Set the object’s permission to None.
Group settings. Specify if the entry is a user name or FIPER group name.
• U.
• FG.
For example, to set the permission for an object called test_model for a user named
fiperacs to the permission setting of Read, you’d type the following command:
setacl job:8580808080808080A781 acl:fiperacs,RE,U,*,NO,U
The first set of acl commands (fiperacs, RE, and U) represent the specified user (in
this example, fiperacs). The last set of acl commands (*, NO, and U), represent all
other users.
For more information on these permission settings and their meanings, see “Setting
Object Permissions,” on page 545.
addpartner. This argument allows you to add a new partner profile. Use the
following sub-arguments to specify the partner and partner options.
deletepartner. This argument deletes the specified partner profile. Use one of
the following sub-arguments to specify the partner.
deleteusermap. This argument is used when setting up Run-As and Library ACLs.
For more information on how to use it, refer to the FIPER Federations (B2B)
Guide.
Miscellaneous Commands
buildlevel. This command displays the version, creation date, and creation
time of the current ACS. It also displays the local iSIGHT-FD information, if
applicable.
Once set, they are executed automatically when the Command Line Client file is
executed. These options may be particularly useful if you always log in using the same
connection profile, user name, and password.
To avoid having to edit the fipercmd.bat (or fipercmd) file, you can put these
settings into the FIPER_JVMPARMS environment variables.
For example, adding the following information (on a single line in the file):
FIPER_JVMPARMS=’-Dfiper.logon.profile=standalone
-Dfiper.logon.prompt=N -Dfiper.logon.mode=console’
would allow the interface to automatically connect in standalone model, and log in
information would be entered directly into the console (instead of through a logon
window). FIPER_JVMPARMS is used by all iSIGHT-FD and FIPER programs.
Setting the logon profile and prompt in this manner will suppress the Logon dialog box
in all programs.
This chapter describes the example models included with the iSIGHT-FD installation.
It is divided into the following sections:
Overview
A set of iSIGHT-FD example model files, associated simulation codes, and data files
needed to run the examples are included in the following directory:
<isight-fd_install_directory>\examples\models
The examples have been built to illustrate a variety of iSIGHT-FD components and to
show how to combine them in useful ways. Each example has been fully annotated,
using the Description property of each example's components. Each root component
describes the example as a whole, while each child component describes the purpose
and function of that component in that example.
This subdirectory also contains sample data files for any examples that are
designed to process file data. The model will also contain a file parameter holding
an instance of this file, so that the model will run as is when loaded.
external programs and manage their input and output files. This subdirectory
contains all external programs used by the examples. The top level of this
subdirectory contains the source codes (in Fortran, C, and so on) for these
programs. They are supplied primarily as documentation. Beneath this
subdirectory is the bin directory, which in turn contains a subdirectory named for
each platform on which iSIGHT-FD is supported. Each sub-subdirectory contains
the actual executables for these programs, for that platform.
If this is done, then the component will be able to locate that executable if one of the
following conditions is satisfied:
The directory containing the executable is in the %PATH% list of the target FIPER
Station. All of the iSIGHT-FD startup scripts add the example simcode directory
for the current platform to %PATH%.
The Simcode component has been edited so that the simcode name includes the
directory path. Ideally, the iSIGHT-FD installation should already complete the
previous item for you, so you should be able to run each example as is. If this is not
the case, contact your system administrator or call Engineous technical support.
If an example reads a data file, then a file parameter in the topmost Task component
will exist and will contain the text of an instance of the data file. You may run the
example on a different data set by editing this file parameter to refer to the file
containing that data set. This data may be either held in-memory, as for the instance in
the model, or read from an external file. In the latter case, the file name entered into the
file parameter must contain the full path to the chosen data file. The %PATH% list is of
no help in this case.
Several of the examples also have non-Simcode components which must be adjusted
before execution. For instance, if an example contains a Mail component, address
information must be entered or the component will not run. These adjustments
unfortunately cannot be done via the Configure and Run options; they must be done in
the Design Gateway before execution.
SpectralAnalysis
This example demonstrates the use of the iSIGHT-FD MATLAB component. A signal
data vector is analyzed to determine its primary frequency components, which are
presented in order of decreasing strength. The calculated frequency data is also plotted
by MATLAB.
Note: In order to keep the MATLAB plot raised after execution ends, the MATLAB
component properties have been set so that MATLAB is not terminated. Hence,
MATLAB will have to be shut down manually after this model is executed.
Generic Examples
The examples described below can be found in the generic directory.
AirplaneSizingDOE
This example uses iSIGHT-FD Design of Experiments to perform preliminary sizing of
a generic aircraft.
I_Beam
This example evaluates a standard I-Beam. It reads the beam dimensions from an
external input file, computes stresses and deflections, and writes the results to an
external output file.
SpringSamples
This example is actually a set of three related examples, grouped into a single model
file for convenience. Each sub-example illustrates the use of an iSIGHT-FD design
search component, applied to the coiled spring design problem commonly discussed in
Mechanical Engineering texts. One sub-example applies iSIGHT-FD Design of
Experiments, another applies iSIGHT-FD Monte Carlo, and the third applies
iSIGHT-FD Optimization. Each sub-example also defines one or more iSIGHT-FD
graphs, which will be created at runtime and populated by the data generated by the
associated search component.
Note: This example has been configured to run the Design of Experiments
sub-example by default.
TestDataMatch
This example illustrates the use of iSIGHT-FD to tune the parameters of a model so
that its outputs match a vector of test data as closely as possible. The example may be
configured to e-mail the best model to any recipient.
TriangleScan
This example demonstrates the use of the iSIGHT-FD Excel and Word components. A
sequence of triangles with integer sides is generated, and the hypotenuse of each
triangle is calculated by Excel and checked. The triangle whose hypotenuse is most
nearly an integer is saved and presented to the user in Word.
For illustration, the Excel spreadsheet which performs the hypotenuse calculation and
graphs each triangle is shown in the triangle.xls file, and the Word document template
for the final triangle report is shown in the TriangleReport.doc file.
This chapter describes how to access and use the iSIGHT-FD documentation, including
PDF files and the online help system (HTML-based help). It is divided into the
following sections:
Introduction
iSIGHT-FD provides both a PDF documentation library and browser-based online
help. The help files are specific to certain interfaces within the software (such as the
Design Gateway and component editors). The PDF files cover all of the functionality
available in the product, including but not limited to the information included in the
online help.
The following books are available in PDF format from the iSIGHT-FD documentation
library:
<isight-fd_install_directory>\docs
The files are in PDF format, and you must have Adobe Reader or some other PDF
viewer installed on your system to view the PDFs. You can download Adobe Reader
for free from the following website:
http://www.adobe.com/reader
Important: It is highly recommended that you install the latest version of Adobe
Reader. Older versions of the reader have been known to not display all of the text in
PDF files correctly.
Note: Adobe Reader also has the ability to search all PDFs in a specific location (such
as the iSIGHT-FD docs directory), but the index method described in the following
procedure will result in faster searches.
The following procedure describes how to access the iSIGHT-FD index using Adobe
Reader. If you are using Adobe Acrobat or any other PDF viewer, refer to that
interface’s online help system for more information on how to access the iSIGHT-FD
index.
1. Open Adobe Reader; then, open one of the PDF files located in the iSIGHT-FD
documentation directory (<isight-fd_install_directory>\docs).
2. Click the Search button on the Reader toolbar. Additional options appear on the
right side of the interface (the Search PDF area).
3. Click the Used Advanced Search Options link at the bottom of the Search PDF
section. The listed options change.
4. Click the Look In drop-down list; then, click the Select Index... option. The Index
selection dialog box appears, showing the pre-defined index.
5. Click OK. The index is accessed, and you can now use it to search each book in
the iSIGHT-FD documentation library.
6. Use the options in the Search PDF area to define your search; then, click the
Search button. All of the books are searched, and your results are displayed on a
per-book basis.
7. Expand any of the books highlighted during the search to display the individual
search results for that book.
8. Click any result to view it. If the result is in a different PDF than that which
currently appears in the Reader, the new PDF is automatically opened.
You’ll have to repeat this procedure each time you access the Reader and want to
perform a full documentation library search. Once the Reader is closed, the link to the
iSIGHT-FD index is lost and must be re-established. For more information on the
Reader’s search capabilities, refer to the Reader online help system.
Browser Specifications
The iSIGHT-FD online help is designed to work on the following browsers:
http://www.microsoft.com/
http://www.mozilla.org
Design Gateway, Runtime Gateway, Generator, and Engineering Data Mining (via
the Runtime Gateway)
Component editors
Use the Index and Search tabs to quickly find topics that may assist you in using
the product.
Click the to view where the current topic (on the right side of the help
interface) falls within the table of contents (on the left side of the help interface).
Using this button may help you quickly find topics related to the current topic.
Don’t forget about your web browser’s Forward and Back buttons. These can be
used in conjunction with the navigation buttons within the online help.
If you have suggestions for improvement, or wish to point out specific errors, please
send your comments to:
Documentation Suggestions
Engineous Software
2000 CentreGreen Way, Suite 100
Cary, NC 27513
Name
Title
Company
Address
Telephone number
Email address
13 Understanding FIPER
Environment Options
This chapter describes Design Gateway and component options that are only available
when connected to the FIPER Environment (a FIPER ACS or FIPER Station). It is
divided into the following sections:
Overview
The FIPER environment is composed on two major items which are not present when
executing locally (the default configuration for iSIGHT-FD): the FIPER ACS and the
FIPER Station.
The FIPER Application Control System or ACS is the FIPER nerve center that manages
workflow, job dispatching, distributed and parallel computing, results processing and
archiving, Library activity, and collaboration activities. For a full FIPER environment,
the ACS utilizes a commercial middleware layer consisting of a standard J2EE
application server and relational database, and exploits EJB, JMS, JTA, JDBC, Servlet,
JSP, and other J2EE technologies.
The Job Dispatcher controls the job distribution and parallel execution of work
items.
The Federation (B2B) services provide access to remote business partners. They
invoke the security of the underlying application server software — leveraging
existing commercial software available to the customer.
The Library is the repository for the storage, access, and version controlling of
components that will be shared within an organization and with partner
organizations.
A FIPER Station is a long-running process that performs work on behalf of the ACS
(and, indirectly, the user of the system). An instance of the Station must be run on any
workstation which is to act as a part of the parallel and distributed execution
environment. Parallel execution occurs when processes (jobs) are run at the same time;
while distributed executions occurs when processes are run without regard to time
specifications.
For more information about FIPER Stations, refer to the FIPER Installation and
Configuration Guide that matches your ACS combination.
Windows: Click the Start button; then, point to All Programs / FIPER 2.5
and click Edit Logon Profile.
If you have already started iSIGHT-FD and are currently viewing the Logon
dialog box, you can click the button to create a new profile.
2. Type the name of the profile in the Profile name text box. This name will appear
on the Connection drop-down list when connecting to the ACS.
3. Select the type of application server you are using from the Server type
drop-down list.
4. Specify the name of the machine running the ACS in the Server name text box.
Important: If you will be using LSF with iSIGHT-FD, do not specify the server
using its fully qualified domain name. For example, you should type
acsmachine, not acsmachine.yourcompany.com.
5. (optional) Change the port number in the corresponding text box. The port number
provided is the default port number for the application server selected. However,
based on your network or system configuration, you may need to change this
number. Contact your local system administrator for more information.
6. Select Save As... from the File menu; then, name and save the connection profile.
All connection profiles should be stored in the top level of the iSIGHT-FD
installation directory in order to ensure that they appear in the Connection profile
drop-down list on the Logon dialog box.
2. Click Default Permissions on the left side of the dialog box. The Default
Permissions options appear.
These options allow you to set user permissions for newly-published objects and
jobs. These default permissions are used whenever an object is published, and help
eliminate the need to manually set permissions every time you publish an object.
You can also set permissions that are particular to a model or job. For more
information, see one of the following topics:
For more information on setting permissions for a specific job, refer to the
iSIGHT-FD Runtime Gateway Guide.
The process for adding users for newly-published objects or jobs is the same. To
configure users for newly-published objects, use the settings located in the upper
section of the dialog box. To configure users for newly-created jobs, use the
settings located in the lower section of the dialog box.
For more information on each setting available with this feature, see “Setting
Object Permissions,” on page 545.
This dialog box is divided into three tabs that provide you with the following
information:
General. This tab displays information about the ACS you are connected to
including the connection profile being used to connect to the ACS, the full name of
the machine with domain, the type of application server used, the user name used
to connect to the ACS, and ACS version information.
Server Details. This tab displays additional server details including the server
name and the port number used.
Stations. This tab shows any FIPER Stations currently connected to the ACS. For
more information on FIPER Stations, refer to the FIPER Installation and
Configuration Guide that matches your ACS combination.
This chapter contains reference information about menu options, toolbar buttons,
component title bar buttons, right-click options, and keyboard shortcuts. It is designed
as a quick reference, and does not necessarily describe how to use the options. It is
divided into the following sections:
Menu Options
The following tables describe the options available from each menu on the Design
Gateway, including the menu option name, the icon that represents the action (if one
exists), the toolbar button that performs the same action (if one exists), and the action
description:
File Menu
The following table (Table A-1) describes options available from the Design Gateway
File menu.
Edit Menu
The following table (Table A-2) describes options available from the Design Gateway
Edit menu.
View Menu
The following table (Table A-3) describes options available from the Design Gateway
View menu.
Window Menu
The following table (Table A-4) describes options available from the Design Gateway
Window menu.
Run Menu
The following table (Table A-5) describes options available from the Design Gateway
Run menu.
Tools Menu
The following table (Table A-6) describes options available from the Design Gateway
Tools menu.
Option Action
SDK Generator Opens the Component Generator, which assists you in
creating components. For more information, refer to the
iSIGHT-FD Development Guide.
Connection Status In the FIPER environment, provides you with details on
your current ACS connection. For more information, see
“Viewing ACS Connection Information,” on page 670.
Help Menu
The following table (Table A-7) describes options available from the Design Gateway
Help menu.
Toolbar Buttons
The following table (Table A-8) describes buttons available from the Design Gateway
Toolbar.
Button Action
Creates a new model, but allows you to select the root component from a list.
Allows you to open a model from your computer’s hard drive.
Saves the current model with the same file name.
Allows you to print model information.
Removes the selected component from the workflow, placing it in memory, and
allows you to paste it in another location.
Places a copy of the selected component from the workflow in memory, and
allows you to paste it in another location.
Takes a cut or copied component from memory and places it in your workflow.
This button, which toggles between an on (depressed) and off (raised) setting,
displays or hides the Component Palette, which is the area that consists of the
Activities, Drivers, and <New> tab, and holds component icons.
Opens the Library dialog box.
This button runs the model based on your current connection mode (ACS or
Desktop (Standalone)). Clicking the down arrow to the right of the button
accesses additional execution options.
Button Action
This button opens the editor for the selected component.
Tab Options
These options are described in “Manipulating Tabs,” on page 39.
Option Action
Edit Opens the selected components editor. For more information on
these editors, see Chapter 4 “Using Components”.
Disable Allows you to disable any component in your workflow. Once a
component is disabled, right-clicking it again reveals an Enable
option. For more information, see “Disabling a Component in the
Workflow,” on page 70.
Properties Opens the selected components properties. For more information,
see “Editing Component Properties,” on page 113.
Collapse / Expand Either displays or hides the contents of process components in the
Workflow tab. This option is only available for process
components
Rename Allows you to rename the selected component.
Cut Removes the selected component from the workflow, placing it in
memory, and allows you to paste it in another location.
Option Action
Copy Places a copy of the selected component from the workflow in
memory, and allows you to paste it in another location. For more
information, see “Copying Model Information,” on page 86.
Paste Copy Takes a cut or copied component from memory and places it in
your workflow. For more information, see “Creating Independent
Copies of Components,” on page 86.
Paste Reference Pastes a reference to a component in your workflow. Similar to a
shortcut in the Windows operating environment. Any change to
the original component is reflected in the reference. For more
information, see “Creating Reference Copies of Components,” on
page 88.
Delete Removes the selected component from the workflow.
View Opens a submenu that allows you to view component parameters,
file parameters, mappings, and validation errors. All information
is displayed in a separate dialog box.
Run Executes the selected component. This option has the same
function as the run button in the Component Title Bar. For more
information, see “Executing a Model or Component,” on page 63.
Print This Component Prints information about the component.
Tree...
Save As Allows you to save the component. For more information, see
“Saving a Model or Component,” on page 62.
Publish Allows you to publish the component, which makes it available to
other users who access your Library. For more information on
publishing components, see “Publishing a Sub-Model
(Component),” on page 544.
Approximations Provides access to the selected component’s approximations. It
allows you to access the Approximation Wizard, the Visual
Design Driver (VDD), and Error Analysis. For more information,
see Chapter 6 “Creating and Using Approximations”.
Encapsulate Allows you to specify a new process component to act as a
container for the selected component. For more information, see
“Encapsulating Components,” on page 82.
Option Action
Change To Allows you to change the selected component to a different
component of the same type (process or activity). For more
information, see “Changing Components In a Workflow,” on
page 57.
Make Submodel Allows you to specify the selected component (and any child
components) as a submodel. Submodels can be referenced any
number of times within a model, allowing you to reuse specific
parts of your model as needed. For more information, see “Using
Submodels,” on page 90.
Edit Condition. Opens a dialog box, which allows you to specify information
about the selected workflow arrow, including execution and label options. For
more information, see “Setting Conditional Workflow Options,” on page 71.
Delete. Allows you to delete the selected workflow arrow.
Paste Copy. Takes a cut or copied workflow arrow from memory and places it in
your workflow.
Keyboard Shortcuts
This section describes keyboard shortcuts available when using the Design Gateway.
Proceed to one of the following topics for more information:
Edit E
Cut T Ctrl-X
Copy C Ctrl-C
View V
Component C
Parameters P Ctrl-Shift-P
Files F Ctrl-Shift-F
Editor E Ctrl-Shift-E
Properties O Ctrl-Shift-T
Dataflow Mapping M Ctrl-Shift-M
Library L Ctrl-Shift-L
Runtime Gateway R Ctrl-Shift-R
Server Information S Ctrl-Shift-S
Job List J Ctrl-Shift-J
Component Palette n
Status Bar a
Tool Bar T
Window W
Clone C
Run R
Run Model (Local) L F4
Run Model (ACS) M F5
Run Component (Local) N Shift-F4
Run Component (ACS) U Shift-F5
Tools T
SDK Generator G Ctrl-Shift-G
Connection Status C
Help H
Contents C F1
About A
2. Execute the following commands, using the xmodmap command to change the
key mappings:
xmodmap -e "keysym Alt_L = Alt_L"
xmodmap -e "keysym Alt_R = Alt_R"
xmodmap -e "clear Mod1"
xmodmap -e "add Mod1 = Alt_L"
xmodmap -e "add Mod1 = Alt_R"
3. Close the terminal window; then, verify that the shortcuts listed below function
properly:
Note: Arguments with a value may be specified using either of the following methods
(tag is case-insensitive):
-l <locale>. This argument sets the locale (language environment) for the current
session. It is useful only when testing support for a language. For example, typing
gateway -l de_DE displays all messages in German.
logfile. This argument allows you to specify a file name and location for the
iSIGHT-FD log file.
syserror
error
warning
info
debug
You can also specify a model to be loaded by adding the following setting at the
end of the set JVMParms= entry in the gateway.bat file (gateway file on
UNIX):
-Dfiper.gateway.modelToLoad=MODEL.zmf
Note: Be sure to leave a space between this argument and the last one currently on
the line.
You can also set the environment variable FIPER_JVMPARMS using the setting
described above.
If you receive an error that the connection profile cannot be found, use a full path
to the profile. For example:
gateway profile:\progra~1\fiper\standalone.cpr
pw:<password>. This argument allows you to specify the password of the user
that will log into the Design Gateway when connecting to an ACS in the FIPER
environment. It is not used for the desktop (Standalone) connections. If you only
specify this argument, the Logon dialog box will appear, but the password will
already be defined.
-r. This argument allows you to open the Runtime Gateway (instead of the Design
Gateway) using the gateway command. For more information on using the
Runtime Gateway, refer to the iSIGHT-FD Runtime Gateway Guide.
Note: Be sure to leave a space between this argument and the last one currently on
the line.
-help. This argument prints information about the available command line
arguments and then exits.
user:<user_id>. This argument allows you to specify the user that will log on to
use the Design Gateway when connecting to an ACS in the FIPER environment. It
is not used for the desktop (Standalone) connections. If you only specify this
argument, the Logon dialog box will appear, but the user name will already be
defined.
B Component Reference
Information
Parameter Study
Although this term can be used quite generally to refer to any study of design
parameters, in iSIGHT-FD “Parameter Study” is used to refer to a true study of the
sensitivity of the design to each factor independent of all other factors. In other words,
each factor is studied at all of its specified levels (values) while all other factors are
held fixed at their baseline. A baseline point is also analyzed for reference, resulting in
(i = # factors, ni = # levels for factor i) design point
evaluations. Although this does not provide any interaction information, it does allow
you to study many factors at many levels with relatively few design point evaluations.
If interactions are insignificant, the results are a good indicator of the effects of the
individual factors.
Full-Factorial Design
A full-factorial design is one in which all combinations of all factors at all levels are
evaluated. It is an old engineering practice to systematically evaluate a grid of points
Orthogonal Arrays
The use of orthogonal arrays lets you avoid a costly full-factorial experiment in which
all combinations of all inputs (or factors) at different levels are studied (pn for n factors
each at p levels), and instead perform a fractional factorial experiment. A fractional
factorial experiment is a certain fractional subset (1/2, 1/4, 1/8, etc.) of the full factorial
set of experiments, carefully selected to maintain orthogonality (independence) among
the various factors and certain interactions. It is this orthogonality that allows for
independent estimation of factor and interaction effects from the entire set of
experimental results. While the use of orthogonal arrays for fractional factorial design
suffers from reduced resolution in the analysis of results (i.e., factor effects are aliased
with interaction effects as more factors are added to a given array), the significant
reduction in the required number of experiments (cost) can often justify this loss in
resolution as long as some of the interaction effects are assumed negligible.
In fractional factorial designs (which are essentially what orthogonal arrays are used
for), the number of columns in the design matrix is less than the number necessary to
represent every factor and all interactions of those factors. Instead, columns are
“shared” by these quantities, an occurrence known as confounding. Confounding
results in the dilemma of not being able to realize which quantity in a given column
produced the effect on the outputs attributed to that column (from post-processing
analysis). In such a case, the designer must make an assumption as to which quantities
can be considered insignificant (typically the highest-order interactions) so that a
single contributing quantity can be identified.
In essence, for an orthogonal array of a given size, the more factors and interactions
you want to study, the greater the confounding. This results in lower confidence in the
analysis of results (since more assumptions of insignificant factors must be made).
Orthogonal arrays have been used in design since as early as the 1940's by Plackett and
Burman, who used saturated designs (only studying factor effects), and were really
popularized by Taguchi, who developed a family of 2- and 3-level orthogonal arrays to
study interaction effects (Ross, P.J., Taguchi Techniques for Quality Engineering,
McGraw-Hill Publishing Company, New York, NY, 1988). The 3-level arrays also
allow for an estimation of 2nd order effects (i.e., design space curvature).
The use of these orthogonal arrays provides a systematic and efficient method to study
the design space and provide suggestions for improving the design. However, the
actual tasks of selecting the appropriate orthogonal arrays to use and assigning the
factors and interactions to columns can be tedious and overwhelming. The automation
of this procedure in iSIGHT-FD allows a designer with little or no knowledge of
orthogonal arrays to efficiently and effectively study the design space using this formal
DOE methodology.
Latin Hypercube
Another class of experimental design which efficiently samples large design spaces is
Latin Hypercube sampling. With this technique, the design space for each factor is
uniformly divided (the same number of divisions (n) for all factors). These levels are
then randomly combined to specify n points defining the design matrix (each level of a
factor is studied only once). For example, Figure B-1 illustrates a possible Latin
Hypercube configuration for two factors (X1, X2) in which five points are studied.
Although not as visually obvious, this concept easily extends to multiple dimensions.
Figure B-1. Latin Hypercube Configuration for Two Factors, with Five Points
Note: A drawback to the Latin Hypercube is that, in general, they are not reproducible
since they are generated with random combinations. In addition, as the number of
points decreases, the chances of missing some regions of the design space increases.
The Optimal Latin Hypercube concept is illustrated in Figure B-2 on page 696 for a
configuration with two factors (X1, X2) and 9 design points. In Figure B-2 (part a), a
standard three level Orthogonal Array is shown. While this matrix has nine design
points, there are only three levels for each factor. Consequently, a quadratic model
could be fit to this data, but it is not possible to determine if the actual functional
relationship between the response and these two factors is more nonlinear than
quadratic. Figure B-2 (part b) shows a random Latin Hypercube.This matrix also
includes nine design points for the two factors, but there are nine levels for each factor
as well, allowing higher order polynomial models to be fit to the data and greater
assessment of nonlinearity. However, the design points in Figure B-2 (part b) are not
spread evenly within the design space. For example, there is little data in the upper
right and lower left corners of the design space. An Optimal Latin Hypercube matrix is
displayed in Figure B-2 (part c). With this matrix, the nine design points cover nine
levels of each factor and are spread evenly within the design space. For cases where
one purpose of executing the design experiment is to fit an approximation to the
resulting data, the Optimal Latin Hypercube gives the best opportunity to model the
true function, or true behavior of the response across the range of the factors.
Figure B-2. Optimal Latin Hypercube Configuration for Two Factors, with Nine
Points
The Optimal Latin Hypercube code implemented in iSIGHT-FD was developed by:
There are two major advances of this algorithm, compared to other optimal design of
experiments algorithms, which increase both the efficiency and robustness of the
algorithm:
Development of an efficient global optimal search algorithm, “enhanced stochastic
evolutionary (ESE) algorithm”
Efficient algorithms for evaluating optimality criteria (significant reduction in
matrix calculations to evaluate new/modified designs during search)
Jin, R., Chen, W., and Sudjianto, A. “An Efficient Algorithm for Constructing Optimal
Design of Computer Experiments,” DETC-DAC48760. 2003 ASME Design
Automation Conference, Chicago, IL, September 2-6, 2003.
Note: Since the Optimal Latin Hypercube begins as a random Latin Hypercube and is
optimized using a stochastic optimization process, this type of matrix is generally not
reproducible (unless the same random seed is reused).
The center and star points are added to acquire knowledge from regions of the design
space inside and outside the 2-level full-factorial points, allowing for an estimation of
higher order effects (curvature). The star point(s) are determined by defining a
parameter α which relates these points to the full-factorial points by
Supper = b + (u-b) x α
Slower = b - (b-1) x α
where:
α = 1, star points are the same value as the full-factorial levels (also referred to as
face-centered central composite design)
Data File
The Data File technique provides a convenient way for you to define your own set of
trials outside of iSIGHT-FD, and still make use of iSIGHT-FD’s integration and
automation capabilities. Essentially, the design matrix can be defined by data imported
from one or more files, allowing you to execute the DOE study (automatically evaluate
all the design points) and analyze the results. Any file used must simply contain a row
of tab or space separated values for each data point and a column for each parameter to
be used as a factor from that file.
Monte Carlo Simulation methods have long been considered the most accurate means
of estimating the probabilistic properties of uncertain system responses resulting from
known uncertain inputs. To implement a Monte Carlo simulation, a defined number of
system simulations to be analyzed are generated by sampling values of random
variables (uncertain inputs), following the probabilistic distributions and associated
properties defined for each.
Sampling techniques for the Monte Carlo component in iSIGHT-FD are implemented
as “plug-ins.” As such, they are extendable by creating new “plug-ins” for new
sampling techniques. For more information, refer to the iSIGHT-FD Development
Guide.
The following two sampling technique plug-ins are currently available for the
iSIGHT-FD Monte Carlo component:
Descriptive Sampling
5. Simulate the design/process (execute system analysis) using the current values for
random variables and the design variables.
6. Repeat step 3 through step 5 for the number of simulations specified in step 2.
Descriptive Sampling
The number of simulations necessary for simple random sampling is usually more than
desirable, and often more than practical. Other sampling techniques have been
developed to reduce the sample size (number of simulations) without sacrificing the
quality of the statistical description of the behavior of the system. These techniques,
called variance reduction techniques, reduce the variance of the statistical estimates
derived from the Monte Carlo simulation data. As a result, the error in estimates is
reduced (estimates from multiple simulations are more consistent), or conversely,
fewer points are needed with variance reduction techniques to obtain error or
confidence levels similar to those obtained through simple random sampling.
One such sampling technique, Descriptive Sampling (Saliby,1990), is available for the
Monte Carlo component. In this technique, the space defined by each random variable
is divided into subsets of equal probability, and the analysis is performed with each
subset of each random variable only once (each subset of one random variable is
combined with only one subset of each other random variable). This sampling
technique is similar to Latin Hypercube experimental design techniques (for more
information on Latin Hypercube refer to “Latin Hypercube,” on page 694), and is best
described through illustration as in Figure B-4 on page 701 for two random variables in
standard normal space (U-space). As shown in Figure B-4, each row and column in the
discretized two variable space is sampled only once, in random order. The cloud of
points generated using simple random sampling is also illustrated for comparison.
The difference between simple random sampling and descriptive sampling is not
necessarily observable with a single simulation using each technique. The actual
estimates may be similar. However, through repeated simulation (with different
randomization), it is observed that the variance of the set of estimates from descriptive
sampling will be less than that from simple random sampling. The range of values
observed for the estimates from descriptive sampling will be less (tighter range), and
thus the confidence in the estimates is increased. Given this property of descriptive
sampling, and variance reduction techniques in general, descriptive sampling will, on
average, provide better estimates for the same number of sampling points as simple
random sampling, or comparable estimates can be obtained with fewer sampling
points.
The basic sampling procedures can be modified to include a convergence check. The
Monte Carlo component implementation of this convergence checking procedure is
described as follows. Rather than calculating all statistics only during the post
processing analysis, the mean and standard deviation for each response is updated at
specified convergence check intervals (the default is after every 25 sample points). If,
during the current convergence check, the mean and standard deviation of all responses
have not changed from the associated values at the previous convergence check (within
a user-set convergence tolerance), the simulation is terminated. The remaining
statistics are then calculated using the existing data set. Since the Monte Carlo
Simulation points are independent, these points can be executed, for efficiency, in
parallel rather than sequentially.
Additional References
For more background information about these Monte Carlo simulation methods, refer
to:
Hammersley, J.M. and Handscomb, D.C., 1964, “Monte Carlo Methods”, Chapman
and Hall, London.
Ziha, K., 1995, “Descriptive sampling in structural safety”, Structural Safety, Vol. 17,
pp. 33-41.
Introduction
Probability distributions are used in some iSIGHT-FD components to characterize the
possible values of an uncertain random variable. Random variables will vary around a
specified mean or nominal value following a defined distribution of values based on
prescribed probabilities for those values. For a given random variable X, the probabil-
ity that X will take on a value x is defined by the probability density function for that
random variable:
where fX(x) 0 for all x. The probability that the random variable X will take on a
value less than a specified threshold value x is defined by the distribution function for
that random variable, often also termed the cumulative distribution function:
where 0 FX(x) 1 for all x. For a continuous random variable X, the probability
density function, fX(x), and cumulative distribution function, FX(x), are related as
follows:
The probability density and cumulative distribution functions for a given probability
distribution are generally defined as a function of one or more distribution parameters
that define the location, shape, or dispersion of the distribution. In this document, the
probability distribution plug-ins available in iSIGHT-FD – normal, lognormal,
Weibull, Gumbel, uniform, exponential, and triangular – are described. The probability
density and cumulative distributions are given and the translation between the
distribution parameter(s) and the mean and standard deviation statistics of a random
variable are given for each distribution type.
Note: Only continuous random variables can be modeled in iSIGHT-FD, and hence
only continuous distributions are defined here. The integral in the previous equation
becomes a summation for discrete random variables, where the summation is taken
over the discrete probability values associated with the set of values for the random
variable.
[1] Evans, M., Hastings, N., and Peacock, B., 2000, Statistical Distributions, Third
Edition, Wiley-Interscience, John Wiley & Sons, New York.
X random variable
fX(x) probability density function
FX(x) distribution function
mean
standard deviation
Euler’s constant (Gumbel)
gamma function
Normal Distribution
The normal or Gaussian distribution is a two-parameter distribution, defined in terms
of the mean and standard deviation of the random variable X. The probability
density function for the normal distribution is given as follows:
The corresponding standard normal density function illustrated in Figure B-5 is given
by:
The normal distribution is the common “bell curve” distribution, often used for
physical measurements, product dimensions, and average temperatures, for example.
Lognormal Distribution
Given a random variable X defined over 0 < x < , and given that Y = ln X is normally
distributed with mean Y and standard deviation Y, the random variable X follows
the lognormal distribution, defined by the probability density function:
Note that = Y and = Y. The mean and standard deviation of the random variable
X are given as follows:
and
The lognormal probability density function, shown in Figure B-6, is often used to
describe material properties, sizes from a breakage process, and the life of some types
of transistors, for example.
Weibull Distribution
The Weibull distribution can be defined by three parameters , , and . Its density
function fX(x) is defined by:
where > 0 is the scale parameter, > 0 is the shape parameter, and ( < < ) is
the location parameter.
The mean value and standard deviation of the random variable X with the
two-parameter Weibull distribution are given as follows:
and
The Weibull distribution can take many different shapes, as shown in Figure B-7. This
distribution is often used to describe the life of capacitors and ball bearings, for
example.
Gumbel Distribution
The Gumbel distribution is also known as extreme value distribution type I for the
largest or smallest of a number of values. The Gumbel probability density function for
largest and smallest elements are given in the following two equations, respectively:
largest element
smallest element
largest element
smallest element
The mean value and standard deviation of the random variable X for the Gumbel
distribution are given by:
largest element
smallest element
and
The Gumbel probability density function, shown in Figure B-8, is often used to
describe the breaking strength of materials, breakdown voltage in capacitors, and gust
velocities encountered by an aircraft, for example.
Uniform Distribution
The uniform distribution has a constant probability for all values of a random variable
X. The uniform probability density function is given by:
where the parameters a and b define the range of the uniform distribution. The uniform
distribution function is:
The mean value and standard deviation of the random variable X for the uniform
distribution are given by:
and
The uniform probability density function, shown in Figure B-9, is used when only a
range of possible values for a random variable is known.
Exponential Distribution
The exponential distribution is a single parameter distribution, with mean and standard
deviation equal. The exponential probability density function for a random variable X
is given by:
where the parameter λ is a scale parameter. The exponential distribution function is:
The mean value and standard deviation of the random variable X for the exponential
distribution are given by:
The exponential probability density function, shown in Figure B-10, is often used to
describe usage life of components.
Triangular Distribution
The triangular distribution is characterized by three parameters: a lower limit location
parameter, a, and upper limit location parameter, b, and a shape parameter that defines
the mode or peak of the triangle, c. The triangular probability density function for a
random variable X is given by:
The mean value and standard deviation of the random variable X for the exponential
distribution are given by:
and
The triangular probability density function, shown in Figure B-11 on page 714, is
commonly used when the actual distribution of a random variable is not known, but
three pieces of information are available: a lower limit which the random variable will
not go below, an upper limit which the random variable will not exceed, and a “most
likely” (expected peak) value.
The Monte Carlo sampling performed at each step uses the Descriptive Sampling
Monte Carlo technique. For more information on Descriptive Sampling, see
“Descriptive Sampling,” on page 700. Samples are taken following the random
variable distributions and uniformly across a local range for design variables. For more
information on distribution functions, see “Understanding Distribution Types,” on
page 702.
At each SDI step, the selection of an improved point, or decision to terminate, is based
on calculation of the distance of each point to the target point, as described in the
following section.
Distance to Target
The target point is defined by the target values of all responses for which a target is
defined. The distance between any sample point and the target is calculated based on
the euclidean distance equation, with a penalty built in if the sample point is outside
any response constraint(s):
where,
the penalty is a large value added to the distance if the sample point lies outside one or
more response bounds.
For a given SDI step, the distance to the target is not reduced at least by the amount
specified in the Termination Threshold Distance (percent change from previous step),
the SDI process is terminated.
We imagine that our mountain range is aptly described by a “cost function” (Objective
and Penalty parameter in iSIGHT). We define probability distributions of the two
directional parameters, called generating distributions since they generate possible
valleys or states we are to explore. We define another distribution, called the
acceptance distribution, which depends on the difference of cost functions of the
present generated valley we are to explore and the last saved lowest valley. The
acceptance distribution decides probabilistically whether to stay in a new lower valley
or to bounce out of it. All the generating and acceptance distributions depend on
temperatures.
In a D-dimensional parameter space with parameters p^i having ranges [A_i, B_i],
about the k'th last saved point (e.g, a local optima), p_k^i, a new point is generated
using a distribution defined by the product of distributions for each parameter, g^i(y^i;
T_i), in terms of random variables y^i in [-1, 1], where p_k+1^i = p_k^i + y^i(B_i -
A_i), and “temperatures” T_i, g^i(y^i; T_i) = 1/[2(|y^i| + T_i)(1 + 1/T_i)].
The cost functions, C(p_k+1) - C(p_k), are compared using a uniform random
generator, U in [0, 1), in a “Boltzmann” test: If exp[-(C(p_k+1) - C(p_k))/T_cost] > U,
where T_cost is the “temperature” used for this test, then the new point is accepted as
the new saved point for the next iteration. Otherwise, the last saved point is retained.
The annealing schedule for each parameter temperature, T_i, from a starting
temperature T_i0, is as follows:
The annealing schedule for the cost temperature is developed similarly to the
parameter temperatures. However, the index for reannealing the cost function, k_cost,
is determined by the number of accepted points, instead of the number of generated
points as used for the parameters.
initial cost temperature and the maximum of the absolute values of the best and last
cost functions and their difference. The new k_cost is calculated taking T_cost as the
maximum of the current value and the absolute value of the difference between the last
and best saved minima of the cost function, constrained not to exceed the current initial
cost temperature. This procedure essentially resets the scale of the annealing of the cost
temperature within the scale of the current best or last saved minimum.
The following are the sequence of steps followed by the Modified Method of Feasible
Directions technique:
1 q = 0, x = x0
2 q=q+1
The Modified Method of Feasible Directions technique uses one of the following
methods to find the search direction at each iteration q:
If no constraints are active or violated, the (previously described) unconstrained
method Conjugate Gradient method is used
If any constraints are active and none are violated, the Modified Method of
Feasible Directions
Minimizes F(xq-1) x Sq
Sq x Sq 1
If one or more constraints are violated, the Modified Method of Feasible
Directions
Minimizes F(xq-1) x Sq -
Sq x Sq 1
Where: J is the set of active and violated constraints
convergence parameter, rho, that lets you determine the number of function
evaluations needed for the greatest probability of convergence.
It has been said that one of the problems with optimization is that “there is nothing you
can say about an arbitrary system”. This statement is correct to some extent. However,
based on many years of experience in applying optimization to various engineering
problems, the following observations can be made. First of all, a system can be
classified once more is known about it. Secondly, once classified, there is some
combination of optimization methods that would work better than random guessing.
Knowing the type of system you have is critical to being able to solve the system
efficiently. Optimization theory has always been developed the other way around.
Assuming that the system has a certain mathematical form, what is the most cost
efficient way of optimizing this system? Over time, a large collection of optimization
methods based on such assumptions were developed. Each of these methods had many
degrees of freedom to adapt the method to the problem at hand. In essence, the specific
problem that people wanted to solve (e.g., design a lighter structure) was now
transformed into finding the right algorithm for designing the structure. This second
task was in many ways a harder task than the original. For many engineers and
scientists, the problem was transformed from a known to an unknown domain. As a
consequence, optimization technology did not become the big commercial success
many had hoped for.
Thus the issue of control became a driving factor in the development of the Pointer
optimization engine. Pointer uses a proprietary algorithm that automatically controls a
set of optimization resources. Similarly, Pointer efficiently solves a wide range of
problems in a fully automatic manner by harnessing and leveraging the power of a
group of distinct complementary optimization algorithms.
The Pointer control algorithm varies the optimizer settings in such a way that either:
1. The best answer is found in the shortest time. In this case the optimizers are
configured such that the maximum rate of improvement of the objective function is
achieved from a single starting position.
2. The most experience is gained. The optimizer settings are selected in such a way
that the highest optimizer robustness is achieved for a given optimization time. The
robustness is defined as the mean harmonic error of the best objective function
(ever found) normalized by the local optimum for a set of random starting vectors.
This approach is an order of magnitude slower than merely finding the best answer,
but the experience gained will allow you to solve similar classes of problem in the
shortest possible time.
Usually, it is not possible for the user to identify the problem topology in such a way
that he/she can select the proper algorithms and settings. A real-life example is shown
in Figure B-14. The topology is that of the drag of an airfoil computed by CFD as a
function of its shape. Previously, the user (from experience) assumed that the drag was
a smooth function of the geometry. From the starting point, a small step was selected to
calculate the gradients accurately. Because the topology of the drag had surface waves,
the steepest downhill slope was considered to be along this wave. If the user had
picked a larger step size, he/she would have concluded that the direction normal to the
waves has the “relevant” steepest downhill slope.
These waves are not caused by the physics of the problem (drag), but by numerical
interference of converging loops inside the numerical code that calculates the drag.
Almost all simulation codes that use partial differential equations exhibit such
behavior. Note that the spikes in this plot represent code-crashes, another difficult
topological feature not inherent in the real physics.
A dozen approaches were identified to correct pathological topologies and find the
correct relevant search direction. These pathological topologies are created by the type
of numerical algorithm used in the simulation code and not by the specific design
problem the simulation code addresses. Therefore, the solution that Pointer presents is
valid over a wide range of topologies.
For smooth problems, the best optimizer is the sequential quadratic programming
(SQP) algorithm. The SQP algorithm uses function calls close to the starting point to
determine the topology of the problem. SQP is widely used in trajectory optimization
and structural optimization.
The SQP algorithm used in Pointer is NLPQL, developed by Dr. Klaus Schittkowski,
which solves general nonlinear mathematical programming problems with equality and
inequality constraints. It is assumed that all problem functions are continuously
differentiable. Proceeding from a quadratic approximation of the Lagrangian function
and a linearization of the constraints, a quadratic subproblem is formulated and solved
by the dual code QL. Subsequently, a line search is performed with respect to two
alternative merit functions and the Hessian approximation is updated by a modified
BFGS-formula.
A third algorithm in Pointer is the so-called evolution or genetic algorithm. SQP and
downhill simplex determine analytically where the best answer is based on previous
objective function calls. Genetic algorithms work well because they incorporate
randomness in their search. It gives the algorithm the ability to correct deterministic
search bottlenecks. No objective function continuity is required for this method.
Genetic algorithms almost always work. However, they are not often the best
algorithms to use because of their very high computational expense.
However, any optimization problem can usually be solved when the right answer is
already known and the starting point “tweaked”. This comparison will therefore focus
on the added value of Pointer versus the already good set of core algorithms.
Although many problems have been solved with Pointer, this section uses a truss
optimization problem because it represents a typical design problem in mechanical or
aerospace engineering. Figure B-15 shows a truss as it supports a series of point loads.
The bridge is supported at the right edge and free at the left edge. It has six joints
whose positions are chosen by the optimizer so as to minimize the weight or cost
subject to a given set of loads. The weight is computed by determining the minimum
bar dimensions that can support the applied load.
The problem is hard because, as the joints locations move with respect to each other,
the loads on the bars change from compression to tension and back. A bar under
compression has to be much thicker (thin-walled cylinder) than a bar under tension
(wire). The weight of the truss structure is therefore a discontinuous function of the
locations of the joints.
The optimization task was to minimize the weight of the truss in 30 minutes. In 1993,
Mathias Hadenfeld completed the task of optimizing the truss from a random starting
point. Hadenfeld was an expert user of optimization. He was free to tweak and restart
the solution until he felt that no more progress could be made, but he could not change
the starting point. His results are shown in Figure B-18 on page 731 (blue symbols).
On average he had more success with the genetic algorithm than the downhill simplex
method, and the gradient method failed completely. On average his answers were 15%
away from the known optimum due to the difficult topology of the problem.
In 1999, the same problem was given to 13 groups of between 7 and 15 professional
engineers. They were given Pointer and its graphical user interface displaying the truss.
They were asked to minimize the weight without using the optimization. They had to
manually input the joint coordinates and run the analysis to see whether an
improvement was made. Since an analysis could be done in less than a second, 30
minutes was ample time to complete the task. The number of iterations was between 10
and 30. In our experience this also represents the average number of industrial product
design iterations.
The groups of engineers came up with vastly different answers. Some were more than
twice as heavy as the best solution. However, some came up with solutions that were
within 5% of the right answer. It is interesting to note that they only achieved these
results through the use of the graphical representation of the truss. In a subsequent test
without the graphics, no engineer came within 20% of the optimizer's best answer.
Next, Pointer was given the control over the core optimizers (red symbol). Just like the
expert, Pointer required less function calls to find the answer with genetic algorithm
than with the downhill simplex algorithm. But with its standard settings, which allow
the optimal use of all algorithms, Pointer was able to consistently get the right answer
from any starting point with just 1000 function calls (< 1 minute).
Even though the group of experts got very different answers when solving the problem
manually, all achieved the correct answer when using Pointer under its standard
settings.
Figure B-18 on page 731 shows the result of the test. Nevertheless, maybe not
surprisingly, Pointer performed exceedingly well on the test. It was the only code
capable of solving all the problems. This is all the more impressive considering that the
same standard settings were used for all the test cases and that there was no expert
intervention in the process. In terms of speed it is usually comparable to the best codes
for each of the specific problems. The “best” benchmark results were provided by Dr.
Egorov the author of IOSO. Other codes in the comparison were IOSO, NLPQL,
DONLP, and MOST.
Figure B-17. Design of a Truss for Minimum Weight Using Various Tools
Summary
The Pointer technique consists of a complementary set of optimization algorithms:
linear simplex, sequential quadratic programming, downhill simplex, and genetic
algorithms. Since all the optimizer control parameters are automatically set with a
special control algorithm, Pointer can efficiently solve a wide range of problems in a
fully automatic manner. This was demonstrated by benchmarking the code with Eric
Sandgren's optimization benchmark test. Pointer was the only algorithm that could
solve all problems and was usually as fast as the best algorithm known for each of the
individual test problems.
Pointer References
Schittkowski, K., “NLPQL: A Fortran subroutine for solving constrained nonlinear
programming problems”, Annals of Operations Research, Vol.5, 485-500. 1985.
Ashley, H., “On Making Things the Best - Aeronautical uses of Optimization”, Wright
brothers lectureship in aeronautics, Journal of Aircraft. vol. 19 No. 1. 1982.
Dr. Spellucci:
(http://www.mathematik.th-darmstadt.de/ags/ag8/spellucci/spellucci.html).
Great changes were applied to the original NSGA to create NSGA-II. The only
common feature between the two was adopting non-dominated sorting. NSGA-II has
Pareto archive P and population Q for genetic search just like SPEA. However, it
utilizes Pareto archive more aggressively. In NSGA-II, the number of individuals in
archive P is N, and it is equal to the number of individuals in population Q. On the
other hand, in SPEA, the best number of individuals in archive P is generally perceived
as one-fourth of the individuals in Q. Genetic operators of crossover and mutation are
performed on population , and the selection for extracting the next generation was
applied on set union , creating . The selection consists of two mechanisms:
“non-dominated sorting” and “crowding distance sorting.” was generated from
by means of selection, the so called “Mating selection.”
Meanwhile, Zitzler improved his SPEA. SPEA2 was proposed in 2001. SPEA2 was an
improvement over SPEA in the following areas:
The second point mentioned above is the same as the mechanism used in NSGA-II.
Moreover, SPEA2 and NSGA-II have the following common points between them:
In other words, the outline of the algorithm is similar in both NSGA-II and SPEA2, and
the differences exist only in the definition of fitness, the reducing mechanism of the
archive, and the selection for . Today, these two algorithms are the main methods
for multi-objective Genetic Algorithm. It is also said that the performance of the two is
almost even.
single-objective Genetic Algorithm. The idea of Pareto optimality was not explicitly
included.
The first multi-objective Genetic Algorithm that adopted the idea of Pareto optimality
explicitly was MOGA (Multi-Objective Genetic Algorithm), proposed by C.M.
Fonseca and P.J. Fleming in 1993. In the remainder of this section, this algorithm is
referred to as “Fonseca's MOGA,” in order to distinguish it from the generic
designation of Multi-Objective Genetic Algorithm.
Although Fonseca's MOGA was the first multi-objective Genetic Algorithm that
adopted the idea of Pareto optimality explicitly, problems were reported. In the
calculation of fitness with niching, as mentioned previously, the algorithm sometimes
generated irrational fitness values, such as solutions on the Pareto front that had lower
fitness due to niching.
This means that solutions on the Pareto front will have the highest fitness value. It is
similar to Fonseca's MOGA in that is performs niching based on the sharing distance.
Pareto optimality and the idea that crowding level and ranking value are equal to
fitness in SPEA.
The term “neighborhood cultivation” means that the individuals to be crossed over
must be within a certain range of the objective space. The idea comes from research for
improving the searching performance of multi-objective Genetic Algorithm by means
of dividing populations into sub-populations, and sending each sub-population onto
distributed CPUs in a network environment. In the divided population of such
multi-objective Genetic Algorithms, a division is decided by one of the element
objectives. Genetic operators are applied in each divided sub-population.
Consequently, in the divided model, crossover operations are performed between
neighbors, which are grouped by the division based on an objective. From a series of
numerical research on this divided population model, it was concluded that crossover
with similar individuals would produce better results than that of greatly differing
individuals. The “neighborhood cultivation” is the crossover operation that performs
the crossover with similar individuals. When the number of objective functions is p,
individuals are sorted according to one of those objective functions, and crossover is
performed by two adjoined pairs. The objective function of each generation that is used
for sorting is changed. However, with complete sorting there is a danger of loss of
diversity in the solution. For this reason, around five percent of the disturbance is
applied on sorted individuals before the crossover operation.
The method of selecting the search population Q(t+1) from the Pareto archive P(t+1) in
NCGA involves simply copying archive P(t+1) of N individuals onto Q. On the other
hand, Non-dominated Sorting Genetic Algorithm - NSGA-II and SPEA2 select
individuals by binary tournament selection with repetition. For more information on
these two algorithms, see “NSGA-II Reference Information,” on page 732. This
difference relates to the standpoint of whether to put the selection pressure onto elites.
The disadvantage of this option is that the selection pressure can result in lost diversity,
and lend to a danger of being trapped in a local optimum.
A research group tested NCGA and compared it with NSGA-II and SPEA2 with
numerous test functions, including an element knapsack problem. They concluded that,
when the following are true, NCGA provides better results than NSGA-II or SPEA2:
NCGA References
Major references and papers are listed below. The references apply to the
Neighborhood Cultivation Genetic Algorithm - NCGA and Non-dominated Sorting
Genetic Algorithm - NSGA-II sections only.
RBF Model
Radial Basis Functions are a type of neural network employing a hidden layer of radial
units and an output layer of linear units, and characterized by reasonably fast training
and reasonably compact networks.
Weissinger (1947) was the first to use numerical potential flow to calculate the flow
around wings. The potential flow equations are a radial basis function. R. Hardy(1971)
realized that the same concept could be used to fit geophysical data to geophysical
phenomena. Broomhead, D. S., and D. Lowe (1988) renamed this technology “neural
nets” and it was subsequently used to approximate all types of behavior.
Usage in iSIGHT-FD
In iSIGHT-FD we follow the Hardy (1972) method as described by Kansa (1999):
Obviously, as the type of physics that are models varies a different type of basis
function would be needed to provide a good fit. The response surface goes through all
the given interpolation data.
For the iSIGHT-FD implementation, the following variable power spline radial basis
function is used:
The reason for choosing this radial basis function is its ability to model extreme
functions within a narrow range of values of c.
For a value c = 1.15, a good approximation of a step function can be achieved with just
seven interpolation points. For a value of c = 2, a good approximation of a linear
function can be achieved with just three interpolation points, as shown below.
Picking c = 3 for the step function example would produce an approximation that
would go through the seven data points, but it would more resemble a single sine wave
than a step function. There are obviously an infinite number of solutions that will go
through any given set of data points.
In most of the literature this problem is solved by splitting the interpolation data into
two groups. One group is used to create the radial basis function approximation and
one is used to compute the error between the radial basis function approximation for
those points and the actual function values. The shape function is optimized to
minimize the summed errors. This is a valid approach when a lot of data points are
available for the interpolation, but in our practice we deal mostly with very sparse data
sets and it seems inefficient to use only half the data to create the actual response
surface.
So we adopted a different approach. We define a good fit as one whereby the shape of
the curve does not change when a point is subtracted. We optimize the value of c for a
minimum sum of the errors N-1 data points.
This approach can be illustrated by going back to the picture of the straight line
approximation, we approximate the first point (circle) from the two top points (square).
The center point is approximated from the two extreme points and the top point is
approximated from the two bottom points. For c = 2 the sum of the errors for the
“missing points” is low.
For c = 0.2, the sum of the errors of the “missing points” is extremely high.
Note: We would like to thank Dr. Kansa for getting us started with the development of
this method.
References
J. Weissinger. “The lift distribution of swept-back wings”. NACA TM 1120, 1947.
Kansa, E.J. “Motivation for using radial basis functions to solve PDE's”. 1999.
(Unpublished paper: author [email protected]).
Where:
Notice that 3rd and 4th order models in iSIGHT-FD do not have any mixed polynomial
terms (interactions) of order 3 and 4. Only pure cubic and quartic terms are included to
reduce the amount of data required for model construction. A lower order model
(Linear, Quadratic, Cubic) includes only lower order polynomial terms (only linear,
quadratic, or cubic terms correspondingly).
The number of initial design points (if Random Designs is used for initialization)
The fraction of the design space around the baseline design in which the initial
random designs are generated (if Random Designs is used for initialization)
This fraction of the design space is referred to as Random Designs Range. This
option can be set individually for each input parameter. The bounds of the design
sub-space are determined by multiplying the value of Random Designs Range for
each input parameter by its initial value (baseline value) and then subtracting or
adding the result to the baseline value.
This option allows you to select a sub-set of polynomial terms using one of the
four available term selection methods (Sequential Replacement, Stepwise
Regression (Efroymson's algorithm), Two-at-a-time Replacement, or Exhaustive
Search). More information about term selection is provided in the next section.
Since a singular system does not guarantee predictable model behavior, iSIGHT-FD
will adjust the Number of Designs for Initialization, if the user specified insufficient
number of designs for calculating all polynomial coefficients. It is recommended that
you use the value of the Number of Designs for Initialization equal to (or slightly
greater than) the number of polynomial coefficients, which for a linear polynomial is
(N+1), for a quadratic polynomial is (N+1)(N+2)/2, for a cubic polynomial is
(N+1)(N+2)/2 + N, and for a quartic polynomial is (N+1)(N+2)/2 + 2N, where N is the
number of input variables.
If you plan to use an approximation in optimization and want to minimize the number
of simcode executions, it is recommended that you set the value of Polynomial Order
to Linear, if a model is constructed using Random Designs initialization mode. During
optimization, approximations are updated with new design points. New design data is
used for calculating unknown polynomial coefficients of the model, thereby gradually
upgrading the model up to a higher order polynomial (quadratic, cubic, or quartic
polynomial, depending on the Maximum Polynomial Order of the model). Using linear
initial polynomial allows you to initialize the model faster, and start optimization
earlier. A linear model is sufficient for determining initial search direction for the
optimizer. As the optimization progresses, more and more designs are analyzed closer
to the optimum design, and used for calculating the model coefficients, thus improving
the accuracy of the model in that area.
Updating an RSM can be controlled via the Optimization Options (on the Setup tab of
the Approximations dialog box) or completely disabled. The default behavior is to add
a new design point and add one new polynomial term. This behavior is preferred
during optimization. iSIGHT-FD also allows you to generate a new set of random
designs and re-initialize the model every time when it is supposed to be updated. This
option can be beneficial with highly non-linear objective and constraint functions.
Setting the value of Polynomial Order to Quadratic, Cubic, or Quartic is justified when
a high accuracy of the model is desired right from the start. It is recommended for all
cases when the approximation will not be updated with new points during execution of
a design exploration plan, i.e., for all non-optimization plans such as Design of
Experiments (DOE), Monte Carlo Simulation, Reliability Analysis, and Robust
Analysis. In the case of optimization plans, including Reliability-Based Optimization
and Six Sigma Robust Optimization, using a higher Polynomial Order is recommended
when a large area of the design space is sampled (accuracy of low order models is low
over a large area), when sufficient data is available in a database file (Database File
Initialization), or when the standard approach of using a Linear model and gradually
upgrading it to a higher order model during optimization does not produce a desired
result.
Selects the best model when a limited number of design points are available
Reduces cost of the model re-initialization for computationally expensive analyses
Given a set of k predictor variables X1, X2, X3,…,Xk, select a subset of p (p<k)
predictor variables that minimizes the Residual Sum of Squares:
In the case of RSM term selection, predictor variables are the polynomial terms, X1,
X2,…, X1^2, X2^2, …, X1*X2, etc. The best combination of the polynomial terms is
selected so that the Residual Sum of Squares is minimized. Since the residuals can be
non-zero only when the model has at least one degree of freedom, minimization of the
RSS implies that the maximum number of polynomial terms selected must be lower
than the number of design points used for the RSM. Otherwise the RSS will be exactly
zero and no term selection will be possible.
The four term selection methods available in iSIGHT-FD have the following features:
start with the constant term, select the next best term
at every step of the forward selection, for every previously selected term find
the best replacement that will decrease the RSS and swap the variables
The Sequential Replacement algorithm does not guarantee the best model.
start with the constant term, select the next best term
at every step of the forward selection, add the next best term if it sufficiently
decreases the RSS using the following criterion
at every step of the forward selection, check if one of the selected terms can be
dropped without appreciably increasing the RSS using the following criterion
repeat the process until no more terms satisfy the first criterion or until the
maximum desired number of terms is selected
start with the constant term, select the next best term
find the best replacement combination that will decrease the RSS and swap the
variables
The Exhaustive Search algorithm is the most expensive one from the four
available. It guarantees finding the best model at the cost of a high computational
time. The number of design points and the number of selected terms will greatly
affect the computational cost, and can make this algorithm a non-viable option for
large data sets and a large number of inputs.
C Glossary
A
ACL. Abbreviation for Access Control List. A method for setting object permissions.
The list contains users that have access to a specific object published to a Library, and
determines the extent of their permission.
Application Control System (ACS). The major part of the FIPER environment. It is a
collection of software (including an application server and a database) that controls the
internal operation of the entire FIPER system. It provides a workflow engine for
interpreting and managing process flow to create work items, a dispatcher for
determining which FIPER Station the work item should be sent to, and a results
manager for processing results from the work items. iSIGHT-FD can connect to an
ACS and, thereby, the FIPER environment.
Application Server. Also called an appserver. This software is used in tandem with a
database (DB2 or Oracle) to create an ACS in the FIPER environment. The appserver
itself is a program that handles all application operations between users and an
organization's backend business applications or databases. Application servers are
B
B2B. Short for business-to-business, the exchange of services, information and/or
products from one business to another, as opposed to between a business and a
consumer. This feature is only available when iSIGHT-FD is used in the FIPER
environment. In this environment, B2B is primarily utilized to describe the sharing of
components and models between organizations. It is not primarily focused on
peer-to-peer collaboration (services such as WebEX and NetMeeting). Typically,
organizations will communicate between each other's ACS’s, utilizing Web Services in
a federated model environment.
C
Calculator Component. An activity component that is used to define computations
that are not provided by a separate part of your model. It can be used to solve
mathematical expressions, and it supports all major mathematical operations.
Class. A category of objects. For example, there might be a class called shape that
contains objects that are circles, rectangles, and triangles. The class defines all the
common properties of the different objects that belong to it. See metamodel.
Cloned Window. A cloned window in the Design Gateway interface allows end users
to bring up the same model in two views. Changes to one window are incorporated into
the other window as well. This allows users to view different levels of workflow,
hierarchy simultaneously.
Command Line Client. A console (character mode) program that provides simple
text-based access to functions of iSIGHT-FD. This console has even more capability
when used with the FIPER environment.
Component Editor. The Component Editor is the unique interface for each
iSIGHT-FD component that allows an end user to modify certain attributes of the
component. The attributes exposed to the end user are determined by the component
developer.
Component Generator. For those tools/applications that require a more complex form
of interaction or that have Application Programming Interfaces (APIs) that can be
taken advantage of to expose more functionality (or even if a custom interface is
simply desired), iSIGHT-FD provides a standard Java-based wrapping mechanism to
allow you to easily create components for the environment. The iSIGHT-FD
Component Generator is provided to help you write the necessary Java code and
package it as a component. The Component Generator consists of a set of API
functions and a wizard to lead a component developer step-by-step through the
wrapping process. For more information, refer to the iSIGHT-FD Development Guide.
Component Palette. The Component Palette is an area on the Design Gateway that
allows users to store icons that represent components in the Library. From the palette,
components can be dragged and dropped to the Workflow tab canvas to create or alter a
model.
Component Template. Part of a metamodel, and defines the structure and behavior of
a particular type of component. Normally it will show up in the component palette of
the iSIGHT-FD Design Gateway.
D
Dashboard. See System Dashboard.
Dataflow. A view of a model that shows the parameter mappings that occur between
individual components in a workflow process. In the Design Gateway interface, users
can switch between a dataflow and workflow view.
Design Gateway. The main iSIGHT-FD interface, it is the primary means for
accessing the Library, building workflows, executing models, and viewing results. It is
primarily used by model developers and assemblers. See Runtime Gateway.
Design Time. This refers to the process of model assembly. It is not required that this
process be carried out with a particular tool, or that it involve human interaction at all.
However, an expert in the problem domain will typically perform model assembly with
a graphical design tool. This term is not intended to encompass the writing of
components by a component developer.
E
EDM. A results viewing tool that provides post-processing functionality for
multi-objective optimization by analyzing the results and effectively visualizing Pareto
solutions and sorting (screening) the data interactively. The multi-objective technique
provided in iSIGHT-FD is NSGA-II.
Encapsulate. A feature in the Design Gateway that allows you to move a workflow
process into a driver component. For instance, if you have created a workflow that has
an Excel component, Word component and Email component, then realize you would
like to perform design studies by modifying Excel parameters, you could select
Encapsulate from the menu, and place the workflow within a DOE Component.
End User. An end user is a person who loads an existing model into iSIGHT-FD to
execute it, experiments with design parameters, and reviews results. Typical examples
of End User use cases are to use either the Runtime Gateway or WebTop interface to
access an iSIGHT-FD model and execute it (or a subset of it) and to monitor/review
results of the execution(s) using graphs/tables to evaluate the progress toward
achieving design improvement.
Exit Status. Integer value returned by an external application to the operating system
when the external application exits. By default, a zero value indicates the external
application terminated normally and a non-zero value indicates the external application
terminated due to an error. Developers can specify a list of additional exit codes that
signify normal termination.
F
FIPER Station. In a FIPER environment, these are computers in the network that have
been registered with the ACS. They handle the execution of work items, essentially
consisting of a lightweight framework for receiving work items, communicating with
the Library, executing components (likely launching corresponding back-end software
applications), and returning results. The ACS dispatches work items to FIPER Stations
based on a defined load-balancing scheme, distribution strategy, and/or affinities (i.e.,
operating system information, third party software licenses supported, machine name,
etc.) defined for the item being executed. In this way, an organization can make the
best use of its computing resources by making them available to do work within the
FIPER environment. FIPER Stations are not used in the iSIGHT-FD local execution
environment.
G
Graphical User Interface (GUI). In iSIGHT-FD there are several graphical user
interfaces. They allow you to use the “point and click” method of making selections
and executing commands, rather than entering syntax. These interfaces include the
Design Gateway, Runtime Gateway, component editors, EDM, the Approximation
Viewer, and the Generator.
I
iSIGHT Component. An activity component that allows pre-built iSIGHT
applications (in the Tcl architecture) to be executed from iSIGHT-FD. It is one-way
execution. That is, iSIGHT-FD components cannot be executed from iSIGHT.
iSIGHT File Parser. An activity component that allows an iSIGHT-FD model to use
file parsing programs (FDL) created using the iSIGHT Advanced Parser. This feature
is mostly to aid in converting iSIGHT models into iSIGHT-FD models.
J
Java. A high-level programming language developed by Sun Microsystems. Java was
originally called OAK, and was designed for handheld devices and set-top boxes. Oak
was unsuccessful so in 1995 Sun changed the name to Java and modified the language
to take advantage of the burgeoning World Wide Web.
Jar. Short for Java Archive, a file format used to bundle all components required by a
Java applet. JAR files simplify the downloading of applets since all the components
(.class files, images, sounds, etc.) can be packaged into a single file. In addition, JAR
supports data compression, which further decreases download times. By convention,
JAR files end with a *.jar extension. As an example, iSIGHT-FD components are
stored as JAR files.
JDK. Java Development Kit, which is comprised of the software and tools needed to
compile, debug, and run Java applets and applications.
JMS. Messaging systems are used to build highly reliable, scalable, and flexible
distributed applications. This article discusses messaging systems in general, providing
an overview of their features and types, and then describes how developers can write
message-based applications using Java Message Service (JMS).
The Java Message Service provides a consistent API set that gives developers access to
the common features of many messaging system products.
Job. Model execution is submitted as a job. A job in iSIGHT-FD is the highest unit
level of work. A job consists of a model, optionally some initial data or values, and job
control information, such as logging level. Jobs are identified by a unique ID
(generated by the system when the job is submitted) and a readable job name provided
by the user or generated by the Runtime Gateway. The readable job name does not
have to be unique. A job is created when a model and job control information is
submitted to the ACS for execution, or run locally in the Runtime Gateway. Jobs
progress through a series of states as they execute, until they reach the “Done” state. A
job that is done is persisted (saved) by the ACS for later analysis. Jobs run locally in
the Runtime Gateway may or may not be saved depending on how the users’s
preferences are configured.
L
LDAP. Abbreviation for Lightweight Directory Access Protocol. LDAP is an Internet
protocol that programs use to look up information from a server. In the FIPER
environment, the FIPER ACS can use an LDAP server to authenticate users and
determine security settings, which allows the ACS to know what privileges users have
when accessing the ACS through iSIGHT-FD.
Library Record. An object containing the name and properties of a published object.
A Library Record may, but need not, contain the implementation of that published
object.
Library Record Group. An object containing the name and a subset of the properties
of one or more published objects, plus a list of Library Records sharing that name and
those properties.
M
Mail Component. An activity component that is used to send e-mail notification of the
status/progress of an executing iSIGHT-FD job. iSIGHT-FD parameter values can be
included in the body of the e-mail message, and parameters or files from a disk can be
added as attachments. The component can be configured to send a message to multiple
recipients.
MATLAB. An activity component that allows you to send data to MATLAB, execute
commands/scripts, and retrieve data from MATLAB.
Model Explorer. A portion of the Design Gateway and Runtime Gateway that allows
you to easily navigate between components in your model. It resembles a tree structure
on the left side of the interface, and includes the Model Selector and Model Properties
button.
MySQL. A database program, created by MySQL AB, that is used to save results
information when executing a model locally (not as part of an ACS in the FIPER
environment).
O
Objective. Parameter that the system uses to measure the effect of a change in the
design variables. The system attempts to maximize or minimize an objective when
optimizing a design. An objective is a response when executing a DOE experiment.
Objective Weight. An optional value used to scale a parameter's value when several
objectives are to be compared to each other. The parameter's value is divided by the
objective divisor and multiplied by the weight to obtain a relative value that can be
used in the comparison.
P
Parallel Workflows. Parallel workflows allows you to specify components that
execute at the same time (in parallel) during the execution of your model. The models
that execute in parallel must be subcomponents of a main component.
Parameters. A named entity that can store a real, integer, or string value.
Parameter Group. A named entity that stores a set of parameter names and parameter
group names.
the same component. A change to the original component will be propagated to all
referenced instances.
Platform LSF. Abbreviation for Load Sharing Facility (LSF). In the FIPER
environment, it is a third-party distributed resource management system (provided by
Platform Computing) that the ACS can be configured to use instead of the default ACS
distributed resource management system. It is used to schedule FIPER ACS
workitems.
Properties. Quantities associated with a component that describe how the application
that the component wraps is to be used or specifies information required by the
application (e.g. files, executable calls, etc.). Properties are typically process-oriented
quantities, and are defined for the component type as a whole (each use/instance of the
component will have all properties defined in a descriptor (described later) for the
component (values for the properties will be set based on specific instance usage).
PSE. Abbreviation for the old name of the Application Control System (Problem
Solving Environment). See Application Control System (ACS).
Published Object. An object with a name, properties, and implementation, which has
been inserted into a Library and which may be fetched from that Library.
R
Reference Component. An activity component that allows you to integrate a
previously created and saved model into your current model. This previously created
model can be stored in your Library or in the Library of a remote partner. You can also
choose a submodel of the current model as a referenced object.
Root User. Also known as Root Access or simply root. A user on UNIX or Red Hat
Linux who has complete access to a system (similar to an Administrator on Windows).
Root access is necessary for some installations in the FIPER environment. It is not
necessary for installing iSIGHT-FD.
Run. A particular execution of a model in a session with a particular set of run data.
Run Context. User provided information for the run, such as parameters, data sources,
and execution policy (e.g. parallel), etc.
Run Database. A database containing the run records of one or more components.
Run Record. Data describing the input and output data for a component's run. The run
data include parameter values needed by the component to begin execution (these are
the inputs to the component, I), parameter values produced by the component (these
are the component's outputs, O), and any additional supporting information (S) needed
to restore the component to its apparent state at the end of the run. The system can look
up a run record (I,O,S) in lieu of executing the component by retrieving (O,S) given (I).
Runtime. This refers to the process of executing an iSIGHT-FD model. This means
carrying out the actions implied by the configuration of the components in the model.
This process executes in the ACS.
S
Script Component. An activity component that allows you to execute java code in
your model. The component uses the Dynamic Java interpreter to run the script.
Security. Refers to techniques for ensuring that data stored in a computer cannot be
read or compromised. Most security measures involve data encryption and passwords.
Data encryption is the translation of data into a form that is unintelligible without a
deciphering mechanism.
Service. This term is often confusing in the iSIGHT-FD context. Within iSIGHT-FD, a
service is simply a capability or functionality that is made available to the system
through the infrastructure, or by creating components that access features from other
tools or methods. By contrast, refer to the service discussed in the definition of
daemon.
Session. It is a runtime instance of an unsaved model; it can support multiple runs with
different set of run contexts. It can live without an interface attached, and it can be
re-connected later from multiple clients.
Shared Library. The shared Library is a set of iSIGHT-FD models and metamodels,
which are stored using the naming and directory services. The underlying services
provide the basic distribution and access protocols that can make the Library available
across a series of users, systems and organizations. iSIGHT-FD adds security
mechanisms that control access to data stored in the shared Library.
SQL. Abbreviation for structured query language, and pronounced either “see-kwull”
or as separate letters. SQL is a standardized query language for requesting information
from a database. The original version called SEQUEL (structured English query
language) was designed by an IBM research center in 1974 and 1975. SQL was first
introduced as a commercial database system in 1979 by Oracle Corporation.
Historically, SQL has been the favorite query language for database management
systems running on minicomputers and mainframes. Increasingly, however, SQL is
being supported by PC database systems because it supports distributed databases
(databases that are spread out over several computer systems). This enables several
users on a local-area network to access the same database simultaneously.
State. Values and other settings saved as a unit. For example, parameter values,
optimization technique settings, constraints, and so on. The system state may be saved
in whole or in part. Structural data (such as the relationships between components in
the system) are not part of a state.
Submodel. Portions of the current model that are designated for use in other parts of
the model. This designation allows a single instance of a component to be easily used
in numerous places in a workflow.
System Dashboard. The interface that allows aspects of the FIPER environment
(FIPER Stations, and ultimately, users) to be monitored. It is primarily used by System
Administrators.
T
Task Component. A process component that provides organizational structure by
serving as a container for other components. The component can be a simple
component that always executes a subflow once, unlike other components (such as
Loop) that may execute a subflow numerous times. It also grants access to the Task
Plan feature, which allows you to apply a design driver or sequence of design drivers to
a workflow of analysis tools.
Task Plan. A feature, accessed through the Task component editor, which allows you
to apply a design driver or sequence of design drivers to a workflow of analysis tools.
Template. A model in which all of the properties and/or initial parameter values have
not been specified. Such a model may be useful as a sample to create any number of
similar models.
Time Limit. Time allowed for some component to execute, measured from the start of
that component's execution. If the time limit is exceeded, the system may abort
execution of that component and behave as if that component terminated with an error.
V
VPN. Abbreviation for virtual private network. A VPN is constructed by using public
wires to connect nodes. For example, there are a number of systems that enable you to
create networks using the Internet as the medium for transporting data. These systems
use encryption and other security mechanisms to ensure that only authorized users can
access the network and that the data cannot be intercepted.
W
Web Services. Describes a standardized way of integrating Web-based applications
using the XML, SOAP, WSDL, and UDDI open standards over an Internet protocol
backbone. XML is used to tag the data, SOAP is used to transfer the data, WSDL is
used for describing the services available, and UDDI is used for listing what services
are available. Used primarily as a means for businesses to communicate with each
other and with clients, Web services allow organizations to communicate data without
intimate knowledge of each other's IT systems behind the firewall. Unlike traditional
client/server models, such as a Web server/Web page system, Web services do not
provide the user with a GUI. Web services instead share business logic, data and
processes through a programmatic interface across a network. The applications
interface, not the users. Developers can then add the Web service to an interface (such
as a Web page or an executable program) to offer specific functionality to users. Web
services allow different applications from different sources to communicate with each
other without time-consuming custom coding, and because all communication is in
XML, Web services are not tied to any one operating system or programming
language. For example, Java can talk with Perl; Windows applications can talk with
UNIX applications.
WebTop. The thin client Web interface that allows access to the Library and execution
of iSIGHT-FD models. It supports a subset of iSIGHT-FD functions (primarily model
selection, parameter setup, execution and results evaluation).
Workflow Engine. A portion of the ACS that directs, schedules and monitors the flow
of an iSIGHT-FD model.
X
XML. Abbreviation for Extensible Markup Language. XML is a specification
developed by the W3C (World Wide Web Consortium). XML is a pared-down version
of SGML, designed especially for Web documents. It allows designers to create their
own customized tags, enabling the definition, transmission, validation, and
interpretation of data between applications and between organizations.
Index
A C
ACS calculator component
client files 28 editing 239
connecting to 28 limitations 244
activity components undeclared parameters 242
defined 110 canvas
editing 113 defined 32
adding components 33, 56 manipulating 84
adding tabs 38 central composite design (DOE) 697
Airplane View button 85 client files 28
AirplaneSizingDOE example file 655 COM component
annotations, using 80 editing 245
approximation component editor 223 command line arguments 632
approximations component editors
analyzing errors 520 accessing 101
coefficient file, using 477 defined 26
deleting 529 component icons
rbf model 737 manipulating 38
response surface model 744 component palette 32
viewing initialization data 493 component properties
visualizing 495 accessing 100
component title bar 32
components
adding 57
B changing 57
disabling in a workflow 70
Boolean parameter 568 editing and configuring 59
executing 63
connection profile, creating 667
orthogonal arrays
description 693 exploratory techniques
setting options 142 neighborhood cultivation genetic algorithm
parameter study - NCGA 733
description 692 non-dominated sorting genetic algorithm -
setting options 143 NSGA-II 732
detach option 574 exponential distribution 712
direct methods, numerical techniques
modified method of feasible directions 718
distribution types
exponential 712 F
gumbel 709
lognormal 705 file names
normal 704 substitution 582
triangular 713 file parameters
weibull 707 simcode component 618
Do Until Loop 154 using with components 606
DOE component Files tab 583
editing multiple parameters 137 FIPER ACS
mapping items to parameters 133 client files 28
overview 122 connecting to 28
dynamic arrays 567 FIPER_JVMPARMS 690
Fix It! option 555
For Each Loop 150
For Loop 144, 146, 302
E full-factorial design (DOE) 692
H L
hooke-jeeves direct search method Library
overview 721 accessing 34
parameters 189, 192 introduction 26
organization 532
removing a model 551
using 533
I lock option 575
log file
I-Beam example file 655 accessing 558
input file parameters 599 copying contents 559
integer parameter 568 e-mailing 559
iSIGHT component lognormal distribution 705
editing 337 loop component editor 143
iSIGHT file parser component
advanced parser, using 362
creating parse using component editor 363
editor overview 350 M
importing description file 353
importing FDC file 357 mail component
opening editor 352 editing 366
overview 349 using with file parameters 621
simcode, creating 365 manipulating components 38
terminology 351 mapping parameters 624
updating 364 MATLAB component
actions, adding 369
defining
commands 375
J mappings 372
editor, starting 369
job permissions (ACS only) 48, 669, 676 environment, setting 368
jobs database 676 menu bar 32
JVMParms 689 message bar 32, 555
multiple messages 557
model
adding components 68
adding workflow arrows (manually) 71
creating a new model 51
deleting workflow arrows 79
executing 63
parallel workflow 75, 762
properties 65
saving 62
O
setting conditional workflow options 71
model explorer 32 optimization
model validation switch 32 general overview
model workflows generalized reduced gradient -
manipulating 68 LSGRG2 721
models hooke-jeeves direct search method 721
opening 54 multi-island genetic algorithm 722
modified method of feasible directions sequential quadratic programming -
introduction 718 NLPQL 722
Monte Carlo component techniques
editing multiple parameters 172 modified method of feasible
mapping items to parameters 166 directions 718
overview 158 neighborhood cultivation genetic
Monte Carlo simulation techniques algorithm - NCGA 733
descriptive sampling 700 optimization component
simple random sampling 699 editing multiple parameters 187
multi-island genetic algorithm mapping items to parameters 183
overview 722 overview 173
parameters 197 orthogonal arrays (DOE) 693
OS Command component
advanced options 385
required files options 388
starting the editor 377
N using with file parameters 609
OS command executable 610
neighborhood cultivation genetic algorithm - output file parameters 603
NCGA
reference information 733
Non-dominated Sorting Genetic Algorithm -
NSGA-II
parameters 203
P
normal distribution 704
parameter
cut/copy/paste 579
moving 579
sorting, clearing 576
parameter mappings
changing settings 627
deleting 628
parameter study (DOE) 692
S T
script component tabs
dynamic Java 416 adding 38
editing 413 task component editor 221, 222
job log 418 task plan
local directory 418 accessing components from the Design
parameter data types 417 Gateway 451
using with file parameters 622 activity components 442
SDI component available components 444
configuring 206 copying components 447
editing multiple parameters 220 deleting components 449
mapping items to parameters 216 editing components 446
overview 205 executing analysis workflow only 440
sequential quadratic programming - NLPQL FIPER WebTop, using with 454
overview 722 model structure change 440
parameters 201 process components 441
server information removing components 449
accessing 670 renaming components 452
button 33 saving 450
Shared File System 581 viewing the workflow 448
show/hide file parameter mappings 60 TestDataMatch example file 656
show/hide parameter mappings 60 toolbar 32
show/hide workflow grid 60 TriangleScan example file 657
simcode component triangular distribution 713
accessing and configuring 421
files on command line 428
overview 420
required files 428 W
simple random sampling 699
SpringSamples example file 656 websphere client files 28
standalone mode 28 WebTop 551
station.properties file 582 weibull distribution 707
string parameter 568 while loop 152
submodels Word component
creating 91 editing 430
defined 90 using with file parameters 619
limitations 91 workflow
usage 90 annotations, adding 80
disabling components 70