TestSuite Elite Users Manual
TestSuite Elite Users Manual
100-234-121 K
©2015 MTS Systems Corporation. All rights reserved.
MTS Trademarks
MTS, be certain., Bionix, Echo, ElastomerExpress, FlatTrac, FlexTest, Just In Case, Landmark, Level
Plus, MTS Acumen, MTS Criterion, MTS Echo, MTS EM Extend, MTS Exceed, MTS Insight, MTS
Landmark, MTS TestSuite, RPC, SWIFT, Temposonics, TestWare, TestWorks are registered
trademarks of MTS Systems Corporation within the United States. Acumen, AdapTrac, Advantage,
Aero ST, Aero-90, AeroPro, Criterion, cRPC, Exceed, First Road, Landmark, MAST, MicroProfiler,
MPT, MTS Exceed, MTS Fundamentals, MTS TestSuite, ReNew, SilentFlo, TempoGuard, TestLine,
Tytron, Virtual Test Lab, and VTL are trademarks of MTS Systems Corporation within the United
States. These trademarks may be registered in other countries.
All other trademarks are the property of their respective holders.
Proprietary Software
Software use and license is governed by MTS’ End User License Agreement which defines all rights
retained by MTS and granted to the End User. All Software is proprietary, confidential, and owned by
MTS Systems Corporation and cannot be copied, reproduced, disassembled, decompiled, reverse
engineered, or distributed without express written consent of MTS.
Preface 21
Before You Begin 21
Safety first! 21
Other MTS manuals 21
Documentation Conventions 21
Hazard conventions 21
Other special text conventions 22
Special terms 22
Illustrations 22
Electronic manual conventions 22
Hypertext links 22
Introduction 23
Overview of MTS TestSuite File Structure 24
Project 24
Test 25
Test Definition 26
Test Run 27
TW Elite Application Main Window 29
About the Multi-Head Run Section 32
Multi-Head Run Section Properties 34
Test Sections 35
Resources 93
Working with Resources 94
Resources Overview 94
Resource Details 95
Resource Buttons 98
Access System Resources 98
Import Test Resources 99
About Disabled Resources 100
NI M Series Multifunction DAQ 100
TEDS Devices 101
For more information 101
TEDS Devices Window 101
Display and Edit the Virtual TEDS Information for a Signal 102
Create a Virtual TEDS File 102
Assign a Virtual TEDS File to a Signal 103
Add TEDS Information to the Test Run Log 103
TEDS Device Verification Checks 104
Perform a Device Verification Check 104
View the Device Verification History 104
Index 665
Technical Support
How to Get Technical Support
Start with your manuals
The manuals supplied by MTS provide most of the information you need to use and maintain your
equipment. If your equipment includes software, look for online help and README files that contain
additional product information.
Type of
Details
Support
Web site www.mts.com > Contact Us > In the Subject field, choose To escalate a problem;
Problem Submittal Form
E-mail Worldwide: [email protected]
Europe: [email protected]
Telephone Worldwide: 1 800 328 2255 - toll free in U.S.; +1 952 937 4000 - outside U.S.
Europe: +800 81002 222, International toll free in Europe
When you have more than one MTS system, the system job number identifies your system. You can
find your job number in your order paperwork.
Example system number: US1.42460
Be prepared to troubleshoot
Prepare to perform troubleshooting while on the phone:
l Call from a telephone close to the system so that you can implement suggestions made over
the phone.
l Have the original operating and application software media available.
l If you are not familiar with all aspects of the equipment operation, have an experienced user
nearby to assist you.
Preface
Before You Begin
Safety first!
Before you use your MTS product or system, read and understand the safety information provided with
your system. Improper installation, operation, or maintenance can result in hazardous conditions that
can cause severe personal injury or death, or damage to your equipment and specimen. Again, read
and understand the safety information provided with your system before you continue. It is very
important that you remain aware of hazards that apply to your system.
Documentation Conventions
The following paragraphs describe some of the conventions that are used in your MTS manuals.
Hazard conventions
Hazard notices may be embedded in this manual. These notices contain safety information that is
specific to the activity to be performed. Hazard notices immediately precede the step or procedure that
may lead to an associated hazard. Read all hazard notices carefully and follow all directions and
recommendations. Three different levels of hazard notices may appear in your manuals. Following are
examples of all three levels. (for general safety information, see the safety information provided with
your system.)
Danger: Danger notices indicate the presence of a hazard with a high level of risk which, if
ignored, will result in death, severe personal injury, or substantial property damage.
Warning: Warning notices indicate the presence of a hazard with a medium level of risk
which, if ignored, can result in death, severe personal injury, or substantial property damage.
Caution: Caution notices indicate the presence of a hazard with a low level of risk which, if
ignored, could cause moderate or minor personal injury or equipment damage, or could
endanger test integrity.
Important:
Important notices provide information about your system that is essential to its proper function.
While not safety-related, if the important information is ignored, test results may not be reliable,
or your system may not operate properly.
Note:
Notes provide additional information about operating your system or highlight easily
overlooked information.
Recommended:
Recommended notes provide a suggested way to accomplish a task based on what MTS has
found to be most effective.
Tip:
Tips provide helpful information or a hint about how to most efficiently accomplish a task.
Access:
Access provides the route you should follow to a referenced item in the software.
Example: Examples show specific scenarios relating to your product and appear with a shaded
background.
Special terms
The first occurrence of special terms is shown in italics.
Illustrations
Illustrations appear in this manual to clarify text. They are examples only and do not necessarily
represent your actual system configuration, test application, or software.
Hypertext links
The electronic document has many hypertext links displayed in a blue font. All blue words in the body
text, along with all contents entries and index page numbers, are hypertext links. When you click a
hypertext link, the application jumps to the corresponding topic.
Introduction
Overview of MTS TestSuite File Structure 24
TW Elite Application Main Window 29
Test Sections 35
General Conventions 36
Tables 39
Docking and Undocking Panels 40
Manage MTS TestSuite Files 41
Diagnostics 44
Application Log, Test Log and Error List 45
Meters 49
Signal Compensation for Servohydraulic Systems 52
General Settings Tab 53
User-Supplied Help Overview 55
Licenses 56
End-User License Agreement (EULA) 59
Version Information Overview 60
Analysis The analysis definition is available in either the Fatigue Analyzer or Fracture
Definition Analyzer application as an overlay to the information that was gathered during a
test run. You can customize the views and displays associated with an analysis
definition to manipulate how the test run data is presented on the screen.
Additionally, you can customize the variable values, DAQ mappings, and
functions in order to create analysis runs and analyze various "what if" scenarios.
Analysis The analysis run uses the analysis definition and the data in a test run to produce
Run a set of analysis results.
Project
A project is the highest level component in the MTS TestSuite file heirarchy. A project contains the
following:
l A collection of tests
l A collection of test templates
l Project settings, such as the name and location of directories in which the tests, test
templates, report templates, external files, and data exports are stored
To view or edit your available projects and their associated settings, click Preferences, select
Configuration, and then select the Project tab. The other tabs on the Configuration window contains
settings that are application-wide and persist regardless of which project you have selected.
Test
A Test is stored within a project folder, and contains the following components:
l Test Definition—Contains the main components of the test, such as the procedure,
variables, test-run display, resources, functions, and report templates.
l Test Run(s)—Contains information that was gathered during the test run, such as variable
values.
l Analysis Definition(s)—Contains variable definitions, functions, DAQ-to-variable
mappings, and the views and displays that organize and present the data within either the
Fatigue Analyzer or Fracture Analyzer applications.
l Analysis Runs—Uses the data gathered from test runs to show data according to the
analysis definition.
A Test Contains the Test Definition, Test Run(s), Analysis Definition(s), and Analysis Run
(s)
Test Definition
The test definition is stored within the test. The test definition contains the following main components
that define the test:
l Procedure—A collection of test activities that are performed step-by-step when the test is
run.
l Resources—A collection of test resources mapped to the controller resources that will be
used during the test.
l Variables—Containers that can hold values that may change during the test run, such as time
or axial displacement. Variables facilitate data manipulation and communication between
different components of the test.
l Test-Run Display—A customizable user interface that shows data when the test is run.
l Report templates—A collection of Microsoft Excel Template files that define the layout of
generated reports.
l Functions—A sequence of instructions that receives arguments and produces a result.
Test Run
A test run is the record of a test performed on a single, selected specimen. Test runs are stored in the
test and include:
l A copy of the test definition, including the procedure, at the time the test run is created.
l A copy of the name of the selected specimen and its values at the time the test run is created.
l Variable values during the test run.
l The state of the test run.
l Results data, such as data acquisitions and calculations.
3 Actuator Allows you to manually position the actuator. You can configure the Jog and
Controls Return buttons at Preferences menu > Configuration > Control Panel tab.
panel For more information, see “Actuator Controls” on page 521.
4 Test The Test Controls buttons allow you to start, pause, and stop the test. For more
Controls information, see “Test Controls” on page 522.
panel
5 Test Run Shows test run information, including name, status, and running time. This panel
Status includes a control that allows you to terminate the current test run. For more
panel information, see “Test Run Status Panel” on page 523.
6 Tabs The various tabs and subtabs across the display are used to monitor and
configure the test and test-run displays.
7 Toolbox The contents of the Toolbox Panel change depending on the subtab selected on
panel the Define tab.
l When you select the Procedure subtab, the Toolbox panel contains
components that pertain to test activities such as commands, data
acquisition, test flow control, and program actions.
l When you select the Test-Run Display tab, the Toolbox panel contains
components that pertain to the display of test data, such as cycle,
variable, and signal views.
8 Work area This is the work area in which to create tests. You can view the workflow in a
Note:
The flowchart view includes Pan, Zoom, and Print Preview
buttons in the lower right corner of the work area window to help
you view complex test procedures.
9 Properties Allows you to define or change the information, characteristics, and appearance
panel of the selected procedure activities and runtime display components. For
example, you can use the Properties panel to change the amplitude of a Cycle
command test activity in a procedure or the Y-axis signal selection on a signal
scope in a monitor display.
10 Error List The Error List shows error and warning messages that describe both critical
(not and non-critical conditions in the test definition. The Error List is dynamic and
shown) changes according to the part of the application you are using.
and
Meters The Meters show the current numeric value of the selected signal. The two
default meters show load and crosshead extension. Right-click on the meter to
add or remove a meter, reset, change units or decimal places, and to configure
the properties.
11 Application The Application Log shows status information about application events in
Log (not recent history, such as logging into the application, exiting the application, and
Note:
The Multi-Head option is a separately licensed feature.
Note:
Prerequisite: Only analog data is collected from the multiple active load cells in a multi-head
frame. You must have National Instruments Data Acquisition (NI-DAQ) hardware and software
or an extensometer installed which will convert the analog data to digital signals.
Multi-head frames can contain up to five active load cells which allow the simultaneous collection of
test-runs for multiple specimens. By default, the test run collects the results for all specimens within
one file. You can create a separate test-run file for each of the specimens by using the appropriate
multi-head template which contains the Multi-Head Run section in the test procedure work area. This
section is similar to the Run section found in templates for single head frames which contains activities
for applying forces to the specimen while performing test runs. Unlike the Run section, the Multi-Head
Run section contains a Properties Panel where you can input configuration data. The Multi-Head
Run is only run once. Data is collected simultaneously from the Ni-DAQ analog signals. After the test is
completed, the data is split into multiple tests runs. At the end of the test, a number of test runs will be
created and populated with the collected data. The new test runs appear post-test as if they were
individually collected.
At the end of the multi-head test, the array data is split into multiple test-run files by moving the
collected data into the normal force, extension, and optional strain variables.
To create a new multi-head template, you must start with an existing test or template that contains the
Multi-Head Run section. To save a test as a template, you must be assigned the Administrator or
Engineer privilege.
Item Description
Number Specify how many test-runs should be created. For example, if you are testing four
of Active specimens, enter 4. When the test run has ended, four test run files will be created.
Load Default: 5
Cells
Click the Automatically Map Variables checkbox to have the system map variables,
or click the Configure button to open the Map Variables window and manually map
variables.
Note:
If you select the Automatically Map option and then change the Number of
Active Load Cells value, some variables will be created or removed.
If you map variables manually, and then select Auto Map Variables, your
manually created variables will be overwritten by the automatically-generated
variables.
Test Run Specify variables that are not in the Common category. For example, if Number of
Variables Active Load Cells is 5 and the Width variable is added to this list, the other five
variables should be mapped to the Width variable (such as Width1, Width2… Width5).
At the end of the test, the variable values from Width1, Width2, and so on, must be
moved to the Width variable in the appropriate test runs. Click the plus sign to add a
variable. To delete a variable, select a variable in the list and click the red minus sign.
Click the Configure button to open the Map Variables window.
Load Specify the name of the array variable that is used to gather data from the Force (Load)
Array channel. Map it to the other array variables as described above in the Test Run
Variable Variables description. At the end of the test, the variable values from mapped arrays
must be moved to the selected Load Array variable in the appropriate test runs. Click
the Configure button to open the Map Variables window.
Enable Select to map additional array variables to the other array variables. You can also move
Extension data from mapped variables to the selected array variable at the end of the test. Click
Channels the Configure button to open the Map Variables window.
Trim Data Select to have the trimming process performed after the data has been split into test-
run files. The trimming process will keep the point identified by the variable. In other
words, the data will be trimmed at the variable index plus one. If the variable is invalid,
no truncation will take place and a message will be logged. Default for Truncate after
data point: Break
Test Sections
The test in the workflow is divided into the Setup, Run and Finish sections, described in this section.
Setup
The Setup section includes operations that you perform before beginning test runs that apply to all the
test runs in the sample, such as:
l Naming the results file
l Entering values for common test variables
l Configuring the load train (setting up fixtures, and so forth)
Run
The Run section performs test runs. In addition to starting each test run with the Start button, you may
perform activities such as entering specimen dimensions and variables. When the test run is complete,
the Review page is displayed, which includes an option to jump to post sample activities. A typical task
after each test run is to describe how a specimen fails (comment).
Finish
The Finish section includes operations such as printing reports, exporting files, saving sample data,
and archiving.
General Conventions
Entry-Type Toggle Button
The entry-type toggle button appears throughout the application. The following table indicates the icon
and its meaning. Click the button to toggle between two entry options.
Icon Description
Variable selection; click to select or enter a variable.
Charts
To copy a chart or test control, right-click the item and click Copy or Copy Image to the Clipboard.
Chart data
To copy data values from a chart instead of the chart image, right-click the chart and click Copy
Values to the Clipboard.
Tabular data
To copy an entire log or table, right-click the item, click Select All, and press Ctrl+c to copy or Ctrl+x
to cut, or right-click again and click Copy.
To copy a single row of a log or table, double-click the row to select it, right-click at the same location,
and select Copy.
You can select a block of rows two ways:
l Click in the column at the first row of the block, hold the mouse button down, roll over the block
of rows, and release the mouse button. Right-click and select Copy.
l Select the first row of the block, press and hold the Shift key, and select the last row of the
block. Right-click and select Copy.
To select multiple rows that are not in a block, hold the Ctrl key and click in the column at each row you
want to select. Right-click and select Copy.
Naming Conventions
Unique names
In general, the components you create and name in the application, such as report templates and
tests, must have unique names within the test. Components that are stored within the test, such as
variables, and procedure activities must also have unique names.
Some items that do not require unique names include:
l Specimens
l Specimen geometries
l Monitor display names
l Analysis views
For items that require unique names, the naming restrictions and the scope of the uniqueness vary by
type of item.
Project name
The following guidelines apply for naming a project:
l The name must be unique among existing projects.
l It is case-sensitive.
l It must follow Microsoft file naming conventions and restrictions.
l It can contain both alphabetical and numeric characters.
l It can contain spaces, commas, ‘-’, ‘_’, ‘.’, ‘!’, ‘@’, ‘#’, ‘$’, ‘%’, ‘^’, ‘(’, ‘)’, ‘=’, ‘+’, ‘;’, ‘~’, ‘{’, and ‘}’.
l It cannot contain apostrophes, quotes, ‘&’, ‘*’, ‘[’, ‘]’, ‘:’, ‘|’, ‘<’, ‘>’, ‘\’, ‘/’, and ‘?’.
l It can start with a number or special character.
Test name
The following guidelines apply for naming a test:
l It is case-sensitive.
l It can contain both alphabetical and numeric characters.
l It can contain spaces, ‘-’, ‘_’, ‘.’, ‘!’, ‘@’, ‘#’, ‘%’, ‘^’, ‘(’, ‘)’, ‘=’, ‘+’, and ‘;’.
l It cannot contain apostrophes, quotes, ‘$’, ‘*’, ‘[’, ‘]’, ‘:’, ‘|’, ‘<’, ‘>’, ‘\’, ‘/’, and ‘?’.
l It can start with a number or special character.
Tables
Choose Columns to Display
To choose columns to display:
1. Click Column Chooser in the upper, left-most cell.
2. In the window that opens, select the check boxes for the columns you want displayed.
Sort Columns
To sort table columns:
1. To sort the table by the order of information in a column, click the column header cell.
A down-arrow indicates descending order. An up-arrow indicates ascending order.
2. To reverse the sort order for information in a column, click the column header cell again.
Filter Data
Use the column filter to select the data you want to see and hide the rest. A filter changes only the
display. The data does not change.
1. To apply a filter, click the filter icon in the column header to open the Filter menu.
The filter menu lists all of the unique values in that column. The menu also provides options for
showing values that are blanks or not blanks.
The menu also provides a Custom filter. You can specify logical operators such as “All”,
“Custom”, and “Read-Only” in the Operator column. “Matches Regular Expression” uses the
.NET standard expression syntax.
2. Select a specific value to show all table entries that have the value or that meet the criteria.
For example, if the table has a Units column and you want to filter the current view of the table
to only show those rows that have Units of mm, select mm in the Filter menu for the Units
column.
If you select a custom filter operator, select an operator and an operand. For example, you
select the Value column and Custom filter. Select the operator Does not equal and operand
0.000. The result is that the table shows the rows that have non-zero values. You can increase
the criteria by clicking Add a condition and selecting another operator and operand. You can
increase the filter further by applying filters to additional columns.
3. To display all table values, select the All command on the Filter menu.
Docking Symbols
Symbol Description
Up Arrow Highlights the top of the work area and docks the panel as a separate work area in the
highlighted area.
Right Highlights the right side of the work area and docks the panel as a separate work area in
Arrow the highlighted area.
Left Highlights the left side of the work area and docks the panel as a separate work area in
Arrow the highlighted area.
Down Highlights the bottom of the work area and docks the panel as a separate work area in
Arrow the highlighted area.
Work Highlights the work area and docks the panel as a separate tab in the highlighted work
Area area.
If you have multiple monitors, the panel docks on the device to which the mouse is pointing.
Undocking a Panel
To undock a panel:
1. Click on the tab or title bar of the panel you want to undock.
2. Drag the view to where you want it.
Arrows appear on the screen that indicate that you have undocked a panel. You do not have
to use the arrow buttons to undock a panel.
Undocking a Panel
Docking a Panel
To dock a panel:
1. Drag any side or corner of the panel.
Docking symbols appear in the middle and on each side of the work area that indicate that you
have undocked a panel.
Docking Symbols
2. When your mouse pointer reaches a docking symbol, a region of the work area becomes
highlighted. To dock the panel in that region, release your mouse.
Note: There can be multiple work areas, each with its own set of docking symbols.
If you have multiple monitors, the panel docks on the device to which the mouse is pointing.
3. Repeat the previous steps to dock other panels as necessary.
In most cases, the management of TestSuite files is done using the MTS TestSuite application. Some
files, such as templates and reports, can be managed using the Windows operating system.
Caution: Using the Windows OS to manipulate the files in a test folder can corrupt the test
and its associated files.
Corrupting the test can make the test unusable and/or result in the loss of test-run data.
Do not manipulate any of the files in the test folder. Any changes to the test should be performed
using the TestSuite application.
From
Folder From TestSuite
File type Windows
Extension Application
Explorer
Legacy Templates .Test* New test from No file
(v2.0 or template, save as manipulation
Note: Once a legacy template is earlier) allowed except
converted, it has a .TSTemplate delete
extension and can be managed like .Project
other templates. (v1.6 or
earlier)
Project Directory Files .Project Import legacy No file
projects (v1.6 or manipulation
earlier), new, open, allowed except
delete delete
Test .Test New, open, save as, No file
delete manipulation
allowed except
delete
*
When using Windows XP to view TestSuite folders, the folder names are determined by the TestSuite
application’s naming convention and are appended with the folder extension. When using Windows 7
or Windows Vista to view TestSuite folders, the folder names are the user-defined display names and
the file extensions do not appear.
From
File From TestSuite
File type Windows
Extension Application
Explorer
User Templates .TSTemplate Create new test Copy, move,
from, save as paste, delete,
Note: Template files are not fully self- rename
contained; they contain references to
other files (such as, Report Templates).
MTS Templates .TSTemplate Create new test Contact MTS
from, save as
Note: Template files are not fully self-
contained; they contain references to
other files (such as, Report Templates).
Exported Tests .tsproj Import/export Copy, move,
paste, delete,
rename
Exported Test Runs .tsproj Import/export Copy, move,
paste, delete,
rename
Exported Unit Sets .tsunitset Import/export Copy, move,
paste, delete,
rename
Report Templates .xltx Add, edit, remove Copy, move,
from test paste, delete,
rename
Reports .xlsx Generate reports, Copy, move,
open, print, paste, delete,
delete, rename rename
External Files (create test from) .xml Create test from Copy, move,
the .xml file paste, delete,
rename
Data Export (exported raw data) .txt .csv Export Copy, move,
paste, delete,
rename
Important: You can use the Windows OS to move test files only if the destination directory is
empty. To move a test into a directory that already contains tests, use the Save As feature in the
TestSuite application.
1. Use the Windows OS to create a new, empty directory where you want to store the test files.
2. If this new location is where you want to store and run all tests, set the default Test Directory
setting to this new location.
A. On the Preferences menu, click Configuration, and click the Project tab.
B. Set the default Test Directory setting to the new directory that you just created.
3. Use Windows OS to move the tests to the new directory.
A. Make sure that the new directory is empty.
B. Move the tests to the new directory.
Note: When using the Windows XP OS, each test appears as a Test folder,
such as TST1.Test, that is numbered in the order that it was created. The user-
defined test names are only visible when the test directory is viewed through
the TestSuite application. When using Windows 7 or Windows Vista, the user-
defined test names appear in the OS.
4. To move additional tests into the directory, you must use the Save As function in the
TestSuite application.
Important: Each Test folder contains a number of files required to run the test. Do not
manipulate any of the files in the test folder.
Diagnostics
Diagnostic Files Overview
The MTS TestSuite applications include a feature to create a diagnostics file that you can send to MTS
Technical Support for analysis. The diagnostic file is useful for troubleshooting and correcting
problems. You can include the following in a diagnostic file:
l Diagnostic logs
l Station configuration
l Report templates
l Specimens (not applicable to the TWE or TWX applications)
l Test runs
If required, you can configure the content of the diagnostics file in collaboration with MTS Technical
Support.
Note:
Contact MTS Technical Support to assist you with transmitting the diagnostics file.
Logging Levels
The Application Log warnings and errors pertain to loading or running the test. The following
information can be displayed:
l Errors—These messages show information about critical conditions that prevent a test run or
stop a test in progress.
l Warnings—These messages show information about conditions that may require attention,
but do not prevent a test run or stop a test in progress.
Log sources
The Application Log shows information from the following sources that appear on the Log Source list:
l Current Log—Shows the messages for all test runs for the current session.
l New Messages—Hides the existing messages and shows newly generated messages.
l From Existing File—Opens a Windows Explorer window so that you can show a log (.log)
file from a previous test session.
Logging Levels
The Test Log warnings and errors pertain to loading or running the test. The following information can
be displayed:
l Errors—These messages show information about critical conditions that prevent a test run or
stop a test in progress.
l Warnings—These messages show information about conditions that may require attention,
but do not prevent a test run or stop a test in progress.
l Information—These messages typically verify the start, result, or completion of a user-
initiated action, or inform the user of the start, result, or completion of a system-initiated action.
They can also be notes added by users.
The application records each message with a date and time stamp. Messages are also persisted from
one session to another.
Log sources
The Test Log shows information from the following sources that appear on the Log Source list:
l Current Log—Shows the messages for all test runs for the current session.
l New Messages—Hides the existing messages and shows newly generated messages.
l From Existing File—Opens a Windows Explorer window so that you can show a log (.log)
file from a previous test session.
Error Location
In addition to the Error list, the application also marks the problem conditions with error and warning
icons on or near the offending selection or setting in the user interface. If you double-click an item in the
list, the program control point moves to (or near to) the location of the error.
Error Identification
The Error list identifies error conditions for the current context or object selected. For example, you
can use the Error list and the Test Definition object to view a summary of the errors in a test.
If you double-click an item in the Error list, the view changes to show the location of the error. Error
and warning icons are placed on or near the property, selection, or setting where the error exists so
that you can quickly locate the source of the error.
Meters
Meters Overview
The Meters tab contains meters that show various data retrieved from signals on your system. On
most systems, the Crosshead/Axial Force and Load/Axial Displacement meters are available when
you first open the Meters tab. However, you can add other meters that show a variety of information
such as interlock status, power status, or even the current time and date. After you add a meter, you
can configure the meter type, unit type shown, number of decimal places shown, sensitivity (of
Peak/Valley meters only), and font settings.
Adding a Meter
1. Click the Meters tab.
2. Right-click any existing meter.
3. Hover over Add Meter.
4. Select the meter you want to add.
Note: This list contains the most commonly-used meters. To add other meters, click
More to open the Meter Configuration window. Then, move each desired meter over
to the list of Selected meters on the right side on the window. When you are finished,
click OK.
Resetting a Meter
You can reset the values recorded in Peak, Valley, Peak/Valley, Running Maximum/Minimum, and
Mean/Amplitude meters. Keep in mind that if the crosshead or actuator is not at the zero position,
resetting certain meters may not always return the displayed value to zero. For example, if the axial
displacement of the crosshead or actuator is resting at 10 mm and you reset a maximum axial
displacement meter, the meter will continue to show 10 mm. This occurs because immediately after
you reset the meter, the axial displacement signal remains at 10 mm, which is considered the
maximum. In this scenario, if you returned the axial displacement to 0 before you reset the meter, the
maximum axial displacement meter would return to 0 after you reset the meter.
1. Click the Meters tab.
2. Right-click the Peak, Valley, Peak/Valley, Running Maximum/Minimum, or Mean/Amplitude
meter that you want to reset.
3. Select Reset to reset the meter you selected or select Reset All to reset all meters that can
be reset on the Meters tab.
Removing a Meter
1. Click the Meters tab.
2. Right-click the meter you want to remove.
3. Select Remove.
Configuring Meters
After you add a meter to the Meters tab, you can configure the meter type, units shown, number of
decimal places shown, sensitivity, and font used in the meter.
Meter Types
The meter type determines what type of information is shown on the meter. When you first launch the
application, the Crosshead/Axial Force and Load/Axial Displacement meters appear on the Meters
tab. By default, the meter type of those meters is set to Timed. This meter type shows the real-time
axial displacement of the system’s crosshead or actuator. However, if you change the meter type to
Running Maximum/Minimum, the meter shows the minimum and maximum axial displacement
experienced by the crosshead or actuator.
Item Description
Timed Displays signal values at timed intervals.
Minimum Displays the running minimum value that was observed since the meter was
added or reset.
Maximum Displays the running maximum value that was observed since the meter was
Item Description
added or reset.
Peak Displays the peak value for the most recent cycle monitored.
Valley Displays the valley value for the most recent cycle monitored.
Peak/Valley Displays both the peak and valley values for the most recent cycle monitored.
Running Displays both the running minimum and maximum values that were observed
Maximum/Minimum since the meter was added or reset.
Mean/Amplitude Displays the midpoint value and the difference between the peak and valley
values for the most recent cycle monitored.
Compensator Types
MTS offers a variety of compensators to optimize command levels. Certain compensators work more
effectively than others for specific applications. The following compensators are available for command
activities:
l Static and Dynamic Null Pacing
l Peak-Valley Amplitude Control (PVC)
l Amplitude Phase Control (APC) Compensator (option)
l Adaptive Inverse Control (AIC) Compensator (option)
l Arbitrary End Level Control (ALC) Compensator (option)
l Peak-Valley-Phase Control (PVP) Compensator (option)
l Adaptive Harmonic Cancellation (AHC) (option)
Compensator Availability
Not all compensators are available to every command activity for one or more of the following reasons:
l Some compensators apply only to specific types of command activities. For instance, Peak
Valley Compensation (PVC) pertains only to cyclic command.
l Some compensators, such as Adaptive Inverse Control (AIC), are licensed and will be
available only if they were purchased.
l Some compensators, such as Null Pacing, will be available only if they are enabled in the
underlying station configuration.
Use the General Settings tab to view and edit the current properties of a test. You can perform the
following tasks from the General Settings tab:
l Changing the test name
l Selecting the logging type for the test (you must have Administrator rights to change this
selection)
l Enabling remote test start with digital input (you must have Administrator rights to change this
selection)
l Switching to the review page after running the test (you must have Administrator rights to
change this selection)
l Add a description
General Settings
Item Description
Name Displays the name of the test.
Creator (View-only) The user who created the test.
Created (View-only) The date the test was created.
Last Modified (View-only) The date the test was created.
Formula Displays the Formula Assistant File for the selected template. Changing the
Assistant File selected Formula Assistant File requires the password for an MTS Field
Service Engineer (FSE).
Log Type The logging type selected for the test. Available options are:
l Basic (default)—The Basic log type does not have the audit trail
feature.
l Audit Trail—The Audit Trail selection allows you to check the audit trail
for a test. The Check Test Audit Trail option becomes available in the
File menu.
Item Description
Enable Remote Enables remotely starting the test with a digital input.
Start using
Digital Input Default: Enabled.
Switch to Review Opens the Review page immediately after running the test. If you do not select
Page after Test the check box, the test remains on the Monitor panel.
Default: Enabled.
Description (Optional) Displays a description about the test.
Note:
If you cannot see the Edit button, check your screen resolution. The Edit control may not be
visible if your screen resolution is less than 1280 x 1024. (Start > Settings > Control Panel >
Display > Settings).
Note:
The custom help button for test-run display is not to be confused with the MTS TestSuite Help
menu options.
Procedure messages
To provide the operator with information during the execution of a test and to prompt the operator for
input, you can add custom message activities to the procedure you define for a test.
Licenses
License Utility Overview
Access
Programs > MTS TestSuite > License Administrator
During installation, the Activation Wizard prompts you to activate the license for your MTS TestSuite
software. The process for obtaining the license file depends on whether the PC was connected to the
Internet. After installation, you can add and manage licenses at any time with the MTS TestSuite
License Administrator utility.
With the MTS TestSuite License Administrator utility, you can activate and manage your licenses and
obtain information about currently installed licenses. You can view the Applications, Templates,
Privileges, Activities, and other special features for which you are licensed.
Tip:
Always save your TestSuite license(s) into a plain text file using Windows Notepad. If you save a
license using other text editors (such as WordPad, Notepad++, or Microsoft Word), characters
in the license may be altered slightly or additional characters may even be appended to the end
of the license. If this occurs, the license may not be recognized when you paste it into the
License Administrator utility.
3. Click I want to activate the software over the Internet panel and click Next. The window
to enter your activation key is displayed.
4. Enter the activation key and click Next.
A message indicates the license is being obtained from the server, and a progress bar is
displayed. The Activation Wizard installs and activates the license.
5. To copy the License Request Contents, which is a PC-identifying string, click Copy to.
6. Paste the copied License Request into a text editor such as Notepad, and save the Request
File to a USB drive.
7. Click Finish to exit the Activation Wizard.
8. Plug the USB drive into a PC that has Internet access. Go to the MTS Licensing Web site:
www.mts.com/testsuite/licensing/
9. Open the Request File on the USB drive. Select and copy the contents.
10. Paste the content into the text box in the Web page and click Download License File. Save
the license file to the USB drive.
11. Bring the USB drive back to the PC without an Internet connection onto which you are
installing software.
12. Open the Activation wizard again. Select the I have a license file I want to install option
and click Next.
13. Browse to the location of the license file. Select the license bin file and click Open.
14. Click Next. The Activation Wizard installs and activates the license.
15. Click Finish to exit the Activation Wizard.
16. Click Close to exit the MTS TestSuite License Administrator.
Remove a License
To remove a license, use the MTS TestSuite License Administrator utility.
1. Click Programs > MTS TestSuite > License Administrator.
2. In the upper part of the window, select the license you want to remove and click Remove. To
remove all licenses, click Remove All.
3. You are prompted to confirm removing the license. Click OK.
4. Click Close.
Managing Users
User Management Overview
If your organization needs to manage multiple users of the MTS TestSuite application, you can
manage users with or without their Windows user accounts. The default User Management option is
none (the No User Management option), and users are not required to log in to the MTS TestSuite
applications. Windows User Management automatically logs in users based on their Windows log in.
By default, the user who installs the MTS TestSuite application is automatically added as an MTS
TestSuite Administrator. Adding the default Administrator user provides the ability to switch to User
Management if desired. Only a user with Administrator role or User Management privileges can add
users and assign roles.
Note:
If your organization does not set up Local or Windows User Management, all users who launch
an MTS TestSuite application have Administrator privileges.
An Administrator grants users privileges through the assignment of a specific role. Each privilege
controls access to performing certain tasks within the application. A user may be assigned one or more
roles; however, a user must select one of the roles when the application starts if Local User
Management is the selected User Management option.
Section Description
User l No User Management—(Default) All users can access the application
Management without having to log in if during installation, the Anyone who uses this
options computer (all users) option was selected. All users are automatically
assigned an Administrator role. If the Only for me option was selected
during installation, only the user who installed the application can launch it.
l Local User Management—Users are managed by the MTS TestSuite
application independently of Microsoft Windows user accounts. You must
add MTS TestSuite users.
l Windows User Management—Users are managed by their Windows
User accounts. There is a one-to-one mapping between Windows and MTS
TestSuite users. You must add MTS TestSuite users.
User Displays all of the currently defined MTS TestSuite users.
accounts list
Add User Opens the Create new MTS TestSuite user window so you can add a new user and
Section Description
button assign the user a Role.
Remove Removes the user selected in the Manage User Accounts window.
User button
Properties Opens the Change User Properties window. You can change the name, password,
button and assigned roles.
Manage Opens the Manage Roles window. You can view the privileges associated with the
Roles button default roles, work with custom roles, and view all users currently assigned to a role.
5. Enter a Password for the user and enter the password again in the Confirm Password box.
6. (Optional) Enter a Complete Name and Description of the user.
7. Select one or more Roles for the user.
8. Click OK. Repeat this procedure for each user you need to add.
6. Click OK.
Remove a User
To remove a user:
1. Click Preferences > User Management > Manage User Accounts. The Manage User
Accounts window appears.
2. Select the user in the Manage User Accounts window.
3. Click Remove User. You are prompted to confirm removing the user.
4. Click OK.
Managing Roles
Note: To perform this task, you must be assigned the Administrator role or be assigned a
custom role with User Management privileges.
The MTS TestSuite application provides several default (predefined) roles. You cannot edit or delete
default roles; however, you can create custom roles that you can edit or delete.
Access
1. Click Preferences > User Management > Manage User Accounts.
2. Either the Local or Windows User Management option must be selected.
3. Click Manage Roles.
Default Roles
Use default roles to assign standardized user privileges. Default roles are predefined categories of
user privileges. You cannot edit or delete default roles; however, you can create custom roles that you
can edit or delete.
Note: The privileges that appear vary depending on the selected role. Only privileges for which
you are licensed are shown.
Default Role
Privileges
Name
Administrator At least one Windows user account must be assigned to the Administrator role.
Only the Administrator can add users and assign them roles. The Administrator can
also change their own role or assign the Administrator role to another user. The
user who installs the application is automatically added as a user and an
Administrator.
The Administrator role has all privileges, including:
l Edit Calibration Values (MTS Insight/Criterion only)
l Change Laboratory Preferences
l Change Polarity
l Create Diagnostic File
l Delete Project
l Delete Test
l Delete Test Run
l Edit Procedure
l Express Editor
l Launch Fatigue Analyzer
l Launch Fracture Analyzer
l Launch Reporter Add-In
l Launch TW Elite
l Launch TW Essential
l Launch TW Express
l Launch Multipurpose Elite
l Launch Multipurpose Express
l Tuning (MTS Acumen only)
l Save Test as Template
l User Management
l View Reports
Engineer Includes most privileges, except for laboratory preferences, calibration, and user
management.
The Engineer role has the following privileges:
l Change Polarity
Default Role
Privileges
Name
l Create Diagnostic File
l Delete Project
l Delete Test
l Delete Test Run
l Edit Procedure
l Express Editor
l Launch Fatigue Analyzer
l Launch Fracture Analyzer
l Launch Reporter Add-In
l Launch TW Elite
l Launch TW Essential
l Launch TW Express
l Launch Multipurpose Elite
l Launch Multipurpose Express
l Tuning (MTS Acumen only)
l Save Test as Template
l View Reports
Operator Creates new projects or tests from templates and run those tests.
The Operator role has the following privileges:
l Create Diagnostic File
l Launch TW Elite
Launch TW Essential
l Launch TW Express
l Launch Multipurpose Elite
l Launch Multipurpose Express
l Tuning (MTS Acumen only)
l View Reports
Note: Operators may start the system application but have limited
capabilities using it. Operator privileges are the same throughout the MTS
TestSuite software applications.
4. Click Close.
Privileges
Note: The privileges that appear vary depending on the selected role. Only privileges for which
you are licensed are shown.
Privileges
Privilege
Description
Name
Edit (Applicable on MTS Insight/Criterion only.) Allows an MTS Field Service Engineer
Calibration to work with TEDS Device files.
Values
Change Allows you to configure default units and names within projects and tests. It enables:
Laboratory
Preferences l Preferences > Configuration > Default Names
l Preferences > Configuration > Unit Set Manager
Change Allows you to change the signal sense of signals in the connected station.
Polarity
Create Allows you to create a diagnostic file, which is used by MTS Technical Support for
Diagnostic diagnostic purposes. It enables Tools > Create Diagnostic File.
File
Delete Allows you to delete a project. It enables the ability to delete a test using
Project Configuration > Project.
Delete Test Allows you to delete a test. It enables the ability to delete a test using File > Delete
Test.
Delete Test Allows you to delete a test run.
Run
Edit Allows you to edit select report templates and a limited set of variable properties
Procedure (Display Name, Default Value, Default Option, Unit, Pretest, Result, Editable Post-
Test, Range, Formatting). The Formula Assistant feature (applicable on MTS
Insight/Criterion only) is also available to apply calculation options to a variable.
Privilege
Description
Name
Express Allows you to edit select report templates and a limited set of variable properties
Editor (Display Name, Express Editor Default Value, Default Option, Unit, Pretest, Result,
Editable Post-Test, Range, Formatting). The Formula Assistant feature (applicable
on MTS Insight/Criterion only) is also available to apply calculation options to a
variable.
Launch Launches the Fatigue Analyzer application.
Fatigue
Analyzer
Launch Launches the Fracture Analyzer application.
Fracture
Analyzer
Launch Allows you to start the Multipurpose Elite application.
Multipurpose
Elite
Launch Allows you to start the Multipurpose Express application.
Multipurpose
Express
Launch Allows you to start the Reporter Add-in to the Microsoft Excel application.
Reporter
Add-In
Launch TW Allows you to start the TW Elite application.
Elite
Launch Allows you to start the TW Essential application.
TW Essential
Launch TW Allows you to start the TW Express application.
Express
Save Test as Allows you to save a test as a template.
Template
Tuning (MTS (Applicable to MTS Acumen systems only) Allows you to tune control modes.
Acumen
Only)
User Allows you to view information related to users, roles, and privileges. It enables
Management Preferences > User Accounts.
View Allows you to view reports generated by an activity in a test procedure. It enables
Reports the View Report option from the context menu.
Configuration Window
Access
Preferences > Configuration > Project tab
Use the tabs in the Configuration window to select preferences and default settings. The window
opens to the Project tab by default.
Configuration Window
Tab Description
Project Modifies the settings file of the selected project. Project settings determine the
organization and flow of data within a project. Project settings map data paths for
the sub folders within projects.
Test/Template Defines alternative ways to start the test (other than pressing the start button)
using keyboard commands and digital inputs.
Opens the current test when the application starts. Allows you to define the Default
Log Type (Basic or Audit Trail).
Language Selects a language for the MTS TestSuite application.
Email Sets up e-mail for the Run Report and Send E-mail activities.
Tab Description
The From e-mail property sets the default for the From e-mail address property in
the Run Report and Send E-Mail activities. The other settings are for specifying
the e-mail server. Check with your e-mail administrator for the correct settings. You
can send a test e-mail to verify the SMTP server settings are working properly.
Default Selects default base names for new projects, tests, and test runs.
Names
Control Panel Configures the Ramp Rate for the Jog Buttons and the Ramp Rate for the Return
Crosshead to Zero activity.
Project Management
Working with Projects
Access
Preferences > Configuration > Project tab
Add a project
To add a project, click the + button in the upper right side of the Projects list. The project is
automatically created using the default naming convention specified on the Default Names tab.
Delete a project
To delete a project, select the project you want to delete and click the – icon in the upper right corner of
the Projects list.
Alternately, you can right-click the project you want to delete and select Remove.
Important: When you delete a project, all the folders within that project’s folder are deleted. If
the Test Directory for the project is configured to store tests within the project’s directory
(default), those tests will also be deleted. For more information about the Test Directory, see
“Test Directory” on page 81
Note: You cannot delete a project if a test within the project is open.
Note: You cannot delete the system default project (that is, Project 1).
Open a project
To open a project, double-click the project name, or right-click the project you want to open and select
the Open Project menu option.
Edit a project
To edit a project, select the project in the Projects list and change the associated project settings as
desired. Your changes are saved when you click the Apply or OK buttons in the Configuration
window.
Project Tab
Access
Preferences > Configuration > Projects tab
Use the Project tab to manage projects. With this tab, you can see all the projects, add and remove
them, and see individual project settings.
As you select projects in the Projects list, the settings for the selected project are shown to the right.
By default, the directory settings are global locations shared between all projects but you can change
this setting for a particular project.
Note:
If you change any of the default directories for a project, an asterisk (*) appears next to the
project.
Project Settings
Setting Description
Name Specifies the name of the project. This name is shown in the Projects list, as well as
in the title bar of the MTS TestSuite application.
Creator Displays the name of the person who created the project. This may be empty if user
management s disabled. This field is read-only.
Created Displays the date and time that the project was created. This field is read-only.
Last Displays the date and time that the project was last modified. This field is read-only.
Modified
Test Specifies the directory in which the project looks for and stores tests. By default, this
Directory directory exists under the project’s directory, but can be set to any valid directory,
including a network location.
Note: If tests are stored in a project directory (default), they are deleted if the
project is deleted.
Note: This field is read-only if there is a test open when the project settings
view is shown.
Custom Specifies the directory in which the MTS TestSuite application looks for existing
Template custom templates and stores new custom templates.
Directory
Note: MTS supplied templates are available from the MTS Templates list on
the start page or from MTS Templates list on the Select tab.
Report Specifies the directory in which the MTS TestSuite application looks for and stores
Template report templates.
Directory
Report Specifies the directory in which the MTS TestSuite application stores generated
Directory reports. By default, this field is blank and reports are stored in a test runs subdirectory
of the project.
External Specifies the directory in which the MTS TestSuite application looks for external files
Files (such as XML files used to create tests).
Directory
Data Specifies the directory in which the MTS TestSuite application saves data export files
Export created by the Export Data activity.
Directory
Description (Optional) Displays a description entered about the project.
Audit Trail
Access
Test Definition tab > General Settings tab > Log Type
When activated, the Audit Trail feature allows you to check the integrity of your data files from a
selection in the File menu. If the application detects any change, the files that do not match are listed in
a message window. It also writes information about the controller’s TEDS devices to the test log every
time the test is run, including model and serial number, version and manufacturer number, and
calibration date.
Note:
You cannot use a keyboard shortcut to resume a test.
Function keys
F1 - F10
E-Mail Overview
Access
Preferences > Configuration > E-Mail tab
You can set up e-mail activities to automatically notify interested parties of test progress. You can
insert variables into the e-mail message and attach the message log. You can also send a report
attached to an e-mail. The Send E-Mail and the Run Report activities require you to configure your
SMTP server settings if you want to use the e-mail activities in your test workflow. The e-mail
configuration uses the SMTP to relay e-mail messages for delivery.
E-Mail Settings
Access
Preferences menu > Configuration > E-Mail tab
Use the E-Mail tab of the Configuration window to enter e-mail server settings.
The following table describes the fields for configuring E-Mail for test activities.
E-Mail Settings
Setting Description
From address The default address from which e-mail is sent. The From address entered in the
E-Mail Configuration window automatically populates the From address in the
Properties panels of the Send E-Mail and Send Report to E-Mail of the Run
Report activities.
Server name The name of the SMTP server for your organization.
SMTP port The SMTP (Simple Mail Transfer Protocol) port number is typically TCP Port 25. If
number the server is set up for SMTP, the port number is typically 465.
Enable SSL If you server does not support SSL (Secure Sockets Layer), clear the Enable SSL
check box.
If your e-mail server supports secure connections, leave the Enable SSL check
box selected.
Default: Enabled
Timeout Adjust the default timeout value at the recommendation of your e-mail system
Setting Description
(seconds) administrator.
Default: 120 seconds
My server Select the check box if your server requires authentication to relay mail to e-mail
requires addresses that are external to your organization. Enter your Account Name and
authentication Password.
Clear the check box if your server does not require authentication; that is, you are
sending e-mail only internally.
Default: Enabled
Send test e- Enter the e-mail address to which you want to send a test e-mail. This is highly
mail to recommended to ensure you have correctly configured this option prior to using
address the Send E-Mail activity in a test.
The body of the test message contains your SMTP server settings.
The test e-mail address is cleared when you exit the Configuration window.
Note: When connected to an MTS FlexTest controller, the Return panel allows specifying the
Ramp Rate for the Return to zero position. When connected to an MTS Insight controller, the
Ramp Rate for the Return must be specified by an MTS Field Service Engineer.
Units Management
Unit Set Overview
Access
Preferences menu > Configuration > Unit Set Manager tab
MTS TestSuite applications contain several built-in unit sets.These sets are read-only and cannot be
modified.
l If a unit set is not defined as the system default, the application uses the MTS TestSuite
Default unit set.
l Variables and charts can point to specific units or use the default unit set for the project.
Item Description
MTS TestSuite Shows the current default unit set for the applications. Click the list arrow to
Default assign another predefined or custom unit set.
Project Default Shows the current assigned unit set for the project. Click the list arrow to assign
for another predefined or custom unit set.
<ProjectName>
Name Shows the predefined unit sets and the custom unit sets.
Type Shows the type of unit set: predefined or custom.
Item Description
Dimension Shows the type of dimension.
Unit Shows the unit selections for that type of dimension. If the unit set is a custom unit
set, click the list arrow to display selections for that type of dimension.
Add Open the Add Custom Unit Set window where you can add a custom unit set.
Enter a display name and description, and select between an International
System of Units (SI) or a United States Customary System of Units (US).
Delete Delete a custom unit set. You cannot delete a predefined system unit set.
Edit Open the Edit Custom Unit Set window where you can change the display name
or description. You cannot change the type of unit system or the individual unit
settings.
Copy Open the Copy Unit Set window to make a copy of the highlighted unit set. If you
copy a predefined unit set, the copy becomes a custom unit set in which you can
change the unit settings.
Export Export a custom unit set to another project or analysis. Click the required custom
unit set (.tsunitset) to export.
Note: If your project uses a custom unit set, it also exports with the project.
Import Import a custom unit set from another project or analysis. Click the required
custom unit set to import (.tsunitset).
Apply Save any changes and keep the Unit Set Manager window open. This button is
useful if you are making multiple custom changes.
7. (Optional) Click the editable fields under the Scale and Offset columns to specify a scale and
offset for the unit.
l The scale determines how the unit scales with respect to other units in the dimension.
To understand how scale works, consider time measurements. Seconds are treated
as the base unit, so they have a scale of 1. Minutes and hours are scaled depending
on how many seconds they contain, so their scales are 60 and 3,600 respectively.
l The offset is a positive or negative value that is always applied to the unit. To
understand how offset works, consider temperature measurements. K (Kelvin) is
treated as the base unit, so it has a scale of 1 and an offset of 0. °C also has a scale of
1 because it scales linearly with K (that is, a 1 K change is the same as a 1°C degree
change). However, because converting from K to °C requires subtracting 273.15,°C
has an offset of -273.15.
8. Click OK to close the Edit Dimension window. The new unit is added to the dimension.
Item Description
Enable Remote Enables the use of remotes services with MTS TestSuite.
Services
Server URL If desired, enter the URL of a custom remote server. By default, the built-in
remote server will be used.
Hide Server Select this option to hide the remote server console window.
Console
Resources
Working with Resources 94
TEDS Devices 101
TEDS Device Verification Checks 104
External Devices 105
Analog Outputs 118
Controller resources
You must map the test resources to controller resources before you can load and run the test
procedure on that controller. Resources are stored with the test definition and validated against the
available controller resources the next time the application connects to a controller.
Template resources
You can map controller resources and then create a test template that includes the controller
resources at the time the template is created. You can then remap any resources as necessary to the
controller the next time the application connects to the controller.
Imported resources
When resources are correctly mapped in a test, you can create other tests offline, and import the
resources between tests. You can also manually add and map individual resources.
Simulated resources
If you are not able to connect to the physical controller, you can use the controller software in
simulation mode and use a pre-configured controller configuration file. In this case, the simulation uses
the controller configuration file as its source for controller resources.
Internal Name
Generally, this is a name that is used internally to the application or by a calculation. These names do
not usually contain spaces and have character restrictions. In some cases, internal names are
assigned by the application and cannot change, and in other cases they are defined by the user and
can change. Because other parts of the system use the internal name, some additional restrictions are
in place to make sure that changing the internal name does not cause the program to fail. In some
cases (such as with variables), the name is adjusted where it can be, but in others (like test resources)
it will not allow the change to take place. These strings do not change when the language is changed.
Display Name
This is a display version of a string. It has some restrictions on allowed characters, but is much more
open than the Internal Names. These strings can be changed by the user without changing any other
part of the application. Some character restrictions apply, and some validation is done so two items at
the same level do not have the same name. These strings are translated and will change based on
language if it was saved in multiple languages (such as with templates).
Resource Details
Fastpath:
Explorer panel > Test name > Test Definition > Resources
Resources Tab
Item Description
Name Shows the names of the resources that are used in the test procedure activities.
The Show Internal Names check box toggles internal or display names in the Name
column. Typically, display names are used instead of internal names.
The Name column shows resources in a hierarchical view organization, allowing the
expand-collapse of the individual resource entries. A context right-click menu is also
available on the entries in the Name column that allows a variety of operations (add,
delete, and rename) that are specific to each entry.
Internal names are not typically edited and cannot be edited if the resource is in use
somewhere in the test procedure. Display names can be edited whenever the test
definition is editable. Test resources cannot be deleted if they are in use somewhere.
Test resources can be created whenever the test definition is editable.
Dimension The dimension of a test resource is only editable if no other test definition modules use
the resource (such as activities and runtime components). If you are connected to a
controller, do not change the dimension because that may invalidate the controller
resource assignment and show an error symbol.
Polarity Use this setting to change the polarity of a float signal. Changing the setting affects the
Effect of Increasing Extension setting. Available settings are:
l Normal
Item Description
l Inverted
Note: The Polarity setting is always available with MTS TestSuite TW or TWS
software running on an MTS Insight Controller. With a FlexTest controller, the
setting appears only when a validation error occurs. After the error is resolved,
the Polarity setting is not displayed for FlexTest (applicable to servohydraulic
only) the next time the Resources panel is accessed.
Use Count Track the use of the test resource by other parts of the test definition. If a test resource
is in use, you cannot delete it.
Controller Assign names to the resources that are expected in the configuration when Test
Resource Manager is connected to the controller.
The resource table maps the Controller Name to the test Name. The two names can
be different. Only the Controller Name must match what is used in the configuration
file. The Name column shows the names of the resources that are used in the test
procedure activities.
The Show internal names check box toggles internal or display names in the Name
column. Typically, display names are used instead of internal names.
The use of this column is different between online and offline modes.
Controller Where a cell is editable in the column, a drop-down list shows the controller resources
Resource that are compatible with a given test resource. Resources are shown in the drop-down
(when list that match the dimension. The edit line contains the current assignment, which may
connected be in the list. If a displayed resource is not in the list of compatible resources, an error
to a symbol is shown. You can select a resource from the list, or type the name into the edit
controller) box.
The Controller Resource name contains a red error symbol if a conflict occurs between
the resource in Test Manager and the resource in the controller configuration.
Controller configuration resources can be uniquely identified by either their internal
names or display names without knowing which is being specified. Therefore, you can
type either the display name or internal name into the Controller Resource column.
The box is updated to reflect the appropriate name, based on the Show Internal
Names check box.
Item Description
Controller The list is empty because no controller is connected from which to query the valid
Resource resource names. The edit box shows the internal name. If you type a different name, it
(when not is stored as the internal and display name. There is no validation error since there are
connected no controller resources to validate against.
to a
controller)
Capacity Click Check to define Max/Min resource capacity for the signal and initiate a check
against these settings when you attempt to run the test.
For example, the Load Cell Capacity configuration item is used to define an optional
minimum and optional maximum capacity for a load cell that is used with a specific
template. A check is performed between the defined minimum/maximum capacity with
the capacity of the load cell being used. If the load cell is inadequate, the test cannot
start.
Effect of Note: This setting is only available with MTS TestSuite TW or TWS software
Increasing running on an MTS Insight Controller.
Extension
This setting defines the relationship between the crosshead/displacement channel and
each float signal.
l Select Increases Value when an increase in the crosshead or actuator
extension will increase the value of the signal.
l Select Decreases Value when an increase in the crosshead or actuator
extension will decrease the value of the signal.
l Select Indefinite for signals (such as time) where there is no direct
relationship to the crosshead or actuator extension.
Resource Buttons
Resources Tab Buttons
Item Description
Add Add a resource to the table. Right-click the entries in the Name column for a menu that
Resource contains a variety of operations (add, delete, and rename) that are specific to each
hierarchy entry. These operations are necessary if no controller or test resource
information is available to import.
Import This function only works when connected to a controller. Test resources are created
Resources that correspond to all controller resources on the controller that is currently connected.
> Import If the table is empty, this function imports all the resources. If some resources are
all unused mapped already, these are not imported. If conflicts occur between existing and new
controller test resources, the names are modified to be unique.
resources
Import This function only works when connected to a controller. A window opens where you
Resources select which resources to import. This function is useful if you have an existing test and
> Import must add a reference to a few resources that were not used previously.
selected
controller
resources
Import Choose another test to import the test resources from.
Resources
> Import
resources
from
another
test
Delete Delete controller resources that are listed in the resources table but are not used
Unused anywhere in the test definition. Typically, a user can add all possible controller
resources, define the test, and delete the unused resources when the test definition is
complete. This approach keeps the resource list to a minimum with only the required
resources listed for the test, which makes the list easier to maintain if controller
resources change in the future.
Use Resources currently shown in the Controller Resource column are copied to the test
Controller resource Name column. The resources in the test procedure are changed to reflect the
Names items in the Name column. Use this feature if you want all resource names to match
(between the test procedure and the controller configuration).
Note: Disabled calculations may be referenced in the Additional Calculations list of a data
acquisition activity without causing a validation error. In these cases, the disabled references are
ignored during a test run.
Disable Resources
1. On the Resources tab, locate the resources that you want to disable. If a validation error
occurs, use the associated error icons to help locate resources that should be disabled.
2. Right-click the resource and select Disable (resource).
Warning:
The information contained in this document should only be used by qualified personnel
Misunderstood, misread, or misapplied information used to set up and operate an MTS test
system can expose personnel and equipment to severe hazards. This can result in damage to
equipment (including test articles) and injury or death to personnel.
Before you use the information in this document, verify your qualifications with your system
administrator or MTS.
MTS TestSuite supports the National Instruments (NI) M Series Multifunction Data Acquisition (DAQ)
driver. It supports Analog Input (AI), Digital Input (DI), and Digital Output (DO) signals.
Analog Input (AI) signals can be configured to single-ended non-referenced, single-ended referenced,
or differential if it is set up as a Voltage or Bridge device (Measurement Type). If it is setup as a
Thermocouple, it has a number of thermocouple types instead. You cannot mix differential and single-
ended signals on a test system. The virtual Transducer Electronic Data Sheet (TEDS) defines the
scaling, dimension, and units of the AI signal. For more information about TEDS, see “TEDS Devices”
on page 101.
The DI and DO signals are grouped into ports of 8 digital signals which are either all inputs or all
outputs. DO signals support Toggle, Pulse, Set, and Clear.
AI and DI signals can be used in limit detectors.
For more information about National Instruments Data Acquisition products, see their website at
National Instruments Data Acquisition (DAQ).
Note: Before purchasing NI M series hardware, contact MTS Technical Support to confirm your
requirements.
Configuration
To configure the NI M Series Multifunction DAQ for your test, you must modify the TW Diag
configuration file. Contact MTS technical support for this procedure.
Once configured, the devices will appear in your test and can be modified from the TW application
Resources tab. For more information about the Resources tab, see “Resource Details” on page 95.
TEDS Devices
When the TW application is used with an MTS Criterion system, the application requires the storage of
calibration information in a TEDS (Transducer Electronics Data Sheet) device or a virtual TEDS file.
The TEDS assignments and other settings made in the TEDS Devices window are saved as controller
resources and appear in each test that is run on that controller.
Note: The following TEDS procedures only apply to MTS Criterion and MTS Insight systems.
Access
Controller menu > TEDS Devices window
The TEDS Devices window shows the calibration source (virtual TEDS file or TEDS device) and
provides access to the calibration settings for the signals that use a virtual TEDS file.
Overview
The TEDS Devices window shows all the signal resources and TEDS assignments associated with
the controller and allows you to:
l Create a virtual TEDS file for a controller resource.*
l Update a virtual TEDS file.*
l Assign a virtual TEDS file to a controller resource.
l Configure a device verification for the selected device.
l Perform a device verification for the selected device.
l View the Device Verification History for the selected device.
* Requires the Edit Calibration Values privilege.
Note: Editing the information for a device that has a TEDS chip can only be performed by an
MTS Field Service Engineer.
Note: This feature only applies to MTS Criterion and MTS Insight systems.
1. On the Controller menu, click TEDS Devices.
2. Select a signal (with a TEDS file assigned as a source) from the signal list.
3. Click Details. The TEDS Details window appears.
4. Edit the TEDS settings as required.
Note: To create a backup copy of the TEDS file that you can revert to if needed, click
Save As before making any changes.
5. Click OK to save your changes.
Any changes will overwrite the settings in the TEDS file that is assigned to the signal.
Note: This feature only applies to MTS Criterion and MTS Insight systems.
1. On the Controller menu, click TEDS Devices.
2. Select a signal.
3. Click New.
4. If the selected signal is an encoder, continue to the next step. If the selected signal is _Load, _
Strain1, or _Strain2, select the type of device in the TEDS Selector window:
l Analog Input Device: Bridge-type sensor such as a load cell or strain gage.
l High-Level Voltage-Output Sensor: Non-bridge sensor (such as a string pot) that
provides a high-level voltage output.
5. The TEDS Details window appears with default settings.
6. If necessary, edit the settings and click OK.
7. In the Save As TEDS window, type a name for the TEDS file and click Save.
8. The new TEDS file is now listed as the source for the signal.
9. Click OK.
10. Click Yes to save the settings as a new file.
Note: This feature only applies to MTS Criterion and MTS Insight systems.
Warning/Lock-Out Ranges
During a device verification, the application compares the new signal value obtained during the check
to the value obtained when the device was calibrated. To configure a warning/lock-out range for a
device:
1. On the Controller menu, click TEDS Devices.
2. Select a signal from the signal list.
3. Set the Warning and Lock-Out ranges.
l If the difference between the new value(s) and the original value(s) is beyond the
Warning Range, a warning message appears. The user must determine whether to
proceed with testing or to resolve the problem with the device.
l If the difference between the new signal value and the original signal value is beyond
the Lock-Out Range, an error message appears. The application will not allow you to
run a test until the problem has been resolved.
Note: For systems running MP version 2.6 and earlier, and Series 793 version 5.7 and earlier,
this functionality is available in the Station Manager application > Station Setup window >
Sensor tab.
Clicking the Details button will show information about the selected device.
You can assign sensors resources:
l While the MTS TestSuite application is connected to the controller, and
l When changing between previously set-up devices.
External Devices
Access
Controller menu > External Devices
The External Devices window allows you to add and configure external devices as controller
resources. After the resources are configured, they can be used in tests.
Important: Many of the configuration settings are device-dependent. For more information, see
the documentation provided with the device.
Note: The External Devices procedures only apply to MTS Criterion and MTS Insight systems.
For information on using External Devices with an MTS Landmark system and other servohydraulic
systems, see the 793 Control Software at Start > MTS 793 Software > Electronic Documentation
> 793 Control Software.
Access
Controller menu > External Devices
Note: If the device you want to add is not listed, click the General Purpose
Ethernet Device Type or General Purpose Serial Device Type as
appropriate.
Once added, the new external device appears in the Device list of the External
Devices window.
2. From the Devices list, select the device that you want to configure.
3. Use the tabs in the External Devices window to configure all the settings required for
communications with the external device.
Note: After you create the External Device resource, you must use the Resources tab
to add the device to your test and define the device commands.
Tab Settings
Device Device Name—The Controller Name that appears in the Resources list.
Configuration
(Serial Serial Port - Select the COM channel for the serial port.
Devices)
Device Device Name—The Controller Name that appears in the Resources list.
Configuration
(Ethernet IP Address—Enter the unique IP address set up on the device.
Devices) Port—Enter a port number to identify the device. If multiple Ethernet devices are
used, each device must have a unique port number assignment.
Device Read Termination String (ASCII only)—Enter the string that appears at the end
Configuration of each message from the external device. For more information, see “ASCII
(Serial and Control Codes for External Devices” on page 117.
Ethernet
Devices) Write Termination String (ASCII only)—Enter the string that will appear at the
end of each message sent to the external device. For more information, see “ASCII
Control Codes for External Devices” on page 117.
Read Timeout—Enter the time the TW application waits for a response after
Tab Settings
sending a read command to the external device before a timeout occurs.
Write Timeout—Enter the time the TW application waits for a response after
writing a command to the external device before a timeout occurs.
Error String—Enter the error string returned by the device.
Protocol—Select the protocol used to communicate with the device.
l Parity
l Stop Bits
l Flow Control
l Restore Defaults - Click to restore default settings.
Command Use the Command Settings tab to add the commands that the TW application
Settings uses to communicate with the external device.
Command Name—Enter the name of the command. For example, the LX Series
Laser Extensometer uses the Target Distance command name for the Tn
command.
Command—Enter the command required by the device. For example, the LX
Series Laser Extensometer uses a L0 command for “Laser ON” and R for “Read
Data.”
Note: Enter %s (lower case) in the Command box if the output command
will be determined by a variable defined in an External Device test activity.
Send Byte Data— Select if the command is sent to the device as a byte.
Tab Settings
Wait for Acknowledgement—Select to have the TW application wait for a
response after it sends information to the external device.
Supports Return Value—Select if the external device returns an input value.
Important: This check box must be selected if the input value will be written
to a variable.
Value Type—Select a value type, such as Floating Point.
Offset—Select to enable an offset on the return value. In the field, enter the offset
to be applied.
Regular Expression—Enter the string that defines how to filter the string (return
value) returned by the external device.
Note: Click the ? button to display the Regular Expression Tool that allows
you to check the expression’s effect on various strings.
For more information on how to use this utility, see “Regular Expression Tool” on
page 111.
Multiplier—Use the multiplier value to scale the return value sent by the external
device into system units.
Signal Can Be Streamed check box—Select the check box if the device provides a signal
Settings stream that may be used in a test. Deselect the check box for devices that do not
provide a signal stream.
Internal Name—Enter the internal name of the controller resource.
Display Name—Enter the display name (the controller name displayed in the
Resources list).
Dimension—Select the dimension for the external device signal.
Unit—Select the unit for the dimension.
Query Command—Select the command (defined in the Command Settings
tab) that the TW application sends to the external device to start streaming data.
Time Interval—Defines how often the TW applications sends the Query
Command to the device to request information.
Device Command—Select the command (defined in the Command Settings tab) to
Verification send for verifying the device is communicating with your PC.
Send Command—Click the Send Command button to verify the device is
responsive.
Response—Displays the response received from sending the command.
C. In the Test String text box, enter an example of the string returned by the external
device.
D. Click Match and evaluate the filtered result that appears.
E. Change the expression as required until you achieve the desired result.
Method 1
1. Click the Test Definition tab and then the Resourcessubtab.
2. Click Import Resources to add the external device to the resource list.
All the commands associated with the device appear in the properties table.
Method 2
1. Add the external device to the Resources list for the test.
A. Click the Test Definition tab and then the Resources subtab.
B. Click Add Resource and choose External Device.
2. In the Add External Device Resource window, define the test resource:
l Show Controller Internal Names - Select this check box if you want the internal
name (defined above) displayed in the Resources list.
5. Click OK. The device now appears in the Resources list for the test.
6. To map the test resource commands to controller-resource commands associated with this
device, you must add each external-device command by clicking the + button in the device
properties table.
Properties Window
Note: If you clicked Import Resources to add the external device to the
resource list, all the commands associated with the device appear in the
properties table.
Note: If you clicked Add Resource to add the external device to the resource
list, you must add each command by clicking the + button in the device
properties table.
3. Use the controller resource lists to map test resources to controller resources.
A. In the Properties table, select a test resource.
B. Select a controller resource from the drop-down list.
4. Optional - to create a new test-resource command:
A. On the properties table for the external device, click the plus (+) button.
B. Select the new test resource (added to the bottom of the list).
C. Select a controller resource from the drop-down list.
4. From the Command list, select the command that you want to send to the device. The
Command list contains all the commands defined in the Command Settings tab.
5. Click Send Command. The response returned from the external device is displayed in the
Response field.
Code Meaning
^@ NULL
^A SOH
^B STX
^C ETX
^D EOI
^E ENQ
^F ACK
^G BEL
^H BS (Backspace)
^I HI
^J LF (Linefeed)
^K VI
Code Meaning
^L FF
^M CR (Carriage Return)
^N SO
^Q CS1
^R DC2
^S DC3
^T DC4
^U NAK
^Y EM
^Z STB
^[ ESC (Escape)
^\ FS
^] GS
^^ RS
^_ US
Analog Outputs
You can use analog outputs to control various analog devices including data recorders, external data
subsystems, oscilloscopes, fans, or other devices. When you connect an analog device to the MTS
Insight controller, the controller will send a specified voltage (between 0 and 10 V) to the device based
upon signals from resources in your test, such as force, stress, or strain.
When configuring the TEDS file for an analog output, the Physical Measurand must match the
Dimension that you selected for Analog Output 1 on the Resources subtab. When configuring the
minimum and maximum measurand values on the TEDS Details (Analog Output 1) window, keep in
mind that these values correspond to the Minimum Electrical Value and Maximum Electrical
Value.
For example, consider a scenario in which the minimum force that will be applied during your test is 0
N, and the maximum force will be 100 N. In this case, you would configure the TEDS file as follows:
As a result, the controller will produce 0 V when 0 N of force is applied. When the full 100 N of force is
applied, the controller will produce a full 10 V. When only 50 N of force is applied, the controller will
produce 5V. If the analog device connected to the controller is an oscilloscope, for example, the
oscilloscope will show readings based upon these voltages.
Managing Tests
Tests 122
Test Runs 128
Templates 132
Project 134
Export and Import 135
Tests
Tests Overview
Note: You must have the Administrator or Engineer privilege on a TWE system to create or
modify a test procedure.
A test is a file that contains test run data (if test runs were performed), and includes a copy of the
template. You can design your own test or create one from a template. Each test includes:
l A test definition
l Test runs
A test run is a single instance of running the test procedure. The data is stored in a test file with a copy
of the test procedure or template.
Test definition
The following tabbed pages are available for creating or modifying tests.
Note: Variables are an important part of a test, because they represent test values or
other information generated or accumulated during a test run. Variables are defined for
and used with a particular test. Each new test run stores a copy of the variables as
defined when the test run is created.
l Define > Report Templates—Create templates that are used to generate test reports. You
can also import report templates previously exported from another test. Report templates are
created in Microsoft Excel.
l Define > Functions—Create, modify, and manage functions.
l Define > Resources—Configure, and manage the hardware and virtual resources that are
available from the assigned test station. You can import resources previously exported from
another test.
Test Editor
The center panel of the main window is the primary work area for the test definition. You can view the
test definition in the Flowchart View by clicking the Flowchart view button (as shown in “Flowchart
View of Workflow” on page 123) or the Outline View by clicking the Outline view button (as shown in
“Outline View of Workflow” on page 124) interface. The search box helps you quickly locate an activity.
The test procedure interface has drag-and-drop and graphic features to facilitate design productivity.
For example, a test procedure consists of a sequence of activities. The Procedure tab for the test
shows the activities that are available. Test procedures are shown in the work area graphically for ease
of design and editing. To construct a test procedure, drag activities from the Procedure tab to the work
area.
Each test has a single procedure that is stored with the test definition. The procedure is included when
you create test templates. You can define the procedure while connected to hardware resources or
while working offline with the resources stored with the test from an earlier connection.
Procedure design
Whether you work with the Procedure workspace that shows the current test procedure as a flowchart
or the Outline view that shows the procedure as a hierarchy in a tree view, the graphical display
simplifies creating tests.
The Toolbox panel contains activity icons that you drag into the Test Editor and name to build a
procedure. The Properties panel shows the properties that you set for the selected activity. You can
hide or resize the panels to increase the amount of visible workspace.
Navigation
The flowchart view includes Pan and Zoom controls to help you move around complex text
procedures. The Outline view provides the Find option for locating activities by name.
Procedure run
When the test is loaded, you use the control panel to perform primary hardware and test control
operations. When you click Run, the test procedure begins. If the procedure is stopped before
completion, you can resume the test from where it stopped.
To troubleshoot procedures, you can include the Test Procedure in the test-run display to monitor test
progress.
An operator can follow the progress of a test as the test-run display indicates the current test activity. A
green triangle indicates the current activities. A blue check mark indicates completed activities.
Test-Run Progress
Procedure activities
Activities are the building blocks for test procedures. To add an activity to a procedure, click the activity
in the toolbox and drag it to a location in the procedure marked with a plus sign. If it is the first activity
being added, drag the icon to the Drop Activities Here area.
The types of procedure activities include:
l Operator messages
l Operator input
l Conditional if/else processing
l Parallel processing
l Parameter input
l Variable handling
l Command generation
l Data acquisition
l Auto offset
l External device control
l Program control and error handling
l Interacting with the monitor display
l Generating reports
Activity properties
Most activities require you to specify properties to fully define how the activity should perform. When
you add an activity that has parameters you are required to specify, the activity in the procedure
includes an error icon. The Properties tab identifies the parameters, and the Error list describes the
problem. You must correct all errors in the test before you can initialize and run the test.
All activities have a Display Name that defaults to the activity name. You can enter a name to display
for an activity. All activities provide an optional Description field to document the procedure design.
You can also set the visibility of the activity in the Progress Table.
All activities have the Enabled check box selected by default. You can clear the Enabled check box to
disable an activity.
Creating a Test
From the File menu, you can create a new test as follows:
l New Test From Current Test: Creates a new test from the test that is currently open. Any
test runs from the test that is currently open will not be transferred to the new test.
l New Test From Template: Creates a container file called a test that is used to collect data
and contains a copy of the template. Each time you run the template on a physical specimen,
the application creates a test run. The test run is a data set that populates the test.
Note: Only templates for which you are licensed appear in the New Test From
Template list.
l New Test From Existing Test: Creates a new test that includes a copy of the test without
test run data.
l New Test From File: Creates a new test from an XML file; typically used in automation.
l New Test from TestWorks 4 Import File: Creates a test from a legacy TestWorks 4 import
file.
User-prompted saves
When you create a test, that is, while you are configuring a test on the Test Definition tab, only user
prompted saves are performed. This allows you to make changes to your test design and then back out
of those changes as long as you do not run the test. To save changes to a test before you run it, you
must select Save from the File menu or choose to save changes when prompted upon closing the test
or exiting the application.
Note: You cannot save parts of a test. When you click Yes, the entire test is saved.
Automatic saves
When you run a test, the application automatically saves the test without a user prompt as follows:
l At the beginning of the test run
l Periodically during the test run
l When the test run completes
l When the test run is interrupted (e.g., power loss to the test frame)
l When the test run is stopped (pressing the Stop button on the Test Controls panel)
l When the test is unloaded (pressing the arrow button to the right of the Test Controls panel)
Saving a Test
To save a test:
1. To save a test without closing it, select File > Save, or click the Save icon.
2. To close the test, select File > Close Test.
3. You are prompted to save the test if you have made changes to the test.
Deleting a Test
Important: When you delete a test, all test definitions, test runs, test data, and reports are also
deleted.
Test Runs
Test Runs Overview
A test run is the record of a test performed on a single, selected specimen. Test run analysis data is
automatically displayed on the Review tab when a test run is finished.
Test runs are stored in the test and include:
l A copy of the test definition, including the procedure, at the time the test run is created
l A copy of the name of the selected specimen and its values at the time the test run is created
l A copy of the variable definitions at the time the test run is created
Note: Information that is not saved with the test run includes runtime display monitor
information and the test resource mapping. The test run does not reflect changes made
after the run concludes.
Test results
When a test run completes, the Review tab shows a number of standard tables and displays with test
results data.
Reports
To generate a report with a test run, you must include the Run Report activity in the test procedure.
To generate reports for existing test run results, you must have the MTS TestSuite Reporter Add-In
license.
The Review tab also includes the following buttons that can be used to generate reports for one
existing test run or for all test runs. Use the dropdown arrow to select the report template.
Color Description
Black The test run completed successfully.
Dark Blue The test run initialized successfully but has not run.
Red The test run stopped.
Orange The run is running, on hold, or an error occurred.
If a test run name is orange, data may not be available. If an error occurs while the test runs, no data is
viewable. If an interruption occurs, some data may be available.
l Create a new test from the template defined in the XML file.
The name of the test is defined in the XML file. Typically, each XML file includes a unique test
name.
l Create a test run for each specimen defined in the XML file.
l Assign values to variables in the test run.
l Assign a name and geometry type to the specimen. The specimen name will also be used for
the test-run name.
Note: A sample XML file that can be used as a test-from-file template is located in the
C:\MTS TestSuite\External Files directory.
3. On the File menu, click New > Test from File, or on the Select page, click New Test and
then double-click the New Test from File icon.
4. In the file open window, select the XML file that defines the test runs that you want to run and
click Open.
The MTS TestSuite application reads the XML file and creates a list of test runs that appear in
the Review tab. The test runs appear in the order defined in the XML file.
5. Click the Review tab to track the test run progress.
In the Review tab, the text for each test run that has not been run appears in blue italic.
6. Click the Run button.
The test run is executed and the test run results appear in the Review tab. As each test run is
performed, the text changes from blue italic to regular (non-italic) black text to indicate that the
test run is complete.
7. Click the Run button to run the next test run. Repeat until all the test runs are complete.
4. Click OK. The top-most table on the Review tab is populated with the pre-allocated test runs.
Note: When you pre-allocate test runs, each test run uses the test's default variable
values. When you select a test run, you can edit the variable values for each test run in
the lower table of the Review tab.
Note: Only variables with the Preallocate option selected (in the variable properties)
are shown in the list of preallocated variables.
When you click the green Run button, the top-most test run in the list begins. When it completes, you
can click the green Run button again to begin the second test run in the list, and so on until you reach
the last test run at the bottom of the list. The names of test runs that have not yet been run are italicized.
To run a specific test run as opposed to running tests in the list from top-to-bottom, right-click a test run
and select Run Test.
Note: If the test definition is changed during test design (for example, variables, resources, and
workflows are edited), any changes made will not be applied to existing pre-allocated test runs.
In this case, the test designer must delete the existing pre-allocated test runs and pre-allocate
new test runs.
Templates
Templates Overview
Access
C:\MTS TestSuite\Templates
Templates eliminate the requirement to re-create existing information and provide an easy way to run
standard tests. Test templates can come from one of several sources:
l An existing test—You open a copy of an existing test and assign it a default name (the original
test is not changed). The new test does not contain test runs or analysis runs from the source
test.
l A test that is saved as a template—You can save a test as a test template (File > Save As >
Template). With the exception of test and analysis runs, specimen definitions, and completed
reports, the template contains all other test information.
l A template supplied by MTS—MTS offers a variety of templates designed to comply with test
method standards (such as ASTM). MTS templates provide all the components you need to
run a test, analyze the test data, and create reports of the results.
l Resources
Note: Although a template can include test resources, if the template is designed for a
particular controller configuration, the resources may not map to (match) the test station
resources in your system.
Test definitions
You can add a test definition to a test from a template. The source of the template can be any existing
test or template that has tests. With the exception of test and analysis runs, specimen definitions, and
completed reports, the new test contains all other test information.
Template locations
Tests and templates exist on disk as folders with the .Test folder name extension. They are typically
located at a subdirectory of C:\MTSTestSuite\Projects and C:\MTSTestSuite\Templates, respectively.
Report templates are located in the C:\MTSTestSuite\Report Templates folder.
Note: Do not rename, move, or change the contents of the Projects or Templates folders
outside of the MTS TestSuite applications. To rename an open test, use the Test Information
window in any application.
Note: Template files are not fully self-contained; they contain references to other files (such as
Report Templates).
Create a Template
To create a template:
1. Open the test that you want to save as a template.
2. Click File > Save As > Template.
3. In the Save As Template window, type a name for the new template.
4. Click Save.
The current test is saved as a template. All variables and their default values are saved with
the template. The template does not include the test runs, analysis runs, or specimens from
the source project.
Delete a Template
Access
C:\MTS TestSuite\Templates
You must use Microsoft Windows Explorer to delete templates. Delete it as you would any other file.
Template files have either a .MPTemplate or a TWTemplate extension depending on which application
the template is designed for.
Project
Projects Overview
A project is a collection of settings related to tests. When you open a test, it opens in the context of its
parent project. Files associated with tests, such as external files and reports, are linked to tests with
project settings.
You can use project settings to create logical groupings of tests that contain references to the same set
of external files. You can also open an individual test in a different project, which allows you change the
files referenced by the test without modifying the test itself (files are specified relative to the directories
in the project settings).
File Locations
Note: Do not rename, move, or change the contents of the Projects, Tests, Templates, or
Report Templates folders.
Projects
Projects exist on disk as special file folders with a .Project file extension. Projects are typically located
in the installation directory: C:\MTS TestSuite\Projects.
Tests
Tests exist on disk as special file folders with a .Test file extension. They are typically located in a
directory under a project.
Templates
Test Templates exist on disk as special file folders with either a .MPTemplate or TWTemplate file
extension. They are typically located in the installation directory: C:\MTS TestSuite\Templates.
Report Templates
Report Templates exist on disk as Microsoft Excel Templates (.xltx) files. They are typically located in
the installation directory: C:\MTS TestSuite\Report Templates.
Import Projects
You can import projects stored in a file. The projects have a .tsproj file name extension. When you
select a project to import, the entire project is imported. If the project you have selected is from an
earlier version, the Conversion Wizard launches to convert it automatically to the version on disk.
Export options
You can use options from the File menu or right-click entries in the test hierarchy to export:
l A test
l One or more test runs
l Raw data from a test run
Import options
You can import:
l A test
l Test runs
l Test resources
Export a Test
To export a test:
1. Open the test that you want to export.
2. Select File > Export > Test.
3. In the Export Test window, click Browse.
4. In the Save As window:
A. Locate the directory to which you wish to export the file.
B. Enter a name.
C. Click Save.
5. In the Export Test window:
A. Select the desired specimen and test run content you wish to export with the test.
B. Click Save.
Import a Test
To import a test:
1. Select File > Import > Test. The application automatically closes any open test and prompts
you to save any changes.
2. In the Import Test window, click Browse.
3. In the browser window, locate and click the required test import (.tsproj) file, and then click
Open.
4. Click OK to close the message window that indicates the test import was successful.
1. Open the test with the test runs that you want to export.
2. Select File > Export > Test Run.
3. In the Export Test Run window, expand the export items hierarchy and select the check boxes
for the test runs that you want to export.
4. Click Browse to open a browser window.
5. If you want to overwrite an existing test run export (.tsproj) file:
A. Locate and click on the file name in the browser window.
B. Click Save.
C. Click Yes in the Save As window.
6. If you want to create a new test run export file, enter the new file name in the File Name box of
the browser window, and then click Save.
7. Click Save in the Export Test Run window. The selected test runs from the source test are
written to the test run export file.
8. Click OK in the confirmation window when the export is complete.
DAQ
Dwell +
DAQ + Cycle + DAQ High-
Detection Speed
Custom Max/Min
Properties (TWE) DAQ
Waveform + DAQ
(MPE
GoTo + DAQ only)
DAQ +
Detection
(TWE)
1) Select Signals Available Available Available Available
What signals do I want to acquire? Time and
segment count
signals are
automatically
acquired.
2) Select Triggers Available Available Hardcoded Hardcoded
to max/min. to Timed
What criteria determines which sample Triggers
points are collected? cannot specify Continues
how much data until it is
to collect. explicitly
interrupted.
Collects data
while the
command is
active.
3) Configure DAQ Buffering Available Hardcoded to N/A Available
Linear
How and when is data transferred from Data is not
the controller to the application? buffered.
Buffer type: Available Hardcoded to N/A Available
Linear
l Linear
l Circular
Buffer size Available Available N/A Available
4) Organize data into blocks? Available Always block Available Available
mode
How do I want to organize the acquired
data? Blocking the data affects how the
data is subsequently processed. If it is
DAQ
Dwell +
DAQ + Cycle + DAQ High-
Detection Speed
Custom Max/Min
Properties (TWE) DAQ
Waveform + DAQ
(MPE
GoTo + DAQ only)
DAQ +
Detection
(TWE)
not blocked, it is processed point-by-
point.
Identifier & Display Name Available Hardcoded to Available Available
Cycle block
Names associated with the data blocks name.
when it is put into the file (cycles, steps,
etc.)
Counter Available Hardcoded to Available Available
CycleCount
The variable that indicates what the block system
number is during calculations. variable.
Block boundary criteria Hardcoded Hardcoded to Hardcoded Available
to use the use the to use the
What is the criteria to divide the data into specified Segment specified
blocks? Counter Count signal. Counter
variable variable
5) Save data to variables? Available Available Available Variables
not
Stores data in variables for immediate supported.
analysis and display. How this feature
behaves depends on whether block
mode is enabled or not.
Note:
In the TWE application, the Save
data to variables option
automatically defaults to Yes
(automatically map variables).
5a) Block mode variable support: Available Available Available N/A
Signal-to-Variable Mapping Max, Min, Max, Min, Max, Min
Mean, Mean, Array functions
Saves data to variables. This is Array functions
accomplished in the Map Variables
DAQ
Dwell +
DAQ + Cycle + DAQ High-
Detection Speed
Custom Max/Min
Properties (TWE) DAQ
Waveform + DAQ
(MPE
GoTo + DAQ only)
DAQ +
Detection
(TWE)
window. functions
Additional Variables to Calculate Available Available Available N/A
The additional variables are recalculated
whenever a new block data is put into the
mapped variables.
Save Variables Available Available Available N/A
Additional variables to store with each
block.
5b) Point-by-point mode variable Available - N/A Available - N/A
support: Array Max, Min
functions functions
Signal-to-Variable Mapping
Saves data to variables.
Additional Variables to Calculate Available N/A Available N/A
The variables are recalculated whenever
a new data point is put into the mapped
variables.
Save Variables Available Available Available N/A
6) Save data to the file? Available N/A; Available Available
hardcoded to
Stores data to the file for post-test save data
analysis and display.
Select Blocks (Block mode only) Available Available Available Available
Selects the blocks to be stored.
Signal list
Each DAQ activity includes Float Signals and Integer Signals lists where you can select the signals
that you want to acquire. When any of the triggers defined in the Trigger list occurs, the signal value
for each of the signals is acquired and processed by the DAQ activity.
Note:
Some Data Acquisition activities, such as Cycle + DAQ and Custom Waveform + DAQ,
automatically collect segment count and running time signals.
Test results from the Cycle + DAQ and Custom Waveform + DAQ activities are the values
gathered for each cycle for each signal in the Signal list. The values for the running time and the axial
integer count of each channel are also included.
Signal availability
The signals you select are test resources that are defined in the Resources tab. Only the signals that
are listed in the test Resources appear in the Data Acquisition signal list.
If the desired signal does not appear in the Signal list, go to the Resources tab and click Add
Resource.
Available triggers
The types of DAQ triggering that are available depend on the type of DAQ activity that you select.
Sample Selection
Select the method used to determine when data is acquired.
l Time Between Points - Provides a convenient list of time units (ms, sec, minute, hour, day)
that allow you to define when data is acquired.
The time between points setting must be a multiple of the system period:
l If you are connected to a controller, the time that you enter is automatically adjusted to
be the closest multiple of the system period.
l If you are not connected to a controller, you can enter any value; however, when you
do connect to a controller, the application checks the system rate and automatically
adjusts the time to the closest multiple of the system period.
l Sample Rate - Specify the frequency at which data is acquired. For example, with a sample
rate of 1 Hz, the buffer acquires data points once each second.
The sample rate must be a sub-multiple of the system rate:
l If you are connected to a controller, the sample rate that you enter is automatically
adjusted to be the closest multiple of the system rate.
l If you are not connected to a controller, you can enter any value; however, when you
do connect to a controller, the application checks the system rate and automatically
adjusts the sample rate to the closest multiple of the system rate.
Sample Duration
Specify how much data is acquired:
Timed Samples - Specify the duration of time that the signals are sampled. This setting in conjunction
with the sample rate determines how many samples are acquired. For example, a timed sample
duration of 10 minutes with a sample rate of 1 Hz would result in 600 samples.
Continuous Sampling - (Default) the activity acquires samples continuously until it is interrupted.
Sample Count - Specify the total samples acquired. For example, specifying a sample count of 600 at
a sample rate of 1 Hz, the DAQ activity would run for 10 minutes.
When a value outside of the delta value is detected, the trigger establishes a new reference level and
monitors the reference signal for another delta value change from that reference level.
This type of trigger is useful when the reference signal sometimes changes quickly, and at other times
changes very little. It stores more data when the signal is changing and less when it is not changing.
Reference Signal - (Required) Select the signal to monitor for delta level triggering.
Delta Value - Specify the amount of change that must occur in the Reference Signalto trigger the
collection of data values for the selected signals.
Settings
Reference Signal - Select the signal to monitor for triggering.
Sensitivity - Defines how much the signal must change before the application detects a peak or valley
data point. Signal changes that are less than the sensitivity do not acquire signals.
Linear Buffers
A linear buffer is continually pulling data from the controller and transferring it to the application for
processing. Linear buffers are typically used when you want to capture all the data over a period of
time.
The size of the buffer determines how much data is acquired before it is processed. When the DAQ
activity ends or the test stops, any data in the buffer is processed.
Note:
When combining Peak-Valley triggering with a Timed trigger type, the buffer size must be large
enough to accommodate the reordering of the peak data relative to the timed data when peaks
and valleys are identified.
Circular Buffers
A circular buffer stores data continuously without processing the data. When the buffer is full, new data
overwrites the oldest data. The circular buffer is useful for acquiring data that captures some crucial
event (such as specimen failure), where data is not required for the whole test. The data in the buffer is
passed to the application for processing when any of the following events occur:
Note:
Make the buffer size large enough to store the data for the event that you want to capture.
When the data is put into variables, it is appended one data point at a time, and any Additional Variable
Calculations specified in the Map Variables window are recalculated after each new piece of data.
l You specify a variable for point-by-point data acquisition using the Save Variables panel of the
Map Variables window.
l Point-by-point values are available in the Array-Variable Chart and Variable Value Scope
test-run displays.
Note:
The Cycle + DAQ and the Custom Waveform + DAQ activities are hardcoded to process
block data using the Segment Count variable.
Acquired data is processed as a new block whenever the specified Counter variable changes value.
Processing options include saving the data organized by blocks for post-test analysis, saving the
blocked data into variables, or both. Calculations are performed on a block-by-block basis.
1. In the Properties panel for the DAQ activity, click the Advanced button. The Advanced Data
Acquisition window opens.
2. Click the Select Blocks button (or Select Cycles) to display the Block (or Cycle) Decimation
Filter Selection window. This window allows you to define which blocks/cycles are saved to
disk.
3. Complete the properties as appropriate.
Setting Description
Blocks/Cycles Specify the increments at which cycles are stored per decade.
per Decade
(Logarithmic) Cycle counts are divided into logarithmic decades, which are in factors of 10 (for
example 10, 100, 1000, and so on). The application divides the number of cycles in
the decade by the number of Cycles per Decade to determine the increments at
which it can reference the cycles in the decade.
For example, if 10 is specified and the test is 105 cycles long, the total number of
cycles would span into the third decade. In the first decade, the cycle increments
are 1 (10/10 =1), which equates to cycles 1, 2, 3, 4, 5, 6, 7, 8, 9, 10. In the second
decade, the cycle increments are 10 (100/10=10), which equates to cycles 10, 20,
30, 40, 50, 60, 70, 80, 90, 100. In the third decade, the cycle increments are 100
(1000/10=100), which equates to cycle 100. The test is over before the next
increment.
Every nth Specify the increments at which cycles are stored over the entire activity.
Block/Cycle
(Linear) For example, if 10 is specified and the test is 105 cycles long, cycles 10, 20, 30, 40,
50, 60, 70, 80, 90, or 100 could be shown or acquired.
Designate Specify a series of cycle numbers to store. Each cycle number must be separated
Specific by a space.
Blocks/Cycles
Block/Cycle Select a variable that the activity will monitor to initiate a data block save. The data
Change block is saved when the Change Criteria Threshold is reached.
Criteria
Variable Monitor a change in a selected variable, and then save block data when the
variable deviates by more than the specified Change Criteria Threshold amount.
You can select any numeric variable that is defined in the test or enter a numeric
value.
After the variable is selected, its dimension appears and allows you to specify the
Change Criteria Threshold.
Change The threshold value for the Block Change Criteria variable. The amount of change
Criteria can be specified with a numeric value for the shown dimension or with a variable.
Threshold
Update Note:
Interval Applicable to cycle decimation for test-run displays only.
The speed at which data can be shown. This is useful for high-speed tests that
would otherwise require too much CPU capacity to show all data points with high-
frequency cycles. The default is 1.0 second.
Setting Description
No The signal data is not saved to variables.
Yes, The acquired signals are automatically mapped to variables of the same name with
automatically the word “Array” appended and illegal characters removed.
map
variables For example, the signal with an internal name of “Axial Force” is mapped to the
variable “AxialForceArray”.
Note: l Only signals whose mapping type is an Array are automatically mapped.
This is
the l If a variable that meets the mapping criteria does not exist in the test, the
default application automatically creates the variable.
setting l Signals whose values are calculated by the DAQ activity (such as axial
for the force mean) are not automatically mapped. You must manually map these
DAQ signals using the Use Default Variables button.
activity.
In addition, any calculations that are dependent on these mapped variables are
automatically added to the Additional Variable Calculations list.
Note:
To view the automatic variable selections, click the Configure button to
display a read-only version of the Map Variables window.
Yes, This selection allows you to manually map the signals and additional calculations by
manually clicking the Configure button and using the Map Variables window. Use the Use
map Default Variable button to perform automatic mapping for the selected signals or
variables use the drop-down list for each signal to assign variables.
Note:
If you select Yes, automatically map variables, the Map Variables window opens in
read-only mode.
Important:
If there are multiple DAQ activities in a test workflow, the Before
starting setting for the first DAQ activity should be set to Discard Array
Data, and for subsequent DAQ activities, set to Retain Array Data.
Otherwise, block or cycle variables contain data acquired in preceding
blocks.
Note:
The Before starting settings are not available for the Cycle + DAQ and
the Custom Waveform + DAQ activities.
2 Signal-to- This table allows you to save (map) acquired signal data to variables.
Variable
Mapping
3 Use Default To automatically map the selected signal to a default variable (creating the
Variables variable if necessary), select the desired signals and click the Use Default
Variables button.
The name of each new variable that is created is the combination of the signal
name and calculation name. Any new variables that are created appear on the
Variables tab.
4 Filter This check box is typically selected to only display variables that are appropriate
variables for mapping.
by l If the check box is selected, the variable list includes only the variables
dimensions with the same dimension and calculation type as the signal.
and
l If the check box is cleared, all variables appear in the list. This list
calculation
type displays all variables, including variables that are not appropriate for
mapping.
5 Additional Use this panel to select calculated variables (whose calculations include signal
Variables data mapped to an array variable) that are recalculated when the mapped array
The Data Storage property setting in the Advanced Data Acquisition window determines whether data
is saved with the test run:
1. Select Discard Data to not save data. Discarded data is not available for post-test analysis.
2. Select Save Data to save the data from the test run. When saving block data, you can use the
decimation filter settings to reduce the amount of data that is saved to disk.
Note:
All time related signals (Time, Rollover Time, Running Time, and Rollover Running Time) start
from zero when the procedure is started. They can be reset during the test using the Auto
Offset activity.
Station Signals
Signal Description
Time Records the time reference signal derived from the controller’s internal clock
which increments continually.
Note:
It is not practical to monitor the Time signal for some types of data
acquisition processes (for example, Peak-Valley).
Rollover Time Records the time reference signal derived from the controller’s internal clock
which resets every hour. Like the Time signal, this signal is not practical to monitor
for some types of data acquisition processes.
Running Time Records the accumulated time of the test program, which begins when you click
Run, and ends when the program stops automatically, or when you click Hold or
Stop. Clicking Run after clicking Stop or Hold causes this value to resume
incrementing.
Signal Description
Rollover Similar to Rollover Time except it increments only while the station test state is not
Running Time in the stopped state.
Date Date is an integer number of days since Jan 0, 1900. Time of Day is a fraction of a
day since midnight. Both signals are float values that can be imported into
Time of Day Microsoft Excel, formatted as separate date and time columns, and added
together to form one date/time column. Both signal values correspond to time
stamps in the station log.
(Controller) Records the accumulated number of system ticks (updates) generated by the
System Tick controller (or multiple controllers in a multi-controller configuration) from the time
Count the Sysload application is started in the current session.
System Tick Count is typically a large unitless integer. It can be used as a
reference if you acquire signals from other controllers. It can also be useful for
synchronizing acquired data for off-line plotting when using spreadsheet
applications, such as Microsoft Excel.
Interlock, Records the binary state of the control, in which 1 = on, and 0 = off (in the case of
Run/Stop, Run/Stop, 1 = Run and 0 = Stop).
Hold, Program
Interlock, The value reveals the state of the associated control when data is acquired. In the
HSM On, HSM case of Run/Stop and Hold signals, the values may not change state since
High acquisition occurs only while the program is being run. These signals may be
useful in calculated signals.
(channel) Records the number of segments executed in the selected channel.
Integer Count
Note:
This signal measures the same value as (channel) Count, however, it has
greater resolution at higher segment counts (for instance, counts greater
than 16 million segments).
Note:
The count for a time history output increments once for each point in the
associated time history file.
(channel) Records the signal that goes to the valve driver.
Output
(channel) Records various types of sensor feedback signals in engineering units. Force and
Sensor signals Displacement are typically sensor signals.
Signal Description
(channel) Records the number of segments executed in the selected channel.
Count
Note:
This signal is a floating point number. Its resolution decreases significantly
at higher segment counts (for instance, counts greater than 16 million
segments).
(channel) Records the control mode error signal in engineering units. This signal shows the
Error difference between the Channel Name Command and the Channel Name
Control Mode Name signals.
(channel) Abs. Records the absolute value of the Error signal in engineering units. Absolute
Error means negative becomes positive and positive remains positive. This signal is
always positive.
Variable Basics
Variables Overview
A variable is a container that is used to store data values. A variable provides the ability to store and
manipulate data in applications. Variables can represent numeric values or text strings. They can also
represent the location of data in memory or on disk and provide test designers with the ability to write
flexible test procedures. The MTS TestSuite applications use variables in test activities, data
acquisition activities, analyzer applications, and reports.
A simple variable can store a single text string, Boolean, or numeric value. An array variable stores a
series of text, numeric, or Boolean values. Various activities such as calculations, operator inputs, and
data acquisition can be used to set the value stored by the variable. System and specimen variables
are predefined, read-only variables that are supplied by the application.
You can create variables from within the Variables editor, or at the point of use within the MTS
TestSuite application. Creating a variable at the point of use is done within the Properties panel of a
test activity. You can add or edit a variable from any window used to manipulate variables, such as the
Variables Selection window, the Select a Variable window, the Calculation Editor, and the DAQ Map
Variables form. Right-click in the window and click New Variable to open the New Variable window,
or click Edit Variable to open the Edit Variable window.
Variables defined in the test are stored with the test. The definition of a given variable, including its
name and type, remains constant throughout the test run, even though its value may change. Each test
run saves a “snapshot” of the test procedure and variable definitions at the time the test run is created.
Note: MTS supplied templates include pre-configured data acquisition activities and variables
that save data for use in various charts and tables that appear in the test, report templates, and
post-test analysis.
Item Description
Test Several test activity property settings can be entered as a static value or a variable.
Activities You can configure variables for an operator to enter. Other settings are defined by
variables so that they can be changed during the test and in post-test analysis
scenarios. Some variables only represent one value in a given test.
Data Data acquisition activities can be configured to store signal data in variables. This
Acquisition process, called variable mapping, makes this data available for calculations, test-run
Activities displays, post-test analysis, and reports.
Calculations You can create data acquisition activities that store signal data in array variables, and
then create an array variable that performs calculations on the signal data and stores
the result. For example, a stress array variable could include a stress calculation that
Item Description
uses data from a load-array variable.
Test-Run The Variable and Cycle views that you can add to a test-run display require data
Display acquisition activities that are set up to map test signals to variables. Once mapped,
these variables can be used in charts and tables that appear in the test-run display.
Test Most information that you want to include in a report must be saved in a variable:
Reports
l If you are creating your own tests and want to include test data in reports,
you must create data acquisition (DAQ) activities to collect the data and
create variables where the DAQ activity can save the data.
l Reports can also include other single-variable values that are not associated
with data acquisition.
Data When the Availability property of variables used in calculations are configured as
Analysis Editable Post-Test, you can change these values in post-test analysis to correct
mistakes in operator setup or to create what-if scenarios.
Data acquisition activities can map signals to variables to store the test data that is
displayed in various post-test charts and tables.
Item Description
Pretest Inputs When the Availability property of variables are configured as Pretest, they can
be displayed and changed by an operator at the beginning of a test run.
Input Variables Your test can use the Input Variables activity to assign values to one or more
test activity variables. When the activity runs, a list of selected variables and their current
values is shown. The operator can edit the variable values as required.
Note:
Variables used with this activity must have the During Test availability
property check box selected.
Assign The Assign Variables test activity can calculate and assign values to one or
Variables test more variables in the test. The calculation can be a simple value or a calculated
activity value that references other variables.
Data The Save data to variables? data acquisition (DAQ) setting allows you to save
Acquisition test acquired signal data to variables. This data is typically saved in an array variable,
activities although some DAQ activities, such as Max/Min, save single values.
Selecting the variable that the signal is saved in is referred to as “signal-to-
variable mapping”. Mapping variables is accomplished by clicking the Configure
Item Description
button in the DAQ properties.
Calculations In the variable properties, you can select the Is Calculated checkbox and use
the Calculation Editor to create a calculation that defines the value of the
variable. These calculations must be forced to calculate values using one of the
following activities:
l Add a Calculate Variables activity to your test.
l Use the Map Variables window in a data acquisition (DAQ) activity to
build a list of “Additional Variables to Calculate.” These variable values
are recalculated each time the DAQ activity collects data.
Default Values The variable editor properties allow you to enter a static default value for a
or Previous variable or select Use Previous Test Run Value to set the value.
Test Run Value
Settings
Read Variables This activity reads an XML file that contains variable values for a test run.
From File Test
Activities
Note: To specify that a numeric variable hold a multiple-value array, select the Array of
Numbers option.
To specify that a variable hold a string, select Text or Array of Text as the Type. In addition to using
text variables to store text values, you can also include text variables in calculations that use text
functions to parse and manipulate the text values. Text variables are also used in choice lists.
Note:
To specify that a text variable hold a multiple-value array, select Array of Text as the Type.
In the preceding example, a[4] refers to the fifth element of the array a.
An array variable in MTS TestSuite holds multiple values of the same data type. The available types of
array variables include:
l Array of Boolean
l Array of Numbers
l Array of Text
The elements of an array can be individually referenced or assigned; that is, each element of an array
is a variable of its own, and can be modified independently of other elements in the array.
An index variable typically defines an Index (data point) value in an array variable – not an actual signal
value (that is, load value). On the left side of the following figure, the Array Index is listed alongside
each corresponding load value that was captured during data acquisition:
Typical post-test analysis involves extracting or calculating values at a specified point in the test. If you
know the array index number, you can extract any signal value from any array associated with the
same data acquisition activity. Furthermore, If you have a signal value that you are interested in, you
can extract the index value and use it to extract a signal value from another array. You can also use the
index value for the [, startIndex, endIndex]) arguments that appear in many functions.
For example, if you extract the index value for a particular load, you can use that index value to extract
the strain value at that load. If you were to create a calculation to perform this operation, it would look
like the following:
ArrayIndex(searchChannel, searchValue[, startIndex, endIndex])
ArrayValueAtIndex(Array, Index)
In this calculation, the ArrayIndex function finds the index in the channel array that has a specified
array value, and the ArrayValueAtIndex function returns the value at that index.
When you are finished, the Assign Variables activity will look like the following:
Note:
To specify that a Boolean variable hold a multiple-value array, select Array of Boolean as the
Type.
Boolean variables are especially useful for showing or hiding interactive test-run displays. For an
example, see “Example: Check Box-Enabled Input Variable Test-Run Display” on page 502.
Important: When using calculated variables in a non-data acquisition test activity, you must add
a Calculate Variables activity to the test procedure to force the application to perform the
calculation.
Note: If a calculation has been defined for the variable and you clear the Is Calculated check
box, the panel clears and the equation is lost. If you later decide that you want to use the original
equation, you must create the equation again.
Example
For example, you want to create several calculations that include velocity, which itself is a calculation.
You can create a calculation that is used to populate the value of a variable, label it “velocity”, define its
equation, and use it wherever an equation requires a value for velocity.
Variables Editor
Open the Variables Editor by clicking the Variables Editor button in the toolbar.
Use the Variables Editor to view and edit the available variables within a test. You can create your own
variables and variable categories using the Variables editor. By default, disabled and read-only
variables are hidden from view. You can use the Variables Actions or context menus to show or hide
variables.
Any changes you make to the display of the Variables Editor are saved when you close the application.
That is, if you filter or sort variables, set the variable order, hide or display certain columns, or set the
column order, your changes to the display will be retained the next time you open the application.
2 Column Selects which columns you want to show in the variables table.
Chooser
Column Chooser
3 Filter and Filters by your selected filter criteria and sorts in ascending or descending
Sort Icons order. If a filter for a column is currently active, the filter icon appears blue.
for
Columns
4 Selected Shows the properties for the variable currently selected in the variables table.
variable
5 Properties Shows the properties for the currently selected variable.
Access
Define tab > Variables tab > Column Chooser button
You can select which columns you want to show or hide in the Variables table. By default, only the
Display Name, Default Value, Unit, and Calculation columns are shown.
Column Chooser
Select Columns
Note: MTS-supplied templates include pre-configured data acquisition activities and variables
that save data for use in various charts and tables that appear in the test, report templates, and
post-test analysis. Templates purchased from MTS may include optional variables (typically
calculations) that appear in tests. These variables are usually disabled (Enabled check box not
selected) and appear grayed out in the variables list.
1. Navigate to the Test Defininition > Variables.
2. From the Variable Actions menu or right-click context menu, choose Show Disabled
Variables.
The disabled variables are shown and appear in lighter gray text. The Show Disabled
Variables menu option toggles to Hide Disabled Variables. Click the Hide Disabled
Variables option when you are done viewing disabled variables.
Access
Test Definition > Variables
The Used By column in the Variables table indicates if and where a variable is used in the application.
This column also shows any views in the application that use the variable. The table does not
automatically show the Used By column. You must either right-click and select Update Used By or
click the Variable Actions icon (next to the red minus sign) and select Update Used By. You can also
add the column using Column Chooser, but all entries are set to “Unknown.” Click Update Used By to
update where variables are used.
The Used By information is useful if you need to:
l Edit a variable used by more than one process. If a variable is used by multiple processes, you
may want to create a new variable rather than edit a variable and impact all its uses.
l Troubleshoot a complex test definition.
l Delete or replace a variable definition. If you delete a variable that is in use, validation errors
occur in the project where the deleted variable is referenced.
Variable Usage
After you update the Used By information, click the arrow in the Used By column for the variable you
want to investigate. The window lists the locations where the variable is in use. To view the context in
which a variable is used, click on the entry:
l For a calculation, the entry for the calculated variable becomes selected.
l For an activity, the Procedure appears in the work area with the activity selected.
l For a test-run display, the Test-Run Display tab appears when you select the view.
l For a data acquisition, the Data Acquisition window appears with the corresponding entry
selected.
If the variable is defined but unused, the Used By column shows “Not Used.”
Pretest variables
Select the Pretest variables from the list of available variables and define the order that they appear in
the Setup Variables data entry window that is displayed at the beginning of a test run on the Monitor
tab.
Note: When you select a pretest variable, the Pretest check box in the Availability properties for
that variable is automatically selected.
Result variables
Select the Result variables from the list of available variables and define the order that they appear in
the Specimen Results table in the Review tab.
Note: When you select a result variable, the Result check box in the Availability properties for
that variable is automatically selected.
Access
Define tab > Variables tab > right-click and select Set Variable Order
or
Define tab > Variables tab > Variable Actions dropdown menu > Set Variable Order
Use the Set Variable Order window to select pretest and result variables and the order that they
appear in the pretest Setup Variables window and the Specimen Results table.
You can also add or edit a variable while in this window. In the Additional Variables to Calculate panel,
to open the Add Variable window, click the New Variable icon (plus sign) or right-click and select New
Variable. To open the Edit Variable window, click the Edit Variable icon (...) or right-click on a variable
name and select Edit Variable.
Delete a Variable
Note: Before you delete a variable, note the Used By information. When you delete a variable,
you also delete the Used By information, which can be useful when resolving validation errors.
You can delete any custom variables that you created. You cannot delete read-only variables, which
include variables in the System and Specimen categories. Deleted variables are not fully deleted
from the project until you save the project.
1. Click the Variables tab.
2. Click Update Used By to update the column in the table that shows whether the variable is in
use in the project.
If you delete a variable that is in use, validation errors occur in the project where the deleted
variable is referenced. You must resolve validation errors before you can create a new test
run.
3. Select the variable in the table and press the Delete key.
4. If you delete a variable that is in use, you are prompted to confirm deleting the variable. Click
Yes.
Variable Categories
Default variable categories include System variables, Specimen variables, and Variables (the default
category for user-defined variables). You can also create custom variable categories to organize
variables based on functionality.
Important: The default setting in the Variable Editor is to hide the Specimen and System
variables. To view Specimen and System variables, click the Variable Actions menu icon and
choose the Show Read-Only Variables option.
Values for all system variables are read-only. The application reads the value of the variable when the
activity that contains the variable is run, or when the test-run display that contains the variable is
updated during a test run.
System variables include the following variables, listed by Display Name and the corresponding
Identifier:
l Current Cycle Index (CycleCount)
l MTS Customer Name (CustomerName)
l MTS Site Number (SiteNumber)
Note: You cannot edit read-only variables, which include the System and Specimen groups.
Item Description
Category Select the category of the variable. By default, any variables you create in the
Variables tab are entered into a category called Variables.
Optionally, you can create a new category using the <New Category> option from
the drop-down list. Categories can only be created from the Variables tab. If you are
creating a new variable from a drop-down list at the point of use, make sure that the
proper category is already created in the Variables tab.
Identifier Uniquely identify the variable among all variables in the project.
Naming convention—Variable identifiers can contain only alphanumeric, hyphen (-)
and underscore (_) characters. The name cannot begin with a number and must
begin with an alphabetical character. They cannot contain spaces, periods, or other
special characters.
Display Provide a more operator-friendly way of identifying the same variable for use in
Name displays and reports. The default display name is the same as the identifier.
Naming convention—The display name must be a unique name; however, it can
match its variable identifier. The display name can contain alphanumeric characters,
spaces, and other special characters. The name cannot contain periods and must not
begin with a number.
Enabled Select the Enabled check box if the variable is enabled for use in the test.
Clear the Enabled checkbox if the variable is not used in the test. Variables that are
not enabled:
l Appear grayed out in the variables list.
l Cannot be used in calculations of enabled variables.
Note: You can add the state of the Enabled check box as a column in
the variable list. This allows you to filter the variables list to hide the
variables that are not used (not enabled) in the test.
Description Describe the intended use for the variable. To eliminate confusion, the description
should provide clear information about the variable. A description can help prevent
creating multiple variables that serve the same purpose.
Type Specifies the type of variable. The following types of variables are available:
l Array of Boolean—The variable holds multiple values of the Boolean data
type.
l Array of Numbers—The variable holds multiple values of the numeric data
type.
l Array of Text—The variable holds multiple values of the text data type.
Item Description
l Boolean—The variable type holds a Boolean value of either True or False.
l Number—(Default) The variable type holds numeric values.
l Text—Specify that the variable holds alphanumeric text rather than numeric
data.
Dimension Selects the unit dimension. Dimension is used by the application to determine under
which circumstances a variable can be used. The dimension is used to filter out
incompatible variables from being incorrectly used within the MTS TestSuite
application. Only those variables that have a dimension that matches the dimension of
the signal can be used in an activity. For dimensionless values such as gain or other
multipliers, Dimension and Unit are not required.
Note: The Dimension and Unit properties are not applicable to Text or
Boolean variable types, including arrays.
Unit Select a unit. The list only shows the set of units that are compatible with the
Dimension of the variable. This is the unit of measure that you want to assign to the
variable value.
Default Specify a default value for the variable to use until another value is provided for the
Value variable, either through user input or a calculation. Specify a value that is consistent
with the variable type, such as a numeric or text value.
Note: If you enter a string for a numeric variable, the default value is forced to a
numeric value of 0.000. If you enter a numeric value for a string variable, the
number is treated as a string, and not as a numeric value.
Note: You can initialize array variables array variables by entering a space-
delimited ordered list of numbers.
If a numeric default value is entered outside the variable Range, an error message is
generated.
Default Specifies the default value. Available options are:
Option
l Use Default Value from the Default Value field
l Use Previous Test Run Value
Calculation Window
Item Description
Is If a calculation has been defined for the variable and you clear the Is Calculated
Calculated check box, the calculation equation is cleared (erased).
To create a calculation, click Is Calculated and click the ellipsis ....
If a calculation is used in a variable, the result must generate the same type of data that
is stored in the variable.
The application validates variable equations as they are entered by the user and
notifies the user if the equation is valid.
... To edit a calculation, click the ellipsis ... button. The Calculation Editor window is
(ellipsis) displayed.
Evaluate Select this check box to limit evaluation of the calculation to only during the test, not
Only post-test.
During
Test When this check box is selected, the calculation is not performed in the Fatigue or
Fracture Analysis applications.
This check box must be selected if the calculation contains references to functions that
access the controller, such as Signal(), SignalFullscale(), and SystemRate(). If the
check box is not selected, a validation error occurs that you must clear before you can
start a new test run.
Option Applies the selected option to the calculation of the variable.
Availability Window
Item Description
Pretest Specify variable values from the Setup Variables window prior to test initialization.
The Setup Variables window appears after the test run is created but before the test is
initialized.
During Specify variable values when prompted to do so by the procedure during a test run.
Test
The Input Variables activity shows a window during the test run so that the operator can
specify the value of one or more variables.
This check box is selected by default.
Result Specify variables that can be used for filtering in test reports and data analysis.
Editable This setting determines post-test availability:
Post-
l When selected, you can edit the variable in post-test analysis.
Test
l When cleared, the variable is read-only for post-test analysis. During post-test
analysis, you cannot change the variable value in tables or, in TW applications,
change the value by moving chart markers.
This check box is selected by default.
Format Properties
Format Panel
Use the Format panel on the Properties panel to format the display of a numeric variable value.
Variable Information
Item Description
Format Fixed: The number appears in standard notation. For example, twenty million appears as
Type 20000000.000 for a Digit Type of Decimal with Digits set to 3.
Scientific: The number appears in E scientific notation. For example, twenty million
appears as 2.000E+007 for a Digit Type of Decimal with Digits set to 3. You can typically
use this notation for number values too large or small to be shown in standard decimal
notation. With Decimal, the number of Digits specifies the number of digits to the right of
the decimal symbol. For example, zero appears as 0.000 with Digits set to 3.
Digit Decimal: The number of digits to the right of the decimal symbol. For example, zero would
Type be displayed as 0.000 with Digits set to 3.
Significant: The number of digits that are significant. For example, zero would be displayed
as 0.00 with Digits set to 3.
Digits Specifies how many digits to use for the Digit Type.
Range Panel
Item Description
Use Range When this option is selected, the application checks the value of the variable during the
test to determine if the value is within the specified range.
If the value of the variable is not within the range, the application adjusts the value to be
within the range. If the value of the variable does fall inside the specified range, the
value remains unchanged.
Minimum Specifies the minimum value for the variable.
If Inclusive is used and the value of the variable is less than the Minimum value, the
application sets the variable value equal to the Minimum value.
If Exclusive is used and the value of the variable is less than the Minimum value, the
application sets the variable value so that it equals the Minimum value plus the
Resolution value.
Maximum Specifies the largest number the variable value can be.
If Inclusive is used, and the value of the variable is greater than the Maximum value,
the application sets the variable value equal to the Maximum value.
If Exclusive is used, and the value of the variable is greater than the Maximum value,
the application sets the variable value so that it equals the Maximum value minus the
Resolution value.
Resolution Sets the value of the variable, relative to the edge of the range.
If the value of the variable falls outside the specified (minimum and maximum) range,
the value will be adjusted to fall within the range. The adjustment is relative to the
closest edge of the range plus or minus the Resolution value.
For example, if a value of -5 is entered and the range is Minimum 0 Exclusive,
Maximum 10 Exclusive, and the Resolution is 1, the value will be set to 1. However, if a
value of 1.75 is entered, the value will not be changed because it falls within the
specified range. If .75 is entered, the value will be set to 1 because .75 is outside of the
Minimum 0 Exclusive limit.
Item Description
Use Choice Select an existing choice list or create a new one. This field is required, as indicated
List by the error icon.
When you create a variable with a choice list, you must assign a default value from
your list of values.
Click the open menu icon to see the available choice lists or to create a new one in
the Global Choice Editor.
Click <modify choice lists> to open the Global Choice Editor.
Add Adds a selection to the local choice list.
Edit Edits the identifier name or the display name of a local choice list selection.
Remove Removes a local choice list selection.
New Variable
6. In the Availability panel, select the check boxes that indicate when a variable is available for
editing.
7. Specify the Format parameters if you do not want to accept the defaults.
8. If desired, specify the Range parameters to restrict possible values to within a specified range.
l Click the add new variable (+) icon in the Test Definition tab > Variables tab. Select the
desired type of array from the Type list.
l Click Calculations in the properties panel of a Data Acquisition activity to open the Map
Variables window. Click the drop-down button in the Variables field.
l Click the Counter field drop-down list in the Data Acquisition activity properties window, and
click <new variable> to create a block variable array.
l Click the add icon in the properties panel of a Cycle + DAQ or Custom Waveform + DAQ
activity to open the Data Acquisition window. Click <new variable> from the Index Variable
field drop-down menu.
Example 1
Use choice lists in If-Else conditions and While loops. For example, in an If-Else activity, the condition
checks for the value of the variable to be equal to one of the choice list values. If that value matches, the
test procedure follows the “if” path.
Example 2
You can create a wave shape variable with values of triangle, sine, and square as its values as another
example.
Access
Tools menu > Define Global Choice List
Item Description
Display Displays the Name of the global choice list. You can select the name and click Edit or
Name Remove. Click the up or down arrow in the Display Name heading row to sort the
available lists alphabetically.
Add Adds a global choice list.
Edit Edits the selected global choice list.
Remove Removes the selected global choice list.
Choice List Items
Add Adds a choice list entry to the selected global list.
Edit Opens the Edit Choice List Entry window to change the identifier or display name for the
list entry.
Remove Removes the selected list entry from the selected global list.
Important: If a variable that meets this criteria does not exist in the test, the
application automatically creates the variable.
B. All calculations that are dependent on these mapped variables are automatically
added to the Additional Variable Calculations list.
If the DAQ activity is set up for point-by-point processing, only dependent array
calculations are added.
If the DAQ activity is set up for block-by-block processing, all dependent calculations
are added.
Note:
If you select Yes, automatically map variables, the Map Variables window opens in
read-only mode.
Important:
If there are multiple DAQ activities in a test workflow, the Before
starting setting for the first DAQ activity should be set to Discard Array
Data, and for subsequent DAQ activities, set to Retain Array Data.
Otherwise, block or cycle variables contain data acquired in preceding
blocks.
Note:
The Before starting settings are not available for the Cycle + DAQ and
the Custom Waveform + DAQ activities.
2 Signal-to- This table allows you to save (map) acquired signal data to variables.
Variable
Mapping
3 Use Default To automatically map the selected signal to a default variable (creating the
Variables variable if necessary), select the desired signals and click the Use Default
Variables button.
The name of each new variable that is created is the combination of the signal
name and calculation name. Any new variables that are created appear on the
Variables tab.
4 Filter This check box is typically selected to only display variables that are appropriate
variables for mapping.
by l If the check box is selected, the variable list includes only the variables
dimensions with the same dimension and calculation type as the signal.
and
l If the check box is cleared, all variables appear in the list. This list
calculation
type displays all variables, including variables that are not appropriate for
mapping.
5 Additional Use this panel to select calculated variables (whose calculations include signal
Variables data mapped to an array variable) that are recalculated when the mapped array
Important:
The application only calculates data for a signal if it is mapped to a variable.
The Signal to Variable Mapping panel allows you to map signals to variables.
To see the variables that are available to map, click the drop-down button.
If the Filter variables by dimension and calculation type check box is selected, the variable list
includes only the variables with the same dimension and calculation type as the signal. If the check box
is clear, all variables appear in the list.
If a variable is mapped to signal data, the data is calculated during the test run for those cycles that are
selected or defined in the properties for the Data Acquisition activity. The data values for each acquired
cycle are available for use in the runtime display and are saved for post-test analysis.
Default mapping
To automatically create new variables (if the defaults do not already exist) for selected signals and map
them to the correct signal data calculations, click the Use Default Variables button.
The name of each variable is the combination of the signal name and calculation name. The application
also copies the new variable definitions to the Variables tab.
Save Variables
Select one or more variables to store the value in the raw data file for each group.
To specify a variable, click Edit List and select one or more variables.
l Cyclic data is stored at the end of each cycle.
l Group data is stored at each boundary, such as a step or segment.
l Non-cyclic data is stored at the end of the data acquisition. The stored data lets you reset the
value at each capture point of the acquisition.
Variables Calculations
Calculation Editor Overview
Access
To open the Calculation Editor, click the Variables tab. Click the name of a variable that contains a
calculation. In the Calculation panel of the Properties panel, click the ellipsis (...) to open the
Calculation Editor.
You can add or edit a variable while in this window. To open the Add Variable window, right-click and
select New Variable. To open the Edit Variable window, right-click on a variable name and select Edit
Variable.
Four panels comprise this screen: Calculation, Errors, Variables, and Functions.
Calculation panel
Use the Calculation panel of the Calculation Editor to build a variable calculation. You can edit text
directly in the panel, or you can use the Variables and Functions panels to insert defined variable and
functions. Note the following on the Calculation panel:
l Variables can use reference signals, other variables, and calculation parameters.
l Names are not case-sensitive.
l Variables and signal labels have identifiers and display names. Use the identifier name when
creating a calculation that uses the signal.
When you are satisfied with the calculation, click OK to add the calculation to the variable selected in
the Variables Editor window.
Note: If adjacent variable names are not separated by a space or function in the Calculation
panel, they are interpreted as a single variable name. This is likely to result in a “...variable...,
was not found” error message.
Errors panel
The Errors panel of the Calculation Editor continually evaluates the calculation as you build it.
Note: Calculations are validated only on syntax and references to variables and functions, not
expected results.
Variables panel
The Variables panel of the Calculation Editor lists all variables defined for the project. Double-click a
variable to add the variable to the calculation. To sort the variables, click a column heading.
Signals/Channels panel
The Signals/Channels panel of the Calculation Editor lists all the signals and channels defined in the
project. Double-click a signal or channel to add the signal or channel to the calculation. The signal or
channel that you added appears at the location of your cursor in the Calculation panel .
To sort the signals or channels, click a column heading.
Functions panel
The Functions panel of the Calculation Editor contains a list of defined program functions and
operators. Double-click a function to add the function to the calculation.
Click the modify choice lists icon to select specific categories of functions. To sort the functions, click a
column heading.
Square brackets [ ] indicate you can add an optional parameter. Remove the square brackets
regardless if you add an optional parameter. A calculation error occurs if they are not removed.
Parentheses ( ) in the syntax means that you must add a parameter.
For example, the function below requires two variable parameters that contain the stress and strain
data. The start and end indexes for loading and unloading modulus calculations are optional because
they are in square brackets.
CycleModulus(Stress,Strain[, startIndexLoading,endIndexLoading, startIndexUnloading,
endIndexUnloading])
Note: The variable parameters between the parentheses are not the identities of the variables.
They indicate the type of variable that must be placed in the syntax.
Note: Some programming languages use a semicolon as a list separator instead of a comma. If
you are using one of those languages, the last operator of the table would be replaced with a
semicolon.
Operator Precedence
Variable-Specific Information
You can reference variables with delimited notation. A dot separates the variable name from the
specifier: <variable_name>.<specifier>
For example, the display name of a variable named PeakLoad is <PeakLoad>.<display name>
Specifier Properties
Item Description
Display Name Shows the display name of the variable.
Identifier Shows the internal name of the variable.
Units Shows the units of the variable.
Size Shows the array size of the variable. If the variable is not an array, the value is 1.
Argument types
The types of arguments that can be passed to a function are:
l Number
l String
l Array
l Signal or test input
In all cases, the argument type that is shown in the Calculation window must be replaced by a
meaningful value. The meaningful value can be an actual value, a variable that contains a value that is
of the correct type for the argument, or another function that produces a result that is of the correct type
for the argument.
For example, if the function cos(number) is added to the Calculation panel, the message, “The
variable, number, was not found” is shown in the Error panel. The argument “number” must be
replaced with a value, a variable of the correct type, or a function that evaluates to the correct type. In
this case the number 30, the variable CycleCount, or the function cos(sin(30)) validates the calculation.
The Error panel message reads, “Equation is OK” when one of these replacements is used.
Argument syntax
When replacing a representative number or string argument type with an actual number value or a
string value, you must use the correct syntax for the value.
l A string value must be enclosed between double-quotation marks. For example: the function
ToLower(string), can be replaced by ToLower(“This is a short sentence.”), but not by
ToLower(This is a short sentence.).
l A numeric value is typed without quotation marks. For example: the function cos(number) can
be replaced by cos(30), but not by cos(“30”).
Arguments can also be replaced with variables of the correct type.
Unique functions
There are unique functions available in the Calculation Editor that do not accept arguments.
l The function e() represents the natural logarithmic base, e.
l The function Pi() represents the mathematical constant, pi.
l The function SystemRate() represents the system data rate.
see the base arguments that the function expects to receive. By doing this, you can better understand
which values are being fed into any specific function that is used in a calculation.
In the example below, the Channel Value function was reinserted at the bottom to provide descriptions
of the arguments. This makes it apparent that the function searches the StrainArray (searchChannel)
for the value of StrainPoint01 (search value) and returns the stress value (resultChannel) at a strain
value = StrainPoint01.
LeastSquaresFit
LeastSquaresFit(StressArray, StrainArray, Slope1, Slope2
The slope of the least squares fit of the array that contains Y-axis data and X-axis data between the
start and end indexes. This is typically used when calculating modulus in TestSuite TW applications.
Loading Modulus
LoadingModulus(Stress, Strain[, startIndex, endIndex])
The loading modulus is the modulus of the portion of the curve where the load on the specimen
increases. This function calculates the loading modulus using the Stress and Strain arrays between
the startIndex and endIndex.
If the startIndex is set to -1, the optimum start index is the valley offset by 5 points. If variables represent
this field in the function and the original value is -1, the variable contains the calculated index at the
completion of the function.
If the endIndex is set to -1, you can calculate the optimum endpoint:
1. Locate a nominal end index at 25% of the stress range and within the linear modulus range.
2. Calculate a nominal modulus at the nominal end index.
3. Expand the nominal end index away from the start index until the new modulus value differs
from the nominal modulus by more than 2%.
4. The endIndex is set before the newly calculated modulus exceeds the nominal modulus.
If variables represent this field in the function and the original value is -1, the variable contains the
calculated index at the completion of the function.
UnLoading Modulus
UnLoadingModulus(Stress, Strain[, startIndex, endIndex])
The unloading modulus is the modulus of the portion of the curve where the load on the specimen
decreases. This function calculates the unloading modulus using the Stress and Strain arrays between
the startIndex and endIndex.
If the startIndex is set to -1, the optimum starting index is the peak offset by 5 points. If variables
represent this field in the function and the original value is -1, the variable contains the calculated index
at completion of the function.
If the endIndex is set to -1, you can calculate the optimum endpoint:
1. Locate a nominal end index at 25% of the stress range and within the linear modulus range.
2. Calculate a nominal modulus at the nominal end index.
3. Expand the nominal end index away from the start index until the new modulus value differs
from the nominal modulus by more than 2%.
4. The endIndex is set before the newly calculated modulus exceeds the nominal modulus.
If variables represent this field in the function and the original value is -1, the variable contains the
calculated index at the completion of the function.
Cycle Modulus
CycleModulus(Stress, Strain[, startIndexLoading, endIndexLoading, startIndexUnloading,
endIndexUnloading])
CycleModulus returns the average of LoadingModulus and UnloadingModulus.
Fatigue Life
FatigueLife(YAxis, XAxis, startIndex, endIndex, percentageDrop)
The FatigueLife function returns the index of the point where the material under test fails. The failure
point is after endIndex where the Y-Axis value falls below (percentageDrop) the Least Squares Fit line
of X-Axis and Y-Axis data between startIndex and endIndex. This function provides the drop line for
the Failure Cycle Chart.
Note:
If adjacent variable names are not separated by a space
or function in the Calculation panel, they are interpreted
as a single variable name. This is likely to result in a
“...variable..., was not found” error message.
2 Errors panel The Errors panel continually evaluates the calculation as you build it.
Note:
Calculations are validated only on syntax and references to
variables and functions, not expected results.
3 Variables tab The Variables panel lists all variables defined for the project. Double-
click a variable or click a variable and click Insert to add the variable to
the calculation. The cursor location in the Calculation panel shows the
added variable.
To sort the displayed variables, click a column heading to sort the
variables by the values in that column. Click the same column heading
again to reverse the sort order.
Note:
The variable parameters between the parentheses are not the
identities of the variables. They indicate the type of variable that
must be placed in the syntax.
Base units
Although MTS TestSuite applications allow the user to specify variable units, all calculations convert
variable values and constants to a constant set of base units. This can be problematic if you add a
constant to an equation and assume that it will use the same user-assigned units as the other variables
in the calculation.
Note: When using the Calculation Editor, you can move the mouse over any variable in the
calculation to display a tool tip that specifies the base units used when that calculation is
performed.
Example
For example, the following calculation would yield incorrect results because the test designer has
entered a constant that they assumed would match the user-assigned units.
y = x +(1)
where: the variable (x) has user-assigned units of feet and the constant (1) is assumed to also have the
same units of feet.
If the value of x=3 feet the assumption is that:
y = 3 ft. + 1 ft. = 4 ft. where: y is a variable with a dimension = “length” and units = feet
But, because the constant (1) is converted to the application’s base units for length (meters in this
example), the equation returns the following:
y = 0.9144 + 1 = 1.9144 so that: the displayed value of y = 6.281 ft. (not 4 ft.)
Specifier Properties
Item Description
Display Name Shows the display name of the variable.
Identifier Shows the internal name of the variable.
Units Shows the units of the variable.
Size Shows the array size of the variable. If the variable is not an array, the value is 1.
Access
Define tab > Test flow > Pre-test > Calculations
Pre-test calculations are calculations that pertain to Common (global) variables. Common variables
are variables associated with the entire test, not individual test runs.
A common use for pre-test calculations is concatenating strings to name the file, the test, and the test
run.
Example: Suppose you want the Test Name variable, which is used as the file name and shown in
test reports, to be a concatenation of the lot number and the test date. To do this:
1. Create a new test.
Click the New Test from Template button. Select the Simplified Tension test.
2. Add two variables to accept lot number and test date data.
A. In the Explorer window, select Variables.
B. On the Variables tab, click the + sign to add a variable.
C. In the New Variable window, enter LotNumber. Click OK.
D. In the Properties window:
a. Change Display Name to Enter lot number.
b. Change Type to Text.
E. In the Variables tab, click the + sign to add a variable.
F. In the New Variable window, enter TestDate. Click OK.
G. In the Properties window:
a. Change Display Name to Enter test date.
b. Change Type to Text.
3. Make the Name of the Test variable calculated.
A. In the Explorer window, click Variables.
B. On the Variables tab, click Name of the Test.
C. In the Properties window, click to select Is Calculated.
D. Click the ellipsis (...) in the Calculation tab.
E. In the Calculation Editor, select Enter lot number from the list, enter +"_"+, and
then select Enter date from the list. The resulting calculation is LotNumber+"_
"+TestDate. Click OK.
F. In the Properties window Availability tab, click to select During-Test and Result.
4. Enable the Input Variables and Calculate Variables activities in the Procedure Flow and
add the appropriate variables to them.
A. Navigate to the Procedure Table by selecting the Define and Procedure tabs.
B. Click the Input Variables icon in the Set Up group of the Procedure Flow.
C. In the Properties window, click Enable.
D. On the Variable List tab, click + to add a variable.
E. In the Variables Selection window, move Enter lot number and Enter test date
from Available to Selected. Click OK.
F. Click the Calculate Variables activity in the Set Up group of the Procedure Flow.
Important: The calculation for this example will occur only the first time you run the
program. This is because the Input Variables and Calculation Variables activities
are in the Set Up Group. To perform calculations for each test run, use the Run
group for the activities instead.
Tip: The input variables used to make up the test name could be selected from choice lists.
Operators
When an operator is added to a calculation, it acts directly on the operands to its left and right by
assigning a value, performing a comparison, or performing a mathematical calculation.
However, some operators like the Not (!), Ones Complement (~), and Subtraction when used as a
Negate (-), operate on only one argument to the right.
Argument types
The types of arguments that can be passed to a function are:
l Number
l String
l Array
l Signal or test input
In all cases, the argument type that is shown in the Calculation window must be replaced by a
meaningful value. The meaningful value can be an actual value, a variable that contains a value that is
of the correct type for the argument, or another function that produces a result that is of the correct type
for the argument.
For example, if the function cos(number) is added to the Calculation panel, the message, “The
variable, number, was not found” is shown in the Error panel. The argument “number” must be
replaced with a value, a variable of the correct type, or a function that evaluates to the correct type. In
this case, the number 30, the variable CycleCount, or the function cos(sin(30)) validates the
calculation. The Error panel message reads, “Equation is OK” when one of these replacements is
used.
Argument syntax
When replacing a representative number or string argument type with an actual number value or a
string value, you must use the correct syntax for the value.
l A string value must be enclosed between double-quotes. For example: the function ToLower
(string), can be replaced by ToLower(“This is a short sentence.”), but not by ToLower(This is a
short sentence.).
l A numeric value is typed without quotes. For example: the function cos(number) can be
replaced by cos(30), but not by cos(“30”).
Arguments can also be replaced with variables of the correct type.
Array Functions
This section provides reference information for functions used on arrays.
Compliance
The Compliance function is used to minimize the effects of frame deflections under high force.
Returns
The amount of the extension that needs to be compensated.
Syntax
Compliance(ForceArray, ComplianceCoefficients)
Parameters
ForceArray - The force array data.
ComplianceCoefficients - The coefficient array generated during the compliance Test Run.
Unit Class
Extension
Example
ExtensionArray - Compliance(ForceArray, ComplianceCoefficients)
CurveFitValue
Returns
The requested coefficient.
Syntax
CurveFitValue(Order, Coefficient, yArray, aArray, StartIndex, EndIndex)
Parameters
Order—The order of the polynomial fit to calculate using the yArray and xArray data.
Coefficient—The coefficient to return.
yArray—The Y array data.
xArray—The X array data.
StartIndex—The optional start index of the arrays.
EndIndex—The optional end index of the arrays.
Unit Class
Dependent upon equation order, coefficient number, and channels specified.
Example
CurveFitValue(2, 0, yArray, aArray, StartIndex, EndIndex)
This example returns the zero coefficient from the second order polynomial fit on the X and Y arrays
between the indexes specified by StartIndex and EndIndex.
Polynomial
The Polynomial function returns the Y value based on an X value and the coefficients generated with
the PolynomialFit function.
Returns
The Y value associated with the X value.
Syntax
Polynomial(X,Coefficients)
Unit Class
The units associated with the Y data used to calculated the coefficients.
Example
Polynomial(X, coefficients)
This example returns the Y value calculated at the value X.
PolynomialFit
The PolynomialFit function fits a polynomial curve of the specified order to the data arrays.
Returns
The coefficients as an array. The number of array values returned is one plus the order specified.
Syntax
PolynomialFit(yArray, xArray, Order[, StartIndex, EndIndex, rSquared])
Parameters
yArray—The Y array data being analyzed.
xArray—The X array data being analyzed.
Order—The order of the polynomial fit.
StartIndex—The optional start index of the region to be analyzed.
EndIndex—The optional end index of the region to be analyzed.
rSquared—An optional variable that is used to pass the coefficient of determination (R2)
Unit Class
Dependent on the coefficient.
Example
PolynomialFit(Force, Extension, 1, Slope1, Slope2)
This example returns the coefficients for a straight line through the regions specified by Slope1 and
Slope2.
Controller Functions
This section provides reference information for controller functions.
Note:
The TimePattern depends upon your Windows settings in the Format tab for regional areas.
GetTransitionTime
Returns
Returns the time from the specified channel and transition time type.
Syntax
GetTransitionTime([ timePattern])
Parameters
timePattern
SetTransitionTime
Returns
Sets the time from the specified channel and transition time type.
Syntax
SetTransitionTime([ timePattern])
Parameters
timePattern
Signal
Returns
Current value from a signal.
Syntax
Signal(SignalName)
Parameters
SignalName
SignalFullScale
Returns
Full scale value from a signal.
Syntax
SignalFullScale(SignalName[, MinimumOrMaximumOption)
Parameters
SignalName
MinimumOrMaximumOption—One of the optional arguments: Minimum; minimum; Maximum;
maximum; Upper; upper; Lower; or lower
SystemRate
Returns
The maximum data rate for the controller.
Syntax
SystemRate()
Trace
Returns
Gets the percentage complete of the current segment for a channel.
Syntax
Trace(ChannelName)
Parameters
ChannelName
Cyclic Functions
This section provides reference information for cyclic functions.
AnalysisRun
Returns
Accesses the variable across analysis runs.
Syntax
AnalysisRun[Index].variable
Block
Returns
Accesses data across blocks.
Syntax
Block[blockName, Index].variable
Parameters
blockName
Cycle
Returns
Accesses the variable in cycles.
Syntax
Cycle[Index].variable
TestRun
Returns
Accesses the variable across test runs.
Syntax
TestRun[Index].variable
TestCreationDate
Returns
Returns the creation date of the test.
Syntax
TestCreationDate([ datePattern])
Parameters
datePattern—Formats the date according to the specified pattern. For example, “d” is a short date
pattern (MM/dd/yyyy); “D” is a long date pattern (dddd, MMMM dd, yyyy).
Detailed date and time pattern format specifier information is available from the MSDN resources Web
site.
Examples
TestCreationDate([ “d”])
Returns a test creation date in a short date format, assuming a United States English culture:
4/15/2012
TestCreationDate([ “D”])
Returns a test creation date in a long date format, assuming a United States English culture:
Saturday, March 31, 2012
TestCreationTime
Returns
Returns the creation time of the test.
Syntax
TestCreationTime([ timePattern])
Parameters
timePattern—Formats the time according to the specified pattern. Set the time pattern to the exact
format desired. For example, to obtain the pattern h-mm-ss for hours-minutes-seconds, the function
should specify "hh-mm-ss".
Detailed date and time pattern format specifier information is available from the MSDN resources Web
site.
Example
TestCreationTime([ “hh:mm:ss tt”])
Displays the time as 10:04:01 PM.
Unit Class
String
TestModificationDate
Note:
This function replaces the SampleModificationDate function from the TW4 application.
Returns
Returns the last modification date of the test run.
Syntax
TestModificationDate([ datePattern])
Parameters
datePattern—Formats the date according to the specified pattern. For example, “d” is a short date
pattern (MM/dd/yyyy); “D” is a long date pattern (dddd, MMMM dd, yyyy).
Detailed date and time pattern format specifier information is available from the MSDN resources Web
site.
Examples
TestModificationDate([ “d”])
Returns a test modification date in a short date format, assuming a United States English culture (us
en):
4/15/2012
TestModificationDate([ “D”])
Returns a test creation date in a long date format, assuming a United States English culture:
Saturday, March 31, 2012
Unit Class
Integer
TestModificationTime
Note:
This function replaces the SampleModificationTime function from the TW4 application.
Returns
Returns the last modification time of the test run.
Syntax
TestModificationTime([ timePattern])
Parameters
timePattern—Formats the time according to the specified pattern. Set the time pattern to the exact
format desired. For example, to obtain the pattern h-mm-ss for hours-minutes-seconds, the function
should specify "hh-mm-ss".
Detailed date and time pattern format specifier information is available from the MSDN resources Web
site.
Example
TestModificationTime([ “hh:mm:ss tt”])
Unit Class
String
TestRunCreationDate
Note:
This function replaces the SampleCreationDate function from the TW4 application.
Returns
Returns the creation date of the test run.
Syntax
TestRunCreationDate([ datePattern])
Parameters
datePattern—Formats the date according to the specified pattern. For example, “d” is a short date
pattern (MM/dd/yyyy); “D” is a long date pattern (dddd, MMMM dd, yyyy).
Detailed date and time pattern format specifier information is available from the MSDN resources Web
site.
Examples
TestRunCreationDate([ “d”])
Returns a test run creation date in a short date format, assuming a United States English culture (us
en):
4/15/2012
TestRunCreationDate([ “D”])
Returns a test run creation date in a long date format, assuming a United States English culture:
Saturday, March 31, 2012
Unit Class
String
TestRunCreationTime
Note:
This function replaces the SampleCreationTime function from the TW4 application.
Returns
Returns the creation time of the test run.
Syntax
TestRunCreationTime([ timePattern])
Parameters
timePattern—Formats the time according to the specified pattern. Set the time pattern to the exact
format desired. For example, to obtain the pattern h-mm-ss for hours-minutes-seconds, the function
should specify "hh-mm-ss".
Detailed date and time pattern format specifier information is available from the MSDN resources Web
site.
Example
TestRunCreationTime([ “hh:mm:ss tt”])
Displays the time as 10:04:01 PM.
Unit Class
String
Directory Functions
This section provides reference information for directory functions that return information about the
default project, test, test run, external files, and data export directories that are configured in
Preferences > Configuration > Project.
CurrentProjectDirectory
Returns
Returns the current project directory.
Syntax
CurrentProjectDirectory()
Unit Class
String
CurrentTestDirectory
Returns
Returns the current test directory.
Syntax
CurrentTestDirectory()
Unit Class
String
CurrentTestRunDirectory
Returns
Returns the current test run directory. The directory is set in Preferences > Configuration > Project.
Syntax
CurrentTestRunDirectory()
Unit Class
String
DataExportDirectory
Returns
Returns the directory for exported data. The directory is set in Preferences > Configuration > Project.
Syntax
DataExportDirectory()
Unit Class
String
DefaultReportDirectory
Returns
Returns the default reports directory. The directory is set in Preferences > Configuration > Project.
Syntax
DefaultReportDirectory()
Unit Class
String
ExternalFilesDirectory
Returns
Returns the directory for external files. The directory is set in Preferences > Configuration > Project.
Syntax
ExternalFilesDirectory()
Unit Class
String
TestDirectory
Returns
Returns the directory for the test. The directory is set in Preferences > Configuration > Project.
Syntax
TestDirectory()
Unit Class
String
CalcInelStrain
Calculated Inelastic Strain.
Returns
The CalcInelStrain function returns the value:
Strain - Stress/Modulus
The calculation provides the value of the Strain minus the Stress divided by the modulus. If Strain and
Stress are arrays, the result is an array. If Strain and Stress are single numbers, the result is a single
number.
Syntax
CalcInelStrain(Stress, Strain, Modulus)
Parameters
Stress
Strain
Modulus
HysteresisArea
Returns
The HysteresisArea function returns the area under the curve defined by the Stress and Strain array
data.
Syntax
HysteresisArea(StressArray, StrainArray)
Parameters
StressArray
StrainArray
MeasInelasticStrainMax
Measured Inelastic Strain Maximum. The measured inelastic strain range is specific to materials
fatigue testing, especially Low Cycle Fatigue (LCF). The application calculates the mean stress from
the stress and strain data that represents one cycle. The two points where the mean intersects the
curve determines the strain values. The MeasInelStrainMax function returns the maximum of these
two strain values. The MeasInelStrainMin function returns the minimum of these two strain values.
Returns
Returns the maximum of the two strain values as described above.
Syntax
MeasInelStrainMax(stressVar, strainVar)
Parameters
stressVar
strainVar
MeasInelasticStrainMin
Measured Inelastic Strain Minimum. The measured inelastic strain range is specific to materials fatigue
testing, especially Low Cycle Fatigue (LCF). The application calculates the mean stress from the
stress and strain data that represents one cycle. The two points where the mean intersects the curve
determines the strain values. The MeasInelStrainMax function returns the maximum of these two
strain values. The MeasInelStrainMin function returns the minimum of these two strain values.
Syntax
MeasInelStrainMin(stressVar, strainVar)
Returns
The MeasInelStrainMin function returns the minimum of the two strain values.
Parameters
stressVar
strainVar
StrainA
StrainA(StrainMax, StrainMin)
The StrainA function returns the value:
((StrainMax - StrainMin)/(StrainMax + StrainMin))
StrainR
StrainR(StrainMax, StrainMin)
The StrainR function returns the value:
StrainMin/StrainMax
StressA
StressA(StressMax, StressMin)
StressR
StressR(StressMax, StressMin)
The StressR function returns the value:
StressMin/StressMax
Index Functions
This section contains reference information about index functions.
Note:
The “Peak” variable stores the index value for peak load. The “PeakLoadStrainValue” variable
uses the ArrayValueAtIndex function to calculate and store the strain value at the peak-load
index.
BreakIndexByDropFromPeak
The BreakIndexByDropFromPeak function is used to calculate the break point using a specified drop
from the peak in the array data.
Returns
This function returns the index point in the array where the break point was detected.
Syntax
BreakIndexByDropFromPeak(channel, dropValue, [startIndex], [endIndex])
Parameters
BreakIndexByDropFromPeak Parameters
Parameter Description
Channel The array data being analyzed for the break point.
DropValue The percentage drop from the peak that signifies a break occurred.
StartIndex The optional starting point in the array. The starting point in the array is used if this
parameter is not provided.
EndIndex The optional ending point in the array. The last point in the array is used if this
parameter is not provided.
Unit Class
Integer
Example
A test contains the input BreakDrop that is equal to 80%.
BreakIndexByDropFromPeak(_Load, BreakDrop)
This formula:
1. Searches the _Load channel.
2. Looks for the _Load channel to drop 80% from its peak value. 80% is the value of the input
BreakDrop.
If PeakLoad = 100lbs, then the calculation returns the number of the data point when the load has
dropped to 20lbs.
If PeakLoad = 80lbs, then the calculation returns the number of the data point when the load has
dropped to 16lbs.
BreakIndexByDropPerExt
The BreakIndexByDropPerExt function is used to calculate the break point using a specified drop from
the peak in the array data that occurs over a predefined change in the extension data.
Returns
This function returns the index point in the array where the break point was detected.
Syntax
BreakIndexByDropPerExt(dropChannel, dropValue, extensionChannel, extensionValue,
[startIndex], [endIndex])
Parameters
Chart Descriptions
Parameter Description
DropChannel The array data being analyzed for the break point.
DropValue The percentage drop from the peak that signifies a break occurred.
ExtensionChannel The extension data being analyzed for the change in extension.
ExtensionValue The change in extension value required for the break to be determined.
StartIndex The optional starting point in the array. The starting point in the array is used if
this parameter is not provided.
EndIndex The optional ending point in the array. The last point in the array is used if this
parameter is not provided.
Unit Class
Integer
Example
A test contains the input BreakDrop that is equal to 80% and the input. It also contains the input
BreakElongation that is equal to 0.1in.
BreakIndexByDropPerExt (_Load, BreakDrop, PrimaryExt,BreakElongation)
This formula:
1. Searches the _Load channel and the PrimaryExtension channel.
2. Looks for the _Load channel to drop 80% from its peak value, and for the PrimaryExt channel
to change by 0.1 in.
If PeakLoad = 100lbs, then the calculation returns the number of the data point when the load has
dropped to 20lbs and the PrimaryExt channel has changed by 0.1 in.
If PeakLoad = 80lbs, then the calculation returns the number of the data point when the load has
dropped to 16lbs and the PrimaryExt channel has changed by 0.1 in.
ArrayIndex
The ArrayIndex function is used to locate the index of the data in the array that is closest in value to the
value being searched.
Returns
This function returns the index point in the array of the closest value.
Syntax
ArrayIndex (searchArray, searchValue,[startIndex], [endIndex])
Parameters
SearchArray—The array data being analyzed.
SearchValue—The value being search for in the array.
StartIndex—The optional starting point in the array. The starting point in the array is used if this
parameter is not provided.
EndIndex—The optional ending point in the array. The last point in the array is used if this parameter is
not provided.
Unit Class
Integer
Example
A test contains the input StrainPoint1 that is equal to 10%.
ArrayIndex (Strain, StrainPoint1)
This formula:
1. Searches the Strain channel.
2. Locates the data point whose value is closest to 10% strain.
If data point #100 has a strain value of 9.8% and data point #101 has a strain value of 10.1%, the
calculation returns the value #101 because this data point is closest to the desired value.
FractureIndex
The FractureIndex function finds the fracture index. A line is drawn at a percentage (the fracture
percent) of the slope of the X-Y curve.
Returns
The fracture index is where this line intersects the curve (Type I) or where it intersects a peak if it
comes before this point (Type II or Type III).
Syntax
FractureIndex(fracture percent, slack value, Load Channel, Primary Extension channel,
slope 1 index, slope 2 index)
Parameters
Fracture percent—Determines the slope at which the fracture line is drawn. This slope is a percentage
of the slope of the X-Y curve.
Slack value—The offset used for calculating slack extension. If slack compensation is not used then
this argument should be zero (0).
Load channel—The channel used for the Y-axis of the curve. This should almost always be the Load
channel.
Primary Extension channel—(PrimaryExtension) The channel used for the X-axis of the curve. This
should almost always be the PrimaryExtension channel.
Unit Class
Integer
Example
The following formula will calculate the fracture index using a 95% fracture percent and assumes that
slack compensation is turned off.
FractureIndex(0.95, 0, _Load, PrimaryExt, Slope1, Slope2
LowerYieldIndex
This LowerYieldIndex function is used to calculate the first occurrence of a zero slope after the upper
yield point.
1. The search for the Lower Yield Point begins after the upper yield index point.
2. The force must drop from the upper yield point by the listed tolerance before the lower yield
index can be identified.
3. From this point, the algorithm keeps track of the minimum load point, and stops searching
when the load value increases by the same amount as the drop from the upper yield index.
4. The Lower Yield index is reported as the minimum load point found during the search.
Returns
This function returns the index point in the array of the lower yield point.
Syntax
LowerYieldIndex(y-axis, tolerance, upperYieldIndex)
Parameters
y-axis—The force array data being analyzed for the zero slope.
Tolerance—The percentage drop in force from the upper yield index that must occur before a lower
yield index can be identified.
UpperYieldIndex—The index representing the location of the upper yield index.
Unit Class
Integer
MaxSlopeStartIndex
The MaxSlopeStartIndex and MaxSlopeEndIndex functions are used to determine a region of data
where the slope of the line is minimized based on the function arguments. The slope of the line is
determined using a Least Squares Fit on the Y and X channel data.
Returns
The MaxSlopeStartIndex function returns the last point of the region. If a valid region cannot be
located given the function arguments, a –1 will be returned as the index.
Syntax
MaxSlopeStartIndex (y-channel, x-channel, % segment length, % tolerance, min load, max
load, %strain point)
Parameters
y-channel—This argument is the channel that represents the Y-axis for the Least Squares fit. The
units for this channel are normally in Force units but it is not a requirement. The unit class of the min
load and max load arguments must be the same as the unit class for this argument.
x-channel—This argument is the channel that represents the X-axis for the Least Squares fit. The
units for this channel are normally in Strain units but it is not a requirement. The unit class of the %
strain point argument must be the same as the unit class for this argument.
% segment length—This argument, which is a percentage, is multiplied by the value determined as the
endpoint index of the analysis region. This number is not necessarily the total number of points in the
range or in the specimen.
% tolerance—This argument is a comparison factor used to expand the region initially selected by the
algorithm. The initial region identified as having the maximum slope is first determined. The region of
data considered is expanded in small increments while the slope of the new line stays within the
tolerance based on the initial region. A value of 100% will not allow the region to expand. A value of
90% will allow expansion while the slope of the data region is within 90% of the initially determined
region.
min load—The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
max load—The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
% strain point—The argument is used to determine the start of the analysis region. The unit class of
this argument must be the same one used with the x-channel.
Note: For more information about how the analysis region is determined, see “Determining
Analysis Region” on page 233.
Unit Class
Integer
MaxSlopeEndIndex
The MaxSlopeStartIndex and MaxSlopeEndIndex functions are used to determine a region of data
where the slope of the line is minimized based on the function arguments. The slope of the line is
determined using a Least Squares Fit on the Y and X channel data.
Returns
The MaxSlopeEndIndex function returns the last point of the region. If a valid region cannot be located
given the function arguments, a –1 will be returned as the index.
Syntax
MaxSlopeEndIndex (y-channel, x-channel, % segment length, % tolerance, min load, max
load, %strain point)
Parameters
y-channel—This argument is the channel that represents the Y-axis for the Least Squares fit. The units
for this channel are normally in Force units but it is not a requirement. The unit class of the min load
and max load arguments must be the same as the unit class for this argument.
x-channel—This argument is the channel that represents the X-axis for the Least Squares fit. The units
for this channel are normally in Strain units but it is not a requirement. The unit class of the % strain
point argument must be the same as the unit class for this argument.
% segment length—This argument, which is a percentage, is multiplied by the value determined as the
endpoint index of the analysis region. This number is not necessarily the total number of points in the
range or in the specimen.
% tolerance—This argument is a comparison factor used to expand the region initially selected by the
algorithm. The initial region identified as having the maximum slope is first determined. The region of
data considered is expanded in small increments while the slope of the new line stays within the
tolerance based on the initial region. A value of 100% will not allow the region to expand. A value of
90% will allow expansion while the slope of the data region is within 90% of the initially determined
region.
min load—The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
max load—The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
% strain point—The argument is used to determine the start of the analysis region. The unit class of
this argument must be the same one used with the x-channel.
Note: For more information about how the analysis region is determined, see “Determining
Analysis Region” on page 233.
Unit Class
Integer
MinSlopeStartIndex
The MinSlopeStartIndex and MinSlopeEndIndex functions are used to determine a region of data
where the slope of the line is minimized based on the function arguments. The slope of the line is
determined using a Least Squares Fit on the Y and X channel data.
Returns
The MinSlopeStartIndex function returns the first point of the region. If a valid region cannot be located
given the function arguments, a –1 will be returned as the index.
Syntax
MinSlopeStartIndex (y-channel, x-channel, % segment length, % tolerance, min load, max
load, %strain point)
Parameters
y-channel—This argument is the channel that represents the Y-axis for the Least Squares fit. The
units for this channel are normally in Force units but it is not a requirement. The unit class of the min
load and max load arguments must be the same as the unit class for this argument.
x-channel—This argument is the channel that represents the X-axis for the Least Squares fit. The
units for this channel are normally in Strain units but it is not a requirement. The unit class of the %
strain point argument must be the same as the unit class for this argument.
% segment length—This argument, which is a percentage, is multiplied by the value determined as the
endpoint index of the analysis region. This number is not necessarily the total number of points in the
range or in the specimen.
% tolerance—This argument is a comparison factor used to expand the region initially selected by the
algorithm. The initial region identified as having the minimum slope is first determined. The region of
data considered is expanded in small increments while the slope of the new line stays within the
tolerance based on the initial region. A value of 100% will not allow the region to expand. A value of
90% will allow expansion while the slope of the data region is within 90% of the initially determined
region.
min load—The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
max load—The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
% strain point—The argument is used to determine the start of the analysis region. The unit class of
this argument must be the same one used with the x-channel.
Note: For more information about how the analysis region is determined, see “Determining
Analysis Region” on page 233.
Unit Class
Integer
MinSlopeEndIndex
The MinSlopeStartIndex and MinSlopeEndIndex functions are used to determine a region of data
where the slope of the line is minimized based on the function arguments. The slope of the line is
determined using a Least Squares Fit on the Y and X channel data.
Returns
The MinSlopeEndIndex function returns the last point of the region. If a valid region cannot be located
given the function arguments, a –1 will be returned as the index.
Syntax
MinSlopeEndIndex (y-channel, x-channel, % segment length, % tolerance, min load, max
load, %strain point)
Parameters
y-channel - This argument is the channel that represents the Y-axis for the Least Squares fit. The units
for this channel are normally in Force units but it is not a requirement. The unit class of the min load
and max load arguments must be the same as the unit class for this argument.
x-channel – This argument is the channel that represents the X-axis for the Least Squares fit. The
units for this channel are normally in Strain units but it is not a requirement. The unit class of the %
strain point argument must be the same as the unit class for this argument.
% segment length – This argument, which is a percentage, is multiplied by the value determined as the
endpoint index of the analysis region. This number is not necessarily the total number of points in the
range or in the specimen.
% tolerance – This argument is a comparison factor used to expand the region initially selected by the
algorithm. The initial region identified as having the minimum slope is first determined. The region of
data considered is expanded in small increments while the slope of the new line stays within the
tolerance based on the initial region. A value of 100% will not allow the region to expand. A value of
90% will allow expansion while the slope of the data region is within 90% of the initially determined
region.
min load – The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
max load – The argument is used to determine the start of the analysis region. The unit class of this
argument must be the same one used with the y-channel.
% strain point – The argument is used to determine the start of the analysis region. The unit class of
this argument must be the same one used with the x-channel.
Note:
For more information about how the analysis region is determined, see “Determining Analysis
Region” on page 233.
Unit Class
Integer
OffsetYieldIndex
The OffsetYieldIndex function is used to calculate the index of the data where the X-Y curve intersects
with a line offset from the modulus line by a defined X-Axis offset.
Returns
The index of the first point past where the line would intersect with the X-Y curve.
Syntax
OffsetYieldIndex(y-axis, x-axis, slope1Index, slope2Index, offset[, endIndex])
Parameters
y-axis - The Y-Axis data.
x-axis - The X-Axis data.
Slope1Index - The start of the region of peak slope (modulus line).
Slope2Index - The end of the region of peak slope (modulus line).
Offset - The offset from the modulus line to use in the calculation.
EndIndex - An optional end index that is used to limit the search region. If this parameter is missing, the
last data point in the array is used as the end.
Unit Class
Integer
PeakIndex
The PeakIndex function locates the index of the maximum value in the array.
Returns
The index of the array associated with the maximum value of the array.
Syntax
PeakIndex(channel[, startIndex, endIndex])
Parameters
Channel - The array data used in the function.
StartIndex - The optional starting index of the region to evaluate.
EndIndex - The optional ending index of the region to evaluate.
Unit Class
Integer
PeakSlopeIndex
The PeakSlopeIndex function locates the region of peak slope of the X-Y curve.
Returns
This function returns the start or end index of the region of the peak slope of the X-Y curve.
Syntax
PeakSlopeIndex(markerNumber, y-axis, x-axis, segmentLength[, startIndex, endIndex,
tolerance])
Parameters
MarkerNumber - 1 returns the start index; 2 returns the end index.
y-axis - The Y-Axis array data.
x-axis - The X-Axis array data.
SegmentLength - The percentage of the peak Y-Axis used to determine the regions used in the slope
calculations.
StartIndex - The optional start index of the region. If this parameter is missing, the start is associated
with the first data point in the array.
EndIndex - The optional end index of the region. If this parameter is missing, the end is associated with
the end of the array data.
Tolerance - The percentage of the slope used to optimize the maximum slope region. The region can
be optimized by reducing the region and rechecking the slope. The optimization step will be terminated
if the new slope is outside of the tolerance band of the original peak slope. If this parameter is missing,
no additional optimization is used beyond locating the maximum region.
Unit Class
Integer
RuntimeOffsetYieldIndex
The RuntimeOffsetYieldIndex function determines when an Offset Yield is reached in a test.
Example: You can use this function to switch test speeds after the offset yield points have been
reached. Basically, you start by using one GoTo activity with a slower speed until the offset yield has
been reached. After the offset yield has been reached, you can use a second GoTo activity running
at a faster speed.
Using the RuntimeOffsetYieldIndex function, you can calculate the offset yield during a test and
determine when it has been reached. To do this, add a variable using this calculation to the first
GoTo activity. Then, configure the limit detection for the first GoTo activity to monitor this variable
and cause the first GoTo activity to move to the second GoTo activity when the offset yield point is
reached.
Returns
The index of the data where the x-y curve intersects with a line offset from the modulus line by a
defined x-axis offset when the yield point is reached. The function returns an invalid number before it
locates the yield point.
Syntax
RuntimeOffsetYieldIndex(y-axis, x-axis, offset, numberOfPoints, threshold, slope, intercept
[, startIndex, endIndex])
Parameters
y-axis - The y-axis array variable.
x-axis - The x-axis array variable.
offset - The variable that contains the offset yield goal in x-axis units. It should be set to a slightly higher
value than the actual yield point. For example, if you want a 2% yield, set it to 3% to guarantee that you
actually reached the desired yield point before moving on.
numberOfPoints - This variable holds the number of points used in the yield point calculations in
counts.
threshold - This variable is used to set a minimum y-axis value that must be exceeded before looking
for the yield point in y-axis units.
slope - This variable holds the slope of the modulus line.
intercept - This variable holds the intercept of the modulus line.
startIndex - The optional start index of the region. If this parameter is missing, the start is associated
with the first data point in the array.
endIndex - The optional end index of the region. If this parameter is missing, the end is associated with
the end of the array data.
Unit Class
Integer
TestRunNumber
Description
The TestRunNumber function returns the current test run number.
Returns
Returns a 1-based number representing the placement of the Test Run in the list of Test Runs.
Syntax
TestRunNumber()
Unit Class
Integer
ValleyIndex
The ValleyIndex function locates the index of the minimum value in the array.
Returns
The index of the array associated with the minimum value of the array.
Syntax
ValleyIndex(channel[, startIndex, endIndex])
Parameters
Channel - The array data used in the function.
StartIndex - The optional starting index of the region to evaluate.
EndIndex - The optional ending index of the region to evaluate.
Unit Class
Integer
Example
Given a force array whose minimum value is located at index 100 in the array, this function returns 100.
YieldIndexByZeroSlope
The YieldIndexByZeroSlope function determines the yield index by searching the curve in segments
until the angle of the curve decreases to the specified angle.
Returns
The function returns the index associated with the Yield point.
Syntax
YieldIndexByZeroSlope(y-axis, x-axis, angle, segmentLength[, threshold, startIndex,
endIndex)
Parameters
y-axis - The Y axis data array used in the calculation of the yield index.
x-axis - The X axis data array used in the calculation of the yield index.
Angle - The angle of the slope used to determine the location of the yield point.
SegmentLength - The number of points to use in each slope calculation.
Threshold - An optional percentage of the peak value of the y-axis data that must be exceeded before
starting the search for the Yield Index. If this field is missing, 2% is used.
StartIndex - An optional starting index for the yield index search region. If this field is missing, the
search starts at the beginning of the data.
EndIndex - An optional ending index for the yield index search region. If this field is missing, the search
ends at the last point of the data.
Unit Class
Integer
Example
Y-Axis = Force array
X-Axis = Extension array
Angle = 0 rad
Segment Length = 10
Threshold = 2 N
Given these values, the algorithm starts looking for the first point in the Force array that exceeds 2 N.
The first Force point that exceeds 2 N becomes the start of the search region.
The slope of the Force and Extension data is calculated using 10 point segments.
The algorithm increments through the data until there is no more data to check or the slope decreases
to an angle of 0 radians.
YpeEndIndexByIncreasingLoad
The YpeEndIndexByIncreasingLoad function determines the end of the Yield Point Elongation.
Returns
The function returns the index associated with the end of the Yield Point Elongation region.
Syntax
YpeEndIndexByIncreasingLoad(ForceArray, YPEStartIndex, Tolerance)
Parameters
ForceArray - The force array used to determine end of the Yield Point Elongation region.
YPEStartIndex - The index associated with the start of the Yield Point Elongation region.
Tolerance - The percentage difference in force at the YPE start index used to detect the YPE end
index.
Unit Class
Integer
Example
YPEStartIndex = 100
Tolerance = 1 %
Force at YPE Start = 1000 N
Force Tolerance = 1000 N * 1% = 10 N
Assuming the peak was located at index 200, the algorithm starts at index 200 and go towards index
100. At each point, the force is compared to the force at YPE Start. When the Force of the currently
compared points is within 10 N of the YPE Start value, the YPE end index is located.
Algorithm
This function uses the following algorithm:
1. Find the peak load index after the YPE Start index.
2. Starting at this point search backwards down the curve until the load value is within the
specified tolerance of the load at the YPE Start index.
3. Report the index where this criterion is met as the YPE End index.
YpeEndIndexByTwoSlopes
The YpeEndIndexByTwoSlopes function located the end of the Yield Point Elongation region by
finding the point of intersection of the maximum slope line and the zero slope line (both after the YPE
Start index).
Returns
The function returns the index associated with the end of the Yield Point Elongation region.
Syntax
YpeEndIndexByTwoSlopes(ForceArray, DisplacementArray, YPEStartIndex,
PeakTolerance, ZeroSlopeSegmentLength, MaxSlopeSegmentLength)
Parameters
ForceArray - The force array used to determine end of the Yield Point Elongation region.
DisplacementArray - The displacement array used to determine end of the Yield Point Elongation
region.
YPEStartIndex - The index associated with the start of the Yield Point Elongation region.
PeakTolerance - The percentage drop from the of the peak force that must occur before starting the
search for the zero slope region of the curve.
ZeroSlopeSegmentLength - The percentage of the total points used to determine the zero slope
region.
MaxSlopeSegmentLength - The percentage of the total points used to determine the maximum slope
region.
Unit Class
Integer
Algorithm
This function uses the following algorithm:
1. Starting at the peak load index, search the curve backwards until the load drops by the
tolerance amount (tolerance is a percentage of peak load).
2. Using the zero slope segment length argument, search the curve backwards until the slope of
the segment becomes less than zero.
3. Find the minimum load point of this segment, referred to as the zero slope index.
4. Starting at the zero slope index, use the maxSlopeSegLen argument to search up the curve
for the segment with the highest slope value.
5. Draw a line for this segment and draw a horizontal line through the zero slope index.
6. Where these two lines intersect, calculate the value of the extension channel.
7. The YPE End index is the data point whose extension value is closest to this value.
Note:
This value can never be lower than the zero slope index.
YpeStartIndex
The YpeStartIndex function finds the start of the Yield Point Elongation region by locating the point
after Yield where the slope of the curve exceeds the specified angle.
Returns
The function returns the index associated with the start of the Yield Point Elongation region.
Syntax
YpeStartIndex(ForceArray, DisplacementArray, Angle, SegmentLength, YieldIndex)
Parameters
ForceArray - The force array being analyzed for the Yield Point Elongation region.
DisplacementArray - The displacement array being analyzed for the Yield Point Elongation region.
Angle - The angle which must be exceeded.
SegmentLength - Percentage of points to use in the slope calculations.
YieldIndex - The index point into the array where the Yield Index was determined.
Unit Class
Integer
Example
Angle = 0
SegmentLength = 2%
YieldIndex = 85
Total points on the curve = 200
Number of points in segment = 0.02 * 200 = 4 points
1. Start with the segment from point 85 to point 89.
2. Increment points until slope is less than zero. For this example, assume that this occurs at
points 100 to 104.
3. Increment points starting at 100 to 104 until the slope value is greater than zero. For our
Math Functions
This section provides reference information about the math functions.
Important:
This function is only used for integer numbers.
Syntax
abs(number)
Syntax
acos(number)
This function is used to calculate the arc cosine of the number specified.
Returns
Angle with a cosine equal to the specified number.
Syntax
asin(number)
This function is used to calculate the arc sine of the number specified.
Returns
Angle with a sine equal to the specified number.
Syntax
atan(number)
This function is used to calculate the arc tangent of the number specified.
Returns
Angle with a tangent equal to the specified number.
Atan2
Syntax:
atan2(y,x)
The angle with a tangent that is the quotient of the two specified numbers.
avg
Syntax:
avg(number1, number2,[numberN])
Returns the average of a series of numbers.
Ceiling
This function is used to round the specified number up to the nearest whole number.
Syntax
Ceiling(number)
The smallest integer greater than or equal to the specified number.
Examples
The following formula returns the value 6: ceiling(5.4)
The following formula returns the value 7: ceiling(6.9)
ArrayValue
The ArrayValue function returns the value of one array that corresponds with the location of a value
found in another array.
Returns
The value from the array at the specified index or NaN (Not a Number) if not found.
Syntax
ArrayValue(resultArray, searchArray, searchValue[, startIndex, endIndex])
Parameters
ResultArray - The array where the result is extracted.
SearchArray - The array used in the search.
SearchValue - The value to search for in the search array.
StartIndex - The optional starting index for the search. If this parameter is not present, the search starts
at the beginning of the array.
EndIndex - The optional ending index for the search. If this parameter is not present, the search ends
at the last point in the array.
Unit Class
Same as result channel.
Example
ArrayValue(Extension, Load, PeakLoad)
This example returns the Extension value associated with the PeakLoad value located in the Load
array.
cos (Cosine)
Syntax
cos(number)
This function is used to calculate the cosine of the number specified.
Cosine of the specified angle
Syntax
cosh(number)
Hyperbolic cosine of the specified angle.
Syntax
e()
CurveArea
The CurveArea function calculates the area under the curve defined by the Y and X axis data.
Syntax
CurveArea(xArray, yArray, startIndex, endIndex)
Returns
The area under the curve.
Parameters
y-axis – The array holding the Y-Axis data.
x-axis – The array holding the X-Axis data.
StartIndex - The start index of the region to analyze.
EndIndex - The end index of the region to analyze.
Unit Class
X-Axis unit / Y-Axis unit
Example 1
CurveArea (_Load, SlackExt, 0 , SizeOfArray(_Load)-1)
This formula calculates the area under the entire Load versus Extension curve.
Example 2
CurveArea (_Load, SlackExt, 0, Peak)
This formula calculates the area under the Load versus Extension curve up to the peak load.
ElasticStrainValue
The ElasticStrainValue function is used to calculate the portion of strain in a specimen that is
recoverable, or elastic. The point where this is determined is based on some percentage of the peak
load.
Returns
The portion of the strain that is recoverable.
Syntax
ElasticStrainValue(ForceArray, StrainArray, StartIndex, EndIndex, Tolerance)
Parameter
ForceArray – The array containing force data.
StrainArray – The array containing strain data.
StartIndex – The start index of the modulus region.
EndIndex - The end index of the modulus region.
Tolerance – The percentage drop from peak force used to determine the transition point.
Unit Class
Strain
Example
Tolerance = 98% (shown at blue oval)
The point is found where the load value is 98% of the peak load. Then a line parallel to the modulus line
is drawn from this point back to the x-axis. The Elastic strain is the difference in strain values as shown
on the graph.
Note:
Unlike plastic strain, there is no flag to set whether the specified load point should be found after
the peak or before. This is because the Elastic Strain value would be the same in either case.
EnergyValue
The EnergyValue function calculates the area under the curve defined by the Y and X axis data. If
using the Force and Extension data, this function returns the amount of energy absorbed by the
specimen during the test.
Returns
The area under the curve.
Syntax
EnergyValue(y-axis, x-axis, startIndex, endIndex)
Unit Class
X-Axis unit / Y-Axis unit
Example 1
EnergyValue (_Load, SlackExt, 0 , SizeOfArray(_Load)-1)
This formula calculates the area under the entire Load versus Extension curve (energy).
Example 2
EnergyValue (_Load, SlackExt, 0, Peak)
This formula calculates the area under the Load versus Extension curve (energy) up to the peak load.
Exp
This function is used to calculate the value of e (2.71828...) raised to the power specified by the
exponent.
Syntax
exp(number)
Returns
A value “e” raised to the specified power.
FindNearestValue
Locate the closest value in an array to the search value.
Syntax
FindNearestValue(array, searchValue[, startIndex, endIndex])
FindNearestValueIndex
Locate the index of the closest value in an array to the search value.
Syntax
FindNearestValueIndex(array, searchValue[, startIndex, endIndex])
Floor
Syntax
floor(number)
Returns
The largest integer less than or equal to the specified number.
This function is used to round the specified number down to the nearest whole number.
Example 1
Floor(5.4)
This formula returns the value 5.
Example 2
Floor(6.9)
This formula returns the value 6.
IsInvalidNumber
Syntax
IsInvalidNumber(number)
Checks the validity of the supplied value.
Returns
This function returns 1 if the value being tested is invalid; otherwise, 0 (zero) is returned.
Example
IsInvalidNumber(PeakLoad)
Where PeakLoad is a non-array variable.
IsValidNumber
Returns “1” if the number is valid. Otherwise, it returns “0”.
Syntax
IsValidNumber(number)
Example
IsValidNumber(PeakLoad)
Where PeakLoad is a non-array variable.
LeastSquaresFit
The slope of the least squares fit of the array that contains Y-axis data and X-axis data between the
start and end indexes.
Returns
The slope of the least squares fit line calculated over the specified region.
Syntax
LeastSquaresFit(yVariable, xVariable, startIndex, endIndex)
Parameters
yVariable – The Y-Axis data.
xVariable – The X-Axis data.
StartIndex – The starting index of the region.
EndIndex – The ending index of the region.
Units
Y-Axis unit / X-Axis Unit
Example
LeastSquaresFit(Force, Extension, Slope1, Slope2)
This formula returns the slope of the line between the two indexes of Slope1 and Slope2.
log(number)
Syntax
log(number)
The natural log of a specified number.
log10(number)
The base-10 logarithm of a specified number.
max
Syntax
max(number1, number2[, numberN])
Returns
The maximum of a series of numbers.
MaxDouble()
Syntax
MaxDouble()
Returns
Returns the maximum value for the type of number.
MaxLong()
Syntax
MaxLong()
Returns
Returns the maximum value for the type of number.
min
The minimum of a series of numbers.
Syntax
min(number1, number2[, numberN])
MinDouble()
Returns the minimum value for the type of number.
Syntax
MinDouble()
MinLong()
Returns the minimum value for the type of number.
Syntax
MinLong()
NaN()
Returns an invalid value for the type of number, which is Not a Number.
Syntax
NaN()
PI()
Value of Pi.
Syntax
PI()
PlasticStrainValue
The PlasticStrainValue is used to calculate the portion of strain in a specimen that is non-recoverable,
or plastic. The point where this is determined is based on some percentage of the peak load.
Returns
The portion of the strain that is non-recoverable.
Syntax
PlasticStrainValue(ForceArray, StrainArray, StartIndex, EndIndex, Tolerance[,
AfterPeakFlag])
Parameters
ForceArray – The array containing force data.
StrainArray – The array containing Strain data.
StartIndex – The start index of the modulus region.
EndIndex – The end index of the modulus region
Tolerance – The percentage of the peak force used to locate the transition point.
AfterPeakFlag – An optional flag to specify looking for transition point after the peak load.
Unit Class
Strain
Example
Tolerance = 98% (shown at blue oval)
The point is found where the load value is 98% of the peak load. Then a line parallel to the modulus line
is drawn from this point back to the x-axis. The Plastic strain is the difference in strain values as shown
on the graph.
pow(base, exponent)
A number (base) is raised to an exponential power (exponent).
Returns
Returns the value of the base raised to the power specified by the exponent.
Syntax
pow(base, exponent)
Example 1
Pow(2, 3)
This formula returns the value 8 (2^3, or 2*2*2)
Example 2
Pow(5, 2)
This formula returns the value 25 (5^2, or 5*5)
rem(dividend, divisor)
This function returns the remainder from the division of two numbers. When using this function, the
result is calculated differently than the modulus operator. This function uses the following ANSI/IEEE-
compliant formula:
Remainder = divided - (divisor * round(divided / divisor))
Syntax
rem(dividend, divisor)
round(number)
Rounds a value to the nearest integer.
Syntax
round(number)
sign(number)
Value that indicates the sign of a number.
Returns
This function returns –1 is the number is negative, or +1 is the number is positive. If the number is
exactly 0, the function returns 0.
Syntax
sign(number)
Example 1
sign(-500)
This formula returns the value -1.
Example 2
sign (20)
This formula returns the value +1
sin(number)
Returns
Sine of the specified angle.
Syntax
sin(number)
sinh(number)
Hyperbolic sine of the specified number.
Syntax
sinh(number)
sqrt(number)
The square root of a number.
Syntax
sqrt(number)
tan(number)
Tangent of the angle.
Syntax
tan(number)
tanh(number)
Hyperbolic tangent of the angle.
Syntax
tanh(number)
truncate
Rounds a value to the nearest integer towards zero.
Returns
The X-Intercept from the least squares fit line.
Syntax
truncate(number)
Parameter
number – The number to be truncated.
Unit Class
Same the number.
Example
truncate(4.5) = 4
XInterceptValue
The XInterceptValue function returns X-Intercept of the least squares fit line calculated over the
specified region.
Returns
The X-Intercept from the least squares fit line.
Syntax
XInterceptValue (y-axis, x-axis, slope1Index, slope2Index)
Parameters
y-axis – Y-Axis data array.
x-axis – X-Axis data array.
Slope1Index – The start index of the region.
Slope2Index – The end index of the region.
Unit Class
Same as X-Axis data.
Example
With the following function, the circled value on the X-Axis is returned.
XInterceptValue (_Load, _Extension, Slope1, Slope2)
XInterceptValue
YInterceptValue
The YInterceptValue returns the point where the line determined by the index values crosses the Y-
Axis.
Returns
The index in to the arrays where the Y-intercept occurs.
Syntax
YInterceptValue(y-axis, x-axis, slope1Index, slope2Index)
Parameters
y-axis – The Y-Axis data array being analyzed.
x-axis – The X-Axis data array being analyzed.
Slope1Index – The starting index of the region used to calculate the straight line.
Slope2Index - The ending index of the region used to calculate the straight line.
Unit Class
Same as Y-Axis data.
Example
The following function returns the Y-Intercept of the line defined by Slope1 and Slope2.
YInterceptValue(_Load, _Extension, Slope1, Slope2)
YInterceptValue
Operator Functions
This section describes Operator functions and precedence.
Note: Some programming languages use a semicolon as a list separator instead of a comma. If
you are using one of those languages, the last operator of the table would be replaced with a
semicolon.
Operator Precedence
Choose
Returns
Returns a value based on the evaluation of the first argument.
Syntax
Choose(Expression, EvaluatedZero,EvaluatedOne[, EvaluatedN])
Parameters
Expression—The Expression must evaluate to an integer.
EvaluatedZero—If the Expression evaluates to a 0 (zero), the EvaluatedZero value is returned.
EvaluatedOne—If the expression evaluates to a 1 (one), the EvaluatedOne value is returned, and so
on.
EvaluatedN —If the Expression is < 0 or > N, the EvaluatedN value is returned.
Note:
The Evaluated arguments must evaluate to be either all strings or all numbers
Example
Examples of the Choose function:
Choose(chosen, “Red”, “Blue”, “Green”)
Choose(chosen, 1.0, 2.0, 3.0, 4.0, 5.0)
Choose(chosen, Choice0, Choice1, Choice2, Choice3)
Peel-Tear Functions
This section describes Peel-Tear functions.
AverageMinPeaks
The AverageMinPeaks function calculates the average of the minimum peaks located in the data using
the specified criterion.
Syntax
AverageMinPeaks(VarArray, peakCriterion, numberOfPeaks[, startIndex, endIndex,
threshold])
Parameters
VarArray - The data array to be analyzed.
PeakCriterion - A percentage of the peak magnitude used to detect when peaks occur.
NumberOfPeaks - The number of minimum peaks to include in the calculations.
StartIndex - The optional index into the array used as the starting location for the calculation.
EndIndex - The optional index into the array used as the ending location for the calculation.
Threshold - The optional minimum value, in array units, which must be exceeded before the data is
used in the calculation.
Unit Class
Same as array data.
Example
AverageMinPeaks(_Load, LoadMinPeakCriteria, 5, 0, SizeOfArray(_Load)-1,MinimumLoad)
This formula:
1. Searches the _Load channel.
2. Looks for drops in the value of _Load channel that correspond to the input
LoadMinPeakCriteria.
3. Determines the average of the 5 minimum peaks.
4. Searches between the first data point and the last data point.
5. Calculates the result only if the _Load channel becomes greater than the value of the input
MinimumLoad.
AveragePeaks
The AveragePeaks function calculates the average of the maximum peaks located in the data using
the specified criterion.
Returns
The average of the maximum peaks.
Syntax
AveragePeaks(VarArray, peakCriterion[, startIndex, endIndex, numberOfPeaks, threshold])
Parameters
VarArray - The array data being analyzed.
PeakCriterion - The percentage of change from the peak that identifies the valley.
StartIndex - The optional starting index of the region to analyze.
EndIndex - The optional ending index of the region to analyze.
NumberOfValleys - The optional maximum number of valleys to identify.
Threshold - The optional threshold that has to be exceeded to start looking for peaks.
Unit Class
Same as the array data.
Example
AveragePeaks(_Load, LoadPeakCriteria, 0, SizeOfArray(_Load)-1)
This formula:
1. Searches the _Load channel.
2. Looks for drops in the value of _Load channel that correspond to the input LoadPeakCriteria.
3. Searches between the first data point and the last data point.
AverageValleys
The AverageValleys function returns the average of all the valleys determined using the peak criteria.
Returns
The average valley calculated.
Syntax
AverageValleys(VarArray, valleyCriterion[, startIndex, endIndex, numberOfValleys,
threshold])
Parameters
VarArray - The array data being analyzed.
ValleyCriterion - The percentage of change from the valley that identifies the valley.
StartIndex - The optional starting index of the region to analyze.
EndIndex - The optional ending index of the region to analyze.
NumberOfValleys - The optional maximum number of valleys to identify.
Threshold - The optional threshold that has to be exceeded to start looking for valleys.
Unit Class
Same unit as the array.
Example
AverageValleys(_Load, LoadMinValleyCriteria)
This formula:
1. Searches the _Load channel.
2. Looks for increases in the value of _Load channel that correspond to the input
LoadMinValleyCriteria.
AverageValue
The AverageValue function returns the average array value over a specified region.
Returns
The average array value.
Syntax
AverageValue(VarArray, startIndex, endIndex)
Parameters
VarArray - The variable being analyzed.
StartIndex - The start index of the region being analyzed.
EndIndex - The end index of the region being analyzed.
Unit Class
Same as the array data.
Example
AverageValue(_Load, Peak, SizeOfArray(_Load)-1)
This formula calculates the average value of the _Load channel between the Peak load point and the
end of the test.
CombinedExtension
The CombinedExtension function returns the value of the extensometer or crosshead/actuator based
on the value of the removal point.
Returns
Extensometer value before removal point, crosshead/actuator after removal point.
Syntax
CombinedExtension(extensometer, crosshead, removalPoint)
Parameters
Extensometer - The extensometer array.
Crosshead - The crosshead/actuator array.
RemovalPoint - The value, in extensometer units, used in the determination of what data to return from
the function.
Unit Class
Length (Same as the extensometer, crosshead, and removal point)
Example
CombinedExtension(Strain, Extension, RemovalPoint)
This formula:
1. Reports the value of the Strain channel
2. Checks to see if the value of the Strain channel has exceeded the value of the RemovalPoint
input.
3. Reports the value of the Extension channel when the Strain channel has exceeded the value
of RemovalPoint.
CombinedStrain
The CombinedStrain function returns the strain value calculated from either the extensometer or the
crosshead/actuator based on the value of the removal point.
Returns
The function returns the extensometer value divided by extGL prior to the removal points or crosshead
divided by gripSeparation.
Syntax
CombinedStrain(extensometer, crosshead, removalPoint, gripSeparation, extGL)
Unit Class
Strain
Example
CombinedStrain( Strain, Extension, RemovalPoint, GageLength2, GageLength1)
This formula:
1. Reports the value of the Strain1 channel divided by the value of GageLength1.
2. Checks to see if the value of the Strain1 channel has exceeded the value of the RemovalPoint
input.
3. Reports the value of the Extension channel divided by value of GageLength2 when the
Strain1 channel has exceeded the value of RemovalPoint.
MedianPeak
The MedianPeak function determines the median of the peaks located in the specified region that meet
the specified peak criterion.
Returns
The median peak value.
Syntax
MedianPeak(VarArray, peakCriterion[, startIndex, endIndex, threshold])
Parameters
VarArray - The array data being analyzed for peaks.
peakCriterion - The percentage change from the peak that signifies a peak.
startIndex - The optional start index of the region. The search starts at the first data point if this
parameter is missing.
endIndex - The optional end index of the region. The search ends at the last data point if this parameter
is missing.
Threshold - The optional threshold that must be exceeded before searching for peaks.
Unit Class
Same as the array data.
Example
AveragePeaks(_Load, LoadPeakCriteria, 0, SizeOfArray(_Load) - 1, MinimumLoad)
This formula:
1. Searches the _Load channel.
2. Looks for drops in the value of _Load channel that correspond to the input LoadPeakCriteria.
3. Determines the median of all of the peaks.
4. Calculates the result only if the _Load channel becomes greater than the value of the input
MinimumLoad.
NumberOfPeaks
The NumberOfPeaks function determines the number of peaks in a region that meet the specified
peak criterion.
Returns
The number of peaks found in the region.
Syntax
NumberOfPeaks(VarArray, peakCriterion[, startIndex, endIndex, threshold])
Parameters
VarArray - The array data being analyzed for peaks.
peakCriterion - The percentage change from the peak that signifies a peak.
startIndex - The optional start index of the region. The search starts at the first data point if this
parameter is missing.
endIndex - The optional end index of the region. The search ends at the last data point if this parameter
is missing.
Threshold - The optional threshold that must be exceed before searching for peaks.
Unit Class
Integer
Example
NumberOfPeaks(_Load, LoadPeakCriteria, 0, SizeOfArray(_Load) - 1 , MinimumLoad)
This formula:
1. Searches the _Load channel.
2. Looks for drops in the value of _Load channel that correspond to the input LoadPeakCriteria.
3. Searches between the first data point and the last data point.
4. Determines the total number of peaks found.
5. Calculates the result only if the _Load channel becomes greater than the value of the input
MinimumLoad.
NextPeak
The NextPeak function searches the data array specified in array and returns the next peak’s index, as
defined by the peak criteria, after the data point specified by the start index. The values in square
braces, [ ], are optional.
Syntax
NextPeak(array, peakCriteria, startIndex[, endIndex, threshold]))
Parameters
array—The array data being analyzed for the next peak.
peakCriteria—A percentage of the peak magnitude used to detect when a peak occurs.
startIndex—The start index of the array used in locating the peak. The first point in the array is used if
this parameter is not provided.
endIndex—The optional end index of the array used in locating the peak. The last point in the array is
used if this parameter is not provided.
threshold—The optional minimum value, in array units, which must be exceeded before the data is
used in the calculation.
Dimension
Count
Example
NextPeak(_LoadArray, LoadPeakCriteria, Peak, SizeOfArray(_LoadArray)-1, MinimumLoad)
This formula:
1. Searches the _LoadArray data.
2. Looks for the next drop in the _LoadArray data's value that corresponds to the input
LoadPeakCriteria.
3. Searches between the peak load's point and the last data point.
4. Finds the next peak and returns its array index.
5. Only calculates the result if the _LoadArray data becomes greater than the value of the input
MinimumLoad.
NextValley
The NextValley function searches the data array specified in array and returns the next valley's index
as defined by the valley criteria, after the data point specified by the start index. The values within
square braces, [], are optional.
Syntax
NextValley(array, valleyCriteria, startIndex[, endIndex, threshold])
Parameters
array—The array data being analyzed for the next valley.
valleyCriteria—A percentage of the peak magnitude used to detect when a valley occurs.
startIndex—The start index of the array used in locating the valley. The first point in the array is used if
this parameter is not provided.
endIndex—The optional end index of the array used in locating the valley. The last point in the array is
used if this parameter is not provided.
threshold—The optional minimum value, in array units, which must be exceeded before the data is
used in the calculation.
Dimension
Count
Example
NextValley(_LoadArray,LoadValleyCriteria,Peak,SizeOfArray(_LoadArray)-1,MinimumLoad)
This formula:
1. Searches the _LoadArray data.
2. Looks for the next increase in the _LoadArray data's value that corresponds to the input
LoadValleyCriteria.
3. Searches between the peak load's point and the last data point.
4. Finds the next valley and returns its array index.
5. Only calculates the result if the _LoadArray data becomes greater than the value of the input
MinimumLoad.
StDevValue
Calculates the standard deviation of a variable array between two index points.
Syntax
StDevValue(VarArray, startIndex, endIndex)
Parameters
VarArray - The array data being analyzed.
StartIndex - The start index of the region being analyzed.
EndIndex - The end index of the region being analyzed.
Unit Class
Same as array data specified.
Example
StDevValue(_Load, Slope1, Slope2)
This formula calculates the standard deviation between given by the variables Slope1 and Slope2.
TearIndex
Locates the index of the tear value in an array.
Syntax
TearIndex(VarArray, TearCriteria[, startIndex, endIndex, Threshold])
Parameters
VarArray - The array data being analyzed.
Tear Criteria
StartIndex - The start index of the region being analyzed.
EndIndex - The end index of the region being analyzed.
Threshold
Unit Class
Same as array data specified.
Sensor Functions
This section provides basic reference information about the available sensor functions.
CalibrationDate
Returns
Returns the last calibration date of the sensor attached to a signal.
Syntax
CalibrationDate(SignalName)
Parameter
Signal Name—The “SignalName” in signal functions is the internal name of the signal and must be
quoted or passed in as a string variable. To determine the internal name of a signal, select the Show
Internal Names check box in the Resources tab. The Name column shows the internal names.
Example
CalibrationDate(“_Load”)
Unit Class
String
CalibrationDueDate
Returns
Returns the calibration due date of the sensor attached to a signal.
Syntax
CalibrationDueDate(SignalName)
Parameter
Signal Name—The “SignalName” in signal functions is the internal name of the signal and must be
quoted or passed in as a string variable. To determine the internal name of a signal, select the Show
Internal Names check box in the Resources tab. The Name column shows the internal names.
Example
CalibrationDueDate(“_Load”)
Unit Class
String
ModelNumber
Returns
Returns the model number of the TEDS device attached to a signal.
Syntax
ModelNumber(SignalName)
Parameter
Signal Name—The “SignalName” in signal functions is the internal name of the signal and must be
quoted or passed in as a string variable. To determine the internal name of a signal, select the Show
Internal Names check box in the Resources tab. The Name column shows the internal names.
Example
ModelNumber(“_Load”)
Unit Class
String
SerialNumber
Returns
Returns the serial number of the TEDS device attached to a signal.
Syntax
SerialNumber(SignalName)
Parameter
Signal Name—The “SignalName” in signal functions is the internal name of the signal and must be
quoted or passed in as a string variable. To determine the internal name of a signal, select the Show
Internal Names check box in the Resources tab. The Name column shows the internal names.
Example
SerialNumber(“_Load”)
Unit Class
String
String Functions
This section provides basic reference information about the available string functions.
CompareStrings
Compares two strings, ignoring case.
Returns
The result is 0 if the strings are equal; negative if the first string is ordered before the second string, and
positive if the second string is reordered before the first string.
Syntax
CompareStrings(string1, string2)
Parameters
string1-First string
string2-second string compared to string1.
Unit Class
String
FindSubString
Returns
Finds the index of the first occurrence of a substring within a string starting at or after a specified
starting index. Results is the index where the substring begins, or negative if not found.
Syntax
FindSubstring(substring, string, startIndex)
Parameter
substring
string
startIndex
Unit Class
String
left
Returns
Extracts a substring from the left side of a string.
Syntax
left(string, length)
Parameters
string
length
Unit Class
String
mid
Returns
Extracts a substring from the middle of a string.
Syntax
mid(string, start[, length]
Parameters
string
start
length
Unit Class
String
NumberToString
Returns
Creates a string from the specified number with the optionally specified digits.
Syntax
NumberToString(number[, digits])
Parameters
number
digits
Unit Class
String
right
Returns
Extracts a substring from the right side of a string.
Syntax
Right(string, start)
Parameters
string
start
Unit Class
String
StringLength
Returns
The length of the specified string.
Syntax
StringLength(string)
Parameters
string
Unit Class
String
StringToInteger
Returns
Converts a string to an integer number.
Syntax
StringToIntger(string)
Parameters
string
Unit Class
String
StringToNumber
Returns
Converts a string to a floating-point number.
Syntax
StringToNumber(string)
Parameters
string
Unit Class
String
tolower
Returns
Converts a string to all lower case.
Syntax
tolower(string)
Parameters
string
Unit Class
String
toupper
Returns
Converts a string to all uppercase.
Syntax
toupper(string)
Parameters
string
Unit Class
String
TrimStringEnd
Returns
Removes whitespace (spaces, tabs, and new lines) from the end of a string.
Syntax
TrimStringEnd(string)
Parameters
string
Unit Class
String
TrimStringStart
Returns
Removes whitespace (spaces, tabs, and new lines) from the start of a string.
Syntax
TrimStringStart(string)
Parameters
string
Unit Class
String
varIdentifier.DisplayValue
This construct is implicit in the MTS TestSuite application. Use this syntax in a calculation to return a
string representation of a string variable; including its name, value, and units.
Returns
Returns the string representation of the variable in display units.
Syntax
variableStringName.displayvalue
Replace variableStringName with the actual name of the string variable.
Example
Create a string variable in any of the TWE application EM templates and enter the following
calculation:
StrnAtBreak.display+" "+StrnAtBreak.displayvalue+" "+StrnAtBreak.units
The result is similar to the following:
Strain at Break 0.236 mm/m
“StrainAtBreak” is the string variable, the display value of the variable is 0.236, and the units are
mm/m.
Functions Tab
Use the Functions tab to manage the functions in the Test Definition.
Access
Define tab > Functions tab
Item Description
Function Displays the function name. The name cannot contain spaces, begin with a number, or
Name contain special characters.
Arguments Displays the arguments of the function. All user-defined functions must follow Python
naming rules.
Category Show the user-defined type of functions.Functions created in the Function Editor are in
the Test Definition category.
Description (Optional) Displays a description of the function.
Add Adds a function. Opens the Edit Function window.
Delete Deletes the selected function.
Edit Edits the selected function. Opens the Edit Function window.
Copy Copies the selected function.
Item Description
Function Shows the function name. A name that is unique within the test is pre-filled in the
name Function Name field. When you enter a function name in the work area, the new name
shows in this field. The name is case-sensitive, and must not contain spaces.
Category Shows the function category. If you create the function from the Test Definition, the
category is Test Definition.
Usage Shows how to use your function and the arguments required. As you enter the function
name and the variables in the work area, you see the name and variables replace the
generic text in the Usage field.
Item Description
Python Enter your function in this area. You can add, edit and delete functions and arguments
Code by changing the def line.
Validation Validates your code as you are entering it. A message displays indicating whether your
code is valid.
Note:
The example above is not entered as TestVariableX=10. You must enter SetValue in the
Function Editor.
Arrays
To read a test variable array in a function, enter the code as in the following example:
functionVariableX=TestVariableX.Value.ValueArray
The above syntax is the function variable code to get the value of the array variable.
Non-array variables
To read a test variable that is not an array, enter the code as in the following example:
functionVariableX=TestVariableX
Order of subfunctions
If you have more than one function within the main function, the main function should appear first in the
code, for example:
def SquareAndSum(a,b):
return Sum(pow(a,2) + pow(b,2))
def Sum(a,b):
return a+b
Here the main function SquareAndSum uses a helper subfunction Sum. Only the first function shows
in the global function list.
Note:
Limit the use of subfunctions and enter one function so that it appears in the global list correctly.
Parentheses
Parentheses ( ) indicate you must add a parameter to the function.
To specify a variable, click Edit List and select one or more variables.
Square brackets
Square brackets [ ] indicate you can add an optional parameter to the function. The brackets must be
removed in any case or an error occurs.
Note:
The variables shown in bold are test variables.
def MyFunction():
#Read test variables.
# Read non-array test variable value into a function variable
pythonVarMaxForce = TestAxialForceMaximum
# Read a test array variable value into a function variable
pythonArrayVarForce = TestAxialForceArray.Value.ValueArray
#Set Test variables
# Set Test variable
TestHalfForceMax.SetValue(pythonVarMaxForce / 2)
# Set Test array variable
TestForceArray2.SetValue(pythonArrayVarForce)
Return
Python Overview
Python is an interpreted, general purpose, high-level programming language with an extensive
resource library. You can use Python to extend the functionality of the MTS TestSuite applications. For
instance, you can use Python for reading and writing to files, dynamic mathematical calculations, and
manipulating MTS TestSuite variables.
Number Variables
Text Variables
Array of Numbers
Array of Text
tsVarArray = [1, 2, 3, 4, 5]
# ================================
# 2) Define the custom function
# ==========================
++++++++++++++++++++++++
# ** NOTE: TestSuite's custom function editor will NOT
# include the iron python libs **
# Therefore, it is required to import the resources you
# will be referencing within your custom function. This is
# done using the "sys.path.append(resourcePath)" method.
#================================================
import sys
sys.path.append(r"C:\Program Files (x86)\IronPython 2.7\Lib")
import os.path
def readFileAsArray(filePath):
results = []
if os.path.exists(filePath):
try:
while True:
# Read a line as text, removing newlines
aLine = infile.readline()
if not aLine:
break;
else:
# Convert the line to numbers and add to
# results
results.append(int(aLine.rstrip()))
except:
results = []
return results
FILE.write(str(num) + "\n")
FILE.close()
return True
except:
return False
# ==============================================
# 3) Execute custom function test environment
# ==============================================
file = r"testFileIO.txt"
if writeArrayToFile(tsVarArray, file):
print "Array successfully written to " + str(file)
else:
print "Failed to write array to " + str(file)
tsVarArray = readFileAsArray(file)
print "\ntsVarArray after readFileAsAraay: "
print tsVarArray
raw_input()
Compare Tool
TestSuite Compare Tool Overview
Access
Tool menu > Compare > Variable or Function
l Test definitions
l Test runs with analysis runs (In the TW application, an analysis run includes any changes
made in the Review tab.)
l Default templates with modified templates
l Specimen variables with other specimen variables
Note: The Count column shows the number of variables or functions in each selected
item.
3. Repeat until you have selected what you want to compare.
4. Click OK. The Comparison window opens to show all the variables or functions in the tests
and indicates mismatches in red.
5. To view only the differences, select the Show Only Differences check box.
6. Click the plus icon to expand the window and view the properties for the variable or function.
Once expanded, the variable property names appear in the first column followed by a column
that shows the variable properties for the currently open test, and then columns for each item
selected in step 3.
Note: If a part of a calculation for a function does not match, you must examine the
whole calculation; the Compare tool does not indicate which part of the calculation does
not match.
7. To add the variable or function to your current test, click the Add Change button below the
appropriate test name and click Apply. After you have added all your selections, click OK to
close the window.
Test Activities
Command Activities 294
Data Acquisition (DAQ) Activities 328
Event Detection Activities 338
Control Settings Activities 351
Test Flow Control Activities 363
Operator Entry Activities 374
Program Actions Activities 385
Command Activities
Allow Handset Control
Allow Handset Control Activity Overview
The Allow Handset Control Activity displays a user-defined message and allows the operator to
take control of the system with the handset while the test is running. If the handset becomes active
while this activity is running, the test control panel is locked.
Note: This activity is not available on systems equipped with an MTS Series 793 controller
(FlexTest).
Example: The Allow Handset Control Activity might be useful when specimen installation is part
of a test procedure.
You can configure the activity to display a message window that displays instructions for how to
insert the specimen. While this activity is running, the handset is allowed to take control of the
system so the operator can safely position the crosshead or actuator while manipulating a specimen
or fixturing.
To continue the test procedure, the operator must release handset control and dismiss the dialog
displayed by this activity.
Item Description
Create Click to open the Custom Message Editor window, a basic HTML editor that you use to
Message compose and format the content of the message.
Window Specify the width of the message window in pixels.
Size >
Width
Window Specify the height of the message window in pixels.
Size >
Height
Preview Click to see the message as it appears to the operator during test execution.
Note:
Variables in the message are not resolved until the test is executed, so the
preview shows only the variable reference, not its current value.
Buttons Custom button options include No Buttons, Yes, No, OK, and Cancel in several
combinations. You can also create one or more custom buttons with labels that you
specify.
Click No Buttons to control the Custom Message window with a parallel activity.
When the controlling activity completes, the Custom Message window closes.
Click Customize to add, modify, and delete custom buttons to the custom message
window. When you select Customize, the area expands with more options to create
custom buttons, which are described below.
Item Description
Button Place the buttons on the lower left, center, or right part of the message window.
Alignment
Results Select a variable from the list to store the text value of the button that you click. Click the
Variable list arrow to see the list of all project variables defined to hold a string value.
Note: If you choose a variable with a choice list, any existing buttons are
replaced with the buttons defined by the choice list.
Add Add a new button to the message window.
Edit Edit the selected button label. The Edit Button window has two boxes. Enter the return
value for the button in the value field. The value can be a text string or the name of a
string variable that you have previously defined. Enter the text for the button label in the
text box.
Remove Remove the selected button.
Remove Remove all custom buttons.
All
Add Add a separator line between groups of buttons. The buttons align vertically with a
Separator separator between each group.
Up Arrow Move the selected entry toward the top of the list. The entry at the top of the list appears
as the left-most button in the message window. Click Preview to see the current button
arrangement.
Down Move the selected entry toward the bottom of the list. The entry at the bottom of the list
Arrow appears as the right-most button in the message window. Click Preview to see the
current button arrangement.
Note: The editor does not support dynamic content or images stored on a web server. It also
does not support scripting extensions, such as JavaScript. If you import or paste content with
unsupported content, it generates error messages when you try to preview the message.
Item Description
Preview Click to see the message as it appears to the operator during test execution.
Note:
Variables in the message are not resolved until the test is executed, so the preview
shows only the variable reference, not its current value.
Insert Click to open the Variable Selection window. From the window you can select a single-
Variable value variable to add to the message output. When the message is shown during the test,
the current value of the variable is substituted for the variable name in the message.
You can enter the reference directly using the following syntax:
$var_<variable_name>$
Note:
If you change the variable identifier name, you must manually change the name in
the Custom Message Editor; otherwise you receive a warning, and the test cannot
run.
Custom Waveform
Custom Waveform Activity Overview
The Custom Waveform activity commands a control channel using a series of ramp and hold
segments that create a custom trapezoid waveform. The entire waveform is played out in one control
mode for one channel. You can control multiple control channels, such as an axial channel in force
control and a temperature control channel.
When the durations of multiple signals differ, the signals with the shorter duration hold at the last end
level until all signals on the waveform definition are complete.
The Number of Cycles box determines how many times the entire custom waveform is generated.
Segment Type
The Ramp Segment Type produces a command similar to the standard Ramp or Go To command,
except that each Ramp can have a different Duration and End Level. The shape of the ramp segment
is linear. Each Hold can have a different Duration (for hold segments, the current end level is used).
You create the segments of a custom waveform in one of two ways:
l Using array variables
l Entering values in the End Levels table
Note: You can dynamically modify arrays by using workflow activities that can access and
modify variables, such as the Assign Variables activity, as well as through custom functions.
For the Ramp segment type, you create Duration and End Level arrays. These arrays contain the list
of segments that define the waveform.
l The Duration array is an array variable that contains duration values for the ramp segments.
The duration values apply to both ramp and hold segment types and are of dimension Time.
For a hold value, you must enter the same value twice in the endlevels. This array must always
contain the same number of elements as the End Level array.
l The End Level array is an array variable containing end level values that specify the target end
level for ramp segments. End level values in this array have the same dimension as the
selected control mode. This array must always contain the same number of elements as the
Duration array.
Note: You can define a hold segment by specifying the same end-level value as
consecutive values in an array.
Test Sequence
Important:
When using array variables to define end levels, you can only define ramp
segments. If you want to define a hold segment, enter the same end-level value
in consecutive ramp segments.
4. Assign Variables activity - add an Assign Variables activity to the test before the Custom
Waveform activity.
5. Set up the Assign Variables activity to use the NewArray(x,y) function to define the number
of elements and the default values for the EndLevelsArray and DurationsArray variables.
A. On the Assign Variables activity's Variable list, click the + icon.
B. Use the Variables Selection window to add the EndLevelsArray and DurationsArray
variables (that you created earlier) to the Selected Variables list and click OK.
C. On the Variable list, double-click the EndLevelsArray variable to display the
Calculation Editor window.
D. Add the NewArray(x,y) function to the calculation.
l Use this function to define the number of end levels (x) and their default
values (y) that will be added to the array variable.
l For example, NewArray(10,0) would result in 10 end levels, each with a
default value of 0.
Note:
The x argument in the NewArray(x,y) for the DurationsArray and the EndLevelsArray
variables must be set to the same value.
6. Repeat this procedure for the DurationsArray variable.
7. Input Variables activity - add an Input Variables activity after the Assign Variables activity
and before the Custom Waveform activity.
A. On the Input Variables properties Variable list, click the + icon.
B. Use the Variables Selection window to add the EndLevelsArray and DurationsArray
variables to the Selected Variables list and click OK.
l When the test runs, the Input Variables activity displays a window where
the operator must enter the end level and duration values for each segment
(end level + duration) defined by the Assign Variables activity. These
segments are then executed by the Custom Waveform activity.
Item Description
Number of Specify the number of times to perform the waveform defined. Click the toggle
Cycles button to specify a numeric value and unit of measure or variable.
Compensator Select a compensator to improve the tracking and accuracy of the control loop for
the selected channel. For more information about compensators, see
“Compensator Overview” on page 52.
Advanced Click to open the Advanced Command Properties window.
Select an Interrupt behavior:
l Interrupt Immediately—End the branch or loop immediately at the current
level.
Item Description
l Interrupt at End of Cycle—Complete the current cycle before ending the
branch or loop.
Relative End Levels—Select to specify that the values of the end levels are
relative to the value of the control mode command signal at the time the activity
begins executing. When not checked, end levels are relative to setpoint.
Suppress Cycle Counter—Select to prevent the channel counter from being
incremented when this activity is executed. When not checked, the channel counter
is incremented.
Channel List Click the plus sign to open the Select Channels window, and select the channel or
multiple channels to use for the activity.
Control Mode Select the type of feedback to use in the control loop for the selected channel.
Specify this for each channel you select.
Note: For MTS Criterion and MTS Insight systems, load and strain modes
are available only if you have purchased the Advanced Rate Control license.
If you select Use variables to specify arrays of End Levels and Durations,
select the variable in the drop-down menu for each box.
End Level 1 Specify two end levels that the command signal cycles between for the selected
and 2 control mode. Click the toggle button to specify a numeric value and unit of measure
or a variable. Specify this for each channel you select.
Phase Lag Specify the phase relationship of the wave form generated by this activity from
channel to channel. Click the toggle button to specify a numeric value and unit of
measure or a Phase Lag variable. If you have selected only one channel, Phase
Lag is disabled. Change this for each channel.
Note: Phase Lag is relative to the channel with the smallest degree of phase.
The phase lag of each channel is referenced to the lower phase lag defined
in the channels.
This composite activity combines the Custom Waveform activity with a Data Acquisition (DAQ)
activity.
The activity is hard-coded to use the SegmentCount signal to process data in block mode with the
“CycleCount” variable used as the counter. For the Custom Waveform + DAQ activities, one pass
through the End Levels table is considered a cycle.
Important:
This composite activity includes hard-coded settings that simplify the setup of data acquisition for
cyclic testing.
Item Description
Number of Specify the number of times to perform the waveform defined. Click the toggle
Cycles button to specify a numeric value and unit of measure or variable.
Compensator Select a compensator to improve the tracking and accuracy of the control loop for
the selected channel. For more information about compensators, see
“Compensator Overview” on page 52.
Advanced Click to open the Advanced Command Properties window.
Select an Interrupt behavior:
l Interrupt Immediately—Complete immediately at the current level.
l Interrupt at End of Cycle—Complete the current cycle before ending the
branch or loop.
Relative End Levels—Select to specify that the values of the end levels are
relative to the value of the control mode command signal at the time the activity
begins executing. When not checked, end levels are relative to setpoint.
Suppress Cycle Counter—Select to prevent the channel counter from being
incremented when this activity is executed. When not checked, the channel counter
is incremented.
Channel List Click the plus sign to open the Select Channels window, and select the channel or
multiple channels to use for the activity.
Control Mode Select the type of feedback to use in the control loop for the selected channel.
Specify this for each channel you select.
Note: For MTS Criterion and MTS Insight systems, load and strain modes
are available only if you have purchased the Advanced Rate Control license.
If you select Use variables to specify arrays of End Levels and Durations,
select the variable in the drop-down menu for each box.
Item Description
Phase Lag Specify the phase relationship of the wave form generated by this activity from
channel to channel. Click the toggle button to specify a numeric value and unit of
measure or a Phase Lag variable. If you have selected only one channel, Phase
Lag is disabled. Change this for each channel.
Note: Phase Lag is relative to the channel with the smallest degree of phase.
The phase lag of each channel is referenced to the lower phase lag defined
in the channels
Signal List Specify the signals for which values are gathered for each cycle. Click the plus sign
to open the Select Signals window.
Data Configure the data acquisition trigger properties and other details in the Data
Acquisition Acquisition window. For details, see the following section on the Data Acquisition
List List.
Item Description
Trigger Select and configure the trigger(s) used for this activity.
List
For more information about triggers, see “Data Acquisition (DAQ) Triggers Overview”
on page 145.
Save data No—The signal data is not put into variables.
to
variables? Yes, automatically map variables—(Default for TWE) The signals being acquired
are automatically mapped to variables of the same name with the word “Array”
appended and illegal characters removed. For example, the signal with an internal
name of “Axial Force” is mapped to the variable “AxialForceArray”.
In addition, calculations dependent on these mapped variables are automatically added
to the Additional Calculations list.
Yes, manually map variables—The test designer must manually map the signals
and additional calculations by clicking the Configure button and using the Map
Variables window.
Configure Open the Map Variables window where you can map signal data into variables that can
button be used to perform calculations on signal data, perform logical condition checks,
acquire signal data for test-run displays.
Starting Specify how many cycles to store when the test starts or restarts.
Cycles
Note: The cycles specified here are in addition to those specified by the “Select
Cycles” filter.
For example, you specify 10 and the test is 50 cycles long. An operator stops and
restarts the test at 30 cycles. The application saves data from cycles 1 to 10 and 31 to
40.
Item Description
Final Specify the number of cycles to store before the test stops, whether at the end or during
Cycles the test. A stoppage can be initiated by an operator, an event action, or a system
interlock.
For example, you specify 10 and the test is 50 cycles long. If an operator stops and
restarts the test at 30 cycles, the application saves data for cycles 21 to 30 and 41 to 50.
Index Specify an array variable to store all the cycle count numbers of cycles where data is
Variable stored.
You must first create an index variable that is an Array type and with a dimension of
Count. This variable stores the current cycle count number when the application stores
data.
The Select Cycles, Starting Cycles, and Final Cycles properties determine the
cycles when the application stores data.
This array stores cycle numbers, not the data. This array can be used to determine
which data is available to analyze.
Select Opens the Cycle Decimation Filter Selection window to further specify which cycles to
Cycles acquire. The raw data is saved for the acquired cycles.
Note: The cycle decimation filter settings do not affect data that is saved to a
variable.
Cycle
Cycle Activity Overview
The Cycle activity commands the control signal to cycle between two different end levels at a specified
frequency, using a specified wave shape, for a specified number of cycles. Two end levels form one
cycle. The number of cycles determines the required number of end levels. The frequency determines
the speed required to achieve the end levels.
The method for cycling between the two end levels is controlled by the Control Mode, which can be
specified in terms of force, strain, or displacement. The End Levels specify the amount of force or strain
to apply or the distance to displace, while the Frequency specifies the speed it should take to achieve
the end levels. The Wave Shape specifies the shape of the signal, which also governs the type of
command rate between each end level, which can produce a constant linear rate (as with a ramp
Note:
Specify these settings for each channel.
In the following example, the Go To activity commands an actuator force from 0.000 N to 2.000 N, and
then the cyclic activity starts. The cyclic activity varies the force between the end levels of 2.000 N and
4.000 N. The command applies force as a linear ramp shape from each end level. The frequency is
0.8333 Hz, as each cycle is 1.2000 seconds long (1/1.2 or 0.8333 cycles per second). The total
number of cycles is 2.5.
In both of the following graphics, “A” represents Cycle activity. “B”represents Go To activity. “C”
represents the Command Signal.
Go To Activity
Signal compensation
You can apply a compensator to enhance performance. Compensators are control techniques that
improve the tracking and accuracy of your controller and optimize system response. Only one
compensator can be applied.
Compensators are set up with the Station Manager application. The settings and properties are found
on the Compensators tab in the Channel Status window. For more information about compensators,
see “Compensator Overview” on page 52.
Interrupt settings
Interrupt behaviors are defined in the Advanced settings and specify what happens in the event the
Cycle activity is stopped before completion.
l Interrupt Immediately—Complete immediately at the current level.
l Interrupt at End of Cycle—Complete the current cycle before ending the branch or loop.
Phase lag
You can specify the phase relationship of the waveform generated by this activity from channel to
channel. You specify Phase Lag relative to the channel with the smallest degree of phase. The phase
lag of each channel is referenced to the lowest phase lag defined in the channels.
Note:
Specify these settings for each channel.
Item Description
Timing Type Specifies how the timing property is expressed. You can select one of the following:
l Frequency
l Time
l Rate
Frequency, Specifies how fast each segment runs. The following methods are supported:
Time, Rate
l Frequency specifies the time to run a two-segment cycle.
l Time specifies the time to run one segment.
l Rate specifies a constant rate between the starting level and the end
levels.
Note:
You cannot use Rate for a command activity that applies to multiple
channels.
Wave Shape Select the shape of the signal. The shape determines whether the command rate
between each end level is a constant linear rate (as with ramp shape) or a varying
rate (as with sine shape). The choices are:
l Square
l Ramp
l Sine
l True Square
l True Ramp
l True Sine
Click the toggle button to select one of the wave shape choices or a variable.
Frequency Specify the speed to complete each cycle. Click the toggle button to specify a
numeric value and unit of measure or a variable.
The numeric mode selections are:
l cpm—cycles per minute; 60 cpm equals 1 Hz
l rpm—revolutions per minute; 60 rpm equals 1 Hz
l Hz—Hertz; 1 Hz equals 1 cycle per second
l kHz—kiloHertz; 1 kHz equals 1000 Hz
Number of Specify the number of end levels. Click the toggle button to specify a numeric value
Cycles and unit of measure or variable.
Item Description
When using the numeric mode, the resulting number of end levels can be specified
by the number of Segments or by the number of Cycles. A segment has one end
level and a cycle has two end levels.
Compensator Select a compensator to improve the tracking and accuracy of the control loop for
the selected channel. For more information about compensators, see
“Compensator Overview” on page 52. The following compensators may be
available with the Cycle activity.
l No Compensator
l Static Null Pacing—Static null pacing holds the command at its segment
boundaries to allow the sensor feedback more time to reach its target
peak.
l Dynamic Null Pacing—Dynamic null pacing reduces the command
frequency to allow the sensor feedback more time to track the command.
l Peak-Valley Amplitude Control—Monitors cyclic command feedback for
any amplitude roll-off or mean-level divergence. Peak-Valley Amplitude
Control increases the command amplitude if it detects amplitude roll-off in
the feedback signal. This compensator adjusts the mean command level if
it detects mean-level divergence in the feedback signal.
l Peak-Valley-Phase—Improves the amplitude and phase tracking of the
command and sensor feedback. Peak-Valley-Phase compensates for
phase error, unlike Peak-Valley-Amplitude Control. Peak-Valley-Phase
provides good amplitude tracking on nonlinear specimens. Peak-Valley-
Phase adjusts the mean command level if it detects mean-level divergence
in the feedback.
Advanced Select an Interrupt behavior:
l Interrupt Immediately—Complete immediately at the current level.
l Interrupt at End of Cycle—Complete the current cycle before ending the
branch or loop.
Relative End Levels—Select to specify that the values of the end levels are
relative to the value of the control mode command signal at the time the activity
begins executing. When not checked, end levels are relative to setpoint.
Suppress Cycle Counter—Select to prevent the channel counter from being
incremented when this activity is executed. When not checked, the channel counter
is incremented.
Channel List Click the plus sign to open the Select Channels window, and select the channel or
multiple channels to use for the activity.
Control Mode Select the type of feedback to use in the control loop for the selected channel.
Specify this for each channel you select.
Item Description
Note:
For MTS Criterion and MTS Insight systems, load and strain modes are
available only if you have purchased the Advanced Rate Control license.
End Level 1 Specify two end levels that the command signal cycles between for the selected
and 2 control mode. Click the toggle button to specify a numeric value and unit of measure
or a variable. Specify this for each channel you select.
Phase Lag Specify the phase relationship of the wave form generated by this activity from
channel to channel. Click the toggle button to specify a numeric value and unit of
measure or a variable. If you have selected only one channel, Phase Lag is
disabled. Change this for each channel.
Note:
Phase Lag is relative to the channel with the smallest degree of phase. The
phase lag of each channel is referenced to the lower phase lag defined in the
channels.
Behavior Description
End Stay immediately at the current level.
Interrupt Control the functionality of an activity when the parallel branch it is in is interrupted or
directed to complete early by a separate parallel completion of a branch. You can select
two interrupt functions:
Interrupt Immediately—Complete immediately at current level.
Interrupt at End of Cycle—Complete the current cycle before ending the branch.
For example, when a crack limit is detected, the cycle can be finished rather than
immediately stopped to obtain accurate test results.
Stop Stay immediately at current level. The Stop At button causes a stop at the end of the
current cycle.
Hold Hold at the end of the current cycle.
Cycle + DAQ
Cycle + DAQ Activity Overview
The Cycle + DAQ composite activity combines two otherwise standalone activities:
l Cycle activity
l DAQ (Data Acquisition) activity
This composite activity is hardcoded to use the SegmentCount signal to process data in block mode
with the “CycleCount” variable used as the counter. For Cycle + DAQ activities, two segment counts
= a cycle (increments a cycle count).
Important:
These composite activities include hardcoded settings that simplify the setup of data acquisition
for cyclic testing.
Cycle activity
Use the Cycle activity to command the Control signal to cycle between two different end levels at a
specified frequency, using a specified wave shape, for a specified number of cycles. Two end levels
form one cycle. The number of cycles determines the required number of end levels. The frequency
determines the speed required to achieve the end levels.
DAQ activity
Use the DAQ activity to define the data to collect and how to collect it. You must add at least one DAQ
activity, and you can add multiple DAQ activities. Each DAQ activity must have a unique name and
trigger type and a number of cycles to monitor.
For multichannel testing, the most lagging channel is used to count cycles during data acquisition.
Note:
This activity is hard coded to always process data in blocks.
Item Description
Trigger Select and configure the trigger(s) used for this activity.
List
Save data No—The signal data is not put into variables.
to
variables?
Yes, automatically map variables—(Default for TWE) The signals being acquired
are automatically mapped to variables of the same name with the word “Array”
appended and illegal characters removed. For example, the signal with an internal
name of “Axial Force” is mapped to the variable “AxialForceArray”.
In addition, calculations dependent on these mapped variables are automatically added
to the Additional Calculations list.
Yes, manually map variables—The test designer must manually map the signals
and additional calculations by clicking the Configure button and using the Map
Variables window.
Configure Open the Map Variables window where you can map signal data into variables that can
button be used to perform calculations on signal data, perform logical condition checks,
acquire signal data for test-run displays.
Starting Specify how many cycles to store when the test starts or restarts.
Cycles
Note:
The cycles specified here are in addition to those specified by the “Select Cycles”
filter.
For example, you specify 10 and the test is 50 cycles long. An operator stops and
Item Description
restarts the test at 30 cycles. The application saves data from cycles 1 to 10 and 31 to
40.
Final Specify the number of cycles to store before the test stops, whether at the end or during
Cycles the test. A stoppage can be initiated by an operator, an event action, or a system
interlock.
For example, you specify 10 and the test is 50 cycles long. If an operator stops and
restarts the test at 30 cycles, the application saves data for cycles 21 to 30 and 41 to 50.
Index Specify an array variable to store all the cycle count numbers of cycles where data is
Variable stored.
You must first create an index variable that is an Array type and with a dimension of
Count. This variable stores the current cycle count number when the application stores
data.
The Select Cycles, Starting Cycles, and Final Cycles properties determine the
cycles when the application stores data.
This array stores cycle numbers, not the data. This array can be used to determine
which data to analyze.
Select Opens the Cycle Decimation Filter Selection window to further specify which cycles to
Cycles acquire. The raw data is saved for the acquired cycles.
Note:
The cycle decimation filter settings do not affect data that is saved to a variable.
Dwell
Dwell Activity Overview
The Dwell activity maintains a command for a specified duration at either the current level or a
specified level in a specified control mode. By default, the activity dwells at the current level (when the
Dwell at Current Value check box is selected in the Properties panel).
When you define a Dwell command activity, you must specify the duration of the command.
Note:
If you are commanding this activity using a load or strain control mode, you may need to tune the
load or strain control mode before using this activity within a test. For more information about
tuning, see “Tuning Parameters Activity Overview” on page 360.
Item Description
Display Name that is shown on the Dwell activity icon in the workflow on the Procedure tab.
Name
Enable Select to enable this command; clear selection box to disable this command.
Description Description of this command that is shown when you hover your cursor over the
Dwell activity icon on the Procedure tab.
Progress Visibility: Indicate whether you want to view the progress table during runtime.
Table l Fixed: The table is always available for viewing.
l Transient: The table is available for viewing during the test only.
l Never: The table is not visible during the test.
Note:
You add the Progress table as a Test-Run Display activity.
Termination Indicate the duration of the Dwell command activity in either time or frequency.
l Duration: Enter the time and unit of measurement.
l Signal: Click the ellipsis to open the Select a Signal window where you
select a signal.
l Comparison: Select from the drop-down menu when the Dwell activity will
end.
l Value: Enter the value and unit of measurement or variable used in the
calculation at which the Dwell activity will maintain the command.
Dwell at The Dwell activity maintains at the current value (this is the default).
Current
Value Advanced button: Click to open the Advanced Command Properties window and
suppress the cycle counter for the duration of the Dwell activity.
Channel Specifies the channel. Click the plus sign to open the Select Channel window. You
List can specify multiple channels.
Control Specifies the control mode or control mode variable. Specify a control mode for each
Mode channel you select.
End Level This feature appears when you clear the Dwell at Current Value box. Enter a value
and unit of measurement or variable for when the Dwell activity should end.
This is a composite activity that combines the following sub-activities in separate branches of a
Parallel Path activity. You can enable one or all of the following activities in the paths.
For more information about the stand-alone activities, click the appropriate reference in the following
list.
l Dwell activity (“Dwell Activity Properties” on page 317)
l DAQ activity (“DAQ Activity Overview” on page 328)
l Limit Detection activity (“Limit Detection Activity Properties” on page 346)
l Break Detection activity (“Break Detection Activity Properties” on page 338)
l Wait for Operator Action activity (“Break Detection Activity Properties” on page 338)
Note:
If you are commanding this activity using a load or strain control mode, you may need to tune the
load or strain control mode before using this activity within a test. For more information about
tuning, see “Tuning Parameters Activity Overview” on page 360.
Item Description
Store Specifies the variable that gets set at the end of the composite activity path. This lets
Ending you identify which path ends the Dwell + DAQ + Detection activity. For example,
Path when running a test, you may either complete the test or hit a preset limit that will stop
Value > the test which is then identified in the Store Ending Path Value variable.
Variable
Name
Dwell “Dwell Activity Properties” on page 317
activity
DAQ “Basic DAQ Activity Properties” on page 329, “Advanced Data Acquisition Properties”
activity on page 330
Limit “Limit Detection Activity Properties” on page 346
Detection
activity
Break “Break Detection Activity Properties” on page 338
Detection
activity
Wait for “Wait for Operator Action Activity Properties” on page 384
Operator
Action
activity
Go To
Go To Activity Overview
Go To Activity Icon
Use the Go To activity to command a control channel to move the crosshead at a specified rate and
direction. The Go To activity is typically part of a parallel path that contains limit/break detection, DAQ
(data acquisition), and other activities.
Note:
If you are commanding this activity using a load or strain control mode, you may need to tune the
load or strain control mode before using this activity within a test. For more information about
tuning, see “Tuning Parameters Activity Overview” on page 360.
Go To Activity Properties
Go To Activity Properties
Item Description
Channel Select the channel that is controlled by this activity.
Control Select the type of feedback to use in the control loop for the selected channel.
mode
Direction Select the signal direction used in the control loop for the selected channel for this
activity.
Increase—Move the crosshead or actuator in a direction that will increase the
control-mode feedback signal value.
Decrease—Move the crosshead or actuator in a direction that will decrease the
control-mode feedback signal value.
Auto—The application will use the “Effect of Increasing Extension” resource settings
Item Description
to determine which direction the crosshead or actuator must travel to reach the
specified end condition.
Note: The Auto setting will not work with resources that have the “Effect of
Increasing Extension” setting set to Indefinite.
Rate Enter the rate at which the crosshead or actuator will move. To toggle between
entering an specific value and an input, click or .
Termination Select the Termination Condition check box if you want to define limits that will end
Condition this activity.
Signal—Select the signal to monitor for the ending condition.
Comparison—Select an absolute or relative comparison, between the actual signal
value and the value entered below, that will end the activity.
Note: When the Direction setting is set to Auto, the Crosses comparison
setting becomes available. When Crosses is selected, the activity ends when
the actual signal equals the set value.
Value—Enter the signal value used by the comparison setting. To toggle between
entering an specific value and an input, click or .
Brake Control-mode braking slows the command to help avoid overshoot. The brake
distance distance value is subtracted from the ending condition value to determine where
control-mode braking starts. To toggle between entering an specific value and an
input, click or .
For example, if the ending condition value is 100 N and the brake distance is set to 10
N, at 90 N, the command will slow down to 10% of the rate setting and at 99 N, it will
slow down to 1% of the rate setting.
Note: This option is not available when the control mode is crosshead or
extension.
Use Tuning If the control mode is set to Load or Strain, you must enter the tuning parameters for
Parameters the control mode. The tuning parameters will be different for different type of
specimen materials.
Note: Tuning parameter settings are only available with MTS TestSuite TW
Software running on an MTS Insight Controller.
Go To + DAQ + Detection
Go To + DAQ + Detection Activity
Note:
This activity is only applicable to the TWE application running in conjunction with an MTS Insight
controller.
This is a composite activity that combines the following sub-activities in separate branches of a
Parallel Path activity. For more information, refer to the topics for the standalone activities.
l Go To activity (“Go To Activity Properties” on page 322)
l DAQ activity (“DAQ Activity Overview” on page 328)
l Limit Detection activity (“Limit Detection Activity Properties” on page 346)
l Break Detection activity (“Break Detection Activity Properties” on page 338)
l Wait for Operator Action activity (“Wait for Operator Action Activity Properties” on page
384)
Note:
If you are commanding this activity using a load or strain control mode, you may need to tune the
load or strain control mode before using this activity within a test. For more information about
tuning, see “Tuning Parameters Activity Overview” on page 360.
Item Description
Store Specifies the variable that gets set at the end of the composite activity path. This lets you
End Path identify which path ends the Go To + DAQ + Detection activity. For example, when
Value > running a test, you may either complete the test or hit a preset limit that will stop the test
Variable which is then identified in the Store Ending Path Value variable.
Name
Go To “Go To Activity Properties” on page 322
activity
DAQ “Basic DAQ Activity Properties” on page 329, “Advanced Data Acquisition Properties”
Item Description
activity on page 330
Limit “Limit Detection Activity Properties” on page 346
Detection
activity
Break “Break Detection Activity Properties” on page 338
Detection
activity
Wait for “Wait for Operator Action Activity Properties” on page 384
Operator
Action
activity
Return to Zero
Return to Zero Activity Overview
The Return to Zero activity returns the crosshead or actuator (depending on the controller) to the
zero position. The activity performs the same action as manually clicking the Return Crosshead (or
Actuator) Control button.
Note:
The return rate for the Return to Zero activity with an MTS Insight controller is determined by a
hardware setting that only an MTS Field Service representative can access. If the rate requires
adjustment, contact your MTS representative.
The return rate when run with a FlexTest controller uses the rate defined in the Control Panel
configuration. To configure the rate, click Preferences > Configuration > Control Panel.
The Return to Zero activity runs even when the test status is stopped.
Item Description
Display Name The name of the activity shown in the Procedure tab.
Enable check box Enable or disable the command activity.
Description Description shown when cursor is hovered over activity icon in Procedure
tab.
Progress Table Indicate whether the progress table is shown during runtime:
l Fixed—The table is always available for viewing.
l Transient—The table is available for viewing during the test only.
l Never—The table is not visible during the test.
Show Indicate whether or not a confirmation window is shown before returning to
confirmation zero. It may be useful to enable this option if you want to allow the test
dialog before operator to decide whether or not to return to zero.
action check box
The DAQ activity is a standalone activity that collects data using a variety of triggers independently of
any Command activity. The DAQ activity is typically placed in a parallel path with a Command
activity. The DAQ activity can write data into a variable or a file using block or point-by-point
processing. It can also perform calculations on the data put into variables.
Note:
If you are running a cyclic test, you may want to use the Cycle + DAQcomposite activity. It
combines cyclic command and a DAQ activity that is hardcoded to support most cyclic testing.
A DAQ activity requires at least one trigger and one signal. You can also specify multiple triggers.
Item Description
Display Name of the activity shown in Procedure tab.
Name
Enable Enables or disables this command activity.
check box
Description Description shown when cursor is hovered over activity icon in Procedure tab.
Progress Indicates whether this activity will show its progress in the Test Progress Table run-
Table time display tool. For more information about the Test Progress Table, see “Test
Progress Table” on page 509.
l Fixed—The table is always available for viewing in the Test Progress Table.
l Transient—The table is available for viewing in the Test Progress Table
during the test only.
l Never—The table is not visible in the Test Progress Table during the test.
Item Description
Trigger List Click the plus sign to open the Data Acquisition Trigger Properties window to add one
or more triggers by specifying the Trigger Type, Sample Selection, Sample Rate,
and Sample Duration.
Signal List Select the signals that you want to acquire when any of the triggers occur. Click the
plus sign to open the Select Signals window and move the desired signals from the
Available List to the Selected List. You can also change the order of the signals in the
Selected List.
Save data Indicate whether you want to save (map) acquired signal data to variables.
to
variables?
Item Description
Data Note:
Storage The Data Storage property is not available for the Cycle + DAQ and Custom
Waveform + DAQ activities. Those activities are hardcoded to save data.
The following Data Storage options are available:
l Save Data—(Default) Saves the data from the test run to the data file.
l Discard Data—Does not save data. Discarded data is not available for
further viewing or for analysis.
Buffer Note:
Type This property is not applicable to the Max/Min DAQ activity.
Linear Buffer—Records data until it is full then delivers it to the application for
processing (blocking, save to disk, save to variables). The size of the buffer
determines how much data is acquired before it is written to disk or put into variables.
Data is continuously processed until the activity ends or is interrupted. When the
activity ends, any data in the buffer is processed.
Circular Buffer—Records data continuously. When the buffer is full, new data
overwrites the oldest data. This type of buffering processes data when the test is
stopped, when the activity reaches its preset count, or when the activity ends.
Buffer Size Note:
This property is not applicable to the Max/Min DAQ activity.
The buffer size specifies the maximum number of data points the buffer stores before
Item Description
processing data.
Acquire Provides the ability to continue or stop acquiring data when a test has been
data while temporarily paused. To acquire data during a hold, select the Acquire data while
holding holding check box. To stop collecting data during a hold, clear the check box.
Default: Disabled.
Collect last Note:
data point This property is not applicable to the Max/Min DAQ activity.
Provides the ability to collect an additional data point. When enabled, data acquisition
collects one more data point when interrupted, such as by a Break Detection
activity. Collecting the last data point ensures critical data is captured.
Default: Disabled.
Block The High-Speed DAQ (MPE only), Dwell + DAQ + Detection (TWE only), Go To
Information + DAQ + Detection (TWE only),Max/Min DAQ, and DAQ activities include the
(Optional) following Block Information settings. Enter the block information if you want to
process data in blocks. If left blank, data is processed point-by-point.
For more information about block data processing, see “Block Data Processing” on
page 154.
Counter Specify the count variable that is going to be the index or boundary identifier that
defines the block.
Identifier Specify the name of the block. The identifier is used by the Block function. For
example, if the identifier is “JICStep”, it could be used as Block(“JICStep”,...)
Display Specify the name of the block that is shown in variable chart views that shows
Name boundaries of data, such as the history view or hysteresis view.
Select Opens the Block Decimation Filter Selection window in which you can specify the
Blocks frequency of downsampling.
Max/Min DAQ
Max/Min DAQ Activity Overview
The Max/Min DAQ activity records the maximum and minimum values of selected signals during a
test. The reference signal selection determines the type of data that is acquired. The selections include
a “single reference signal” or “All included signals.”
When the maximum and minimum values are detected, they are compared to the maximum and
minimum values currently stored for the associated signals. If the new values exceed the stored
values, they replace the stored values.
Data processing
The Max/Min DAQ activity processes data when:
l The activity ends normally
l The activity is stopped
l The activity is interrupted
Important:
At the end of the activity, the activity writes one minimum and maximum value into the
single block number that is in effect when the data is written, not when the max/min
occurred.
Item Description
Signal Selects signals from which this process acquires data. Use the left and right arrows to
List move desired signals from the Available list to the Selected list.
Reference Select the appropriate reference signal option.
Signal
Maximum Monitors the Reference signal for the maximum values when selected.
Values
Item Description
Minimum Monitors the Reference signal for the minimum values when selected.
Values
Save data No—The signal data is not put into variables.
to
variables? Yes, automatically map variables—The signals being acquired are automatically
mapped to variables using the mapping type of "Minimum" and "Maximum," and
appends "Minimum" and "Maximum" to the signal names to form the variable names.
In addition, calculations dependent on these mapped variables are automatically added
to the Additional Calculations list.
Yes, manually map variables—The test designer must manually map the signals
and additional calculations by clicking the Configure button and using the Map
Variables window.
Configure Opens the Map Variables window where you can map signal data into variables that
button can be used to perform calculations on signal data, perform logical condition checks,
and acquire signal data for test-run displays.
Item Description
Data By default, data is saved; however, you can use this option to discard data.
Storage
Click Discard Data to not save data.
Click Save Data to save the data from the test run.
Note:
Discarded data is not available for further viewing or for analysis.
Block Important:
Information At the end of the activity, the activity writes one max and one min value into the
single block number that is in effect when the data is written, not when the
max/min occurred.
Record Video
Record Video Activity Overview
The Record Video Activity records video from a connected USB video device.
Example: Suppose you want to configure a test to capture a video recording of the Go To (TW) or
Ramp (MP) activity. In this case, you would add the Record Video activity as a parallel branch
along with the Go To or Ramp activity. After you configure the properties of the Record Video
activity and run the test, you can review your test data and the synchronized video recording.
Note: For more information about configuring a test to include video recordings, see “Appendix:
Video Recording” on page 615.
Item Description
Video Set Select an existing video set or select <new video set> to create a new video set. To
edit an existing video set, click the ellipsis (...) or click Tools > Edit Video Sets in the
menu bar at the top of the application.
For more information about editing the properties for a video set, see thefollowing
Video Set Properties table.
Continuous Select to record video continuously throughout the duration of this activity.
One Frame Select to capture a single frame when this activity is encountered.
Duration Select to record video for a specified duration. When the video recording duration has
ended, the test procedure will progress to the next activity in the test.
Item Description
Video Set Enter a name for this video set (optional).
Display Name
Record this Enable this option to record video for the entire test run. Disable this option if
video set you want to record video at specific times during the test run using one or more
continuously for Record Video activities (typically in parallel with program command activities).
the entire test
run.
Time Set the signal that will be synchronized to the video recording.
Synchronization
Signal
Cameras Click the plus sign to add a new camera.
Note: The remaining camera fields are disabled until you add at least
one camera to the video set.
Camera Display Enter a display name for the camera. If you have multiple cameras, it will be
Name easier to manage your cameras during test design and post-test analysis if you
give each camera a unique name.
Source Select the connected USB camera you want to use to capture the video. All
cameras that are connected to a USB port on your PC are listed.
Resolution Select a resolution for the recorded video. Video recorded at a higher
resolution will include more detail, will also create larger video files.
The Break Detection activity monitors signals for occurrence failure events (peak or valley values),
and determines whether the failure events meet the criteria for specimen failure, and if so, completes
the activity.
Item Description
Enable Enables the process. (Clear this box to disable the process.)
Display Specifies the process name displayed on the Procedure or Group process window. If
Name left blank, the software will automatically generate a name based on the selected
signal(s).
Description Enter an optional description to document the procedure design.
Progress Indicates whether the activity will have a listing in the Progress Table. The Progress
Table Table is a control that can be placed on the Test-Run Display.
Visibility
Options are:
l Fixed—The activity will have a listing in the Progress Table that shows while
the test is executing and persists after the test is complete.
Item Description
l Transient—The activity will have a listing in the Progress Table only while
the program is executing.
l Never—The activity will not have a listing in the Progress Table.
Completion This control is only pertinent if more than one signal is listed in the Signals list or if the
machine has multiple heads (an available option for some Criterion machines).
Options are:
l All Breaks—The activity completes when all signal breaks have been
detected.
l Any Break—The activity completes when any one signal break is detected.
Signals Click to open the Add Signals window. In this window, select the signal(s) you wish
to monitor for a break.
Reference The Reference determines whether the break is base on the Peak or the Valley.
Options are:
l Peak—After the Peak is located, the signal is monitored for it to reach (1.0 -
PercentChange)*Peak.
l Valley—After the Valley is located, the signal is monitored for it to reach (1.0-
PercentChange)*Valley.
Note:
PercentChange is the value entered for Percent Change. Peak is the
value of the signal at the Peak. Valley is the value of the signal at the
Valley.
Percent Specify the percentage of the monitored signal’s referenced value (Peak or Valley)
Change that represents a specimen failure.
Item Description
Threshold Select the threshold that the signal must exceed before the activity begins monitoring
for breaks.
Sensitivity Specify how much the monitored signal must change before a level is considered a
maximum event (peak) or a minimum event (valley). This value is typically set to 0.0
so as not to require large reversals, however, doing this requires more overhead.
Overhead is usually not an issue with Insight controllers, but could be for FlexTest
controllers.
Action Specify the action to take when a specimen failure occurs. These actions are
dependent on your controller and test resources configurations. Options are:
793 Controllers
l Disabled—Break detection for that signal is not being monitored.
l Indicate—A break condition is registered in the software causing the break
detection activity to complete. Nothing occurs on the controller.
l Program Stop Interlock—A break condition is registered in the software
causing the break detection activity to complete and the 793 interlock is set.
Insight Controllers
l Disabled—Break detection for that signal is not being monitored.
l No Action—A break condition is registered in the software causing the
break detection activity to complete. Nothing occurs on the controller.
Example: Suppose you are expecting a peak load of 1000 N in a simplified tension test on a
Criterion 43 load frame and want to detect a break when there is a 90% change in load. You do not
want to begin monitoring until the load has reached 50 N.
1. Click Enable to enable break detection.
2. Do not change Display Name because it will be populated when you select a signal.
3. Enter a Description, if desired, to document the procedure design.
4. Set the Progress Table Visibility to Fixed to make the Progress Table visible any time.
5. Set Completion to Any Break to detect the first break, although for this single signal
example either setting would produce the same results.
6. Click the + to add a signal, and select the Load signal.
7. Set Reference to Peak because the load will be a positive value.
8. Set Percent Change to 90%. This results in the Break Detection activity completing when
the load changes 90% from the peak. For example, if the peak load reaches 1000 N at the
break, the activity will complete when the load drops to 100 N.
9. Set Threshold to 50 N. This results in the Break Detection activity starting its monitoring
when the load reaches 50 N.
10. Set Sensitivity to 0.0 N. This results in Break Detection occurring at every point during the
test.
11. Set Action to No Action. This option allows the activity to complete in the software, but has
no effect on the controller.
12. Run the test.
Digital Input
Digital Input Activity Overview
The Digital Input activity monitors and responds to digital input states, such as when the signal is high
(1) or low (0), or when it transitions from one state to another.
With a single activity, you can monitor one or more inputs and specify whether the activity performs a
specified action when any of the monitored signal states occur or only when all of the monitored states
occur. The actions you can specify are controller- and test resource-dependent.
If you want an operator to interactively monitor digital output and input during a test run, you can
configure a Digital IO test-run display.
Item Description
Monitor Sets the type of monitoring for the activity:
l One Time—(Default) Performs one check of the inputs. The action is triggered
only if the conditions are detected by the one-time check.
l Continuous—Performs a continuous check of the inputs. The action is
triggered if any of the checks detects that the conditions are met.
Trigger Specifies when to perform the associated action.
When
l Any Digital Event Occurs—(Default) Any one of the monitored events can
trigger the action if the signal conditions are met.
l All Digital Events Occur—All monitored signals must reach their signal
conditions for the activity trigger to occur.
Action Specify the action to take. The available actions are controller- and test resource-
dependent.
Required.
Log Indicates whether or not to log events from the Digital Input activity and the level at
which to log. Available options are:
Item Description
l None
l Informational
l Warning
l Error
Digital Selects the specific digital inputs for the activity to monitor. To add or delete inputs from
Inputs the list, click the plus or minus signs.
Required.
Extensometer Removal
Extensometer Removal Activity Overview
Note:
If your test will end before your extensometer has completely opened, you should NOT use this
configuration item.
This configuration item sets the point that your extensometer becomes invalid, and is extremely useful
when you are setting up an extensometer displacement test. This test uses an extensometer as its
primary source of extension data for the initial part of the test, and then uses the LVDT for the
remainder of the test. The removal point is usually set as the full travel of the extensometer.
For instance, a 1”-50% extensometer can open 0.5 inches, therefore, the removal point for this
extensometer is set at 0.5 inches.
Note:
This configuration item only specifies the extensometer removal point. It does NOT change your
extension channel to be a combination of your extensometer and your LVDT.
Item Description
Extensometer Specifies the signal the extensometer is monitoring. Click the ellipsis to open the
Select a Signal window.
Removal Point at which the test will stop and hold, and the extensometer will be removed,
Point usually set as the full travel of the extensometer. Specify value and unit of
measurement or variable.
Hold Test Select if you want the test to stop and hold when extensometer reaches removal
point.
Limit Detection
Limit Detection Activity Overview
TheLimit Detection activity monitors signals and variables during a test run and compares their
values against defined upper and lower limits. Configure the Limit Detection activity to respond to a
single limit event or multiple limit events.
You can specify the action that the Limit Detectionactivity takes. For example, you can choose to
indicate that a limit is reached, or you can choose to stop the test and generate an interlock condition.
Item Description
Completion Select Any Limit to cause the Limit Detection to trigger based on any single
monitored item reaching its limit.
Select All Limits to cause the Limit Detection to trigger only if all monitored items
reach their limits.
Log Select whether the limit event is logged as Informational, Warning, or Error. You
can also choose None if you do not want to log the event.
Signal Select which signals to monitor. Click the plus sign to open the Select Signals
Limits window.
Variable Select variables to monitor. Click the plus sign to open the Select Variables window.
Limits
Comparison Select Absolute to set a defined value for a variable limit. If you set an absolute
Mode value at 10 kN, the limit is triggered at 10 kN.
Select Relative to set the limit relative to the value of the variable when the activity
starts. If you set a relative value of 10 kN, the limit is triggered at 10 kN above the
value when the activity starts—if the value is 5 kN when the activity starts, the limit
triggers at 15 kN.
Lower
Limit/Upper
Limit
Action Specify the action to take if the lower limit conditions are met. The available actions
are controller-dependent.
Value Specify the value (or variable) to trigger a limit event. For a lower limit, if the
monitored values fall below this value, a limit event occurs.
For an upper limit, if the monitored values exceeds this value, a limit event occurs.
The State Change Detection activity checks for a specific program state. The activity typically occurs
in parallel with other activities to limit them or provide a path if an activity fails.
For example, a parallel path contains a State Change Detection activity that monitors for a stop
condition. If the test stops, the UserStop variable is set to True.
Item Description
Running The procedure is controlling the machine and playing out a waveform. This state is
sometimes referred to as “Run” in log messages.
Stopped The procedure and controller actuators are fully stopped. This state is sometimes
referred to as “Stop” in log messages.
Hold The state in which the test procedure suspends the activity on the controller. The
actuator is not moving, but the test can be continued by clicking Run.
Starting The transition state between Stopped and Running.
Stopping The transition state between Running or Holding and Stopped.
Holding The transition state between Running and Holding.
Resuming The transition state between Hold and Running.
Use the Wait for Event activity to indicate when the test flow should wait for a condition to be true.
The Wait for Event is a blocking activity that ends when the condition is met, allowing activities after it
to execute.
The condition you define is an expression that uses the variables, functions, and operators available in
the Calculation Editor window. For example, to wait until the controller is in a run state, the wait
condition could be the following:
Signal(“Run/Stop”)==1
Use the Input Variables activity to prompt a user to provide a simple value.
Use the Calculate Variables selection to evaluate existing calculations.
Item Description
Condition Define a condition that when met indicates that the activity should stop and the
procedure should continue with the next activity. Click the ellipsis to open the
Calculation Editor.
Use the Auto Offset activity to apply an automatic offset for a group of selected feedback signals.
Feedback offset
Feedback offset alters the feedback signal used by the controller to zero the conditioner output.
External factors such as specimen size, test component forces, and cable length can affect calibrated
sensor outputs. To compensate for these static external factors, you can add an offset to the feedback
signal. Feedback offset alters the feedback signal used by the controller without shifting the conditioner
zero reference. Feedback offset is included in control loop calculations.
Item Description
Display Specifies the name shown in the activity icon in the Procedure tab.
Name
Enable Enables the activity. Clear this box to disable the activity.
Description Specifies what is shown when you hover your cursor over the activity icon in the
Procedure tab.
Progress Specifies whether you can view the progress table during runtime.
Table l Fixed—The table is always available for viewing.
l Transient—The table is available for viewing during the test only.
l Never—The table is not visible during the test.
Note:
Add the Progress table as a Test-Run activity.
Signal List Specifies the signals to which you want to apply the auto offset. Click to open the
Add Signals window. Click to remove the selected signal.
Item Description
The Reset Cycle Count activity resets the cycle counter for the selected channel to zero while the test
is in progress. The activity resets the cycle count, also referred to as a segment count, of the controller.
The value of the controller segment counter is available through signal resources such as Axial Count
or Axial Integer Count.
The Cycle + DAQ and Custom Waveform + DAQ activities use the segment generator's segment
count to divide up the data into cycles. Therefore, resetting this cycle count affects how the acquired
cyclic data is displayed and stored. The data acquisition cycle decimation filters work relative to the
cycle numbers.
For example, a test can do some preliminary warm-up cycles, zero the cycle counter, and then do the
rest of the test (including cycle decimation filters). The acquired data appears to start from cycle zero.
Other than the properties common to all test activities, the Channel property must be selected.
Property Description
Channel The selected channel on which to reset the cycle (segment) count.
The channels that appear in the list are test resources that are available in the
Resources tab.
Required.
The Set Calculation Parameter activity changes the value of a controller calculation parameter. This
activity provides support for calculated signal and output processing.
For example, the following calculation computes stress: stress = force / area
Typically, the controller can measure force but the area must be specified by the user. A calculation
parameter is a mechanism by which that value can be sent to the controller.
A calculated resource acts like a variable, but is set at the controller resource level. You must have one
or more calculated resources in the test to set their value with this activity.
Item Description
Parameter Specifies the controller calculation parameter to be changed.
List
Set Value Specifies the value or variable to be set for the selected controller calculation
parameter.
Use the Set Control Event activity to trigger an action in the controller and optionally log a message
based on test conditions or on user input. The list of actions is controller-dependent.
This activity is typically used in conjunction with an If-Else Condition activity that evaluates a test
condition or variable that contains user input. For example, the activity shuts down the test, triggers an
action supported by the controller, or writes a message to the log. Use this activity in conjunction with
the State Change Detection activity to determine if the change has occurred before continuing with
subsequent activities. For example, if you use the Set Control Event activity to trigger a Program
Hold action, you can use the State Change Detection activity to determine if the controller is in a hold
state before continuing.
Item Description
Action Specifies the action to occur when a condition is triggered, which is specified by another
activity such as an If-Else Condition.
Log as: Specifies the type of optional message to be generated.
Message Specifies the optional message to be generated.
Controller Actions
You can set the following actions in activities that set controller actions. The actions depend on the
type of controller and the defined test resources. Additionally, any controller actions (such as Interlock,
C-Stop Interlock, or Program Stop Interlock) will appear in the Application Log under the category
ControllerLog.
Action Description
Selected
No No controller action is taken. The test continues to run.
Action
Indicate A message is generated and shown to the operator. The test continues to run.
Station Testing stops. Power is removed from the station.
Power
Off
Interlock An interlock is generated and testing stops. Power is removed from the station.
Program The program (test) stops and an interlock is generated. The station still has power but the
Stop Run button cannot be pressed.
Interlock
Program The program (test) holds and an interlock is generated. The station still has power but the
Hold Run button cannot be pressed. The test can be resumed after the interlock is reset.
Interlock
C-Stop Note:
Interlock The C-Stop Interlock is applicable only to MTS FlexTest controllers.
A C-Stop (Controlled Stop) Interlock results in the following actions:
l A Program Stop Interlock occurs. The test stops but the station still has
power.
l The Station Manager C-Stop indicator is turned on.
l The Station Manager application logs a message.
l The control channel will execute the user-defined C-Stop action, which is
enabled and configured at Station Manager Tools menu > Channel Options
window > C-Stop tab. You must have Configuration access level to configure
the C-Stop Interlock action.
Note:
The actions of the C-Stop interlock present a fundamental difference from the
Ramp To and Hold At Level user-defined actions, which require the Function
Generator to be in the run state to execute. C-Stop does not have this
requirement.
Program The program (test) stops but the station still has power.
Stop
Program The program (test) holds with the current command. The station still has power, and the
Hold test can be resumed.
Custom These are custom program actions you can create, such as “Turn on light.” For more
Actions information on using the Station Builder application to add resources to a station
configuration, see the MTS Series 793 Control Software Manual.
The Set Digital Output activity specifies how the digital output is set. State can be Off or On. Toggle
will set the digital output to the state it is not currently in. Pulse will set the digital output to the state it is
not currently in, wait the amount of time indicated in the Pulse Width column, and then set the output
back to the state it was in when the activity started. The state of the digital output is set when the
procedure moves to that activity. The digital output remains at that state specified unless it is changed
by another instance of a Set Digital Output activity.
Digital Output
If you want an operator to interactively monitor digital output during a test run, you can configure a
Digital IO test-run display.
Temperature Control
Temperature Control Activity Overview
The Temperature Control activity provides an interface to set Target setpoint, Hold Time,
Minimum Limit and Maximum Limit, Maximum Fluctuation range, Zone Gradient, and Warning
Action for one or more Temperature Zones. Use the Temperature Control activity in series to
bring the system to the Target temperature before testing. Use the Temperature Control activity in
parallel to monitor temperature through the test. Typically, test designers use the Temperature
Control activity in pairs with one Temperature Control activity in series to bring the system to the
Target temperature and one Temperature Control activity in parallel to monitor temperature during
testing.
Target
Target is the variable used by Setpoint Command.
Hold Time
Hold Time is either a specified amount of time or monitoring until the activity has stopped. The Hold
Time starts when all the Temperature Zones are within the Maximum Fluctuation range and within
the Zone Gradient if there is more than one temperature zone.
Maximum Fluctuation
Maximum Fluctuation is the acceptable range above and below the Target temperature. The
Maximum Fluctuation range must be within the Minimum Limit and Maximum Limit.
Zone Gradient
Zone Gradient applies when more than one temperature zone is used. The Zone Gradient is the
maximum difference between two adjacent temperature zones.
Warnings
Warnings generate a message in the test log and prompt the designated Warning Action. Warning
conditions are monitored during the Hold Time.
Warning conditions
l Exceeding the Maximum Fluctuation range
l Exceeding the Zone Gradient
Warning Actions
l End Test
l Restart Hold Time
l Do Nothing
For more information about temperature controllers, see “Appendix: Eurotherm 2000 Series
Temperature Controller” on page 577
Tuning Parameters
Tuning Parameters Activity Overview
Note:
This activity is available only for MTS Criterion and MTS Insight systems where portions of a test
are run in load or strain control.
The Tuning Parameter activity applies tuning parameter values for a control mode added by the
Advanced Rate Control software option. These tuning parameter values apply to any subsequent
Command activity using that Advanced Rate Control mode. The tuning parameter values persist until
they are overwritten.
To apply previously determined tuning parameter values, use the Tuning Parameter activity in series.
To aid in determining the tuning parameter values, use the Tuning Parameter activity in parallel. The
process of determining the tuning parameter values is usually referred to as PID tuning.
Tuning Examples
For the Custom Waveform or Cycle Command activity using an Advanced Rate Control mode, the
Tuning Parameter activity is required to apply tuning parameter values. For the Go To or Dwell
Command activity using an Advanced Rate Control mode, the Tuning Parameter activity is optional.
For the Go To and Dwell Command activities, the tuning parameter values can be applied in the
Properties panel of those activities.
Some tests may require multiple pairs of Tuning Parameter/Command activities. For example, a test
may include a set of tuning parameters and command used before a specimen yields and another set
for after the specimen yields.
For more information about the MTS Tuning Template Example, see “Appendix: MTS Tuning
Template Example” on page 601.
Use the Write Variables to Handset activity to write desired variable information to the operator
handset. The variable display name, variable value, and variable units can be shown to an operator in
the handset display screen. This feature is useful for operators who need to determine whether they
need to run a test again.
Up to four lines of text are visible at a time on the handset display area, 20 characters per line, up to a
maximum of four pages. There are 16 total text lines available; four pages of four lines. If the text on
any line exceeds 20 characters, the text is truncated. Displayed characters are limited to those
supported by the handset display.
Digital inputs from the F1 and F2 buttons can be configured as responses when operator messages
are pushed to the handset. For example, F1 can indicate Yes or OK; and F2 can indicate No or Cancel.
For more information about interactively monitoring digital input, refer to the Digital IO test-run display.
If there is no handset detected when connected to an MTS Insight controller, a warning is displayed
when designing or running a test.
Item Description
Variable Selects the variables that are displayed in the handset. You can select from zero to eight
List variables. Array variables are also supported for this activity. Only the last array value is
shown.
For this activity, an empty variable list is allowed (that is, no validation error) during test
design time. If there are zero variables, the handset display becomes blank.
Note:
If you select more than eight variables, a validation error is displayed in the Error
List tab.
Use the End Test activity to force the test run to end before completing all stages of the test run. When
the test procedure reaches the End Test activity, workflow activities that follow and are parallel to the
End Test activity do not execute, and the procedure immediately proceeds to the end of the test. A
message is written to the test run log indicating that the test run was stopped due to the End Test
activity.
If-Else Condition
If-Else Condition Activity Overview
The If-Else Condition activity creates two possible paths for a test procedure based on a conditional
expression that evaluates to True or False. If the expression evaluates to True, the test procedure
follows the True path. If the expression evaluates to False, the test procedure follows the False path.
The evaluated condition can be the result of a response from the operator, or it can be an evaluation of
a specific test value or condition.
Note: The Condition must evaluate to True or False or else a validation error will appear. Use
logical operators such as “==”, rather than assignment operators such as “=”. The Calculation
Editor provides a list of available variables, operators, and functions.
The two possible paths for the procedure to follow are automatically created when you add the If-Else
Condition activity to the test procedure. Each path can contain zero or more activities, including If-
Then Condition and other activities.
Item Description
Condition Specifies the conditional expression that evaluates to True or False. Click the ellipsis
to open the Calculation Editor.
If true, then Specifies which path to follow if the expression is true.
follow
Parallel Paths
Parallel Paths Activity Overview
The Parallel Paths activity enables you to use alternate and parallel paths within a test procedure.
Each parallel path can contain a series of activities that run sequentially within that path. The activities
in the path run simultaneously and independently of activities in the other parallel path.
Note:
When designing procedures, do not use activities in parallel paths within the same parallel
activity that operate on the same control channel. Resource conflicts of this sort are not reported
during test design, but do generate an error during test execution.
Two parallel paths (branches) are automatically created when the Parallel Paths activity is added to
the test procedure. Within the activity, you can add activities and other parallel paths. Each path has its
own display name.
When you create a new parallel paths activity, a validation error is present until you select one or more
terminal paths in the Terminal Paths property. The parallel paths activity completes when any of the
selected terminal paths complete. To designate specific activities as terminal activities, click the plus
sign in the Additional Terminal Activities property and add the desired terminal activities from the list of
activities in the parallel path.
Item Description
Store Specifies the variable that gets set at the end of the path. This lets you identify which
Ending path ended the Parallel Path activity. For example, when running a test, you may
Path either complete the test or hit a preset limit that will stop the test which is then identified
Value in the Store Ending Path Value variable.
Terminal Specifies the path and activity that will indicate the end of the Parallel Path activity.
Paths When this activity ends, the test workflow moves onto the next activity.
Additional Specifies other activities that will terminate the Parallel Path activity. Click the plus
Terminal sign to open the Activities Selection window and select the activities that will end the
Activities Parallel Path activity.
Important:
To produce a trigger, the Periodic Time Event activity must be active at the time you want the
trigger event to occur.
The Periodic Time Event activity is used to schedule arbitrary and repetitive times at which the
activity produces a trigger or a series of triggers. You can use these time-based triggers to invoke an
event, such as triggering another activity, actuating an external device, and so forth. These are
activities that you have dragged from the Toolbox panel to the Periodic Time Event icon.
When you define a Periodic Time Event activity, you can specify periodic trigger times and the trigger
mode.
Note:
The activity does not trigger immediately after the test starts, regardless of the settings. The
minimum amount of time required for the activity to trigger after the test starts is approximately
one minute.
Item Description
Visibility Select to view the progress table during runtime.
l Fixed—The table is always available for viewing.
l Transient—The table is available for viewing during the test only.
l Never—The table is not visible during the test.
Note:
You add the Progress table as a Runtime activity.
Recurrence Select the recurrence pattern for the Periodic Time Event activity. The following
Pattern options are available:
l Interval—Select how frequently the event occurs. Enter an amount of time
and select msec, sec, min, hr, daily.
l At Time—Select minute, hour, day, or month and enter the appropriate
information.
l Days of Week—Select the time and day of the week for the activity to
occur.
End of Select when the event should quit occurring.
Recurrence
l No End Time—Select to have the event ongoing with no elected conclusion
time or day.
l End After N Occurrences—Select to set a certain number of occurrences
before the event quits. You may also select a variable.
l End After Interval—Select to have the event stop after a specific amount
of time. You may also select a variable.
l End by Time—Select to enter the year, month, day, and time the event
should stop.
Repeat Loop
Repeat Loop Activity Overview
Note:
If you need to configure an infinite loop, use the While Loop activity.
Use the Repeat Loop activity to repeat the loop and perform the test activities within the loop by the
number of times necessary to achieve a desired result. You can configure the repeat loop with a Total
Count property. The repeat loop iterates from zero (0) to its total loop count and then exits to the
activity immediately following the loop. For each iteration, the repeat loop executes the activities
contained within the loop. The Total Count property can be set with a positive integer constant at test
design time or with an integer variable with the Count dimension and units.
A Repeat Loop activity must have at least one subordinate test activity contained within it or a
validation error is displayed in the Error list.
Property Description
Total Indicates the number of times to repeat the loop. You can enter a constant count value,
Count select an existing count variable, or create a variable at the point of use (the New
Numeric Variables properties are pre-populated; you can adjust as appropriate).
The Repeat loop iterates until the Total Count value is attained, unless an Exit at the
End of activity has been selected to prematurely exit the loop immediately when it
encounters the first selected activity or activities in the workflow.
Default: 1
Zero iterations of the loop are allowed. The loop count can be set to zero (0). With the
loop count set to zero (0), the activities within the loop are skipped and the workflow
continues with the activity at the end of the loop. Using a counter variable for the loop
count, it is possible to decide at runtime to not execute the repeat loop; that is, skip the
repeat loop, by setting the loop counter variable to zero before entering the repeat loop.
Loop Defining this property exposes the internal iteration counter for the loop. Create a Loop
Index Index Variable if you want to be aware of the current index value.
Variable
After each iteration through a loop, the Loop Index Variable is incremented by the step
by value of 1.
The default starting point is zero (zero-based).
Optional.
Exit at The Exit at the End of property allows for early termination of the loop. Click the plus
the End sign to open the Activities Selection window and select the activity or activities within the
of Repeat Loop that prematurely terminates the Repeat Loop activity. This exit property is
similar to the Additional Terminal Activities property of the Parallel Paths activity.
The repeat loop stops all workflow processing after it encounters the first exit activity
referenced and starts the workflow sequence for the activity at the end of the loop.
Optional.
1. Click and drag a Repeat Loop activity to the desired location in the test workflow.
2. In the Total Count box, enter the number of times you want to repeat the loop.
3. Drag the activity or activities you want to repeat into the Repeat Loop container.
4. If desired, select an activity or activities to exit the loop early from the Exit at the End of
property.
The associated test-run display in the Test-Run Display tab has variable meters configured to show
counts tracked by the Loop Index variables, which are LoopIndex01 and LoopIndex02 for the outer
and inner loops (respectively) in the following figure:
While Loop
While Loop Activity Overview
The While Loopactivity repeatedly runs the activities defined within it as long as a defined condition
evaluates to True.
If the defined condition is False at the start or at the repeat of the loop, the While Loop activity does
not run. To exit the While Loop activity successfully while it runs, you must alter the value of the
condition so that it evaluates to False.
The tested condition can be the result of a response from the operator or an evaluation of a specific
value or condition.
Note:
The Condition must evaluate to True or False. Use logical operators such as “==”, rather than
assignment operators such as “=”. The Calculation Editor provides a list of available variables,
operators, and functions.
Item Description
Progress Specifies whether test activity is visible in the Test Progress Table test-run display tool.
Table > Options are:
Visibility l Never—(Default) Omits the activity from the Test Progress Table
l Fixed —Shows the progress of the activity in the Test Progress Table while
the activity is executing, and for the duration of the test.
l Transient—Shows the progress of the activity in the Test Progress Table only
when the activity is executing. When the activity ends, the activity status
disappears from the table, regardless of whether the test is done.
Condition The While construct consists of a block of code and a condition. If the condition is true,
the code within the block is executed. This repeats until the condition becomes false.
Click the ellipsis to open the Calculation Editor to create the code.
The Custom Message Window activity shows messages to an operator and records the response
from an operator. This activity is used to alert the operator to perform certain tasks, such as insert or
remove a specimen or remove an extensometer. It can also be used to notify the user that the test is
about to begin or end.
User input
The Custom Message window captures the name of the button you use to acknowledge the message
window and assigns it to a specified variable. You can later use this variable in subsequent activities,
such as If-Else Condition activity.
Custom buttons
By default, the message window includes the Close button. Custom button options include Yes, No,
OK, and Cancel in several combinations. You can also set up the Custom Message window to have
no buttons with the No Buttons option.
Create one or more custom buttons with values that you specify either manually or in a predefined
choice list.
Message content
To edit a message, click Edit message to show the Custom Message Editor window.
The message window is a basic HTML text editor. You can enter text, images, and hypertext links as
well as specify the text size and color, font family, and background color of the message. Use the
Preview button to preview the message appearance. You can import the entire contents of a valid
HTML file as well as cut, copy, and paste content using the operating system clipboard.
Variables in messages
To show the value of test variables in a message, click Insert Variable located in the Custom
Message Editor. Alternatively, you can reference the variable directly using the following syntax:
For a single-value, enter $var_<variable_name>$
Note: If you change the variable identifier name, you must manually change the name in the
Custom Message Editor; otherwise, you will not be able to run the test due to a validation error.
Item Description
Create Click to open the Custom Message Editor window, a basic HTML editor that you use to
Message compose and format the content of the message.
Window Specify the width of the message window in pixels.
Size >
Width
Window Specify the height of the message window in pixels.
Size >
Height
Preview Click to see the message as it appears to the operator during test execution.
Note: Variables in the message are not resolved until the test is executed, so the
preview shows only the variable reference, not its current value.
Buttons Custom button options include No Buttons, Yes, No, OK, and Cancel in several
combinations. You can also create one or more custom buttons with labels that you
specify.
Click No Buttons to control the Custom Message window with a parallel activity.
When the controlling activity completes, the Custom Message window closes.
Click Customize to add, modify, and delete custom buttons to the custom message
window. When you select Customize, the area expands with more options to create
custom buttons, which are described below.
Button Place the buttons on the lower left, center, or right part of the message window.
Item Description
Alignment
Results Select a variable from the list to store the text value of the button that you click. Click the
Variable list arrow to see the list of all project variables defined to hold a string value.
Note: If you choose a variable with a choice list, any existing buttons are
replaced with the buttons defined by the choice list.
Add Add a new button to the message window.
Edit Edit the selected button label. The Edit Button window has two boxes. Enter the return
value for the button in the value field. The value can be a text string or the name of a
string variable that you have previously defined. Enter the text for the button label in the
text box.
Remove Remove the selected button.
Remove Remove all custom buttons.
All
Add Add a separator line between groups of buttons. The buttons align vertically with a
Separator separator between each group.
Up Arrow Move the selected entry toward the top of the list. The entry at the top of the list appears
as the left-most button in the message window. Click Preview to see the current button
arrangement.
Down Move the selected entry toward the bottom of the list. The entry at the bottom of the list
Arrow appears as the right-most button in the message window. Click Preview to see the
current button arrangement.
Note: The editor does not support dynamic content or images stored on a web server. It also
does not support scripting extensions, such as JavaScript. If you import or paste content with
unsupported content, it generates error messages when you try to preview the message.
Item Description
Preview Click to see the message as it appears to the operator during test execution.
Note:
Variables in the message are not resolved until the test is executed, so the preview
shows only the variable reference, not its current value.
Insert Click to open the Variable Selection window. From the window you can select a single-
Variable value variable to add to the message output. When the message is shown during the test,
the current value of the variable is substituted for the variable name in the message.
You can enter the reference directly using the following syntax:
$var_<variable_name>$
Note:
If you change the variable identifier name, you must manually change the name in
the Custom Message Editor; otherwise you receive a warning, and the test cannot
run.
The result follows the order of the options specified in the variable reference. For example, a variable
has data such as 1.00 mm. If you specify [unit,value] for the keyword options, the result shows the data
as mm 1.00.
Note: Most activities that require you to specify a file do not support the information derived from
a variable, such as Profile activity (MPE only), Time History Output and Time History Input
activities (MPE only), and Read Variable From File and Write Variable To File activities.
The Read Variable From File and Write Variable To File activities have an internal
mechanism that prompts the user for the file reference.
Item Description
Display Name This is the name of the Select File activity. The
default name is the type of activity. Click in the box
and type a new name.
Progress Table Select one of the following Visibility options for the
Test Progress Table:
l Never (Default)—Omits the activity from the
Test Progress Table.
l Fixed—Shows the progress of the activity in
the Test Progress Table while the activity is
executing, and for the duration of the test.
l Transient—Shows the progress of the
activity in the Test Progress Table only when
the activity is executing. When the activity
ends, the activity status disappears from the
table, regardless of whether the test is done.
Parameters Select Open File to have the activity prompt the
operator for an existing file to read or update. Select
Save File to have the activity prompt the operator for
a new or existing file to create or overwrite.
Title: The title for the dialog box for the activity.
Initial Folder: The directory that the activity defaults
to when prompting you to select a file.
File Extension: The extension of the file you want to
select. The accepted format is *.<file extension> (for
example,*.xml). The default is *.*. You can also
include multiple extensions separated by the “|”
symbol (for example, *.xlsx|*.xml).
Results Variable: The variable where the activity
writes the file path.
Add Cancel Button: Adds a Cancel button to the
Select File window. Selecting the Add Cancel
Button check box enables the Store To drop-down
menu.
Store To: The variable into which the activity writes
whether or not the cancel occurred.
Input Variables
Input Variables Activity Overview
Use the Input Variables activity to assign values to one or more variables. When the Input Variables
activity becomes active in the test workflow, a list of selected variables and their current values is
shown to an operator. An operator can edit the variable values as required.
The Input Variables activity accepts simple values only. Calculations or references to other variables
are not evaluated.
Note:
Only variables that have the Editable property of During Test are available for use with the
Input Variables activity.
For example, you can use an Input Variables activity to prompt the operator to provide waveform
definition properties, and then use those variables in subsequent Cycle or Custom Waveform
activities.
If any corresponding Input Variables test-run displays are configured, the variable values are reflected
in the Input Variables test-run display.
property Description
Message Shows instructions or prompts for an operator in the Message box.
Variable Selects one or more variables that an operator can change.
List
Configure at least one variable; otherwise, a validation warning appears in the Error
list. Click the plus sign to open the Variables Selection window.
Rules Define any additional rules for the variable. Click the ellipsis to open the Rules for
Variable window (you must have selected a variable in the Variable List).
Add Adds a Cancel button to the Input Variables window. Selecting the Add Cancel
Cancel Button check box enables the Result Variable list.
Button
When used as a separate branch in a parallel path, this activity adds an operator button on the Test-
Run Display tab that when clicked ends the parallel path. This activity is typically used to force the test
to the next test segment.
For example, a test may include a parallel path with a long ramp that the operator may want to end to
allow the test to continue.
Important:
To use this activity to terminate a Parallel Paths activity, you must select the Parallel Paths
activity and select the Terminal Paths check box for the Wait for Operator Action path.
Placing the Wait for Operator Action activity in the main test flow (outside any parallel path) pauses
the test until the operator button is clicked.
Property Description
Enable The Goto+DAQ+Detection and Dwell+DAQ+Detections are compound activities
Path which means they are really parallel branches. The Wait for Operator activity is on one
branch in the compound activity. The Enable Path check box enables the parallel path
used by the Wait for Operator Action path.
Ending Ending Path Value is a setting that can be used to specify a value when this path ends
Path the test. The drop down box contains the choice list values for the variable found in the
Value Store Ending Path Value tab (which for this example illustration is Test Run End
Reason).
Button Enter the button ID number that defines the horizontal position of the button in the
ID Operator Button portion of the Monitor window.
Important:
Multiple Wait for Operator Action activities that use the same button ID number
cannot run at the same time.
If multiple Wait for Operator Action activities use the same button ID, the operator
button appears in the same location and the display text that appears next to the button
changes to reflect the currently active Wait for Operator Action activity.
Display Enter the text that you want to display next to the button.
Text
Important:
To use this activity to terminate a Parallel Paths activity, you must select the
Parallel Paths activity and select the Terminal Paths check box for the Wait for
Operator Action path.
Use the Assign Variables activity to explicitly calculate and assign values to one or more variables in
the test. You can also add a calculation that uses a variable with a choice list for activities such as If-
Else or While loops.
For each variable you include in the list, you must provide a calculation to set the value of the variable.
The calculation can be a simple value, a reference to another variable, or a calculated value that can
reference other variables.
To prompt a user to provide a simple value, use the Input Variables activity. To evaluate existing
calculations, use the Calculate Variables activity.
Note:
Only variables that have the Availability property of During Test are available for use with this
activity. To set this property, open the Calculation Editor, right-click on the variable name, and
select Edit Variable. The Edit Variable window opens. In the Availability panel, select the
During-Test checkbox.
Item Description
Variable Specifies the variable(s) being used to calculate and assign values to one or more
List variables in the test. Each variable must have a calculation to set the value of the variable.
Click the ellipsis to open the Calculation Editor.
Calculate Variables
Calculate Variables Activity Overview
The Calculate Variables activity calculates all variables assigned to the activity.
Note: Only variables that you enter, or variables that you explicitly calculate using one or more
Calculate Variables activities, are updated during a test run.
You may be required to break a calculation into multiple statements. As a result, a variable may be
calculated to store intermediate results.
Variables can also be used to retain data from one clock tick to the next. As a result, a variable must be
recalculated at each clock tick.
Item Description
Before Specifies whether to clear the array when the activity starts (default) or keep existing
starting data and append new points to the array.
This setting is useful when multiple DAQ activities write data to the same array at
different points in the test.
Variable Specifies the variable(s) being calculated in the activity.
List
Export Data
Export Data Activity Overview
Important:
A Data Acquisition activity must precede the Export Data activity in the test workflow.
Use the Export Dataactivity to programmatically export raw data to a tab-delimited text (.txt) or
comma-separated value (.csv) file for use in Microsoft Excel and other applications. You can specify
how the data is formatted, the unit set, and the directory to which the data is exported. Any Cycle and
Block Decimation Filter settings in data acquisition filter the exported data.
Note:
To manually export raw data for a test, select File > Export > Raw Data or right-click a test
run.
Item Description
Folder Defines the path to the directory in which the application writes the data file. The
Path default directory path is: “<Data Files>”. By default, “<Data Files>” points to C:\MTS
TestSuite\Data Files.
You can set the default directory path in the Configuration window (Preferences >
Configuration > Project > Data Export Directory).
Folder Defines whether the application saves the data file in a new folder or overwrites an
Save existing folder.
Format Defines whether the data is formatted as tab-delimited text or comma-separated
values.
Default: Tab-Delimited Text
Unit Set Defines the unit set in which the data is written. You can override the MTS TestSuite
Default selected in Preferences > Configuration > Unit Set Manager.
Allow Defines whether the operator is allowed to stop the export process while in progress.
Cancel When the export process is in progress, a window appears that includes a Cancel
button.
Default: Disabled
Data Defines the Data Acquisition activities for which data is exported. Each Data
Acquisition Acquisition activity selected results in a separate export file. The list is automatically
List populated with the information defined for the Data Acquisition activity in the test
workflow.
Item Description
Signal List Defines which signal data is included in the data export file. Each Data Acquisition
activity in the test has its own signal list. The list is automatically populated with the
information defined for the Data Acquisition activity in the test workflow.
Combine Writes peak and valley values side-by-side in different columns on the same line to
Peak- facilitate comparison.
Valley on
One Line Important:
Select this check box only if your Data Acquisition activity has a single peak-
valley trigger. If there are any other trigger types defined, clear the check box
for best results.
Default: Disabled
Select Note:
Group Applicable to cyclic tests in MPE/MPX/FAA/FRA only.
Items
Enters cycles separated by space characters and enables grouping by selected items.
Selecting the Select Group Items check box enables the Items list. For example,
the items can be a list of cycles or blocks you want to export, such as 1 4 5 6 7 10.
Default: Disabled
6. The Data Acquisition List and Signal List properties are pre-populated with the Data
Acquisition activities defined in the test workflow. Edit the lists as appropriate.
7. If the Data Acquisition activity uses a singular peak-valley trigger, and you want to combine
the values on one line for convenient comparison, select the Combine Peak-Valley on One
Line check box.
8. (Applicable to MPE/MPX/FAA/FRA only) If the test is a cyclic test and you want to group
items, select the Select Group Items check box and enter the Items list.
The External Device activity is a program action used to execute one of the commands defined for an
external device. These commands can be an output that controls the device or an input that reads data
from a device.
For example:
l An output command can set a furnace to a specific temperature.
l An input command can read data from a laser extensometer.
Note:
The external device controlled by this activity must first be created and configured using
the External Devices window (available from the Controller menu).
Note: For more information about setting up and configuring external devices,
see “External Devices” on page 105.
Item Description
Progress Select if or when you want to display the progress table for this activity.
Table
Device Select the external device that you want this activity to control.
Command Select the external device command that this activity will execute. All commands
defined in the External Device window are listed.
Item Description
Command Select the variable that defines the command value that is written to the device. The list
Variable below only appears if the Command box for one or more commands in the External
(optional) Devices window contains the following characters: {0}, {1}, and so on.
Result Select the variable where value returned by the device is written. This list only appears
variable if one or more command settings in the External Devices window has the Supports
Return Value check box selected.
(optional)
Error Select an error handling option:
handling
l Continue test and log error
l Stop test and log error
Log Message
Log Message Activity Overview
The Log Message activity writes an entry to the message log when a test performs the activity. The
entry can contain text and the value of one or more single-value variables. You cannot use arrays or
choice lists in the message log.
The procedure performs activities in logical order. Your log message is added to the message log
when the activity completes. You can track the progress of the test by watching the log messages.
Note:
If you change the variable identifier name, you must manually change the name in the Custom
Message Editor; otherwise, you receive a warning and the test cannot run.
Item Description
Edit Click to open the Log Message window where you can type the message to be logged
Message when the test performs the activity.
Insert Variable button: Click to open the Select a Variable window. The message will
include the value of this variable when the message is written to the log.
This activity allows the test to read data (such as variable values) from an XML file or database and
apply those values to the current test run. You can configure the activity to prompt the operator for the
file name during test runtime, or allow the activity to automatically select the file while running a test.
Typical uses
This activity can be adapted for a number of applications, including:
l Automated testing applications—A laboratory information management system (LIMS) can
generate XML files that include variable values that define portions of the test. When the LIMS
saves the XML file in the predefined location, the test application can read the file and use the
variable values in the test run.
l Compliance testing values—(Applicable only to the MTS TestSuite TW Software) For testing
where load frame compliance is required, you can run a compliance test and generate an XML
file that stores the compliance coefficients as variables. During actual testing, this activity can
read the file and use them to compensate for compliance.
l Tuning parameter values—(Applicable only to MTS Criterion and MTS Insight systems) You
can save various sets of outer loop tuning parameters to an XML file and set up your tests to
read these files or allow an operator to select the appropriate tuning file from a list.
The MTS TWE application can read test input data from a Laboratory Information Management
System (LIMS).
The LIMS stores test procedure and test results data in a central database, accessible from a network
directory shared by both systems.
The primary objective of automatically transferring input data from a LIMS/database is to eliminate
human error and improve efficiency.
You can view and select test procedure files available in the LIMS with MTS TWE. When tests are
complete, you can export the test data back to the LIMS.
Note: When a Read data activity reads an appended file (a file created by the Write data
activity with the Append to File check box selected), it only reads the last set of values that
were appended to the file.
Property Description
Read Data Select File to read from an XML file, or select Database to read from a
From database.
Prompt for File Prompts an operator during test runtime to select the file from which to read
Name variables.
Selecting this check box disables the Folder Path and File Name properties
and instead allows you to specify a File Extension and Results Variable.
Display the Select this option to display the inputs when the test is running.
Inputs
Use All the Select this option to use all of the inputs from the file. Clear this option to select
Inputs from the certain variables from the Variable List below.
File
Ignore Missing Select to ignore specified variables that are missing from the file so they are not
Variables logged as errors.
Folder Path The Folder Path for the generated XML file. Defaults to the External Files
directory in MTS TestSuite.
Required if not prompting at runtime for a file.
File Name The File Name of the XML file that contains the variables to read. If the file is not
defined as a variable, the Update from File button is available.
Required if not prompting at runtime for a file.
Variable List Lists the selected variables to read from a file.
Example: Suppose you want to import test input data from an MS Access Database using an SQL
query. To configure MTS TWE to read Pre-Test Inputs from this data source:
1. For data label, select MS Access Database.
2. For query type, select SQL.
3. Enter query: “SELECT * FROM Tests WHERE Id=@varid”, where “SELECT”, “FROM”
and “WHERE” are SQL keywords.
This query selects a record from the “Tests” table that has an “Id“ that matches the value
contained in the TestSuite TWS variable “varid”.
The “@” in front of the variable name means that it takes the variable’s value. The “*” in
“SELECT *” returns all columns for the record.
The variables are populated in the order that they are listed by the columns that are
returned. MTS TWS variables: “Id”, “Name”, and “Description” are the display names of the
variables that will be populated with the columns returned from the query.
With the Run External Application activity, you can launch another application using arguments you
specify in the activity.
Example
Suppose you want to create a test in which the procedure automatically display data when the test is
complete. With the Run External Application activity, you can start the Microsoft XML Notepad
application to display the specimen data file that contains the data acquired during the test.
Item Description
Application Specifies the application that the activity launches.
Name
l To run an application registered by Microsoft or available in the system path,
you do not have to specify a full path. For example, if you want to select
Microsoft Excel, you can simply type “excel”.
l To run other applications, type the full path to the application in this box, or
browse for the application to find its path.
Arguments Specifies an input or parameter to pass to the target application when the activity
starts. The argument may be anything appropriate for the application, such as a file
name, folder name, variable, and so on. If a variable is used, the variable value is
written to the external application in place of the variable name.
When you type arguments directly, observe the following standard command line
syntax:
l Syntax for a variable in an argument is $var_Variable1$.
l You must type a space between multiple arguments.
l If the path placeholder results in a path with spaces, you must add double
quotation marks around the argument.
Default Specifies the default path to the selected argument. Define the default path by typing
Directory the desired path in the entry box or by browsing to the desired location. If the path
includes spaces, enclose the path in double quotation marks.
Wait for When enabled, the activity waits until the external application has completed before
the the activity completes. Selecting this check box makes the Results Variable and
application Resume Option After Restart properties become available.
to
complete When disabled, the activity completes immediately after starting the specified external
application.
Default: Disabled
Results Specifies a variable to hold the return status of the external application. You can use
Variable the results variable as input to subsequent activities, such as If-Else Condition or
While Loop activities.
The Resume Option After Restart option defines how the external application resumes when the
procedure has been stopped and restarted.
Item Description
Start the application and wait Causes the activity to restart the external application and
for it to complete complete when the application has completed.
Proceed as if the application Causes the Run External Application activity to complete
has completed immediately. This is the default.
Run Report
Run Report Activity Overview
The Run Report activity generates a test report based on the selected report template. The
generated report is a Microsoft Excel file by default. You can also select other report format options,
such as PDF.
You can configure the Run Report activity to send the report to one or more e-mail addresses.
To send the report attached to an e-mail, you must configure the e-mail server settings. Click
Preferences menu > Configuration option > E-Mail tab. If you are unsure of your mail server
settings, contact your network administrator.
Note:
The Send E-mail activity and the E-Mail panel in the Run Report activity share the same
properties. The configuration you complete for the SMTP (Simple Mail Transfer Protocol) server
enables e-mail for both activities.
Item Description
Name Selects a report template to use for the report. If desired, you can explicitly override the
default template set in the Report Templates tab. Parentheses indicate the Default
Test Report template or Default Test Run Report Template.
Report Templates
If you do not select a report template, a warning is shown in the Error list.
Open Select to open the report after running the test.
Report
When
Complete
Print Select to print the report after running the test.
Report
When
Complete
Send Allows you to send a copy of the report to one or more e-mail addresses. Separate
report to multiple address with a semi-colon. The e-mail is sent right after the report is generated
e-mail by the activity. The report is sent as an attachment to the e-mail.
The Run Report activity requires valid To e-mail address syntax. The From e-mail
parameter must also have valid e-mail address syntax.
Selecting the Send report to e-mail check box expands the panel and enables the
corresponding E-Mail boxes.
To: (Required) Sends an e-mail message to the specified e-mail address or variable.
CC: Sends a copy of the e-mail to the specified e-mail address or variable.
Item Description
From: Shows the default address from which the e-mail is sent or a variable. The default From
address is configured in Preferences > Configuration > E-Mail.
Subject: Populates the Subject line of the e-mail. The default is “MTS TestSuite report”.
Message: Shows the message in the body of the e-mail. You can use the default variables, insert
custom or other variables, or enter text directly in the Message text box.
The Insert Variable button opens the Variable Selection window. Selected variables
appear in the Message box.
Any Run Report activities within a test that use the default template are automatically
updated to point to the new default template. Any changes to templates made from the
Report Templates tab are also reflected in the generate and print reports templates lists of
the Review tab.
5. Click Save.
Note:
If you select the PDF option, test the report template format first to ensure the
information displays properly within the PDF pages. Proper data formatting requires
iterating the template design in Microsoft Excel using the Reporter Add-In, and viewing
the result in PDF format after running the report in the MTS TestSuite application. In
Microsoft Excel, use the Save As PDF feature to quickly review the report format.
To change the output report format:
1. Open the test for which you want to change the report format.
2. Navigate to the Report Templates tab: Click Define tab > Report Templates tab.
3. Click the report template whose report format you want to change.
4. Select the format you want to use for the report.
5. Click Save.
Send E-Mail
Send E-Mail Activity Overview
The Send E-Mail activity is used to send an e-mail message at a designated point during a test run.
The timing of the e-mail depends on the placement of the Send E-Mail activity in the test procedure.
As the test progresses and the Send E-Mail activity becomes the current activity, an e-mail is sent.
To use the Send E-Mail activity, you must configure the e-mail server settings. Click Preferences >
Configuration and click the E-Mail tab. If you are unsure of your mail server settings, contact your e-
mail administrator.
Note:
The Send E-mail activity and the E-Mail panel in the Run Report activity have similar
properties. Configuring the SMTP (Simple Mail Transfer Protocol) server enables e-mail for
both activities.
The message of your e-mail is automatically filled in with the following default variables:
l User Name
l Project Name
l Test Name
l Test Run Name
l Specimen Name
l Test Run Date
You can customize the variables included in the e-mail message. For troubleshooting, you can attach
the Message Log to the e-mail either as a text file named “MTS TestSuite.log” or a zipped version
named “MTS TestSuite.log.zip”.
Item Description
E-Mail panel
To: (Required) Sends an e-mail message to the specified e-mail address or variable.
cc: Sends a copy of the e-mail to the specified e-mail address or variable.
From: (Required) Showss the default address or variable from which the e-mail is sent. The
default From address is configured in Preferences > Configuration > E-Mail.
Subject Populates the Subject line of the e-mail. The default is “MTS TestSuite report”.
Message: Shows the message in the body of the e-mail. You can use the default variables, insert
custom or other variables, or enter text directly in the Message text box.
The Insert Variable button opens the Variable Selection window. Selected variables
appear in the Message window.
Message Log panel
Attach Attaches the messages to the e-mail message. Selecting the Attach Log check box
Item Description
Log enables the other log boxes in the panel.
Zip Compresses the attached log file. If the Zip check box is not selected, an unzipped text
attached file is attached to the e-mail.
log
Log Filters the attached log by the selected category:
category
l All Categories—(Default) Includes messages from both the AppLog and the
TestRunLog categories.
l Application—Only includes messages from the AppLog category.
l Test Run—Only includes messages from the TestRunLog category.
Log Filters the log messages by the selected severity:
message
type l All Messages—(Default) Includes Errors, Warnings, and Information
messages.
l Errors—Includes only messages classified as Errors.
l Errors and Warnings—Includes Errors and Warnings but excludes
Information messages.
Wait
Wait Activity Overview
Use the Wait activity to pause the test procedure for a specified amount of time. You can use the Wait
activity in the following ways:
l With a variable—Enter a wait time when prompted at the beginning of the test. When the test
procedure reaches the Wait activity, the test uses the variable that was set in the Input activity
and pauses for the specified time.
l With a literal value—Specify a amount of time for the Wait activity so that when the procedure
reaches the activity, the test waits for the amount of time specified in the Wait activity
properties window.
l As a controlling activity—Place the Wait activity in a parallel path as the controlling activity.
Activities after the Wait activity in the path pause, but the activities in the parallel path continue
to run.
If you stop the procedure, the Wait activity also stops. When you restart the procedure, the Wait
activity resumes for the remainder of the time that was specified for the activity.
Item Description
Duration Specifies the amount of time to pause the test procedure. Time can be specified as a
value and a unit of measure or a variable.
Write Data
Write Data Activity Overview
This activity directs the MTS TestSuite application to write variable values from a test run, such as
array variable data and other results, to an XML file or database.
You can use the Write data activity to write an XML file to use as a template or XML-formatting
guidelines for other applications that generate XML files.
Typical uses
For automated testing applications, the MTS TestSuite application can write variable values from a test
run to an XML file. A laboratory information management system (LIMS) can then read the XML file
from that test run.
The MTS TWE application can read test procedures from and write test data to a.Laboratory
Information Management System (LIMS).
The LIMS stores test procedure and test results data in a central database, accessible from a network
directory shared by both systems.
The primary objective of automatically transferring test data to a LIMS/database is to eliminate human
error and improve efficiency.
You can view and select test procedure files available in the LIMS with MTS TWE. When tests are
complete, you can export the test data back to the LIMS.
Property Description
Write Select File to write to an XML file, or select Database to write to a database.
Data To
Folder The folder path for the generated XML file. Defaults to the External Files directory in MTS
Path TestSuite.
File The file name of the generated file. You can also specify a variable.
Name
Append Appends or overwrites variables values depending on its setting:
to File
l When the Append to File check box is cleared, each time a test run is
executed, the activity overwrites the XML file with the values of the variables
selected in the Variable List.
l When the check box selected, each time a test run is executed, the variable
values selected in the Variable List are appended to the end of the XML file.
Note: When a Read data activity reads an appended file, it only reads
the last set of values that were appended to the file.
Unit Set Select a unit set to use when writing the variables to the file.
Variable Lists the variables that will be written to the file.
List
Example: Suppose you want to export test run data to an MS Access Database using an SQL
query. To configure MTS TWS to export Post-Test Run data to this data source:
1. For data source, select MS Access Database.
2. For query type, select SQL.
3. Enter query: “INSERT INTO Results(Id,PeakLoadResult) VALUES(@Id,@PeakLoad)””,
where “INSERT INTO” and “VALUES” are SQL keywords.
In this example, the query inserts a new record into the table named “Results”.
The column names of the table are “Id” and “PeakLoadResult”. These columns in the new
record are filled-in from the data in the variables with the internal names of “Id” and
“PeakLoad”. The “@” in front of the variable name means that it takes the variable’s value.
The typical use of this export activity is to store test results back into the LIMS/database
under the Id read from the LIMS/database.
Cycles Category
Cycle Counter
About Cycle Counters
Important:
The Cycle Counter test-run display shows the number of completed command cycles
associated with a data acquisition cycle. The Cycle Counter test-run display is independent of
and not related to the Reset Cycle (Segment) test activity, which counts the cycles (segments)
of the FlexTest controller.
The Cycle Counter shows the number of completed command cycles and displays the value of the
predefined count variable in the System category, referred to as the Current Cycle Index. The
predefined variable is used by the Cycle + DAQ and Custom Waveform + DAQ test activities, which
divide acquired data into cycles.
A Data Acquisition (DAQ) activity must added to the test procedure, or the cycle count remains at
zero and a warning is logged in the Error list.
Display Name
This is the name that is shown for the object in the application. It is a required property so the box
cannot be empty. The default is the type of the chart and the number indicating how many are on the
Display tab, such as Cycle Statistics Table 1. You can also click in the box and type a new name.
Note:
The Display Name is only used in the event of validation errors.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Display Name
This is the name that is shown for the object in the application. It is a required property so the box
cannot be empty. The default is the type of the chart and the number indicating how many are on the
Display tab, such as Cycle Statistics Table 1. You can also click in the box and type a new name.
Note:
The Display Name is only used in the event of validation errors.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
You can monitor a variable for change by selecting an existing variable from the drop-down list or
create a new one by selecting <new variable> to open the New Numeric Variable window (for more
information about new numeric variables, see “Numeric Variables Overview” on page 170). Every time
a change occurs to the variable you choose to monitor (for the Cycle Statistics Table, Cycle Time
Chart, History Chart, Hysteresis Chart), the data in the view is updated. The default value is Current
Cycle Index, which stores the index number of the current cycle count. Other variables listed in this
box are variables specified in the Save Variables box of the Map Variables window.
To plot the updated data, it must also meet the cycle decimation filter selection criteria.
For example, if you select Current Cycle Index (which is used by the Cycle + DAQ and Custom
Waveform + DAQ activities to count cycles), the application shows the results only when all of the
following are true:
l The Current Cycle Index variable changes (when the cycle count changes).
l The cycle meets the selection criteria set in the Cycle Decimation Filter Selection window.
l The update interval set in the Cycle Decimation Filter Selection window occurs when the
selected cycle is complete but before the next selected cycle.
Monitor for Change is also used to select the Counter variable in the block Information of DAQ.
The Cycles to Display property works in conjunction with the Cycle Decimation Filter Selection
property. Cycle Decimation Filter Selection determines when variable data should be displayed for
the test cycles. Cycles to Display specifies how many should be displayed at one time. For example,
if the Cycle Decimation Filter Selection is set to display data for every fifth cycle, and the Cycles to
Display is set to display 3, the display starts out displaying cycle numbers 5, 10, 15 and then 10, 15, 20
and then 15, 20, 25 and so forth.
There are several test-run display tools that share similar chart properties:
l Cycle Time Chart
l History Chart
l Hysteresis Chart
l Array-Variable Chart
You can monitor a variable for change by selecting an existing variable from the drop-down list or
create a new one by selecting <new variable> to open the New Numeric Variable window (for more
information about new numeric variables, see “Numeric Variables Overview” on page 170). Every time
a change occurs to the variable you choose to monitor (for the Cycle Statistics Table, Cycle Time
Chart, History Chart, Hysteresis Chart), the data in the view is updated. The default value is Current
Cycle Index, which stores the index number of the current cycle count. Other variables listed in this
box are variables specified in the Save Variables box of the Map Variables window.
To plot the updated data, it must also meet the cycle decimation filter selection criteria.
For example, if you select Current Cycle Index (which is used by the Cycle + DAQ and Custom
Waveform + DAQ activities to count cycles), the application shows the results only when all of the
following are true:
l The Current Cycle Index variable changes (when the cycle count changes).
l The cycle meets the selection criteria set in the Cycle Decimation Filter Selection window.
l The update interval set in the Cycle Decimation Filter Selection window occurs when the
selected cycle is complete but before the next selected cycle.
Monitor for Change is also used to select the Counter variable in the block Information of DAQ.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you
set the opacity to a lower value, it makes the trace more transparent.
Draw Line Select this check box to draw lines between data points. Clear the Draw
Line check box and click OK to only show data points if a Symbol Type is
selected; otherwise, the trace is not drawn.
Line Thickness Select the thickness of the lines from 1 to 10 points.
Line Type Select the line style as solid, dotted, or dashed.
Symbol Type Select the type of symbol to mark the location of data points. If you do not
want to mark the data points with symbols, choose the blank selection in
the list.
Symbol Size Select the size of the data point symbols. To automatically size the
symbols, select the multiple size image, which is the first item in the drop-
down list.
Y Variable
Select a single value variable for which you want data plotted on the Y axis of the chart.
X Variable
Select a single value variable for which you want data plotted on the X axis of the chart.
The Cycles to Display property works in conjunction with the Cycle Decimation Filter Selection
property. Cycle Decimation Filter Selection determines when variable data should be displayed for
the test cycles. Cycles to Display specifies how many should be displayed at one time. For example,
if the Cycle Decimation Filter Selection is set to display data for every fifth cycle, and the Cycles to
Display is set to display 3, the display starts out displaying cycle numbers 5, 10, 15 and then 10, 15, 20
and then 15, 20, 25 and so forth.
There are several test-run display tools that share similar chart properties:
l Cycle Time Chart
l History Chart
l Hysteresis Chart
l Array-Variable Chart
Item Description
Display Select a display unit for the selected trace signal. The list only shows the set of units
Unit that are compatible with the dimension of the signal that is assigned to the selected
trace.
Blank is the default value.
Maximum Set the display range of the Y axis to the maximum or minimum values.
or
Minimum Click the corresponding button to use this feature.
To have the software calculate the maximum or minimum value(s) of the Y signal and
then set the maximum or minimum display range to the value(s), click to clear the check
boxes.
To manually set the maximum or minimum display range for the Y axis, select the check
boxes and then specify the maximum or minimum values.
Mean or Set the display range of the Y axis to the amplitude or mean values. Amplitude is a plus
Amplitude or minus display range. Mean is an offset, and the amplitude is relative to the mean.
Click the corresponding button to use this feature.
Click to clear the check box(es) to have the application set the amplitude or mean
display range to the amplitude or mean value(s) of the X signal.
Click the check box(es) and then specify the amplitude or mean values to manually set
the amplitude or mean display range for the X axis.
Expand The Expand Only feature was developed for auto-scaling such that when the range
Only expanded during auto-scaling, this option prevented the range from contracting when
the command stopped.
Click the check box to allow a range to automatically expand if the data exceeds the
maximum and minimum ranges. The chart does not rescale to a smaller range.
Specifying the Maximum and Minimum for an axis avoids auto-scaling, however, also
checking Expand Only implies that you want to auto-scale if the data is outside the
specified range.
Log Scale Toggle between linear scale and log scale for the axis. Select the check box for
logarithmic scale. Leave the box blank for linear scale.
Item Description
Log Set the base for displaying values in a logarithmic format. Click the up-arrow or down-
Base arrow to raise or lower the base.
Label Set the number of significant digits displayed in the labels along the X-axis and Y-axis. Only
Digits non-zero digits are shown after the decimal point to avoid overcrowding in the label area
next to the axis.
Color Set the color of the associated trace or axis. Click the down-arrow and select a color from
the list.
Draw Select the check box to show grid lines on the chart. Deselect the check box to suppress
Grid the grid lines.
Lines
History Chart
About History Charts
The History Chart plots any variable in relation to the cycle number or block number (that is, the
Counter variable in the Block Information of DAQ). The Y-axis presents data values and the X-axis
presents index values.
History charts are typically one of the first views used for checking test data. For example, strain peak
and strain valley may provide the first signal-strength indicator. History peak and valley curves can also
be the starting points for checking stress and load results.
You can include an image of a History Chart in reports.
Runtime
History charts are available as part of the Monitor and Results tabs.
Group variable mapping occurs in the Procedure definition part of the test. If more than one type of
group is available, the Monitor for Change box of the History Chart Properties contains a drop-
down selection button. The default value is Current Cycle Index. Other variables listed in the
Monitor for Change box are variables specified in the Save Variables box of the Map Variables
window.
Analysis
History charts are also available in data analysis.
If more than one type of block is available, select a value from the drop-down list. The default value is
Cycle. Other variables listed in this box are variables specified in the Save Variables box of the Map
Variables window.
If an invalid cycle is selected for the chart, a warning icon is shown with the error message, “Invalid
cycle values are not plotted.”
You can monitor a variable for change by selecting an existing variable from the drop-down list or
create a new one by selecting <new variable> to open the New Numeric Variable window (for more
information about new numeric variables, see “Numeric Variables Overview” on page 170). Every time
a change occurs to the variable you choose to monitor (for the Cycle Statistics Table, Cycle Time
Chart, History Chart, Hysteresis Chart), the data in the view is updated. The default value is Current
Cycle Index, which stores the index number of the current cycle count. Other variables listed in this
box are variables specified in the Save Variables box of the Map Variables window.
To plot the updated data, it must also meet the cycle decimation filter selection criteria.
For example, if you select Current Cycle Index (which is used by the Cycle + DAQ and Custom
Waveform + DAQ activities to count cycles), the application shows the results only when all of the
following are true:
l The Current Cycle Index variable changes (when the cycle count changes).
l The cycle meets the selection criteria set in the Cycle Decimation Filter Selection window.
l The update interval set in the Cycle Decimation Filter Selection window occurs when the
selected cycle is complete but before the next selected cycle.
Monitor for Change is also used to select the Counter variable in the block Information of DAQ.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you
set the opacity to a lower value, it makes the trace more transparent.
Draw Line Select this check box to draw lines between data points. Clear the Draw
Line check box and click OK to only show data points if a Symbol Type is
selected; otherwise, the trace is not drawn.
Line Thickness Select the thickness of the lines from 1 to 10 points.
Line Type Select the line style as solid, dotted, or dashed.
Symbol Type Select the type of symbol to mark the location of data points. If you do not
want to mark the data points with symbols, choose the blank selection in
the list.
Symbol Size Select the size of the data point symbols. To automatically size the
symbols, select the multiple size image, which is the first item in the drop-
down list.
Y Variable
Select a single value variable for which you want data plotted on the Y axis of the chart.
X Variable
Select a single value variable for which you want data plotted on the X axis of the chart.
The Cycles to Display property works in conjunction with the Cycle Decimation Filter Selection
property. Cycle Decimation Filter Selection determines when variable data should be displayed for
the test cycles. Cycles to Display specifies how many should be displayed at one time. For example,
if the Cycle Decimation Filter Selection is set to display data for every fifth cycle, and the Cycles to
Display is set to display 3, the display starts out displaying cycle numbers 5, 10, 15 and then 10, 15, 20
and then 15, 20, 25 and so forth.
There are several test-run display tools that share similar chart properties:
l Cycle Time Chart
l History Chart
l Hysteresis Chart
l Array-Variable Chart
Item Description
Display Select a display unit for the selected trace signal. The list only shows the set of units
Unit that are compatible with the dimension of the signal that is assigned to the selected
trace.
Blank is the default value.
Maximum Set the display range of the Y axis to the maximum or minimum values.
or
Minimum Click the corresponding button to use this feature.
To have the software calculate the maximum or minimum value(s) of the Y signal and
then set the maximum or minimum display range to the value(s), click to clear the check
boxes.
To manually set the maximum or minimum display range for the Y axis, select the check
boxes and then specify the maximum or minimum values.
Mean or Set the display range of the Y axis to the amplitude or mean values. Amplitude is a plus
Amplitude or minus display range. Mean is an offset, and the amplitude is relative to the mean.
Click the corresponding button to use this feature.
Click to clear the check box(es) to have the application set the amplitude or mean
display range to the amplitude or mean value(s) of the X signal.
Click the check box(es) and then specify the amplitude or mean values to manually set
the amplitude or mean display range for the X axis.
Expand The Expand Only feature was developed for auto-scaling such that when the range
Only expanded during auto-scaling, this option prevented the range from contracting when
the command stopped.
Click the check box to allow a range to automatically expand if the data exceeds the
maximum and minimum ranges. The chart does not rescale to a smaller range.
Specifying the Maximum and Minimum for an axis avoids auto-scaling, however, also
checking Expand Only implies that you want to auto-scale if the data is outside the
specified range.
Log Scale Toggle between linear scale and log scale for the axis. Select the check box for
logarithmic scale. Leave the box blank for linear scale.
Item Description
Log Set the base for displaying values in a logarithmic format. Click the up-arrow or down-
Base arrow to raise or lower the base.
Label Set the number of significant digits displayed in the labels along the X-axis and Y-axis. Only
Digits non-zero digits are shown after the decimal point to avoid overcrowding in the label area
next to the axis.
Color Set the color of the associated trace or axis. Click the down-arrow and select a color from
the list.
Draw Select the check box to show grid lines on the chart. Deselect the check box to suppress
Grid the grid lines.
Lines
Hysteresis Chart
About Hysteresis Charts
The Hysteresis Chart shows the cyclic or block data produced during a test cycle.
Runtime
Hysteresis charts are available as part of the Monitor and Results tabs. To create a new Hysteresis
Chart in the Test-Run Display tab, double-click or drag the icon to the work area. To see a
Hysteresis Chart in the Results tab, select the Hysteresis tab.
Group variable mapping occurs in the Procedure definition part of the test. If more than one type of
group is available, the Monitor for Change box of the Hysteresis Chart Properties contains a drop-
down selection button. The default value is Cycle. Other variables listed in the Monitor for Change
box are variables specified in the Save Variables box of the Map Variables window.
You can select a cycle by number or by using a variable. On the chart, the zero-value reference lines
are slightly darker than the other grid lines to provide a visual orientation to your data.
You can include an image of a Hysteresis Chart in reports.
You can monitor a variable for change by selecting an existing variable from the drop-down list or
create a new one by selecting <new variable> to open the New Numeric Variable window (for more
information about new numeric variables, see “Numeric Variables Overview” on page 170). Every time
a change occurs to the variable you choose to monitor (for the Cycle Statistics Table, Cycle Time
Chart, History Chart, Hysteresis Chart), the data in the view is updated. The default value is Current
Cycle Index, which stores the index number of the current cycle count. Other variables listed in this
box are variables specified in the Save Variables box of the Map Variables window.
To plot the updated data, it must also meet the cycle decimation filter selection criteria.
For example, if you select Current Cycle Index (which is used by the Cycle + DAQ and Custom
Waveform + DAQ activities to count cycles), the application shows the results only when all of the
following are true:
l The Current Cycle Index variable changes (when the cycle count changes).
l The cycle meets the selection criteria set in the Cycle Decimation Filter Selection window.
l The update interval set in the Cycle Decimation Filter Selection window occurs when the
selected cycle is complete but before the next selected cycle.
Monitor for Change is also used to select the Counter variable in the block Information of DAQ.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you
set the opacity to a lower value, it makes the trace more transparent.
Draw Line Select this check box to draw lines between data points. Clear the Draw
Line check box and click OK to only show data points if a Symbol Type is
selected; otherwise, the trace is not drawn.
Line Thickness Select the thickness of the lines from 1 to 10 points.
Line Type Select the line style as solid, dotted, or dashed.
Symbol Type Select the type of symbol to mark the location of data points. If you do not
want to mark the data points with symbols, choose the blank selection in
the list.
Symbol Size Select the size of the data point symbols. To automatically size the
symbols, select the multiple size image, which is the first item in the drop-
down list.
Y Variable
Select a single value variable for which you want data plotted on the Y axis of the chart.
X Variable
Select a single value variable for which you want data plotted on the X axis of the chart.
The Cycles to Display property works in conjunction with the Cycle Decimation Filter Selection
property. Cycle Decimation Filter Selection determines when variable data should be displayed for
the test cycles. Cycles to Display specifies how many should be displayed at one time. For example,
if the Cycle Decimation Filter Selection is set to display data for every fifth cycle, and the Cycles to
Display is set to display 3, the display starts out displaying cycle numbers 5, 10, 15 and then 10, 15, 20
and then 15, 20, 25 and so forth.
There are several test-run display tools that share similar chart properties:
l Cycle Time Chart
l History Chart
l Hysteresis Chart
l Array-Variable Chart
Item Description
Display Select a display unit for the selected trace signal. The list only shows the set of units
Unit that are compatible with the dimension of the signal that is assigned to the selected
trace.
Blank is the default value.
Maximum Set the display range of the Y axis to the maximum or minimum values.
or
Minimum Click the corresponding button to use this feature.
To have the software calculate the maximum or minimum value(s) of the Y signal and
then set the maximum or minimum display range to the value(s), click to clear the check
boxes.
To manually set the maximum or minimum display range for the Y axis, select the check
boxes and then specify the maximum or minimum values.
Mean or Set the display range of the Y axis to the amplitude or mean values. Amplitude is a plus
Amplitude or minus display range. Mean is an offset, and the amplitude is relative to the mean.
Click the corresponding button to use this feature.
Click to clear the check box(es) to have the application set the amplitude or mean
display range to the amplitude or mean value(s) of the X signal.
Click the check box(es) and then specify the amplitude or mean values to manually set
the amplitude or mean display range for the X axis.
Expand The Expand Only feature was developed for auto-scaling such that when the range
Only expanded during auto-scaling, this option prevented the range from contracting when
the command stopped.
Click the check box to allow a range to automatically expand if the data exceeds the
maximum and minimum ranges. The chart does not rescale to a smaller range.
Specifying the Maximum and Minimum for an axis avoids auto-scaling, however, also
checking Expand Only implies that you want to auto-scale if the data is outside the
specified range.
Log Scale Toggle between linear scale and log scale for the axis. Select the check box for
logarithmic scale. Leave the box blank for linear scale.
Item Description
Log Set the base for displaying values in a logarithmic format. Click the up-arrow or down-
Base arrow to raise or lower the base.
Label Set the number of significant digits displayed in the labels along the X-axis and Y-axis. Only
Digits non-zero digits are shown after the decimal point to avoid overcrowding in the label area
next to the axis.
Color Set the color of the associated trace or axis. Click the down-arrow and select a color from
the list.
Draw Select the check box to show grid lines on the chart. Deselect the check box to suppress
Grid the grid lines.
Lines
Variables Category
This section describes the available test-run displays for variables.
Adjust Variable
About Adjust Variable Slider
Use this control to change the value of assigned variables at runtime. You can adjust the test variables
you have setup within the range specified while the test is running.
Item Description
Display Name Required. This is the name of the activity in the test
run display. The default name is the type of variable
and the number indicating how many times the slider
is used in the run time display, for example, Adjust
Variable 1. You can also click in the box and type a
new name.
Visibility Panel For Docking, select where on the monitor you want
the test-run display positioned: Top, Left, Bottom,
Right, or Fill (where the display fills the entire tab or
panel).
Show Condition lets you show or hide the test-run
displays, depending on the condition of the variable
expression. For example, you can set up a condition
to check the variable containing the specimen type
for a Set Variable test-run display to make the
diameter visible only when the specimen type is
round, but hidden for a rectangular specimen.
Likewise, you can use two more Set Variable test-
run displays for width and length to be visible if the
specimen type is rectangular, but hidden when the
specimen type is round.
Enabled Condition Required. Defines a condition that determines when
a variable becomes available to an operator during a
test run. Click the ellipsis to open the Calculation
Editor window.
Item Description
Variable Required. A variable must be selected. A validation
error appears in the Error list until you select a
variable. Click the ellipsis to open the Select a
Variable window.
Show Label When you select this option, the application shows
the label of the variable.
Use Range When you select this option, the application checks
the value of the variable during the test to determine
if the value is within the specified range. If the value
of the variable is not within the range, the application
adjusts the value to be within the range. If the value
of the variable falls inside the specified range, the
value remains unchanged.
5. Scroll to the Cycle control, and drag and drop the Cycle activity to the left side of the Parallel
Path. Use the following parameters for the Cycle activity:
l Frequency: 1 Hz
l Number of Cycles: 100
l Control Mode: Displacement
l Absolute End Level 1: 1 mm
l Absolute End Level 2: -1 mm
6. Scroll to the Set Span and Setpoint control, and drag and drop the Set Span and Setpoint to
the right side of the Parallel Path. Use the following parameters for the Set Span and
Setpoint activity:
l Monitor: Continuous
l Channel: Ch 1
l Control Mode: Displacement
l Span: Toggle to the Variable icon, and select <new variable> from the drop-down
menu. The New Numeric Variable window appears with Span as the identifier. Click
OK.
l Setpoint: Toggle to the Variable icon, and select <new variable> from the drop
down menu. The New Numeric Variable window appears with Setpoint as the
identifier. Click OK.
7. Select the Parallel Paths activity, and select Parallel Path: Cycle: 1 mm to -1 mm at 1 Hz
as the terminal path.
You can then use the slider controls to change the values while the test is running to, for example, a
Setpoint of 2 mm and a Span of 50%.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Traces Properties
A trace is the representation of a series of values plotted against another series of values. Depending
on the type of view, you can plot signal or variable data on either the Y- or X-axis.
If you define more than one trace on an axis, all the traces must have the same dimension. For
example, you cannot add a force signal trace and a displacement signal trace together on the Y-axis.
If you define more than one trace on an axis, a legend is displayed by default. You can use the Hide
Legend option to hide the legend.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you
set the opacity to a lower value, it makes the trace more transparent.
Draw Line Select this check box to draw lines between data points. Clear the Draw
Line check box and click OK to only show data points if a Symbol Type is
selected; otherwise, the trace is not drawn.
Line Thickness Select the thickness of the lines from 1 to 10 points.
Item Description
Line Type Select the line style as solid, dotted, or dashed.
Symbol Type Select the type of symbol to mark the location of data points. If you do not
want to mark the data points with symbols, choose the blank selection in
the list.
Symbol Size Select the size of the data point symbols. To automatically size the
symbols, select the multiple size image, which is the first item in the drop-
down list.
You can plot multiple test runs on one Array-Variable Chart. On the Explorer panel, click Test-Run
Display. After you add an Array-Variable Chart to the Designer tab, the Properties panel displays
the Plot Previous Test Runs panel. You can specify that the results of the first test run (select First
Test Run) and up to 20 previous test runs (select Last Test Runs and select number) display on the
same Array-Variable Chart. Modify the Y-Offset and X-Offset values to displace the multiple traces.
Multiple test runs display only on the Monitor tab; you can still view the single test result under the
Results > Variable Chart tab.
Item Description
Color Click the drop-down menu, and select the color of the associated line.
Limit Select one of the following limit types.
type l Horizontal
l Vertical
l Slope Intercept, m∙x + b
l General XY (Single Value or Array)
l Indexed Values
l Horizontal at Index
l Vertical at Index
For details about each limit type, including the fields you can configure when selecting
each different option, see “Horizontal limit type” on page 491.
Y Select a single value variable or an array variable for which you want data plotted on the Y
Variable axis of the chart.
X Select a single value variable or an array variable for which you want data plotted on the X
Variable axis of the chart.
Legend Select this option to add a custom legend label to the chart. In the text box, enter the name
label of the legend label.
Limit Types
Limit Types are not available for all charts. The charts that do utilize them contain only the limits that
pertain to that particular chart.
Click the Edit (ellipsis) button on the Limit or Curve Fit Lines title bar to open the Line Drop
Percentage window. Type the value in the box, and specify the units from the drop-down menu.
Y Variable
Select a single value variable for which you want data plotted on the Y axis of the chart.
X Variable
Select a single value variable for which you want data plotted on the X axis of the chart.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you
set the opacity to a lower value, it makes the trace more transparent.
Draw Line Select this check box to draw lines between data points. Clear the Draw
Line check box and click OK to only show data points if a Symbol Type is
selected; otherwise, the trace is not drawn.
Line Thickness Select the thickness of the lines from 1 to 10 points.
Line Type Select the line style as solid, dotted, or dashed.
Symbol Type Select the type of symbol to mark the location of data points. If you do not
want to mark the data points with symbols, choose the blank selection in
the list.
Symbol Size Select the size of the data point symbols. To automatically size the
symbols, select the multiple size image, which is the first item in the drop-
down list.
Item Description
Display Select a display unit for the selected trace signal. The list only shows the set of units
Unit that are compatible with the dimension of the signal that is assigned to the selected
trace.
Blank is the default value.
Maximum Set the display range of the Y axis to the maximum or minimum values.
or
Minimum Click the corresponding button to use this feature.
To have the software calculate the maximum or minimum value(s) of the Y signal and
then set the maximum or minimum display range to the value(s), click to clear the check
boxes.
To manually set the maximum or minimum display range for the Y axis, select the check
boxes and then specify the maximum or minimum values.
Mean or Set the display range of the Y axis to the amplitude or mean values. Amplitude is a plus
Amplitude or minus display range. Mean is an offset, and the amplitude is relative to the mean.
Click the corresponding button to use this feature.
Click to clear the check box(es) to have the application set the amplitude or mean
display range to the amplitude or mean value(s) of the X signal.
Click the check box(es) and then specify the amplitude or mean values to manually set
Item Description
the amplitude or mean display range for the X axis.
Expand The Expand Only feature was developed for auto-scaling such that when the range
Only expanded during auto-scaling, this option prevented the range from contracting when
the command stopped.
Click the check box to allow a range to automatically expand if the data exceeds the
maximum and minimum ranges. The chart does not rescale to a smaller range.
Specifying the Maximum and Minimum for an axis avoids auto-scaling, however, also
checking Expand Only implies that you want to auto-scale if the data is outside the
specified range.
Log Scale Toggle between linear scale and log scale for the axis. Select the check box for
logarithmic scale. Leave the box blank for linear scale.
Item Description
Log Set the base for displaying values in a logarithmic format. Click the up-arrow or down-
Base arrow to raise or lower the base.
Label Set the number of significant digits displayed in the labels along the X-axis and Y-axis. Only
Digits non-zero digits are shown after the decimal point to avoid overcrowding in the label area
next to the axis.
Color Set the color of the associated trace or axis. Click the down-arrow and select a color from
the list.
Draw Select the check box to show grid lines on the chart. Deselect the check box to suppress
Grid the grid lines.
Lines
Item Description
Show Select to show a crosshair, circle, and data point value when selecting a data point
highlight in the chart.
circle
Show delta Select to show the values of two points, the difference between their values, and the
and slope slope of a line drawn through the two points.
Labels
Number of Enter the number of rows used to arrange the labels, delta, and slope. Click the up
rows arrow or down arrow to increase or decrease the number of rows. The value range
is 1 - 6.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Click the plus sign in the Variable List panel to open the Variables Selection window.
The variables that you select in the Variables Selection window (double-click or use arrows to move
variables from the Available Variables column to the Selected Variables column) are placed in a
horizontal row.
Variable Meter
In addition to the Display menu > Meters tab, you can create a test-run display to monitor the value of
a variable. The meter configuration settings are saved with the test.
Tip:
To see a run-time message as each test segment is executed, you can do one of the following:
l Create a Log Message activity for each segment, which will appear in the log during
run time.
l Create a Variable Meter on the Run-Time Display tab that monitors the value of a
string variable. That string variable can be modified at any time during the test using the
Assign Variables activity. The Variable Meter will then update automatically.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Value Properties
When you select a numerical value to be displayed (such as Variable or Signal), the items in the Value
panel become populated with the relevant information for that item. The fields in the Value Properties
panel vary depending on the item to be displayed. Some fields that will be displayed include:
Item Description
Meter Select the type of meter to display: Timed, Minimum, Maximum, Peak, Valley,
Type Peak/Valley, Running Maximum/Minimum, or Mean/Amplitude. For more
information about the available meter types, see “Meter Types” on page 51.
Sensitivity Defines how much the signal must change before the application detects a peak or
valley data point. Signal changes that are less than the sensitivity do not acquire
signals.
Unit From the drop-down list, select the units to be displayed.
Format With Fixed, the number is shown in standard notation. For example, twenty million
would be displayed as 20000000.000 for a Digit Type of Decimal with Digits set to 3.
With Scientific, the number is shown in E scientific notation. For example, twenty
million is displayed as 2.000E+007 for a Digit Type of Decimal with Digits set to 3.
This notation is typically used for number values too large or small to be shown in
standard decimal notation.
Digit Type With Decimal, the number of Digits specifies the number of digits to the right of the
decimal symbol. For example, zero would be displayed as 0.000 with Digits set to 3.
With Significant, the number of Digits specifies the number of digits that are
significant. For example, zero would be displayed as 0.00 with Digits set to 3.
Digits Specifies how many digits to use for the SignificantDigit Type.
Format Properties
Format Panel
Use the Format panel on the Properties panel to format the display of a numeric variable value.
Variable Information
Item Description
Format Fixed: The number appears in standard notation. For example, twenty million appears as
Type 20000000.000 for a Digit Type of Decimal with Digits set to 3.
Scientific: The number appears in E scientific notation. For example, twenty million
appears as 2.000E+007 for a Digit Type of Decimal with Digits set to 3. You can typically
use this notation for number values too large or small to be shown in standard decimal
notation. With Decimal, the number of Digits specifies the number of digits to the right of
the decimal symbol. For example, zero appears as 0.000 with Digits set to 3.
Digit Decimal: The number of digits to the right of the decimal symbol. For example, zero would
Type be displayed as 0.000 with Digits set to 3.
Significant: The number of digits that are significant. For example, zero would be displayed
as 0.00 with Digits set to 3.
Digits Specifies how many digits to use for the Digit Type.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Traces Properties
A trace is the representation of a series of values plotted against another series of values. Depending
on the type of view, you can plot signal or variable data on either the Y- or X-axis.
If you define more than one trace on an axis, all the traces must have the same dimension. For
example, you cannot add a force signal trace and a displacement signal trace together on the Y-axis.
If you define more than one trace on an axis, a legend is displayed by default. You can use the Hide
Legend option to hide the legend.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you
set the opacity to a lower value, it makes the trace more transparent.
Draw Line Select this check box to draw lines between data points. Clear the Draw
Line check box and click OK to only show data points if a Symbol Type is
selected; otherwise, the trace is not drawn.
Line Thickness Select the thickness of the lines from 1 to 10 points.
Item Description
Line Type Select the line style as solid, dotted, or dashed.
Symbol Type Select the type of symbol to mark the location of data points. If you do not
want to mark the data points with symbols, choose the blank selection in
the list.
Symbol Size Select the size of the data point symbols. To automatically size the
symbols, select the multiple size image, which is the first item in the drop-
down list.
Item Description
Color Click the drop-down menu, and select the color of the associated line.
Limit Select one of the following limit types.
type l Horizontal
l Vertical
l Slope Intercept, m∙x + b
l General XY (Single Value or Array)
l Indexed Values
l Horizontal at Index
l Vertical at Index
For details about each limit type, including the fields you can configure when selecting
each different option, see “Horizontal limit type” on page 491.
Y Select a single value variable or an array variable for which you want data plotted on the Y
Variable axis of the chart.
X Select a single value variable or an array variable for which you want data plotted on the X
Variable axis of the chart.
Legend Select this option to add a custom legend label to the chart. In the text box, enter the name
label of the legend label.
Limit Types
Limit Types are not available for all charts. The charts that do utilize them contain only the limits that
pertain to that particular chart.
Click the Edit (ellipsis) button on the Limit or Curve Fit Lines title bar to open the Line Drop
Percentage window. Type the value in the box, and specify the units from the drop-down menu.
Item Description
Display Select a display unit for the selected trace signal. The list only shows the set of units
Unit that are compatible with the dimension of the signal that is assigned to the selected
trace.
Blank is the default value.
Maximum Set the display range of the Y axis to the maximum or minimum values.
or
Minimum Click the corresponding button to use this feature.
To have the software calculate the maximum or minimum value(s) of the Y signal and
then set the maximum or minimum display range to the value(s), click to clear the check
boxes.
To manually set the maximum or minimum display range for the Y axis, select the check
boxes and then specify the maximum or minimum values.
Mean or Set the display range of the Y axis to the amplitude or mean values. Amplitude is a plus
Amplitude or minus display range. Mean is an offset, and the amplitude is relative to the mean.
Click the corresponding button to use this feature.
Click to clear the check box(es) to have the application set the amplitude or mean
display range to the amplitude or mean value(s) of the X signal.
Click the check box(es) and then specify the amplitude or mean values to manually set
the amplitude or mean display range for the X axis.
Expand The Expand Only feature was developed for auto-scaling such that when the range
Only expanded during auto-scaling, this option prevented the range from contracting when
the command stopped.
Click the check box to allow a range to automatically expand if the data exceeds the
maximum and minimum ranges. The chart does not rescale to a smaller range.
Specifying the Maximum and Minimum for an axis avoids auto-scaling, however, also
checking Expand Only implies that you want to auto-scale if the data is outside the
specified range.
Log Scale Toggle between linear scale and log scale for the axis. Select the check box for
logarithmic scale. Leave the box blank for linear scale.
Item Description
Log Set the base for displaying values in a logarithmic format. Click the up-arrow or down-
Base arrow to raise or lower the base.
Label Set the number of significant digits displayed in the labels along the X-axis and Y-axis. Only
Digits non-zero digits are shown after the decimal point to avoid overcrowding in the label area
next to the axis.
Color Set the color of the associated trace or axis. Click the down-arrow and select a color from
the list.
Draw Select the check box to show grid lines on the chart. Deselect the check box to suppress
Grid the grid lines.
Lines
Item Description
Show Select to show a crosshair, circle, and data point value when selecting a data point
highlight in the chart.
circle
Show delta Select to show the values of two points, the difference between their values, and the
and slope slope of a line drawn through the two points.
Labels
Number of Enter the number of rows used to arrange the labels, delta, and slope. Click the up
rows arrow or down arrow to increase or decrease the number of rows. The value range
is 1 - 6.
Signal Category
This section describes the available test-run displays for signals.
Signal Gage
About Signal Gages
The Signal Gage shows the current level of a signal in a meter and in a linear or radial gage. The
signal shown during runtime is chosen from a list of available signals. The list of available signals is
determined by the test Resources. A signal gage can show one signal. For multiple signals, create an
equal number of signal gages.
Value Properties
When you select a numerical value to be displayed (such as Variable or Signal), the items in the Value
panel become populated with the relevant information for that item. The fields in the Value Properties
panel vary depending on the item to be displayed. Some fields that will be displayed include:
Item Description
Meter Select the type of meter to display: Timed, Minimum, Maximum, Peak, Valley,
Type Peak/Valley, Running Maximum/Minimum, or Mean/Amplitude. For more
information about the available meter types, see “Meter Types” on page 51.
Sensitivity Defines how much the signal must change before the application detects a peak or
valley data point. Signal changes that are less than the sensitivity do not acquire
signals.
Unit From the drop-down list, select the units to be displayed.
Format With Fixed, the number is shown in standard notation. For example, twenty million
would be displayed as 20000000.000 for a Digit Type of Decimal with Digits set to 3.
With Scientific, the number is shown in E scientific notation. For example, twenty
million is displayed as 2.000E+007 for a Digit Type of Decimal with Digits set to 3.
This notation is typically used for number values too large or small to be shown in
standard decimal notation.
Digit Type With Decimal, the number of Digits specifies the number of digits to the right of the
decimal symbol. For example, zero would be displayed as 0.000 with Digits set to 3.
With Significant, the number of Digits specifies the number of digits that are
significant. For example, zero would be displayed as 0.00 with Digits set to 3.
Digits Specifies how many digits to use for the SignificantDigit Type.
Format Properties
Format Panel
Use the Format panel on the Properties panel to format the display of a numeric variable value.
Variable Information
Item Description
Format Fixed: The number appears in standard notation. For example, twenty million appears as
Type 20000000.000 for a Digit Type of Decimal with Digits set to 3.
Scientific: The number appears in E scientific notation. For example, twenty million
appears as 2.000E+007 for a Digit Type of Decimal with Digits set to 3. You can typically
use this notation for number values too large or small to be shown in standard decimal
notation. With Decimal, the number of Digits specifies the number of digits to the right of
the decimal symbol. For example, zero appears as 0.000 with Digits set to 3.
Digit Decimal: The number of digits to the right of the decimal symbol. For example, zero would
Type be displayed as 0.000 with Digits set to 3.
Significant: The number of digits that are significant. For example, zero would be displayed
as 0.00 with Digits set to 3.
Digits Specifies how many digits to use for the Digit Type.
Use the Signal Gage panel to specify how the signal gage is formatted.
Item Description
Minimum Specifies the minimum value or variable and units for the signal.
Maximum Specifies the maximum value or variable and units for the signal.
Tickmark Interval Sets the incremental number of tickmarks that are displayed for the
signal indicator and units for the tickmarks.
Marker Color Specifies color of marker
Scale Color Specifies the color of the scale, or tickmarks.
Labels Color Specifies the color of the value labels for the scale.
Use a needle indicator Check the box to use a needle indicator instead of a bar marker.
instead of a bar marker.
Use a radial scale instead of Check the box to use a radial scale instead of a linear scale.
a linear scale.
Orientation Select Horizontal or Vertical.
Color Ranges
The Color Ranges panel allows test designers to use color to indicate the status of a signal. For
example, green for valid or good performance, yellow for marginal performance, red for invalid or hot,
blue for cold.
Click the plus sign to add a color range to the Color Ranges panel. Double-click that range, or highlight
the range and click the ellipsis, to open the Color Range window.
Item Description
Minimum The Minimum range value can be a numeric value or defined by a variable (see example
figure above), which allows the range to be assigned a minimum value that changes at
run-time.
Maximum
The Maximum range value can be a numeric value or defined by a variable, which
allows the range to be assigned a maximum value that changes at run-time.
Color Select the color for the range.
Signal Meter
About Signal Meters
A Signal Meter displays signal data at all times. Signal meters display calculated signal data only
when the test is running. Calculated signals are displayed as “***” before and after test runs.
The Signal Meter shows the current numeric value of a selected signal in a meter. It can show one
signal. For multiple signals, create an equal number of meters. The meter display includes the label,
the value, and the unit.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Value Properties
When you select a numerical value to be displayed (such as Variable or Signal), the items in the Value
panel become populated with the relevant information for that item. The fields in the Value Properties
panel vary depending on the item to be displayed. Some fields that will be displayed include:
Item Description
Meter Select the type of meter to display: Timed, Minimum, Maximum, Peak, Valley,
Type Peak/Valley, Running Maximum/Minimum, or Mean/Amplitude. For more
information about the available meter types, see “Meter Types” on page 51.
Sensitivity Defines how much the signal must change before the application detects a peak or
valley data point. Signal changes that are less than the sensitivity do not acquire
signals.
Unit From the drop-down list, select the units to be displayed.
Format With Fixed, the number is shown in standard notation. For example, twenty million
would be displayed as 20000000.000 for a Digit Type of Decimal with Digits set to 3.
With Scientific, the number is shown in E scientific notation. For example, twenty
million is displayed as 2.000E+007 for a Digit Type of Decimal with Digits set to 3.
This notation is typically used for number values too large or small to be shown in
standard decimal notation.
Digit Type With Decimal, the number of Digits specifies the number of digits to the right of the
decimal symbol. For example, zero would be displayed as 0.000 with Digits set to 3.
With Significant, the number of Digits specifies the number of digits that are
significant. For example, zero would be displayed as 0.00 with Digits set to 3.
Digits Specifies how many digits to use for the SignificantDigit Type.
Format Properties
Format Panel
Use the Format panel on the Properties panel to format the display of a numeric variable value.
Variable Information
Item Description
Format Fixed: The number appears in standard notation. For example, twenty million appears as
Type 20000000.000 for a Digit Type of Decimal with Digits set to 3.
Scientific: The number appears in E scientific notation. For example, twenty million
appears as 2.000E+007 for a Digit Type of Decimal with Digits set to 3. You can typically
use this notation for number values too large or small to be shown in standard decimal
notation. With Decimal, the number of Digits specifies the number of digits to the right of
the decimal symbol. For example, zero appears as 0.000 with Digits set to 3.
Digit Decimal: The number of digits to the right of the decimal symbol. For example, zero would
Type be displayed as 0.000 with Digits set to 3.
Significant: The number of digits that are significant. For example, zero would be displayed
as 0.00 with Digits set to 3.
Digits Specifies how many digits to use for the Digit Type.
Signal Scope
About Signal Scopes
The Signal Scope allows you to configure offline the scope properties during test runs. The signals that
are available in the scope properties come from the mapping in the test Resources. You can define
the scope configuration settings offline when the application is disconnected from the station.
However, the application must be connected to the controller when the test is run to show the data for
the signals.
When a scope is used in a test-run display for a test:
l The scope shows signals for the test when the test is run.
l The scope updates only while the test is running and shows the last available signal status
when the test is stopped.
l The scope configuration settings are saved with the test.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Traces Properties
A trace is the representation of a series of values plotted against another series of values. Depending
on the type of view, you can plot signal or variable data on either the Y- or X-axis.
If you define more than one trace on an axis, all the traces must have the same dimension. For
example, you cannot add a force signal trace and a displacement signal trace together on the Y-axis.
If you define more than one trace on an axis, a legend is displayed by default. You can use the Hide
Legend option to hide the legend.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you
set the opacity to a lower value, it makes the trace more transparent.
Draw Line Select this check box to draw lines between data points. Clear the Draw
Line check box and click OK to only show data points if a Symbol Type is
selected; otherwise, the trace is not drawn.
Line Thickness Select the thickness of the lines from 1 to 10 points.
Line Type Select the line style as solid, dotted, or dashed.
Symbol Type Select the type of symbol to mark the location of data points. If you do not
want to mark the data points with symbols, choose the blank selection in
the list.
Symbol Size Select the size of the data point symbols. To automatically size the
symbols, select the multiple size image, which is the first item in the drop-
down list.
Item Description
Color Click the drop-down menu, and select the color of the associated line.
Limit Select one of the following limit types.
type l Horizontal
l Vertical
l Slope Intercept, m∙x + b
l General XY (Single Value or Array)
l Indexed Values
l Horizontal at Index
l Vertical at Index
For details about each limit type, including the fields you can configure when selecting
each different option, see “Horizontal limit type” on page 491.
Y Select a single value variable or an array variable for which you want data plotted on the Y
Variable axis of the chart.
X Select a single value variable or an array variable for which you want data plotted on the X
Variable axis of the chart.
Legend Select this option to add a custom legend label to the chart. In the text box, enter the name
label of the legend label.
Limit Types
Limit Types are not available for all charts. The charts that do utilize them contain only the limits that
pertain to that particular chart.
Click the Edit (ellipsis) button on the Limit or Curve Fit Lines title bar to open the Line Drop
Percentage window. Type the value in the box, and specify the units from the drop-down menu.
Item Description
Display Select a display unit for the selected trace signal. The list only shows the set of units
Unit that are compatible with the dimension of the signal that is assigned to the selected
trace.
Blank is the default value.
Maximum Set the display range of the Y axis to the maximum or minimum values.
or
Minimum Click the corresponding button to use this feature.
To have the software calculate the maximum or minimum value(s) of the Y signal and
then set the maximum or minimum display range to the value(s), click to clear the check
boxes.
To manually set the maximum or minimum display range for the Y axis, select the check
boxes and then specify the maximum or minimum values.
Mean or Set the display range of the Y axis to the amplitude or mean values. Amplitude is a plus
Amplitude or minus display range. Mean is an offset, and the amplitude is relative to the mean.
Click the corresponding button to use this feature.
Click to clear the check box(es) to have the application set the amplitude or mean
display range to the amplitude or mean value(s) of the X signal.
Click the check box(es) and then specify the amplitude or mean values to manually set
the amplitude or mean display range for the X axis.
Expand The Expand Only feature was developed for auto-scaling such that when the range
Only expanded during auto-scaling, this option prevented the range from contracting when
the command stopped.
Click the check box to allow a range to automatically expand if the data exceeds the
maximum and minimum ranges. The chart does not rescale to a smaller range.
Specifying the Maximum and Minimum for an axis avoids auto-scaling, however, also
checking Expand Only implies that you want to auto-scale if the data is outside the
specified range.
Log Scale Toggle between linear scale and log scale for the axis. Select the check box for
logarithmic scale. Leave the box blank for linear scale.
Item Description
Log Set the base for displaying values in a logarithmic format. Click the up-arrow or down-
Base arrow to raise or lower the base.
Label Set the number of significant digits displayed in the labels along the X-axis and Y-axis. Only
Digits non-zero digits are shown after the decimal point to avoid overcrowding in the label area
next to the axis.
Color Set the color of the associated trace or axis. Click the down-arrow and select a color from
the list.
Draw Select the check box to show grid lines on the chart. Deselect the check box to suppress
Grid the grid lines.
Lines
Item Description
Show Select to show a crosshair, circle, and data point value when selecting a data point
highlight in the chart.
circle
Show delta Select to show the values of two points, the difference between their values, and the
and slope slope of a line drawn through the two points.
Labels
Number of Enter the number of rows used to arrange the labels, delta, and slope. Click the up
rows arrow or down arrow to increase or decrease the number of rows. The value range
is 1 - 6.
Interactive Category
Interactive category tools allow an operator to interact with a test during a test-run via the test-run
display.
Digital IO
About Digital IO Displays
The Digital IO test-run display monitors the current state of one digital input or digital output. If
necessary, you can create multiple instances to monitor multiple digital inputs and outputs. You can
also allow an operator to toggle digital output during a test run.
Prerequisite: The station configuration (.cfg) must have the appropriate resources configured.
Note:
When a test is running on a FlexTest controller, the settings and properties for the digital inputs
and outputs are defined in the Station Manager application and cannot be edited.
During a test run, the indicator box lights green when the digital input or output is active. The output
toggle for the Digital IO test-run display is predefined and cannot be configured otherwise.
Note:
Calculated digital outputs cannot be changed by the Digital IO test-run display.
To programmatically invoke a digital output, use the Set Digital Output activity.
Digital IO Properties
Item Description
Signal The signal selected to monitor. Click the ellipsis to open the Select a Signal window.
The Signal list reflects the digital signals included in the test resources. You can only
select a digital input or digital output signal. Selecting a digital output signal enables the
Set Digital Outputs at Runtime check box.
Set Allows an operator to toggle a digital output during a test run.
Digital
Outputs Note:
at To enable this check box, select a digital output signal in the Signal list.
Runtime Default: Disabled
Enabled Optional. Defines a condition that determines when an On/Off button (to change the
Condition signal) becomes available to an operator during a test run. Clicking the ellipsis opens
the Calculation Editor window. This box is active when a digital output signal is specified
in the Signal box and the Set Digital Outputs at Runtime is selected.
1. Click the Test-Run Display tab > Designer tab > Toolbox panel.
2. In the Interactive section, click the Digital IO tool and drag it to the desired location in the
Designer tab workspace.
3. In the Properties panel, click the Signal ellipsis button.
4. Select either a Digital Input or Digital Output signal to monitor and click OK.
5. (Optional) Adjust the Font Size as needed.
6. Repeat these steps for each digital IO signal you want to monitor.
Input Variables
About Input Variables
In addition to presenting input variables to an operator during a test run with the Input Variables
activity, you can present input variables in the test-run display during a test run. An operator must press
Enter to apply any changed variable value in a text box. If a variable value is changed by an Input
Variables activity while a test is running, the corresponding Input Variables test-run display reflects
the changed value. The Input Variables test-run display shows the last valid value at the end of a test
run.
Item Description
Enabled Optional. Defines a condition that determines when an input variable box becomes
Condition available to an operator during a test run. Clicking the ellipsis opens the Calculation
Editor window.
By default, an Input Variable test-run display is always enabled if nothing is explicitly
defined for the Enabled Condition.
Variable Required. A variable must be selected. A validation error is logged in the Error list until a
variable is selected. Click the ellipsis to open the Select a Variable window.
Note:
Only variables that have the Editable property of During Test are available for
use with the Input Variables test-run display.
You can also add or edit a variable while in this window. To open the Add Variable window, click the
New Variable icon (+) or right-click and select New Variable. To open the Edit Variable window, click
the Edit Variable icon (...) or right-click on a variable name and select Edit Variable.
Note:
An operator must click Enter after entering a value.
Note:
Only variables that have the Editable property of During Test are available for use with this
activity.
Item Description
Button Required. Shows the label for the Set Variable button. Defaults to “Set Variable”.
Text
Enabled Required. Enabled Condition is an expression that specifies when the button is
Condition active. For example, to wait until the controller is in a run state, Enabled Condition
could be Signal(“Run/Stop”)==1.
Variable Required. The variable that changes when the operator presses the button during a
test run.
Expression Required. Expression that is evaluated when the operator presses the Set Variable
button and a variable to hold the result. You can use Expression to assign a simple
value to the variable, or you can use the variables, functions, and operators available
in the Calculation Editor window to evaluate complex conditions.
Image File Specify the path to the image you want to use for the button.
Name
General Category
The tools in the General category let you visually track progress of a test and add additional labels or
images to other test-run displays.
Help Button
About Help Buttons
The Help Button is a customized runtime help button that lets you provide your own help file for a test.
Note:
The customized help button for test-run displays is not part of the MTS TestSuite Help menu
options.
The runtime Help Button provides access to information from one of several different content
sources:
l A specific file located on a disk or on a Web server.
l A topic in a locally stored help file (the file must be a compiled HTML help file with a .chm
extension).
l User-entered text displayed as pop-up text.
Item Description
Button Text Enter label text for the face of the help button. You can resize the button on the
Designer tab to accommodate long labels.
Help File Enter the directory path or the URL for the file that contains the help text. Specify the
Path or URL complete path including either the drive letter or the server name. The following are
examples of complete file paths:
C:\Documents\MyHelp.chm
\\MyServer\Documents\MyHelp.doc
http:\\www.myweb.com\Documents\MyHelp.htm.
Image File Enter the directory path or the URL for the file that contains the image to be used for
Name the help button. Specify the complete path including either the drive letter or the
server name.
Launch Select this option to open the file using the default application associated with the file
Associated type by the operating system.
Application
Launch Select this option to open the file using a designated application. Specify the
Application complete path, including the executable file name.
CHM ID If the help file is a compiled HTML help file (.chm), you can optionally specify a topic
within the help file with a reference to a topic ID (identifier).
To use this option, the help file must implement topic IDs in a topic map. If the help file
does not use a topic map, you can reference a specific topic by name with the CHM
Topic option.
CHM Topic If the help file is a compiled HTML help file (.chm), you can optionally reference a
specific topic within the help file by specifying a named destination.
Each topic (or page) in a .chm file is a separate HTML page. To direct the user to a
specific topic, enter the name of the HTML page here. For example:
MyTopic.html
Pop-up Text Click option to display a text string when the help button is clicked. Enter the pop-up
text in the adjacent box.
When you select a different content source for the help button, you clear the text you
previously entered.
1. On the Explorer panel, click Test-Run Display tab > Designer tab.
2. In the Toolbox panel; under General, drag the Help Button to your Designer window. You
can move or resize the button in the Designer window.
3. In the Properties panel, specify the button name, where it should be located on the window
(Docking), the location of the help file, and how it will be displayed.
4. Click the Preview tab to test the functionality you have set up for the Help button.
When you click the Help button during a test run, the information from the selected source is
shown in a separate window.
Label
About Labels
Label contains a single line of text that you can use to:
l Reference elements in a test-run display
l Provide instructional or context statements in a test-run display
Labels contain a simple text string and cannot contain variable values.
Label Properties
Label Properties
Item Description
Text Required. Text of the label. A blank label results in a validation error in the Error list.
Default: Label n
Font Size Size of the text for the label.
Range: 4-100 points
Default: 8 pt
1. Click the Test-Run Display tab > Designer tab > Toolbox panel.
2. In the General Views section, click the Label icon and drag it to the desired location in the
Designer tab workspace.
3. In the Properties panel, edit the default label text in the Text box.
4. Adjust the Font Size as needed.
5. Repeat for each label you want to add.
Image
About Images
You can select an image to show in a test-run display. If desired, you can define a condition that
determines whether to show an image.
Note:
Image files for test-run displays are not included when you import or export a test.
Image Properties
Picture Properties
Item Description
File Name Shows the path and file name of the selected image.
Supported paths include:
l Absolute paths, such as C:\MyPicture.jpg
l Relative paths (those relative to current project settings) such as <External
Files>\MyPicture.jpg
l UNC paths, such as \\MyNetworkPath\Picture\MyPicture.jpg
Note:
URL addresses are not supported.
Supported image formats include:
l .jpg
l .gif
l .png
If the image file is invalid or does not exist, nothing is shown in the test-run display and a
warning is displayed in the Error list.
Show Defines the condition by which to show an image in the test-run display. The Show
Condition Condition expression must evaluate to True to show the picture in the test-run display.
Clicking the ellipsis opens the Calculation Editor. If the equation defined in the
Calculation Editor to show the condition cannot be validated, and error message is
logged to the Error list.
Test Procedure
Create a Test Procedure Test-Run Display
To create a test procedure test-run display:
1. Click the Test-Run Display tab > Designer tab > Toolbox panel.
2. In the General section, click the Test Procedure tool and drag it to the desired location in the
Designer tab.
3. (Optional) Edit the default Display Name or select a Docking option to position the test-run
display. For a maximum view of the test procedure, select the Fill option in the Docking list.
You can accept the default values for the Update Interval property or create a variable.
Visibility Panel
For Docking, select where on the monitor you want the test-run display to be positioned, Top, Left,
Bottom, Right, or Fill, where the display fills the entire tab or panel.
Show Condition lets you show or hide the test-run displays, depending on the condition of the
variable expression. For example, you could set up a condition to check the variable containing the
specimen type for a Set Variable test-run display to make visible the diameter only when the
specimen type is round, but hidden for a rectangular specimen. Likewise, you can use two more Set
Variable test-run displays for width and length to be visible if the specimen type is rectangular but
hidden when the specimen type is round.
Click the plus sign in the Variable List panel to open the Variables Selection window.
The variables that you select in the Variables Selection window (double-click or use arrows to move
variables from the Available Variables column to the Selected Variables column) are placed in a
horizontal row.
Layout Category
Use the tools in the Layout category to organize multiple test-run displays. You can create multiple tabs
with transitions and place panels within the tabs to delineate.
About Panels
Use panels to group and organize your displays. Double-click Panels in the Layout group of the
Toolbox panel to open two panels in the Designer tab. You can then drag and drop displays onto a
panel. Configure panel details in the Properties panel.
Panels Properties
Orientation
Choose Vertical or Horizontal from the drop-down menu to indicate how the panels should be
positioned on the monitor.
Panel Resizing
Item Description
Both Proportionally As you resize a panel, both panels are resized proportionally.
Right or Bottom Panel Select to resize only the right or bottom panel
Left or Top Panel Select to resize only the left or top panel.
About Tabs
Use Tabs to organize monitor displays into multiple views. While running a test, you can view the test-
run displays on that tab by clicking the tab. You can also associate a tab with an activity in the test
procedure so that the tab is automatically displayed when the activity runs.
Tabs Properties
In the Layout group of the Toolbox panel, double-click Tabs to open a resizable, 2-tab window. You
can nest tabbed pages to create multi-level test-run display structures or add Panels to add more
structure to your display organization. During a test run, you can selectively view the information in
predefined tabs. You can automatically show a tab when an associated activity occurs by using
transitions.
The activity consists of two parts: the control window and the individual tabs within the control window.
The tab control window is a container for the individual tabs. The individual tabs are containers for
other monitor display controls—including other tab controls.
Note:
If you want to create a new tab control by copying an existing tab control, make sure to select the
entire tab control (not an individual tab). If you try to paste an individual tab onto the display, an
error occurs.
Tab controls
By default, when a tab control is placed in the test-run display, two tabs are included in the control
window. The number of tabs in the Designer area and the individual tab functionality is defined by the
tab control properties. The individual tabs do not have separate property settings.
You can add and remove tabs, edit the tab name, and sequence the individual tabs. To add a tab, click
the plus sign. To change the name of a tab, click the ellipsis. To delete a tab, highlight it and click the
red minus sign. To change the order of the tabs, highlight a tab and click the up or down arrow to adjust
its position.
Activity transitions
You can find pertinent test information for the current test activity by using tab transitions. Start by
using tabs to organize test-run display controls according to portions of the test procedure. Then
assign a transition to a tab so that it is shown during the appropriate portion of the test. If you organize
the test-run display in this manner, the operator does not have to sort through multiple controls to find
information of immediate interest.
To assign a tab transition, click the plus sign to open the Tab Transition Selection window. Select a
defined test activity and a defined monitor display tab. The activity and tab are linked when the
transition is added to the current transitions list. During the test run, the tab is shown when the activity
is performed.
Note:
To sort the current transitions, click the Activity or Tab headings. Sorting only affects the
display of the current transitions. The order of activities during a test is defined in the test
procedure layout.
To edit an existing transition, highlight the Activity, and click the ellipsis to open the Tab Transition
Selection window. Make your modifications, and click OK. To delete an Activity Transition, highlight it,
and click the red minus sign.
Scopes
About Scopes
A scope is a time-based chart, similar in principle to an oscilloscope, that you can use to plot data over
a specified period of time. A scope can plot one or more trace signals on the Y axis and either time or
another trace signal on the X axis. Additional trace signals can be added to additional Y axes.
You can set up and use signal scopes in two ways: for general system operation or for within a test. A
difference in these uses of a scope depends on where the scope is opened.
Scope Buttons
Item Description
Run Shows live data on the scope.
Scope
Stop Stops showing live data on the scope. This button becomes active when the scope
Scope begins to run.
Launch Creates a tab for an additional scope.
Another
Scope
Close Click Launch Another Scope to remove the additional scope you create. This button
Scope does not close the original scope. To close the original scope, click Display > Scope.
Item Description
Operator When active, the Wait for Operator Action activity adds an Operator Buttons
buttons window to the top of the Monitor tab as the test runs. When the active button is clicked,
it ends the current parallel path, to force the test to the next test activity.
Note:
The Operator Buttons window does not appear when you preview the Monitor
tab layout.
Copy Copy the image of the display component to the clipboard.
Image to
Clipboard
Copy Copy the chart data to the clipboard.
Values to
the
Clipboard
Item Description
Properties Open the Properties panel of the chart on which you clicked. If you change the
properties of a display component while the test runs, data may be excluded.
Move to a Temporarily explodes the view of the monitor display component in its own tab.
New Tab
Return to Closes the temporary tab opened from the Move to a New Tab option and returns to
the Monitor the monitor display.
Item Description
Cut Remove the view from the monitor display. A picture of the view is placed on the Windows
clipboard. The image is made available to paste into any document or location where the
clipboard is available. The image is only a picture and is no longer active.
Copy Place a picture of the view in the Windows clipboard. The image is made available to paste
into any document or location where the clipboard is available. The image becomes a
picture and is no longer active. You can copy from tables during runtime. All boxes transfer
to the clipboard.
Paste Transfer the contents of the clipboard to the Monitor display. If the content is not a view,
nothing new appears. If the content is a view, it appears on the display and is active. Its
properties are contained on the Properties tab. If the name duplicates an existing display
name, a warning appears in the Error list. Type a new name in the Display Name box and
save the test by clicking the Save toolbar icon or by clicking File > Save. When you paste to
a table, you can only paste one value (table cell) at a time. You cannot paste to Name
boxes.
Delete Deletes the monitor display.
Any changes you make during a test run apply only to that test run. Subsequent test runs default to the
properties specified in the Monitor definition.
Control Description
Station Lights when the interlock (hardware) chain for the test station opens. Hydraulic power
(Interlock) turns off and the test run stops.
Program Lights when a program interlock occurs due to an event (typically a test limit) that is
(Interlock) detected in the test procedure. Although hydraulic power remains on, the test run
stops.
Reset Reset a test station interlock or program shutdown. For a station interlock, you must
click Reset before you can reapply hydraulic power and restart the test run.
If the cause of a test station interlock prohibits a reset, click Override to temporarily
override the interlock so that you can clear the cause.
Override
Warning:
Station limits are disabled during the override time.
Disabling station limits also disables safety limits.
Always clear the actuator area before applying hydraulics.
Temporarily override a test station interlock so that you can clear the cause. Each time
you click the button, ten seconds is added to the length of time the interlock is
overridden, up to a total of 120 seconds. The digital readout to the right of the button
shows the duration and the countdown.
Power Controls
Power Controls Panel
Control Description
Off Places the HSM (hydraulic service manifold) for the test station and the HPU (hydraulic
power unit) in their zero-pressure states (red indicators lit).
Low Places the HPU in the high-pressure state (green indicator lit) and the HSM for the test
station in the low-pressure state (amber indicator lit).
High Places the HSM for the test station in the high-pressure state (green indicator lit). You
must first click Low to enable the High button.
Actuator Controls
The buttons on the Actuator Controls panel allow you to position the actuator. You can configure the
actions for these buttons at Preferences menu > Configuration > Control Panel tab.
Note:
The actuator can also be controlled with a handset. For more information on using a handset,
see the Product Manual that came with your system. When control is provided by a handset, the
actuator controls will be locked and overlaid by the handset exclusive control icon:
Test Controls
The Test Controls panel allows you to run, hold, or stop a test.
Control Description
Run. Start a test or resume a test that is held.
Hold. Pause the test at the end of the current cycle or at the end of the current non-cycle
command activity. Click Run to resume the test run.
Stop. Stop the test in place. The current cycle or command activity is not completed. Click
Run to resume the test at the point where it was stopped.
Item Description
Cancel the Test Run. When a test run is in the Stopped state, you can click the Cancel
the Test Run button to cancel the test run. If you cancel the test run, you will not be able to
restart it.
After canceling a test run, the Review tab appears and you can load another specimen
and run additional test runs.
Status Control Mode - When connected to a station, the control mode appears, in parentheses
(_Extension, for example), next to the status.
Running - The test run is in-progress. The Running Time field shows the current
elapsed run time.
Hold - The test run is held at the end of the current cycle. The Running Time field does
not change until the test run is restarted. The test resumes at the start of the next
segment.
Stopped - The test run is stopped.
l If the test was in a cycle, the cycle completes before the test stops.
l The test restarts at the beginning of the current cycle.
Note:
The test run can be canceled while in the Stopped state.
Completed - The test run is complete.
Running Displays the amount of time the test run has been running.
Time
Note:
The time that elapses while the test run is held or stopped is not included.
Item Description
Ramp Rate This is the speed that the actuator moves when the jog (up or down arrows) buttons
are clicked.
Commands This table displays the columns of parameters necessary to set up the return functions
for the available channels.
Enabled Enable or disable the jog function for the corresponding channel.
Is Positive Indicates the direction the jog buttons will move the actuator based on the calibration
Direction of the station and the physical orientation of the actuator (base-mounted or
Up? crosshead-mounted). For example, typical servo hydraulic load frames where the
actuator is mounted in the base are calibrated so that tension is positive. Thus,
retracting the actuator (moving down) is positive. Therefore, Is positive direction
up? should be set to No. Typical servo-hydraulic load frames with the actuator
mounted in the crosshead are calibrated so that tension is positive. Thus, retracting
the actuator (moving up) is positive. Therefore, Is positive direction up? should be
set to Yes. This action is independent of any signal polarity inversion indicated in the
Item Description
test procedure.
Item Description
Ramp Ramp Time and Commands set the length of time an Enabled channel takes to
Rate achieve its programmed End Level when you click Move the actuator to the return
position button.
When you click the Move the actuator to the actuator return position button, the
application determines the difference between the current signal value and the target end
level for each channel. It then commands the channel to ramp to the target end level at a
rate based on the ramp time you enter.
Enabled Enable or disable the function for the corresponding channel.
Hydraulic Controls
Hydraulic Controls Control Panel Overview
The hydraulic power unit (HPU) provides hydraulic pressure while the hydraulic service manifold
(HSM) hydraulic service manifold of HPU pressure to the test station.
Station controls
Typically, the Control Panel has both HPU and HSM controls.
l On test systems that use house hydraulic power, the Control Panel may have only HSM
controls.
l On some small test systems without an HSM, the Control Panel may have only HPU controls.
Interlocks
A station interlock prevents an HSM start but permits an HPU start. The HSM is a station resource and
cannot start when a station interlock is active. An HPU is considered an external device and can be
started with an active station interlock (even if the hydraulic power unit has caused the interlock)
Power Panel
The Power panel provides individual controls for the HPU (hydraulic power unit) and HSM (hydraulic
service manifold). The HPU can be set to low or high separate from the power supplied to the HSM.
The HSM can be set to low with the HPU set to low or high.
Note:
The HSM cannot be set to a higher setting than the HPU. If the HPU power is set to a power
level that is less than the HSM setting, the HSM setting shifts down to match the HPU.
Power window
The Power window is an alternative to the Control Panel for setting power levels. Some system
configurations may require you to use the Power window to start the HPU before you are allowed to
start the HSMs.
To access the Power window, click the Control icon on the Power panel.
Power Window
Note:
Some system configurations may require you to click the control icon on the Power panel to
display the Power window, and use the Power window controls to start the HPU before you are
allowed to start the HSMs.
1. If the Interlock indicator is on, click Reset to release system interlocks.
If the interlock remains on, use the Message Logs to identify and correct the cause of the
interlock.
Warning:
Applying hydraulic power can result in sudden actuator motion.
A moving actuator can injure anyone in its path.
Always clear the actuator area before applying hydraulic power.
Note:
You do not use the TestSuite application for the pretest tasks.
1. Determine the name and location of the project.
A project that contains the required test must already exist. Verify the name of the project and
determine its media file location in relation to the workstation you intend to use.
2. Determine the name of the test.
Verify the name of the test and make sure it exists in the parent project you identified earlier.
Make sure that the test and specimen you intend to use are compatible.
3. Determine which test station to use.
A test station typically includes a load unit, a hydraulic service manifold (HSM), a hydraulic
power unit (HPU), and some part of an electronic test controller. Because most test
controllers can support the operation of multiple test stations simultaneously, you must verify
the name of the controller test station that is designated for your test.
4. Identify any test parameters that you must enter before or during the test run.
The test designer can include steps in the test procedure that require you to enter values or
make selections before the test run starts or during the test run. Verify this condition with the
test designer and agree on the parameter values or selections you must make.
2. Use the Controller menu of the MTS TestSuite application to connect your session to the test
station.
Crosshead Controls
Note: The crosshead can also be controlled with a handset. For more information on using a
handset, see the product manual that came with your system. When control is provided by a
handset, the crosshead controls will be locked and overlaid by the handset exclusive control
icon:
Caution:
Unintended force can be applied to a mounted specimen, grips and fixtures, or other objects in
the crosshead path.
Unintended force can injure anyone in its path and damage a mounted specimen, grips and
fixtures, or other objects in the crosshead path.
Before you move the crosshead, make sure that the mechanical crosshead limits are set to help
prevent the crosshead from damaging grips and fixturing and make sure to clear the crosshead
area to help prevent personal injury.
Caution:
Unintended force can be applied to a mounted specimen, grips and fixtures, or other objects in
the crosshead path.
Unintended force can injure anyone in its path and damage a mounted specimen, grips and
fixtures, or other objects in the crosshead path.
Before you move the crosshead, make sure that the mechanical crosshead limits are set to help
prevent the crosshead from damaging grips and fixturing and make sure to clear the crosshead
area to help prevent personal injury.
1. Display the Extension meter to provide a real-time indication of the crosshead position.
2. Use the mouse to click and hold the Up or Down button to move the crosshead up or down.
Keep the mouse button depressed for as long as you want the crosshead to move.
3. When the crosshead reaches the desired position, release the mouse button to stop the
crosshead.
Note: Only an MTS FSE can adjust the ramp rate for the Crosshead Return to Zero with the
MTS Insight/Criterion (electromechanical) controller. Contact your MTS service representative
for assistance.
Caution:
Unintended force can be applied to a mounted specimen, grips and fixtures, or other objects in
the crosshead path.
Unintended force can injure anyone in its path and damage a mounted specimen, grips and
fixtures, or other objects in the crosshead path.
Before you move the crosshead, make sure that the mechanical crosshead limits are set to help
prevent the crosshead from damaging grips and fixturing and make sure to clear the crosshead
area to help prevent personal injury.
1. Set the mechanical crosshead limit switches to help prevent the crosshead from damaging the
grips and fixtures.
2. Click the Move Crosshead to Return Position button to move the crosshead to the Return
position.
Caution:
Unintended force can be applied to a mounted specimen, grips and fixtures, or other objects in
the crosshead path.
Unintended force can injure anyone in its path and damage a mounted specimen, grips and
fixtures, or other objects in the crosshead path.
Before you move the crosshead, make sure that the mechanical crosshead limits are set to help
prevent the crosshead from damaging grips and fixturing and make sure to clear the crosshead
area to help prevent personal injury.
1. Set the mechanical crosshead limit switches to help prevent the crosshead from damaging the
grips and fixtures.
2. Click the Move crosshead to the specified position button to display the Go To window.
3. In the Go To window, select the appropriate units and type the desired crosshead position.
Click OK to move the crosshead to the specified position.
The Crosshead meter updates as the Crosshead moves to the specified position. The
Direction arrow flashes and indicates the current direction the crosshead is moving, and the
Move crosshead button flashes until the crosshead reaches its specified target.
4. When the crosshead reaches its destination, a message indicates the specified target has
been reached. Click OK.
Status Panel
Note: The following information only pertains to MTS Criterion and MTS Insight.
The Status portion of the control panel indicates the status of various fault indicators, such as Upper
and Lower limits and the Enclosure Open switch. A red light indicates a fault indicator has been tripped
and must be reset. Hover your cursor over the red light in the Status panel and a message will appear
that states which fault indicator has been tripped. To open the Status window and see a list of all fault
indicators, click the Open Window icon on the Status panel.
Views
A view is chart or table that you can place in a panel on the Review tab. A panel can contain multiple
views but only one view can be active (visible) at a time. The following views are available (the cycle-
based views are not shown in the drop-down list if the test does not contain cycle data):
Description of Views
Variable Table Table that shows non-array-variables (in a single active test-run) and their
properties. For more information, see “Variable Table” on page 548.
Variable Table for Table that shows data from two or more analysis runs selected as an analysis
Multiple Runs set. This table is activated, along with the Variable-Column Table for
Multiple Runs, when an analysis set is created.
Array-Variable Table that shows array-variables (in a single active test-run) and their
Table properties. For more information, see “Array-Variable Table” on page 550.
Fixed-Column Table that shows the value and other properties for each cycle (or boundary)
Boundary Table of each non-array-variable in a single active test-run.
Data Acquisition Table that shows values for each cycle (or boundary) and each array index of
Variable Table each non-array-variable in a single active test-run.
Variable-Column Table that shows values for each cycle (or boundary) of each variable in the
Boundary Table multiple selected test runs. This table is activated, along with the Variable
for Multiple Runs Table for Multiple Runs, when an analysis set is created.
Array-Variable Chart that shows array-variable values versus the array index or another
Marker Chart for array-variable with optional markers.
Multiple Runs
History Marker Chart that shows values of variables versus the cycles (or boundaries) with
Chart for Multiple optional markers.
Runs
Cycle Marker Chart that shows array-variable values versus the array index or another
Chart for Multiple array-variable at specific cycles (or boundaries) with optional markers.
Runs
Cycle Time Chart that shows array-variable values versus a time array-variable (where
Marker Chart for the time values are shifted so the first index is at zero to allow overlaying data)
Multiple Runs at specific cycles (or boundaries) with optional markers.
Right-click options
You can right-click on the results table for other test run selection options.
Delete View
To use the Display Manager window to delete a view:
Important: You cannot delete active (visible) displays. Any view that you delete will not appear
in any display that included that view.
1. Make sure that the view that you want to delete is not visible.
2. On the Actions drop-down list, click Display and then click Open Display Manager.
3. In the View list, select the view you want to delete and click Delete.
Note: If the view supports multiple test runs, the data for each test run is displayed in
the table or chart.
Traces
A trace is the representation of a series of values plotted against another series of values. Depending
on the type of view, you can plot signal or variable data on either the Y- or X-axis.
If you define more than one trace on an axis, all the traces must have the same dimension. For
example, you cannot add a force signal trace and a displacement signal trace together on the Y-axis.
If you define more than one trace on an axis, a legend is displayed by default. You can use the Hide
Legend option to hide the legend.
Item Description
Opacity Adjust the opacity to better see through traces when they overlap. If you set the opacity
to a lower value, it makes the trace more transparent.
Draw Click this check box to draw lines between data points. Clear the Draw Line check box
Line and click OK to only show data points if a Symbol Type is selected, otherwise, the trace
is not drawn.
Line Select the thickness of the lines from 1 to 10 points.
Thickness
Line Type Select the line style as solid, dotted, or dashed.
Symbol Select the type of symbol to mark the location of data points. If you do not want to mark
Type the data points with symbols, choose the blank selection in the list.
Symbol Select the size of the data point symbols. To automatically size the symbols, select the
Size multiple size image, which is the first item in the drop-down list.
Item Description
Add a Limit or Click to add a limit or curve fit line.
Curve Fit Line
Remove a Click to remove a limit or curve fit line.
Limit or Curve
Fit Line
Limit or Curve Lists the names of the limit or curve fit lines that are defined for the scope or chart. If
Fit Lines more than one line is defined, use the up-arrow and down-arrow buttons to scroll
the list.
Click the Add icon to add a limit or curve fit line. Click the Minus icon to remove a
limit or curve fit line.
When the Horizontal, Vertical, or Slope Intercept radio button is selected and no
variable is defined, this box shows Undefined Limit.
Color Use the color that is shown, or click the down-arrow and select an alternate color
for the selected trace.
Limit Type The types include:
l Horizontal—Shows a single value parallel to the X axis
l Vertical—Shows a single value parallel to the Y axis
l Slope Intercept, M*x+b—Shows a curve aligned with the slope of the trace
l General Array—Shows an array for the X and Y variables as complex
limits that are not linear, such a logarithmic or polynomial
Y Variable Click the down arrow and select a variable, or create a new variable.
X Variable Click the down arrow and select a variable, or create a new variable.
Legend Label Enter text for the trace legend.
Item Description
Display Select a display unit for the selected trace signal. The list only shows the set of units
Unit that are compatible with the dimension of the signal that is assigned to the selected
trace.
Blank is the default value.
Maximum Set the display range of the Y axis to the maximum or minimum values.
or
Minimum Click the corresponding button to use this feature.
To have the software calculate the maximum or minimum value(s) of the Y signal and
then set the maximum or minimum display range to the value(s), click to clear the check
boxes.
To manually set the maximum or minimum display range for the Y axis, select the check
boxes and then specify the maximum or minimum values.
Mean or Set the display range of the Y axis to the amplitude or mean values. Amplitude is a plus
Amplitude or minus display range. Mean is an offset, and the amplitude is relative to the mean.
Click the corresponding button to use this feature.
Click to clear the check box(es) to have the application set the amplitude or mean
display range to the amplitude or mean value(s) of the X signal.
Click the check box(es) and then specify the amplitude or mean values to manually set
Item Description
the amplitude or mean display range for the X axis.
Expand Click the check box to allow a range to automatically expand if the data exceeds the
Only maximum and minimum ranges. The chart does not rescale to a smaller range.
Log Scale Toggle between linear scale and log scale for the axis. Select the check box for
logarithmic scale. Leave the box blank for linear scale.
Item Description
Log Set the base for displaying values in a logarithmic format. Click the up-arrow or down-
Base arrow to raise or lower the base.
Label Set the number of significant digits displayed in the labels along the X-axis and Y-axis. Only
Digits non-zero digits are shown after the decimal point to avoid overcrowding in the label area
next to the axis.
Color Set the color of the associated trace or axis. Click the down-arrow and select a color from
the list.
Draw Select the check box to show grid lines on the chart. Deselect the check box to suppress
Grid the grid lines.
Lines
Point Pick
Item Description
Show Click the check box to show a circle around an individual data point and the value of
Highlight the point when selected by the mouse cursor. Deselect the check box to suppress
Circle the data display.
Tip: After you select a location on the graph, use the left and right arrow keys
to traverse the graph one data point at a time.
Show Delta Show the values of two points, the difference between their values, and the slope of
and Slope a line drawn through the two points.
Labels
Number of Specify the number of rows used to arrange the labels, delta, and slope. Click the
Rows up-arrow or down-arrow to increase or decrease the number of rows. The value
range is 1 - 6.
Click the Titles and Legends button to open the Chart Titles and Legend window where you can
configure the details of your display and legend, such as color, font size, location in the window, and
border details.
Zoom to Region
You can zoom in on a point on a line, which may be a marker or a variable, using Zoom to Regions on
the Configure Chart window. The zoom to option then appears when you right-click on the graph.
Click the plus sign to open the Zoom to Region window.
Table Views
Add and Configure Table Views
To add and configure table views:
1. Add a table to the current display.
A. Right-click in the chart/table area and click Views and then Add View.
B. Select the type of table that you want to add.
2. Customize the columns that appear in the table.
A. Click the Column Chooser icon.
B. In the Column Chooser window, select the check box for each column that you want
to appear in the table.
3. Optional - Rearrange the column order by clicking on a column heading and dragging it to the
desired location.
Note: Rearranging columns in the Statistics table is temporary. The next time you run
the test, the order will revert to the order that the test designer set in the application Set
Variables Order window.
Variable Table
The Variable Table shows the current value of the selected analysis run variables. The table supports
direct value overrides that can be used for error correction or “what if” speculation.
You can override values for data not measured from a signal directly in the Value column. However,
you cannot override and recalculate calculations, unless you type a number in the Value column. In
that case, the calculation is handled as an assigned constant value.
Changes made in the Variable Table are processed only in the current analysis run.
Variable Table
By default, the One Panel View is shown. If you click the Two Panel View button, the second panel for
the Variable Table is pre-configured to show the columns selected in the following figure, by default.
In these tables, You can filter the results that appear in any column. The funnel turns blue when filtering
is on; click the funnel to see a drop-down list of filtering options.
Column Filtering
You can configure the columns to be shown for the variables and variable array values in the table by
clicking the Column Chooser icon, as shown in the following figure.
You can override values for data not measured from a signal directly in the Value column. However,
you cannot override and recalculate calculations, unless you type a number in the Value column. In
that case, the calculation is handled as an assigned constant value.
Array-Variable Table
The Array-Variable table shows you the element values in one or more selected array variables. Click
the Array Variables button to open the Variables Selection window. Use the arrows to move
Available Variables to the Selected Variables box and click OK.
l Right Arrow button—Click this button to add a variable that you have selected on the Available
Variables panel to the Selected Variables panel.
l Double Right Arrow button—Click this button to add all variables to the Selected Variables
panel.
l Left Arrow button—Click this button to delete a single variable from the Selected Variables
panel.
l Double Left Arrow button—Click this button to delete all the variables from the Selected
Variables panel.
The default left-hand column of the table is the Array Index. Subsequent columns contain the values of
the array variables.
You can see the units for each selected array variable using the Column Chooser button.
Chart Views
Active Test Run
Charts can display data for multiple test runs but activities such as adding and removing markers,
moving markers, and adding text annotations are only applied to the active test run in the results table.
The active test run is indicated by a black triangle in the left column of the results table.
Add text
1. In the Results Table at the top of the Review window, select the test run that you want to
annotate with a text callout.
The black triangle on the left of the Results table indicates the active test-run selection.
2. Right click on the chart near the point of the curve where you want to attach a text box and
arrow and click Add Text.
3. Use the Edit window to define the text and line attributes.
The default text is the name of the test run that you selected (the active test run) in the Results
table.
Move text
Click and drag the text to reposition it on the chart.
To configure the chart, right-click on the chart and select Configure Chart.
Markers
Right-click on a marker to open Add or Remove Markers, Edit Marker, Edit Variable, and Move
Selected Marker.
Marker Properties
Item Description
Add or Opens the Variables Selection window where you can use the arrows to add or remove
Remove variables. When you add a variable to the Selected Variables box, it appears on the
Markers graph.
To remove a marker, right-click on the marker to be removed and select Add or Remove
Markers. In the Variables Selection window, move the variable to be removed from the
Selected Variables box to the Available Variables box. The marker is removed from
the chart.
Edit Select to change the Display Name and Symbol Color of the marker.
Marker
Edit Select to open the Edit Variable window where you can modify various aspects of the
Variable selected variable.
Item Description
Move To reposition the marker, right-click on the marker to reposition and select the Move
Selected Selected Marker. Move your cursor along the curve. When the cursor touches a data
Marker point, an orange circle surrounds the point and shows the X and Y values. To set the
marker, click the curve at the data point. The orange circle changes to an orange diamond
shape. Right-click and select Move Selected Marker to clear the move action. The
marker changes to a purple diamond shape.
To move the marker to the original location, right-click on the moved marker and select
Reset Marker.
Test runs
Each test run appears as a row in the Results table.
Statistics
At the bottom of the results table are calculated statistical values (such as Mean and Standard
Deviation) for the test. The types of statistics displayed and their order is user defined. Statistics
calculations include data from all the test runs that are not tagged (excluded) from the test.
Note: The list of available statistics calculations is hard coded and cannot be edited.
Results columns
Each variable whose Results properties check box is selected will appear as a column in the results
table. Once a column is added, the value calculated from the test runs appears and is included in any
statistical calculations.
5. Optional - Generate a report that shows the changes or use the Export Raw Data function to
analyze the data in another application.
Note: This button can also be used to apply changes made to the Auto Tag rules.
Note: In the Results table, the selected test run is indicated by a black arrow to the left
of the test run.
2. Click the Revert and Recalculate the Test Run Variables button to revert all variable
changes in the selected test run and recalculate the statistics in the Results table.
Important: If you get unexpected results, it may be because the autotag rule uses system
variable units as opposed to project variable units. Make sure that your rule uses system units.
You can find the system units by looking on the Variables tab provided at the bottom of the
Configure Autotag Rules window as shown in the following illustration.
Example
Suppose you want to automatically exclude test runs with grip slippage. For this example, assume that
peak loads less than 1.8 kN indicate grip slippage. Setting up an autotag rule will automatically tag
those test runs so that they do not affect your statistical results and reports. The following procedure
shows how to set up an autotag rule.
1. Open the autotag window by right-clicking anywhere in the leftmost panel and selecting
Configure Autotag Rules.
2. Set up a rule.
A. Add a rule.
Click the green + sign in the upper right corner of the Configure Autotag Rules
window.
B. Enter a variable.
Click the Variables tab, and then select PeakLoad from the list. PeakLoad appears
in the Calculation panel.
C. Enter a function and a value.
In the Calculation panel, enter <1800 immediately following PeakLoad.
D. Enter an error message.
Enter PeakLoad is less than 1.8kN in the Error Message text box.
E. Click Close.
Notice that Test Run 3 is autotagged. While autotagging can conveniently tag test
runs with numerical data, it will not tag test runs without numerical data. Always
review autotagging results to ensure the results are as expected.
Markers
A marker is a variable that defines a data point in a test run. Selected markers appear in charts as a
symbol placed on a data point.
A marker variable can be defined by a calculation or when a run-time event occurs. In either case, the
marker variable saves an index into a data array. When the marker is added to a chart, its position
represents the x and y axis values associated with the index.
l Calculated - Marker values are typically derived from a calculation and are often used in a
calculation. For example, the least squares calculation for the modulus line uses two
calculated marker variables (Slope1 and Slope2) that appear on a chart.
l Run-time events- Markers may also be assigned during a test by an operator through a digital
input to provide a visual cue that an event has occurred. For example, an operator may create
markers by pressing a key on the handset during a pull test to mark an event. A digital input
triggered during a test run can also mark an event.
Marker Variables
Note:
To revert any changes caused by moving markers, click the Revert and Recalculate the Test
Variables icon in the Review tab toolbar.
Note:
You can create markers after a test run to annotate a chart.
Marker Calculations
Marker examples
Peel tests - Move the start and end markers (usually a calculation that calculates the average value
between these two markers). You can move the markers to compensate for anomalies that occurred
during the test run.
Modulus calculations - Place B and M markers in the chart, the slope of the modulus line is calculated
using a least squares algorithm.
Run-time markers are typically set by a digital input triggered by one of the F keys (F1 or F2) on the
handset. You can also use hardwired digital inputs to trigger a marker.
Note:
The AxialForceDataArray is used in the above expression example. You can
specify any array available in your test’s activity.
H. Right-click the MarkerArray variable, click Set Index, and use the Set Array Index
window to select LoopCount as the index.
Assign Variable Activity 2 - This activity increments the LoopCount variable that you
created earlier.
I. Click the Assign Variables activity to display the properties.
J. On the Variable List, click + and use the Variable Selection window to add the
LoopCount variable that you created earlier, and click OK.
K. On the Variable List, double-click the LoopCount variable and use the Calculation
Editor window to add the following expression: LoopCount+1.
Important:
To view run-time markers in a Review tab chart, right-click on the chart, click
Add or Remove Markers and add the MarkerArray variable to the Selected
Variables list.
Note: To revert any changes caused by moving markers, click the Revert and
Recalculate the Test Variables icon in the Review tab toolbar.
Note: A report can be generated without Excel installed. The Reporter Add-In option is required
to create report templates.
3. Select the default directories for storing report templates and generated reports.
Important: If you leave the Report Directory setting blank, test run reports are saved
with the test run.
Important: If you select (highlight) multiple test runs and click the report icon, you will
generate a separate report for each selected test run.
Item Description
Folder Defines the path to the directory in which the application writes the data file. The
Path default directory path is: “<Data Files>”. By default, “<Data Files>” points to C:\MTS
TestSuite\Data Files.
You can set the default directory path in the Configuration window (Preferences >
Configuration > Project > Data Export Directory).
Folder Defines whether the application saves the data file in a new folder or overwrites an
Save existing folder.
Format Defines whether the data is written as tab delimited text or comma separated values.
Unit Set Defines the unit set in which the data is written.
Data Defines the DAQ (data acquisition) activities whose data will be included in the data
Acquisition export. Each data export activity selected will result in a separate export file.
List
Signal List Defines which signal data will be included in the data export file.
Combine Writes peak and valley values side-by-side in different columns on the same line to
Peak- facilitate comparison.
Valley on
One Line
Filter Writes a single minimum and a single maximum value to the data file. This feature is
Minimum- useful if you want only the single-most minimum and the single-most maximum values
Maximum in instances where the application produces multiple values for each (due to looping
Data or restarting the test).
If this feature is not enabled, the data file will contain a minimum and a maximum value
for each time activity run during the test
Displays
A Display is a convenient way to save the layout of the Review tab including the number of panels,
panel sizing, and the views associated with each panel. Once saved, use the Display Manager window
to select and manage displays.
Save a Display
To save a display:
1. Arrange the layout and appearance of the charts and tables in the Review tab.
2. Click the Actions drop-down list and click Display and then Save Display As.
1. Click the Actions drop-down list and click Display and then Switch to Display.
2. On the Display menu, click a previously saved display.
Delete a Display
To delete a display:
1. Click the Actions drop-down list and click Display and then Open Display Manager.
2. Use the Display Manager window to delete a previously saved display.
1. Open the TestWorks 4 converter from Start menu > All Programs > MTS TestSuite >
TestWorks 4 Converter.
2. Click the radio button for Test or Template conversion.
3. If applicable select any of the following options:
A. Convert for TW Essential—Creates a template that is editable in the
MTS TestSuite TWE application.
B. Omit disabled segments—Any disabled test segments in the TW4 method will not
be converted into the resulting template.
C. Omit disabled inputs and formulas—Any disabled input or formula int he TW4
method will not be converted into the resulting template
4. Save to the default file location, or click Change and browse for a different folder.
5. Drag your method or sample file or folder onto the converter window.
6. After the conversion process is complete, you will see a message indicating success or failure.
Once converted, the test or template is stored in a sub-folder with the same name in the
default file location.
7. Open the converted test or create the test from the converted template and verify the
conversion results.
Note: When you import the file, the imported resources may not map to the controller resources
of the control system networked with your session or workstation. You will have to correct these
resource validation errors before using the test. For more information about resources, see
“Working with Resources” on page 94.
Before you import the file, verify the following:
l The MTS TestSuite template must have the same name as the TestWorks 4 method and be
placed in the templates folder (by default, it is C:\MTS TestSuite\Templates).
l TestWorks 4 Global variables must be found in the Common variables section in the loaded
template or an error will be generated and the import process will stop.
Overview
Configuring MTS TestSuite TW to communicate with a Eurotherm 2000 Series Temperature
Controller consists of five steps.
1. Connecting to the computer
2. Configuring the external device file
3. Importing controller resources
4. Adding meters
5. Adding temperature control to the procedure
Note: To communicate with a single Eurotherm 2000 Series Temperature Controller, use
Configuring the External Device File for EI-Bisynch Single Zone. To communicate with
more than one Eurotherm 2000 Series Temperature Controllers, use Configuring the
External Device File for EI-Bisynch Multi-Zone. Configured external device files can be
exported and imported onto a different system.
8. Change the Data bits to 7, the Parity to Even, and click Advanced.
10. Verify that the Driver tab is similar to the following image.
11. Verify that the Details tab is similar to the following image.
2. In the External Devices window, click the plus sign to add an external device file.
3. In the Select Device Type window, select Eurotherm 2000 Series Temperature
Controller EI-Bisynch.
4. On the Device Configuration tab, use the drop-down menu to select the appropriate serial
port. Verify the Device Address. Typically, for a single zone system the Device Address is
1.
7. On the Signal Settings tab, verify that the Unit selection is the same as the Eurotherm units.
8. On the Device Verification tab, select the Read Temperature command and click Send
Command to verify communication.
Note: Each Eurotherm 2000 Series Temperature Controller controls one temperature zone.
1. On the Controller menu, click External Devices.
2. In the External Devices window, click the plus sign to add an external device file.
3. In the Select Device Type window, select Eurotherm 2000 Series Temperature
Controller EI-Bisynch.
4. On the Device Configuration tab, use the drop-down menus to select the appropriate serial
port and set the Device Address to <none>.
6. On the Command Settings tab, add commands to read temperature and set setpoint using
variable for each temperature zone. The command to read temperature is PV. The command
to set setpoint using variable is SL{0}. The address of the device for each temperature zone
precedes the command: 1PV, 1SL{0}, 2PV, 2SL{0}...
For the read temperature commands, add a descriptive Command Name, add the
Command, check Supports Return Value, and add the Regular Expression Pattern: ^
[-]?\d+[.]?\d*$
For the set setpoint using variable commands, add a descriptive Command Name, add the
Command, and select the Wait for Acknowledgment check box.
7. On the Signal Settings tab, add a signal for each read temperature command added on the
Command Settings tab.
Add a descriptive Internal Name and Display Names. Use the drop-down menus to set the
Dimension to Temperature, to set Unit to match the units used by the Eurotherm, and to
select the appropriate Read Temperature command for Query Command.
8. On the Device Verification tab, use the drop-down menu to select each Read Temperature
command and click Send Command to verify communication.
2. In the Import Controller Resources window, expand External Devices and check
Eurotherm 2000 Series Temperature Controller, and expand Float Signals and check
the read temperature signals configured on the Signal Settings tab of the external device file.
Note: Ensure that you select the read temperature signals and not the read
temperature Command signals.
Adding Meters
To add meters for temperature float signals from a Eurotherm 2000 Series Temperature Controller:
1. Right-click a meter and select Add Meter > More.
2. In the Meter Configuration window, click Source to show the signals first. Scroll down to the
temperature signals. Click the arrow to add the temperature signals to the list of meters. Click
Apply to add the meters. Click OK to close the Meter Configuration window.
2. Drag and drop a Temperature Control activity to the left path of the Parallel Paths activity.
Drag and drop a DAQ activity to the right path.
C. Configure the Temperature Warning Limits. Only the Maximum Fluctuation and
Warning Action are required. The Zone Gradient becomes active when a second
4. Configure the DAQ activity Properties by setting the Trigger List and Signal List.
5. Set the Temperature Control activity as the Terminal Paths for the Parallel Paths activity.
6. To monitor temperature during the test, add a Temperature Control activity to the Parallel
Paths activity containing the Command activities.
8. Add temperature signals to the DAQ activity that is in parallel with the Command activity.
9. Observe that initially the Load (blue line) does not respond to the Load Command (red line)
until the kP_Load variable is increased.
Note: The maximum speed for metals is about 1 mm/min. The maximum speed for
rubber is about 10 to 100 mm/min.
10. Increase the value of kP_Load by a factor of 10 and click OK until a response is seen. Then
increase the value more gradually.
For example: 0.0010 OK; 0.010 OK; 0.1 OK, 0.2 OK...
4. Add the Yes/No variable to the Input Variables activity in the Run section fo the Procedure.
5. Drag and drop an If-Else Condition activity below the Input Variables activity.
6. Set the If-Else Condition to true when the Yes/No variable is Yes.
7. Drag and drop a Read Data activity to the True path of the If-Else Condition.
9. Select the Command activity that is using the Advanced Rate Control or HD Control mode.
10. In the Command activity Properties, select the control mode and check Use Tuning
Parameters.
12. In the PID Parameters window, change the tuning parameters to variable selection.
13. To create variables for each tuning parameter, use the drop-down menu and select <new
variable>.
14. Change the Identifier, Display Name, and set the Default Option to Use Previous Test
Run Value. Ensure that the Identifier matches exactly the Identifer of the corresponding
variable in the XML file.
Overview
This appendix describes how to use the video capture features available in MTS TestSuite applications
to add and configure a basic video recording to the MTS EM Tension (Simplified) template when
using MTS TestSuite TW. The customized test procedure will record video of the test’s Go To + DAQ
+ Detection activity (including when the break index is reached).
Note: To use the video recording features in MTS TestSuite applications, the
Custom.VideoCapture license must be activated. If you do not have this license activated, the
Record Video activity will not be available in the test procedure toolbox. For more information
about purchasing this license, contact your local MTS sales and service office.
You can record video of test runs using the video recording features available in MTS TestSuite
software along with one or more USB video devices.
After you plug the USB video device into the PC running MTS TestSuite software, the software will
recognize the video device. Then, you can customize several options for the video recording, such as
frame rate and resolution. When you are finished configuring the camera options, you can add one or
more Record Video activities and select to record:
l Continuously throughout the entire test.
l In parallel with other test activities, such as the Go To activity.
l One or more video frames.
l For a specified duration of time.
After you have gathered the data from the test run, you can display the data in a chart alongside the
video recording. You can synchronize the recorded video to acquired test data (displayed in charts),
which allows you to observe what happened to your specimens at any point during the test run.
Video recording features are also available in MTS TestSuite MP. The procedure for adding video
recording is similar to the procedure for adding video recording to MTS TestSuite TW. However,
instead of adding the video recording activity as a branch in a parallel activity alongside a Go To
activity, you would add it alongside the Cycle, Dwell, Ramp, or other activities available in MTS
TestSuite MP that you want to record. However, if you are recording a full video of a very long cyclic
test, keep in mind that the recorded file may be extremely large. So, you may want to design your test
to only record during certain points of interest.
5. In the test procedure, expand the Parallel Paths activity by clicking the + in the top left corner
of the activity.
6. Right-click inside the expanded Parallel Path activity and select Add Branch.
7. Click and drag the Record Video activity from the Toolbox into the new empty branch.
Note: If you want to record video of the entire test procedure (instead of only the Go To
+ DAQ + Detection activity), enable Record this video set continuously for the
entire test run. In this case, you do not need to add a Record Video activity to the test
procedure.
Note: You can also edit video sets by clicking the ellipsis (...) next to the Video Set
drop-down menu or by clicking Tools > Edit Video Sets in the menu bar at the top of
the application.
4. Click OK to save your settings and close the Video Sets window.
Note: For more information about the Record Video activity and the Video Sets
window settings, see “Record Video Activity Properties” on page 336.
Tip: If you are using multiple cameras, you could add a Video for each camera and
organize them on the Test-Run Display as follows:
5. Select the new Video you added. On the Properties panel on the right side of the screen,
select a Video set and Camera to use when capturing data. If you want to edit the video set,
click the ellipses (…) next to the Video set field on the Properties panel. For more
information about editing video sets, see “Create and Configure a Video Set” on page 618.
3. In the Display Window Name window, enter a name for the new video chart (optional) and
click OK.
4. Right-click the new video chart and select Configure Chart.
5. In the Configure Chart window that appears, select a video set.
6. Enable X-axis data and select Extension from the list.
7. In Y-axis data, select Load.
8. In Time data, select Time.
9. Click OK. The Load versus Extension chart containing video now appears on the Review tab.
Video Chart
Note: The MTS TestSuite Reporter Add-In software option is required to make changes to the
Test-Run Report template.
There are 5 steps to create the Example Scenario: One Camera template:
1. Modify the Procedure.
2. Add video to the Test-Run Display.
3. Add variables.
4. Modify the report template.
5. Add a video chart to the Review page.
6. In the Parallel Paths activity Properties, remove the Break Detection: Load from
Additional Terminal Activities.
7. Right-click inside the Parallel Path activity and select Add Branch.
11. Configure the DAQ activity by setting the Sample Rate to 10 Hz and adding signals to the
Signal List.
12. Connect the USB video device and wait until the operating system recognizes the USB video
device.
13. Configure the Record video activity by selecting <new video set>.
14. Configure the video set by setting Time Synchronization Signal to Time, select the
Source, and set the Continuous Frame Rate to 10 Hz.
15. Expand the Parallel Paths activity containing the Command activity.
17. Disable the DAQ activity by clicking to clear the Enable Path check box.
18. Drag and drop a Dwell activity before the Parallel Paths activity containing the Command
activity.
20. Drag and drop a Dwell activity after the Parallel Paths activity containing the Command
activity.
5. Resize the canvas under the chart to make space for the video.
6. Double-click the Video icon ( ) from the Toolbox to add it to the Test-Run Display.
7. Drag the video object to the desired location on the Test-Run Display.
8. If desired, resize the video object.
Adding Variables
To add variables:
1. Select the Define page.
2. Select the Variables tab.
4. In the New Variable window, enter the variable identifier and click OK.
5. In the new variable’s Properties, set Dimension to Count and Unit to (count). Under
Calculation, select the Is Calculated check box.
7. In the Calculation Editor window, add the calculation SizeOfArray(_LoadArray)-1 and click
OK.
Note: The calculation SizeOfArray(_LoadArray)-1 will return the array index of the
last entry to the array _LoadArray. MTS TestSuite array indexes start at 0.
Note: The MTS TestSuite Reporter Add-In software option is required to make changes to the
Report Template.
1. Select the Define page.
2. Select the Report Templates tab.
3. Under Test Run, select the Default Test Run Report and click the edit icon.
8. In the peak video image Properties, select the Video Set and Camera. Select the Select
image by marker button. Set the Time array to Time and Marker to Peak Index.
10. In the list of variables, expand Peak and drag and drop Peak Load to the location for the peak
video image label.
11. In the Peak Load Properties, set Display to Display name, value with unit in adjacent
cells.
14. In the break video image Properties, select the Video Set and Camera. Select the Select
image by marker button. Set the Time array to Time and Marker to Break Index.
16. In the list of variables, expand Break and drag and drop Break Load to the location for the
break video image label.
Note: Ensure that the variable Break Load is enabled in MTS TestSuite software.
17. In the Break Load Properties, set Display to Display name, value with unit in adjacent
cells.
18. Select the location for the after break video image.
19. Double-click Video Image.
20. In the after break video image Properties, select the Video Set and Camera. Select the
Select image by marker button. Set the Time array to Time and Marker to After Break.
22. In the list of variables, expand Variables and drag and drop After Break to the location for
the after break video image label.
28. Select the new report template and select the check mark to set as the Default.
l Capture video from one camera from 1 second before testing until a specified load.
l Capture video from two cameras from a specified load to 1 second after break.
l Show video from both cameras in the Test-Run Display during testing.
l Show the video charts on the Review page.
l Generate a test-run report showing video images for peak, break, and 1 second after break.
Note: The MTS TestSuite Reporter Add-In software option is required to make changes to the
Test-Run Report template.
There are 5 steps to create the Example Scenario: Two Cameras template:
1. Modify the Procedure.
2. Add video to the Test-Run Display.
3. Add variables.
4. Modify the report template.
5. Add a video chart to the Review page.
6. In the Parallel Paths activity Properties, remove the Break Detection: Load from
Additional Terminal Activities.
7. Right-click inside the Parallel Path activity and select Add Branch.
9. Configure the DAQ activity by setting the Sample Rate and adding signals to the Signal List.
10. Right-click inside the Parallel Path activity and select Add Branch.
11. Drag and drop a While Loop activity to the new branch.
12. Drag and drop a Parallel Paths activity below the While Loop activity.
13. Drag and drop a Record video activity into the While Loop activity and to each path in the
Parallel Paths activity.
14. Configure the Condition for the While Loop activity Properties.
15. In the Calculation Editor window on the Variables tab, click the plus sign to add a new
variable for the specified load.
16. In the New Variable window, enter a descriptive Identifier and Display Name, set the
Dimensions to Force, and set a Default Value.
17. In the Calculation Editor window, add the calculation Signal("_Load")<SpecifiedLoad and
click OK.
18. Connect the USB video device and wait until the operating system recognizes the USB video
device.
19. Configure the Record video activity in the While Loop activity by selecting <new video
set>.
20. Configure the video set by setting Time Synchronization Signal to Time, select the
Source, and set the Continuous Frame Rate.
21. In the Parallel Paths activity, select the Record video activity on the left path.
22. Configure the Record video activity by selecting the video set configured in Step 20.
23. Select the Record video activity on the right path.
24. Configure the Record video activity by selecting <new video set>.
25. Configure the video set by setting Time Synchronization Signal to Time, select the
Source, and set the Continuous Frame Rate.
26. Expand the Parallel Paths activity containing the Command activity.
28. Disable the DAQ activity by clicking to clear the Enable Path check box.
29. Drag and drop a Dwell activity before the Parallel Paths activity containing the Command
activity.
31. Drag and drop a Dwell activity after the Parallel Paths activity containing the Command
activity.
5. Resize the canvas under the chart to make space for the video.
6. Double-click the Video icon ( ) from the Toolbox to add it to the Test-Run Display.
7. Drag the video object to the desired location on the Test-Run Display.
8. Repeat Steps 6 and 7.
9. If desired, resize the video object.
10. In the Video Properties, select the Video set and Camera.
Adding Variables
To add variables:
4. In the New Variable window, enter the variable identifier and click OK.
5. In the new variable’s Properties, set Dimension to Count and Unit to (count). Under
Calculation, select the Is Calculated check box.
7. In the Calculation Editor window, add the calculation SizeOfArray(_LoadArray)-1 and click
OK.
Note: The calculation SizeOfArray(_LoadArray)-1 will return the array index of the
last entry to the array _LoadArray. MTS TestSuite array indexes start at 0.
Note: The MTS TestSuite Reporter Add-In software option is required to make changes to the
Report Template.
1. Select the Define page.
2. Select the Report Templates tab.
3. Under Test Run, select the Default Test Run Report and click the edit icon.
8. In the peak video image Properties, select the Video Set and Camera. Select the Select
image by marker button. Set the Time array to Time and Marker to Peak Index.
10. In the list of variables, expand Peak and drag and drop Peak Load to the location for the peak
video image label.
11. In the Peak Load Properties, set Display to Display name, value with unit in adjacent
cells.
14. In the break video image Properties, select the Video Set and Camera. Select the Select
image by marker button. Set the Time array to Time and Marker to Break Index.
16. In the list of variables, expand Break and drag and drop Break Load to the location for the
break video image label.
Note: Ensure that the variable Break Load is enabled in MTS TestSuite software.
17. In the Break Load Properties, set Display to Display name, value with unit in adjacent
cells.
18. Select the location for the after break video image.
19. Double-click Video Image.
20. In the after break video image Properties, select the Video Set and Camera. Select the
Select image by marker button. Set the Time array to Time and Marker to After Break.
22. In the list of variables, expand Variables and drag and drop After Break to the location for
the after break video image label.
28. Select the new report template and select the check mark to set as the Default.
Internal Name 95 M
International System of Units (SI) 89
interrupt main window 29
cycle and custom waveform stop 313 Manage User Accounts window 64
interrupt command manually mapping variables
custom waveform stop 313 data acquisition 201
cycle waveform stop 313 manuals 17
map variables 205
J automatically map variables 158
save data to variables settings 158
Jog button 86 mapping variables
K data acquisition 160, 200-201
markers
keyboard shortcut 82 add and remove 566
keyword edit 566
variable 378 handset 565
invalid 566
L moving 566
moving invalid markers 567
left (extract SubString) function 275
run-time 564
license
variable 564
removing 59
markers and marker lines 553
License Administrator 59
Math functions
Licensing Utility 56
average 251
Limit Detection activity 346
Max/Min DAQ activity 332
limit line 541
Maximum Values property
Limit Types
Max/Min DAQ activity 334
General XY 455, 473, 492
MeasInelasticStrainMax function 231
Horizontal 454, 472, 491
MeasInelasticStrainMin function 232
Horizontal at Index 456, 474, 493
Menu bar and Quick Access panel 30
Vertical 455, 473, 492
message
Vertical at Index 457, 475, 494
procedure 56
line and symbol
message log
properties 425, 432, 439, 451, 458, 470,
description 45, 47
489, 541
meter
linear buffers
signal 486
data acquisition 150
variable 468-469
load control 360, 602
meters
Loading Modulus function 211
add meter 49
log message
change color 51
how to use 394
change decimal places 51
Log Message activity 393-394
change font 51
Log property
change sensitivity 51
Limit Detection activity 347
change type 50
change unit type 50
configure 50
switching 539
Visibility property
Periodic Time Event activity 368
W
Wait activity 409
Wait for Event activity 349
Wait for Operator Action activity 383
Wave Shape property
Cycle activity 311
waveform
stop behavior 313
While Loop activity 373
window
add custom unit set 89
copy unit set 89
edit custom unit set 89
edit function 280
TW Elite Application 29
Window Size > Height property
Custom Message Window activity 295, 376
Window Size > Width property
Custom Message Window activity 295, 376
workarea 30
workflow 122
Write Variables to File activity 395, 410
X
XML
Read Variables from File activity 395
write variable values to file 410
XML format 410
Y
Y-axis properties 428, 435, 442, 459, 476,
495, 543
Yes, automatically map variables property
data acquisition 306, 315
Yes, manually map variables property
data acquisition 306, 315