07 10 Env
07 10 Env
1 System Environment
This section describes various aspects of the interface between
OPNET Modeler and its operating environment, including:
Related Topics
• Licensing
Components of the licensing system are not stored in the installation directory,
but rather locally, in one of the following locations:
• Windows: <primary_hard_drive>:\OPNET_license
The <primary_hard_drive> is the first drive letter (usually C:) that names
a non-removable, non-network local drive partition.
• Linux: /opt/OPNET_license
<user_models_2>
sys doc models
<user_models_n>
std
<arch> include
tutorial_ref
configs lib
vendor_models
etc reports
help schemas
op_admin
hpov tariff
images web_reports
OPNET_license
Because the installation directory stores all OPNET analysis software (including
software for different solutions, releases, and workstation architectures), there
typically is only one installation directory per installation site. Even when several
workstations are used to execute OPNET Modeler, all of the workstations can
share a single <install_dir> located on a file server (via the Network File
System, NFS, or a similar system).
When installed, new releases replace the existing files within the subdirectory,
but the top-level organization remains unchanged. The following figure depicts
this organization.
<install_dir>
<reldir>
Because sys contains all of the software, it is a resource that can be shared by
multiple users. It is also possible that more than one version of OPNET Modeler
will be present at a site, due to different machine architectures. The software for
different architectures is stored in individual subdirectories.
utilities Miscellaneous files that do not fall under any other category
<arch> include
configs lib
etc reports
help schemas
hpov tariff
icons utilities
images web_reports
sys.icons System icon database contains icons used in most GUI-based programs.
<program>.icons Separate program icon databases exist for each GUI-based program
(such as modeler or op_vuanim). These databases contain icons specific
to the corresponding program.
<name>.icons User icon databases contain user-defined icons created with the Icon
Editor.
In addition to the icons in these databases, a special “missing” icon is built into
GUI programs. A program displays this icon when it can locate neither the
specified icon (usually a user-defined icon) nor an appropriate default icon.
Models Directory
The models directory (<reldir>/models) contains the models that are
included on the release media. The organization of models, like that of sys, is
initially obtained from the release media and generally remains fixed.
You can use the models in the std subdirectory as guides or as a basis for
developing your own network models.
The organization of std is initially obtained from the release media and
generally remains fixed.
On Windows, the user home directories are located under the following
directory:
• Models Directory
• program configurations
• model backups
Because the installation directory serves as a centralized resource for all users
at a site, it is not an appropriate place to store files that are specific to a particular
user. Such files are best stored in the home directory of each user, where they
can be easily found and are protected by the user’s directory permissions. For
this reason, OPNET Modeler supports individual administration directories in
which users store their files.
• time-based backup files preserve all model files being edited at the time the
backup occurs. You can specify the backup interval (by default set at 60
minutes) with the backup_interval preference.
Note—The backup operation is not performed if OPNET Modeler is
performing another operation (such as a simulation) when it is time to
perform a backup.
• version-based backup files are created each time you modify and save an
existing model file. You can specify the number of versions saved with the
backup_max_count preference.
<model_name>_bk.<n><file_type_suffix>
<model_name>_bk.<file_type_suffix>
If a name has not been assigned to a model when a time-based backup occurs,
it has the default name unnamed. This file overwrites any older unnamed
model backups of that type.
The file suffix identifies the type of file. See File Naming Conventions on
page EI-1-20 for a list of these suffixes.
You can make a model backup a regular model file by moving or copying it into
a model directory, using one of the following commands:
% mv net1_bk.nt.m net1.nt.m
Most of the files stored in tmp have value for a limited time only, after which they
can be removed. Typically, the only files worth keeping are captured graphics
or PostScript files that must be reprinted periodically. You should move such
files from tmp and store them elsewhere to avoid accidental removal.
During periods when a great deal of printing is being performed, the temporary
directory tends to fill up with files. It is a good idea to periodically clear out tmp
using the op_clrtmp utility described in op_clrtmp on page EI-3-4.
Related Topics
• User model directories, which contain the models that you or other users
have created.
As a convenience, OPNET Modeler creates a directory named op_models
in your user home directory and adds this directory to the mod_dirs
preference. You can change this after installation, completely removing
op_models if desired.
• OPNET directories, which contain files that are included in the standard
installation. These directories include system and model files (under
<install_dir>/sys and <install_dir>/models, respectively).
These directories are described in Installation Directory (<install_dir>) on
page EI-1-3.
When the preferences file is first created, it generally lists one user model
directory as the first entry in the table. Then it lists all the standard directories in
subsequent entries:
You might find that your list of user model directories grows as you continue to
create and save models.There are two primary mechanisms for adding a model
directory:
• When you save a file in a directory that is not included in your mod_dirs list,
OPNET Modeler adds the directory automatically.
• You can also add a directory manually by choosing File > Model Files >
Add Model Directory.
Project Subdirectories
In contrast with other types of models, a project model has multiple associated
files: the project file itself, as well as network scenario files, analysis
configurations, output files, and so on. For this reason, the behavior when
saving projects differs from the behavior for other types of models.
When you save a new project for the first time—or save an old project with a
new name—OPNET Modeler does not save the project in the current directory.
Instead, it creates a subdirectory (<project_name>.project) and saves all files
associated with that project in the subdirectory. This ensures that all files related
to a specific project reside in one directory, and that different projects do not
share the same directory.
Note—You cannot save other types of files in a project directory (that is, a
directory whose ends with “.project”) because project directories are reserved
for files created as part of that project.
The following figure shows a simple user models directory. The user saved two
projects (my_App_Config_project and my_IP_project) in
c:\users\jsmith\op_models. As a result, OPNET Modeler has created
two subdirectories and stored the corresponding project files in these
subdirectories.
• Keep all files under one parent directory. This makes it easier to keep track
of all your files—you know that they are all located in that directory—and to
move them if necessary.
• Whenever you save a file in a directory that is not listed in your mod_dirs list,
OPNET Modeler adds the new directory to mod_dirs automatically. As you
add new directories, your models list becomes more complex and potentially
harder to navigate. Consider carefully where you want to save a new file. Do
you want to add a new, separate directory for this file, or store it with similar
files in an existing models directory?
Suppose you have two models named “my_node_model” that are stored in two
different model directories. For any node based on “my_node_model,” an
analysis or design operation (such as a simulation or flow analysis) uses the
model in the first directory and ignores the file in the second directory.
Note—It is good practice to specify a unique name for every file of a specific file
type (project, node model, process model, ACE Analyst file, and so on). If
OPNET Modeler notifies you that your model directories contain multiple files
with the same file type and name, we recommend that you rename files so that
all filenames are unique. This ensures that the wrong model does not get used.
If you want to keep multiple versions of the “same” model in your model
directories, you might need to open the mod_dirs preference and edit the order
of your user model directories. This might occur, for example, if you want to run
discrete event simulations for a scenario using different versions of the same
node model.
You should observe the following guidelines when organizing your model
directories (and icon database directories, which are also listed in mod_dirs):
• Do not change the “sys” and “models” sections of the table (that is, the
directories beneath <reldir>/sys and <reldir>/models. Edit only the
user model directories at the start of the list. These three sections are
illustrated in Figure 1-5 on page EI-1-12.
• Place the directory that takes precedence for new models first in the user
model directories list. The first directory in the list is the default models
directory; in some cases, OPNET Modeler saves new files here
automatically, without prompting you for a location. For more information,
see Default Model Directory on page EI-1-16.
• Place more actively used model directories, and directories with custom icon
databases, before less actively used directories. This ensures that their
contents will take precedence in the event of name conflicts.
• If you have duplicate versions of the same model (same model type and
same filename), place the directory with the “highest-priority” models before
the other directories. This ensures that any simulation, flow analysis, or other
process uses the correct version of that model.
• Place the icon directory (icons) last in the user model directories section.
This behavior applies to new models only, not to previously saved models: when
you save a previously saved model, OPNET Modeler writes the file to its original
location when the program started or the last time a Refresh Model Directories
operation was invoked.
There are some enforced “coupling” relationships between models that can
cause new models to be stored in non-default model directories. Model coupling
applies to all model types that are derived from other model types. The following
table lists model coupling relationships.
Related Topics
The following sections describe how reports are organized within the parent
directory. The overall directory organization is illustrated in Reports Directory
Organization on page EI-1-18.
Project/Scenario Reports
Reports generated from a specific project and scenario are organized into
subdirectories based on project and scenario name. Within each
project/scenario-specific subdirectory, reports are organized by report type. For
example, the reports directory for a specific scenario might look like this:
<reports_dir>
<project_name>
<scenario_name>
DES Reports
Flow Analysis Reports
Scenario Web Reports
<project_name>-<scenario_name>/
Obj-Attr Diff/
• For all other ACE Analyst reports, the default directory is based on the
ACE Analyst file name: <reports_dir>/ACE
Reports/<ace_file_name>
NetDoctor Reports
Reports generated by NetDoctor are organized into subdirectories based on
report type, as follows:
<reports_dir>
<project_name>
<scenario_name>
NetDoctor Reports
<template>-RTF Report/
<template>-Web Report/
Security Report@<date><time>/
<reports_dir>/
Capacity Planning Reports/
VoIP Readiness Assessment Reports/
<reports_dir>/
ACE Reports/ 1
2
<ACE Analyst_file_name>@<date><time>/
3
<ACE Analyst_file_name>/
ICI Format Reports/
Mainframe Characterization Reports/
Packet Format Reports/
Process Model Reports/
<project_name>/
Capacity Planning Reports/
VoIP Readiness Assessment Reports/
<scenario_name>/
DES Reports/
graphs@<date><time>/
tables@<date><time>/
Flow Analysis Reports/
tables@<date><time>/
NetDoctor Reports/
<template>-RTF Report/
<template>-Web Report/
Security Report@<date><time>/
Object-Attribute Difference Reports/
Compared Against <project><scenario>/
Scenario Web Reports/
User-Defined Reports/
tables@<date><time>/
Notes
1) This is the default directory for ACE Analyst Multiple Transaction Word
reports and ACE Analyst Comparison reports.
3) This is the default directory for all other ACE Analyst reports.
Related Topics
Refer to the version number to verify that you are using the most recent version
of a particular model. Version numbers might be included in the following file
types:
Environment Suffix
The file names for object files, repositories, and simulation executables include
a suffix that identifies what kind of code the file contains. This suffix is used to
prevent different compilation modes from overwriting one another’s files. The
environment suffix appears before the architecture suffix, as in
sink.mtdev32.i1.o.
Simulations
• Sequential
— Development: dev32, dev64
— Optimized: opt32, opt64
• Parallel
— Development: mtdev32, mtdev64
— Optimized: mtopt32, mtopt64
Graphical tools
• gui32, gui64
Architecture Suffix
All model files are portable across different machine architectures. However,
simulation executables, object code files, and simulation archives are specific
to a given machine architecture.
Architectures are characterized by CPU type (which determines the object code
format) and OS type (which determines the variations of library functions). The
architecture suffix incorporates these data items in a two-character code, as
follows:
<CPU_char><OS_number>
eth_mac.dev32.pr.obj eth_mac.dev32.i0.pr.obj
eth_net.opt32.sim eth_net.opt32.i1.sim
Windows
• Libraries: .dll
Linux
• Object files: .o
• Libraries: .so
.pd.s Probability Density Function (PDF) binary data (simulation loadable form)
These changes are made by editing the files that control the interface. These
are text files with the file name extension .ets (external tool support).
2 Locate the .ets file that contains the operation definition of the operation you will
create a shortcut for. Check each of the following files in turn, until you find the
desired operation definition:
• std_modeler_project_operations.ets
• std_help_operations.ets
• std_edit_operations.ets
• std_shortcut_operations.ets
start_operation
menu header: “File”
menu string: “Close Project”
operation: exec_builtin close_project
position: 2
shortcut: “ctrl-w”
separator “yes”
end_operation
start_operation
menu header: “File”
menu string: “Save Project”
operation: exec_builtin save_project
position: 4
shortcut: “ctrl-s”
end_operation
3 Use the text editor’s search capability to locate the operation you want to modify.
The text string shown as “menu string” duplicates the menu item shown in
OPNET Modeler.
4 Change the shortcut defined, or add a line for a new shortcut. Shortcut keys can
be function keys (<F1>, <F2>) or control key combinations (specified as ctrl-<key>
in the operation definition).
5 Save the changes to the file, close the text editor, and start OPNET Modeler.
• User lock and comment log operations are added to the File menu. User lock is
the last item in the list; comment log is next to last. The position of the menu item
in the list is controlled by the position variable.
• Buttons for both operations appear in the button bar. The position of the button
in the button bar is determined by the order of the operation definition in the file
(for example, the first operation listed will be the left-most button).
start_operation
menu header: “File”
menu string: “Comment Log”
operation: exec_builtin open_comment_log
position: 9998
icon: comments
end_operation
start_operation
menu header: “File”
menu string: “User Lock”
operation: exec_builtin toggle_user_lock
position: 9999
icon: lock_unlock
end_operation
4 Save the changes to the file, close the text editor, and start OPNET Modeler.