Caefatigue Vibration (CFV) : Installation and Operations Guide
Caefatigue Vibration (CFV) : Installation and Operations Guide
INTRODUCTION
STYLEREF "Heading 1" \* MERGEFORMAT
www.caefatigue.com
Disclaimer
CAEfatigue Limited reserves the right to make changes in specifications and other information contained in this document
without prior notice.
The concepts, methods, and examples presented in this text are for illustrative and educational purposes only and are not
intended to be exhaustive or to apply to any engineering problem or design. CAEfatigue Limited assumes no liability or
responsibility to any person or company for direct or indirect damages resulting from the use of any information contained
herein.
This notice shall be marked on any reproduction of this documentation, in whole or in part. Any reproduction or distribution of
this document, in whole or in part, without the prior written consent of CAEfatigue Limited is prohibited.
This software contains certain third-party software that is protected by the 3rd party software suppliers own copyright and is
being licensed from those suppliers. A list of third-party suppliers is listed in the Appendix.
Please consult readme file that comes with installation package for latest documentation updates.
INTRODUCTION
STYLEREF "Heading 1" \* MERGEFORMAT
Table of Contents
1 INTRODUCTION .................................................................................................................................................... 4
1.1 Using This Document...................................................................................................................................................... 5
1.2 System Requirements..................................................................................................................................................... 5
1.3 CFV Licensing................................................................................................................................................................. 5
INTRODUCTION
STYLEREF "Heading 1" \* MERGEFORMAT
1 INTRODUCTION
INTRODUCTION
STYLEREF "Heading 1" \* MERGEFORMAT
The CAEfatigue VIBRATION program (CFV) is an application that reads an input control file and results files from a variety of
CAE (Computer Aided Engineering) programs, such as OP2 files from Nastran, RST files from ANSYS and ODB files from
Abaqus. CFV calculates a variety of values from the stress values obtained from the CAE results files. The CFV program
performs these calculations in “batch” or background mode and, on Windows platforms, may be monitored through our GUI
interface (CAEfatigue GUI-CFG). This document describes the installation and operation procedures for running the CFV
program and supporting files, noting that, since the CFV program itself is a “batch” or background program, none of its results
are available until its processing has completed. Note, the Windows version of CFV includes a Graphical User Interface (GUI)
utility (CFV.exe) that provides many support functions, including running the CFV program itself along with a variety of plotting
and other analysis tools. See the User Guide for more information.
Within the rest of this document, references to <ver> will represent the current version and will normally mean 2019.
• For Windows, Windows Vista64 or later is supported. The Graphical User Interface support program also
requires the Microsoft .NET 4.5 (or later) framework. Note that this will be installed automatically if it is not
already installed.
• For Linux, Centos 6.5 or later, SuSE 11 or later, RHEL 5.5 or later and compatible systems are supported.
The system should have a minimum of 2GB RAM. Approximately 1GB of free disk space is
required for the installation and additional disk space will be required to run the CFV application
although it is highly recommended that 8GB RAM be available.
The term “directory” is used throughout this document and is equivalent (in almost all cases) to the term “folder” that is
frequently used in Window documentation.
The most common way to install CFV on Windows, is to run the installation file provided by CAEfatigue Limited.
These files may be run by selecting them in a Windows Explorer screen or from a command prompt. If these files are run from a
command prompt, you may also specify “/quiet” as a command line option that will tell the Windows Installer program to skip
displaying the initial “Please wait while Windows configures CAEfatigue” message box. If desired, you may run the installation
file from a command prompt by explicitly using the system msiexec program as follows:
Note: It is recommended that the installation file be run as an Administrator. Otherwise, User Access Control may ask you if you
want to run the installation file.
2.1.2 Installaton using the Graphical User Interface (GUI) - for Windows ONLY
Download the MSI installation file provided by CAEfatigue Limited to a location on your PC/laptop that has read/write access.
The example below is for installing CFV but it is also applicable for installing CFG4N (CAEfatigue GUI for Nastran).
1) Double click on “CAEFatigue_<ver>.msi” file to begin the installation. Depending on the protections in place on your
Windows device, you may see the following. If so, select “More Info” and then select the “Run anyway” button.
=>
3) Next, you will see the CFV Installation Wizard. Select “Next” to continue. This example is for CFV V3.1.2.
6) Installation can be EXPRESS or CUSTOM. Select EXPRESS if you do not wish to change default values (go to step 7).
Otherwise, select CUSTOM and hit “Next” to continue.
6A) For CUSTOM installation you will have the following choices. Note: It is very important to make sure the TPL directory is
in a location that has both read and write privileges.
=>
7) OPTIONAL: If desired, enter the locations for Abaqus Path and (NODELOCK) License File.
The Abaqus Path is an optional entry if you plan to use Abaqus as your stress solver. You can also enter this
information at a later time after the software is installed if you wish. Using this entry will create an extra file
(caefatigue_opts.bat) in your installation directory.
The License File is an optional entry if you are using a NODELOCK license. This entry allows you to copy the nodelock
license file directly into the appropriate CAEfatigue directory. This can also be done at a later time after the software is
installed.
PLEASE NOTE: When using a SERVER license, do not check the “Copy License File to Program Files directory”
check box (see below). Instead, you must create a User Environment Variable called CAEFATIG_LICENSE_FILE and
set it equal to <port_number>@<Host_Name>. You can get this information using LMTOOLS on the server
machine. This is described as the last step in the FlexLM license server installation later in this guide.
Check this box if you plan to use a Do not check this box if you plan to
NODELOCK license. use a SERVER license.
OR
If you checked the License box you will If you checked the Abaqus box you will
see the following window: see the following window:
=>
9) When complete, you can choice to see the latest Release Notes. Hit “Finish” to complete the installation process. A CFV
icon should be on your desktop. This example shows the icon for CFV version 3.
10) If you are using a NODELOCK license proved by CAEfatigue Limited and you did not copy the license file into the
Program File directory (see Step 7), then you must manually copy the license file into the Program Files directory.
Locate the license file proved by CAEfatigue Limited and copy the file into the default directory c:/Program
Files/CAEfatigue. Note: this location may be different if you changed the location as part of a Custom Install.
11) If you are using a SERVER license provided by CAEfatigue Limited, you must tell CFV where the server license file can
be found. This is done by creating a User Environment Variable called CAEFATIG_LICENSE_FILE and setting it equal
to <Port_Number>@<Host_Name>. You can get this information from using LMTOOLS on the server machine. The
operation of LMTOOLS is described in the FlexLM license server installation section later in this guide.
For the HW version, you must ensure that the Altair HyperWorks License Manager is running and that one of the
LMX_LICENSE_FILE or ALTAIR_LICENSE_FILE environment variables are set. The CFV run scripts determine that the
HyperWorks CFV version is to be run by checking that one of these environment variables has been set. Environment variables
are set as described above.
The CFV for Windows installation files are built using the Inno Setup installer tool (http://www.jrsoftware.org/isinfo.php) and
converted to Windows MSI format using the MSI Wrapper Professional program (http://www.exemsi.com). One of the features
of installation files built using the Inno Setup installer tool is that, in addition to the standard interactive GUI installation method,
a “command line” installation method is available that includes the option of performing a “silent” installation.
The “silent” mode can be useful in situations where application installations are performed using scripts instead of using the GUI
interface. This includes installations performed using the Microsoft Group Policy Object procedures. In this mode, the GUI
screens of the normal installation process are not displayed, and all of the installation information is specified on the command
line and, optionally, in associated text files. While this mode is applicable to both local and remote installations, it is probably
most useful for remote installations where the CFV application is to be installed on one or more remote systems. Also, there are
restrictions in that this “silent” installation procedure does not allow the selection of options such as adding the installation
directory to the path, specifying the Abaqus Library directory or copying a license file to the installation files. It does, however,
allow the specification of custom installations where only some of the CFV components are installed.
In the descriptions below, the fully-qualified path to the installation file name followed by the installation file name itself is to be
substituted for the string <CAEFINST>. Just as described above, since the installation files are MSI files, they may be invoked
directly:
In the descriptions below, the first format is used for simplicity. It is important to note that if any of the desired options include
embedded blanks, the option must be enclosed in doubled quotes since the options themselves are included in quotes. For
example, if the /dir option is to be used and if the directory to be used contains embedded blanks, e.g. q:\caefatigue inst dir,
then the specification within wrapped arguments would be
Note: If the “wrapped_arguments” command line option is omitted, the normal GUI installation procedure is performed.
This option might be useful if a CFV installation is to be performed using a script that may also install other applications and that
might be used if an entire set of applications are being installed or reinstalled on a system. It also might be useful if there are
multiple systems that have the same configuration and a simple command line is desired, where all the installation options are
specified in a text file. It is important to note that the CFV installation files support the installation of CFV in a network location,
i.e., an installation directory starting with “\\network_name”, regardless if the installation is done in GUI mode or in command line
mode.
To perform a full CFV installation into a specified directory (see comments above about specifying options containing embedded
blanks):
Note, too, that the /saveinf= option can be specified in GUI installation mode, i.e., where /verysilent or /silent is not specified.
This can be used to capture desired options for use in the examples shown here.
To perform a custom CFV installation into a specified directory, requesting only the exe and user_docs components:
To perform a CFV installation using a previously saved information file and using the same options:
Probably the most important component of any remote installation procedure is determining how to access the remote systems.
Perhaps the most common method is to use the Microsoft Group Policy Object (GPO) process available through Active
Directory. Another method is to use direct remote system access using utilities such as the Microsoft psexec utility or using
third-party solutions involving, for example, telnet/ssh implementations, PCAnyWhere, etc., that allow direct access to the
remote systems. Describing the implementation of third-party solutions is well beyond the scope of this documentation. The
psexec utility is provided as part of the Microsoft Sysinternals set of utilities. This utility is very similar to telnet in that it is used
to run programs on remote systems while maintaining standard Windows authentication. It is documented at
https://technet.microsoft.com/en-us/sysinternals/bb897553.aspx and can be downloaded from
https://download.sysinternals.com/files/PSTools.zip.
Regardless of the remote installation method used, there may be issues related to the Windows UAC (User-Access Control)
facility, Group Policies, firewalls, etc. Solving these issues is beyond the scope of this documentation and should be resolved in
conjunction with the technical staff at the installation site.
When using GPO, if the <CAEFINST> file is specified when the GPO is defined, a standard GUI installation will be initiated on
each of the remote systems. If, however, a “silent” installation is preferred, installation options can be passed to the
<CAEFINST> MSI file using “transforms” (MST files) that can be connected to the MSI file when the GPO is defined. The
following MST files are available from CAEfatigue Limited in a file named caefatigue_transforms.zip located at the same location
where the <CAEFINST> installation file is located. The transforms available in this file are:
$ caefatigue_quiet.mst
This transform specifies that the
“/sp- /verysilent /suppressmsgboxes”
command line options are to be used. This will install CFV quietly using all default options.
$ caefatigue_exe_only.mst
This transform specifies that the
“/sp- /verysilent /suppressmsgboxes /type=custom /components=exe”
command line options are to be used. This will install CFV quietly using the default location with only the EXE
component installed.
It is also possible for a site to build a customized transform that could specify, for example, a /dir= option that would over-ride
the default installation directory. The Orca utility, available from Microsoft as part of the Windows SDK, can be used to build
customized transforms. There are other third-party utilities that could also be used but a discussion of these is beyond the
scope of this document. The following prototype transform is included in the caefatigue_transforms.zip file that can be modified
to build the customized transform. Note that this transform cannot be used directly since it specifies
“/dir=<your_install_directory>” and this, clearly, is not a valid installation directory. A description of how to modify this transform
using Orca is given below.
$ caefatigue_quiet_with_dir.mst
Describing how to create Group Policy Objects is beyond the scope of this document. However, the following Microsoft
references may be of use:
https://msdn.microsoft.com/en-us/library/bb742376.aspx
https://technet.microsoft.com/en-us/library/cc754740.aspx
Another reference that, while specific to the Symantec™ Corporation, gives a useful guide to using a transform, along with tips
and caveats, is:
http://www.symantec.com/connect/articles/creating-transform-mst-file-control-installation-symantec-endpoint-protection
You may now build the Group Policy Object using the modified transform. Here is a simplified description of how to do this (as
extracted from the Symantec reference given above):
1. Create a new Software Installation Package in the Computer Settings node of Group Policy Object Editor.
2. Select the <CAEFINST> MSI file. Note that the full path to the MSI file must be specified.
3. Click Advanced. (This is the ONLY opportunity you will have to apply a Transform to this Package.)
4. On the Modifications tab, click Add and select the MST file you created.
There are several ways in which CFV can be installed and run on multiple systems as long as each system is on a common
network and can access a shared file system on that network.
As described above, installing CFV on remote systems requires the use of utilities to access these systems. The examples
below assume that the psexec utility is being used (possibly in conjunction with the runas command).
1. Install CFV on the shared file system and instruct the users how to access the installation either:
a. by defining a shortcut on the desktop for each system that points to the shared file location for the GUI interface
program, CFV.exe. This can be done using third-party software from sites such as
http://www.optimumx.com/download/Shortcut.zip. This option allows the user to specify the CFV input file to be run
using a GUI interface.
b. by creating a script on each system that runs the caefatigue.bat located on the shared file system. A possible very
simple version of this script could be: @call \\network_loc\caefatigue\caefatigue.bat %* where
\\network_loc\caefatigue specifies the actual installation location on the shared file system.
c. by defining a DOSKEY macro that accesses and calls the shared file location for the caefatigue.bat file. The
command to define this macro could be: doskey caefatigue=\\network_loc\caefatigue\caefatigue.bat again, where
Examples:
In the examples below, the fully-qualified path to the psexec command itself is to be substituted for the string <PSEXEC>. If a
network-accessible installation file is to be used, e.g., \\netfile\instfiles\caefatigue_<ver>.exe, it is represented by
<CAEFATIGUE> in the examples. If a network-accessible installation is to be used, i.e., where CFV has been installed on a
network-accessible location using either the GUI interface or the command-line interface, this location is represented by
<CAEFINST> in the examples.
1. Install CFV locally on two systems, HOST1 and HOST2, into the directory c:\CAEF, from a network-accessible installation
file. All installation components are to be installed.
2. Same as example 1 except that only the exe and user_docs components are to be installed.
3. This example assumes that CFV has been previously installed in a network-accessible location, e.g. where <CAEFINST>
is \\NETFILE\CAEFATIGUE. It also assumes that the shortcut utility is located at \\netfile\shortcut\shortcut.exe. A shortcut
is to be defined on the desktop on two systems, HOST1 and HOST2, that points to the CAEfatigue GUI program,
CFV.exe:
As stated above, the CFV Installation executables are created using the Inno Setup Installer tool. The generated installation
files accept a number of command line options that can be used to control the installation process. The following lists the
command line options pertinent to a CFV installation. Note: The complete list of command line options can be found at the Inno
Web site (http://www.jrsoftware.org/isinfo.php). Note: All command line options are case-insensitive.
/HELP, /?
Shows a summary of this information.
/SP-
Disables the “This will install... Do you wish to continue?” prompt at the beginning of Setup.
/SILENT, /VERYSILENT
/SUPPRESSMSGBOXES
Instructs Setup to suppress message boxes. Only has an effect when combined with '/SILENT' or '/VERYSILENT'. The
default response in situations where there's a choice is:
Yes in a 'Keep newer file?' situation.
No in a 'File exists, confirm overwrite.' situation.
Abort in Abort/Retry situations.
Cancel in Retry/Cancel situations.
Yes (=continue) in a DiskSpaceWarning / DirExists/DirDoesntExist / NoUninstallWarning / ExitSetupMessage /
ConfirmUninstall situation.
/NOCANCEL
Prevents the user from cancelling during the installation process, by disabling the Cancel button and ignoring clicks on the
close button. Useful along with '/SILENT' or '/VERYSILENT'.
/LOADINF="filename"
Instructs Setup to load the settings from the specified file after having checked the command line. This file can be
prepared using the '/SAVEINF=' command as explained below.Don't forget to use quotes if the filename contains spaces.
/SAVEINF="filename"
Instructs Setup to save installation settings to the specified file. Don't forget to use quotes if the filename contains spaces.
/DIR="x:\dirname"
Overrides the default directory name displayed on the Select Destination Location wizard page. A fully qualified pathname
must be specified. May include an "expand:" prefix which instructs Setup to expand any constants in the name. For
example: '/DIR=expand:{pf}\My Program'.
/TYPE=type name
Overrides the default setup type. For a CFV installation, the valid types are “Custom” and “Full” (equivalent to “Express”).
If the specified type exists and isn't a custom type, then any /COMPONENTS parameter will be ignored.
Step 1. The self-extracting zip file is called CAEFatigue_<ver> for FlexLM and CAEFatigue.<ver>.l64.date for HW where
“date” is the date of creation of the file. Move this file to a temporary directory with read/write access and execute it.
The following files will be extracted into this directory:
Step 2: The CAEinstall.sh script is then used to do the actual installation. You have the following options:
where
<options> specifies options that modify normal script processing
<install_dir> specifies the directory where the CFV files being extracted for this invocation of the script are to be
installed. Note that this directory is the "high-level" directory and there will be sub-directories created
under this directory. If this directory does not exist, you will be asked if you wish to create it.
<Abaqus_dir> is optional and specifies the location of the Abaqus Library files to be used during CAEfatigue
execution. This directory will be validated to ensure that is for a supported Abaqus version and that it
contains the necessary Abaqus files.
The valid options (which may be specified in any order) noting that if conflicting options are specified, the last one specified will
be the one used. Note that these options are case-sensitive.
-v requests that the list of files extracted from the compressed files be displayed as they are extracted. The
default is to extract the files "quietly".
-full specifies that all CFV files are to be extracted into the specified directory. This is the default if neither -exe nor -
doc are specified.
-exe specifies that only the files required for CFV execution are to be extracted into the specified directory.
-doc specifies that only the "documentation" files, i.e., the TPL and User_Docs files are to be extracted into the
specified directory. If this option is specified, the <Abaqus_dir> option is ignored and any directory information
is not validated.
After various parameter and value verifications, the CAEinstall.sh script proceeds in the following manner:
• If the specified <install_dir> does not exist, you will be asked if you want it to be created. If you do not reply y or
Y, script processing will terminate.
• You will be asked to accept the End-User-License Agreement (EULA) specified in the
CAEfatigue_EULA_<year>.html file. If you do not reply y or Y, script processing will terminate.
• The specified files will then be extracted from the compressed files and saved in the specified <install_dir>.
• If the installation type was not -doc (i.e.., was one of -exe or -full) and if <Abaqus_dir> was specified and was
validated, a utility script (caefatigue_opts.sh) will be written to the installation directory (the directory where the
CAEFatigue script is located). This script will be used by the CAEFatigue script to automatically set the location
of the Abaqus Library files.
Notes:
• The directory containing the installation files can only contain one version of the installation files. If you wish to
keep the installation files for multiple versions, each set must be kept in a separate directory. This is validated by
the CAEinstall.sh script.
<install_dir>
Windows
Documents
lib
Net45
VTK
Wizard
Linux
TPL
User_Docs
FlexLM Only present in the FlexLM version
The contents of each directory, where a forward slash (/) is used to denote directory levels regardless of the platform and where
<ver> represents the CFV version is:
sample_nodeloc.lic a sample FlexLM node-lock license file (only present in FlexLM versions)
sample_server.lic a sample FlexLM server mode license file (only present in FlexLM
versions)
<user_license_file> the actual FlexLM license file to be used for CFV (only present in FlexLM
versions)
uns000.exe the “uninstall” program. This file should not be deleted since it is required
if the CFV package is to be uninstalled.
uns000.dat the “uninstall” program data file. This file should not be deleted since it is
required if the CFV package is to be uninstalled
<various other files> various files used as part of the installation. These may be deleted, if
desired
.
For a Linux installation:
caefatigue_opts.sh an “options” script that sets installation specific parameters. This will be
present only if Abaqus library file information was specified during
installation.
caefatig.exe The CFV specific FlexLM licensing daemon for FlexLM versions
Graphical User Interface (GUI) utility for running CFV and looking
at results.
CFVLibraryAccessALS.dll The shared object that supports the ALS Licensing system..
CFVLibraryAccessFlex.dll The shared object that supports the FlexLM Licensing system.
caefatig The CFV specific FlexLM Licensing daemon for FlexLM versions.
CFVLibraryAccessALS.so The shared object that supports the ALS Licensing system.
CFVLibraryAccessFlex.so The shared object that supports the FlexLM Licensing system.
<install_dir>/TPL Present in all standard installations and contains the Test Problem
Library (TPL) directories and files.
<install_dir>/User Docs Present in all standard installations and contains the User Guide,
Quick Reference Guide, Release Notes, Installation Guide, and
possibly other reference documents.
As mentioned in the GUI Installation procedure, using the standard installation method will install the CFV files in the following
default locations.
TPL </Documents/CAEFatigue/TPL>
User Docs </Documents/CAEFatigue/User Docs>
Note: The above assumes the “Program Files” and “Documents” directory are present, and the Installer has “read/write
permission”. The above locations can be changed during installation, if desired, using a Custom Install process.
For Windows:
• Modify the system environment variables to set the ABAQUS_PATH environment variable to specify the location
of the Abaqus library.
• Write a wrapper script that sets the environment variable and then calls the CFV caefatigue.bat script. This
method is useful if you have multiple Abaqus libraries and wish to easily select the version to be used. The
following is an example of such a wrapper script:
@echo off
@setlocal
@set ABAQUS_PATH=<location of your Abaqus library>
@call "<install_dir>\caefatigue.bat" %*
@endlocal
where <install_dir> is the directory specified as part of the installation. Save this script in a convenient location
for you to access.
For Linux:
• Set the ABAQUS_PATH environment variable in the system profile or user profile so that it specifies the location
of the Abaqus library.
• Write a wrapper script that sets the environment variable and then calls the CFV CAEFatigue script. This method
is useful if you have multiple Abaqus libraries and wish to easily select the version to be used. The following is an
example of such a wrapper script:
#/bin/bash
export ABAQUS_PATH=<location of your Abaqus library>
<install_dir>/CAEFatigue $*
where <install_dir> is the directory specified as part of the installation. Save this script in a convenient location
for you to access.
• Edit the CAEFatigue script file, locate the “** User Modifications Below **” string and change the
ABAQUS_PATH_VAL=*NOTSET* to read ABAQUS_PATH_VAL=<location of your Abaqus library>. This value
will be used later in the script to set the ABAQUS_PATH variable if it has not been set before the CFV execution
script is called.
• Add a caefatigue_opts.sh script (or edit an existing caefatigue_opts.sh script), located in the same directory as
the caefatigue.bat script, to include the following line: ABAQUS_PATH_VAL=<location of your Abaqus library>.
Make sure this script is marked “executable”, using, for example, chmod a+x caefatigue_opts.sh, if necessary.
• Note that these methods of specifying the Abaqus path information are not incompatible If you define a wrapper
script, the ABAQUS_PATH value set in the script will override any system profile or user profile set value.. If you
use the ABAQUS_PATH_VAL method and then define a wrapper script that sets ABAQUS_PATH or set
ABAQUS_PATH in a system profile or user profile, you do not have to undo your changes in CAEFatigue or
caefatigue_opts.sh. The value of ABAQUS_PATH set in the wrapper script or system profile or user profile will be
used and the value set in ABAQUS_PATH_VAL will be ignored.
The CFV script is invoked the same way on both Windows and Linux:
where
<script_path_name> specifies the path to the script and the name of the script. On Windows, the script name is
caefatigue.bat (noting that the “.bat” extension may be omitted). On Linux, the script name is
CAEFatigue (it is a bash script).
<options> specifies zero or more optional parameters used to control the script execution, where each
option must start with a dash (-) or, on Windows, with a forward slash (/). (In the list below, the
options are shown using a dash.) The most common options valid on both Windows and Linux
are:
-nocd specifies that the “current directory” is not to be changed to the directory containing the CFV
input file.
-cd specifies that the “current directory” is to be changed to the directory containing the CFV input
file. Note that the directory change will only be in effect while the CFV executable is running.
This is the default.
-nolog specifies that the stdout output from the CFV executable is not to be redirected to an “out” file
saved in the directory from which the CFV script was called. This is the default for Windows.
-log specifies that the stdout output from the CFV executable is to be redirected to an “out” file
saved in the directory from which the CFV script was called. This is the default for Linux.
-norun specifies that the actual execution of the CFV executable is to be skipped. This would normally
be used in a “debug” mode to verify that the script has been invoked correctly and that the CFV
input file exists.
-run specifies that the CFV executable is to be run after all validations have made. This is the
default.
? requests that “help” information about the script is to be printed out and actual script execution
skipped. If this option is specified, it must be the first option specified and all other options will
be ignored.
If more than one of the paired options (-nolog/-log, -norun/-run, -nocd/-cd) are specified, the last one specified will be used. If
one of the “help” options is specified, script processing is terminated after writing “help” information to stdout (i.e., the screen).
<CFV_input_file> specifies the CAEfatigue input file to be processed. This must be the last argument on the
command line.
Unless “-nolog” is in effect, the stdout output from the CFV executable is sent to an “out” file that will be in the current directory
in effect when the CFV script is invoked and that will have the name “<CFV_input_file_base_name>.out”, where
<CFV_input_file_base_name> is the name of the CAEfatigue input file with all path and extension information removed.
Notes:
• Normally the -nocd option should not be used, especially if the <CFV_input_file> specifies include files. Often, the
include file name is assumed to be relative to the <CFV_input_file> directory. If this is the case and if the current
directory is other than the directory containing the <CFV_input_file>, CFV include processing will fail.
• There are other <options> values that the scripts accept and special environment variables that can be used to control
script processing but these are primarily intended for specialized debug or other processing. There are comments at
the start of each script that explain these values and their usage. Their use is not required for normal processing.
• For Windows, the various options may be specified in any case. For Linux, the options must be specified in lower-
case.
• The first time the CFV application is run after installation, the -nolog option should be specified (note for Windows, this
is the default). This makes it easier to view any warning or error messages that may be generated by the CFV
application.
Even though there is only a single version of the CFV executable, two licensing versions are available: one using FlexLM
licensing and one using the Altair HyperWorks License Manager. The CFV scripts must determine the licensing mode to be
used and must pass this information to the CFV executable. The technique used to determine the proper licensing mode and
executable name is:
• If the CAEFATIG_LICENSE_FILE environment variable is set, FlexLM licensing mode is assumed, noting that if either
the ALTAIR_LICENSE_PATH or the LMX_LICENSE_PATH environment variable is set, processing will terminate
because the proper licensing mode cannot be determined. The “flex” command line option will be passed to the CFV
executable.
• If either the ALTAIR_LICENSE_PATH or the LMX_LICENSE_PATH environment variable is set, Altair License
Manager mode is assumed. The “als” command line option will be passed to the CFV executable.
• If none of the CAEFATIG_LICENSE_FILE, ALTAIR_LICENSE_PATH or LMX_LICENSE_PATH environment variables
are set:
• If the <script_path_name> specification has embedded blanks, the entire specification must be enclosed in double
quotes (").
• If the <CFV_input_file> name has embedded blanks, the entire name must be enclosed in double quotes (").
• There may be several problems that occur the first time you attempt to run the CFV programs.
• If you are running an anti-virus program (such as Avast) that scans executables for malware or viruses the first time the
executables are run, note that, in spite of their disclaimers, this scan may interfere with the CFV program execution. If
this scan occurs, simply let it complete, close out the CFV application and rerun it before attempting to resolve any
error messages or other problems that may occur during the scan.
• The CFV GUI application (CFV.exe) requires Microsoft .NET Framework 4.5 or later. This should have been installed
as part of the Windows installation. If it was not or if the installation failed, you may install it yourself. The installation
file is located at <install_dir>/Windows/Net45/NetFrameWorkInstall.exe or may be downloaded from the Microsoft
Web site https://www.microsoft.com/en-us/download/details.aspx?id=30653 or equivalent in other countries.
Just as with most Linux applications, CFV does not support <install_dir> or <CFV_input_file> values that contain embedded
blanks.
In order to set up a Windows FLEXLM server license manager, you must use the LMTOOLS utility to configure server so it can
manage the installation of CAEfatigue Limited server licenses. This information below assumes you have the LMTOOLS utility
installed on your server. If you do not have the LMTOOLS utility, CAEfatigue Limited can provide it for you.
1) Install CAEfatigue VIBRATION on the CLIENT machine(s) as necessary following the installation guide provided by
CAEfatigue Limited. Note: if you plan to use a SERVER license, you will ignore the step where the installation process
asks if you want to copy the license file
2) Once installed, two (2) files must be copied from a client machine to the License Server machine.
a. caefatig.exe: (located in c:/program files/CAEFatigue directory on the client machine) – This is the DAEMON file
that communicates with the license manager.
b. lmgrd.exe: (located in C:/program files/CAEFatigue/FlexLM/Windows on the client machine) – This is the license
manager that communicates with the DAEMON.
3) Copy these two files to a location on the License Server machine. Document the location because it will be needed when
configuring the License Manager through LMTOOLS utility.
5) You will need to edit the license file to add the HOST NAME and PORT number to the SERVER line in the file, i.e.
SERVER myserver <hostid> 27000. This license file was created using your Server HOST ID and this ID will already be
in the license file. It cannot be changed without creating a new license file.
a. If unknown, the HOST NAME can be found by using the command IPCONFIG /ALL in a command prompt
window (CMD). The HOST NAME is at the top of the return information. Myserver should be replace by the
HOST NAME.
b. By default, CAEfatigue Limited has chosen PORT 27000. You should confirm that this port is empty by using
NETSTAT -an | findstr 27000 in a command prompt window (CMD). The return should be empty. If not, try
successive port numbers until the return from command is empty, i.e. 27001, 27002, etc. Use the successful port
number in the license file.
7) Select the Service/License File tab, select the Configuration using Services option and then (optional) check the box
next to LMTOOLS ignores license file path environment variables.
8) Select the Config Services tab. In the Service Name drop down box, create a new service name that will manage ALL
your CAEfatigue Limited licenses. The default service name is FLEXlm Service 1 but you can rename the service to
something with CAEF in the name, perhaps FlexLM_CAEF_Service, or similar. It will be more recognizable in the future
if you are troubleshooting Windows Services.
9) While in the Config Services tab, also specify the three (3) paths below:
• Path to the lmgrd.exe file: Click the Browse button, select the appropriate file found in your Network License
Manager folder and then click the Open button.
• Path to the License File: Click the Browse button, select the license file you obtained from CAEfatigue Limited
and then click the Open button.
• <OPTIONAL> Path to the Debug Log File: Click the Browse button, select the debug log file you created
earlier and then click the Open button. A DEBUG File is a simple empty text file that can be created with a text
editor.
10) Finally, check the Use Services box and then check the Start Server at Power Up box when it appears on the Config
Services tab. This ensures that the license server will start automatically if the server has been rebooted for some
reason, such as a power outage or maintenance. Note: You must check Use Services first before you can check Start
Server at Power Up.
13) Next, you must confirm that the license server is configured correctly and running. Click on the Server Status tab and
then click Perform Status Enquiry.
14) The enquiry will display several pieces of information in the status window. Scroll down to check for the following two (2)
lines of information. The license file you are using will also be listed at the bottom of the box.
• <YourServerName>: license server UP (MASTER) v <version number> – this line tells you that the license
server is up and running and the version.
• caefatig: UP v <version number> – this line tells you that the license server has successfully read the license file,
has found no errors and has started running the service.
Note: If you do not see these two lines, the license server was not started correctly. Check to make sure you have
correctly followed the steps above including the file transfer from client to server machin and the edit made to the license
file provided by CAEfatigue Limited. IF the license server still does not start, confirm the HOST ID and contact
CAEfatigue Limited to have us reissue the license file. Having a LOG file helps CAEfatigue Limited debug any issues you
encounter.
15) Select the FILE tab and select EXIT to close LMTOOLS.
Example: CAEFATIG_LICENSE_FILE=27002@Licenseserver-3
For more detail, see Step 11 of the CFV V312 Installaton – User Guide provided by CAEfatigue Limited.
4.6 Troubleshooting
Assumptions
This troubleshooting guide assumes the FlexLM license server is installed using the LMTOOLS program with a configuration as
below. Each installation site will have a different license file and (optional) debug file. The SERVER license file provided by
CAEfatigue Limited has the following line in the file: SERVER <HOST_NAME> <HOST_ID> <PORT_NUMBER>.
The license file provided by CAEfatigue will only have the HOST_ID and a default port number set. The User must modify the
license file to set the HOST NAME and PORT NUMBER to what is applicable for their installation. This is explained in Step 5.
The User network is assumed to a layout similar to that shown below, i.e. a main License Server holds the FlexLM license(s)
that will be pulled by the CLIENT device(s) as needed when running CAEfatigue software.
Client: CAEFatigueClient1
Client:
CAEFatigueClient2
Server:
LicenseServer1
Troubleshooting Issues:
By way of example, the service issuing the license(s) in this case is called “CAEFatigue FlexLM Service”. As mentioned in Step
8, it is good to name a Service with CAEFatigue in the title (or something similar) so it is immediately recognizable when viewing
the listed services.
The Startup Type of this service is set to “Automatic (Delayed Start)” which means it will start automatically when the computer
is rebooted, and the current Status is “Running”.
Open lmtool.exe on the SERVER machine and click on “Start Server”. Once complete, check the Services winddown again to
see if the Status has changed.
If the Status has not changed, click on “Config Services” tab and click on VIEW LOG (this will only work if you chose to set up
the optional LOG file path in the setup). If the log contains the line:
It means the license file was not modified as described in Step 5, and needs to be fixed.
When the service is UP (running), open the program lmtools.exe on the CLIENT machine. Click on “Configuration using
License File” and enter the port @ host name. This is the same information specified in the CAEFATIG_LICENSE_FILE
variable.
Next, click on “Server Status” tab and select the “Perform Status Enquiry”. Ensure that the license server and the DAEMON
(caefatig) shows UP (running). Also scroll down and check that the licenses (features) listed correspond to what should be in
the Server license. If the Client machine is having difficulty communicating with the Server, you will see issues here that should
be investigated by the IT group and/or communicated to CAEfatigue Limited for support.
4. Check the Environment Variable and confirm the variable is being picked up by the CLIENT and passed to the
SERVER.
The CLIENT machine will not checkout a license from the SERVER if the license variable is not set or is set incorrectly. Check
that the license variable is correct by entering the Environment Variables definition window. If the variable is incorrect, it must
be deleted and and recreate.
Once we are sure the variable is correct, you need to check that the CLIENT machine is reading the value (license path) from
the variable and passing that along to the SERVER. To do this, open lmtools.exe on the CLIENT maching and select
“Configureation using License File“ but leave the license file settings box blank. This will force lmtools to use the value from the
environment variable.
It should show that the server is UP and all licenses should be present. If it does not, we must check that the CLIENT machine
is reading the variable you just set or is it using a stored REGISTRY variable that is wrong but is not being overwritting when
you reset the environment variable.
In these cases, the Windows registry for the variable must be deleted first before the newly defined variable can become
effective. To do this we need to go into the REGISTRY to clear old license file path(s).
Start a Windows command prompt (CMD) and type regedit to enter the registry editor in Windows. Navigate to the location
shown in the image below and delete the name CAEFATIG_LICENSE_FILE (right mouse click, delete). This will clear out any
OLD references that the CLIENT machine may be using.
Once complete, reset the CAEFATIG_LICENSE_FILE variable as described in Step 16 and perform a Status Inquiry again. If it
still does not work, contact your IT group or CAEfatigue Limited for further help.