For your convenience, EKM comes with various predefined External Application definitions. These are
definitions for external applications that can be launched by EKM when
data is extracted from simulation files, or when jobs are run from EKM.
External applications are directly associated with Data Extraction
and Job Submission queues. Predefined applications are located in
two different folders under EKM_HOME/conf/.
The predefined applications in the EKM_HOME/conf/applications folder are loaded into the Data Extraction queue at /Administration/Servers/Master/EKM Server the very first
time that EKM is started.
When defining settings for a Job Submission queue, you can choose
to automatically load the predefined applications in the EKM_HOME/conf/jobSubmissionApplications folder
into the queue that you are defining.
Some external applications (such as graph generation) are bundled
with EKM, while other applications are required to be installed
on the server. See the EKM Installation Guide for a complete list of applications that require installation. The AWP_ROOT182 environment variable must be
correctly set in order to run these installed applications. This environment
variable is set automatically on Windows systems. To learn how to
set it on Linux systems, see Set the Location of ANSYS 18.2 Applications.
The following is a list of all predefined applications in EKM:
aedt.app.xml: This application is used to extract metadata from
ANSYS Electronics Desktop projects (.aedt files)
and archives (.aedtz files). You will need to
specify the correct location of this application on the server.
Note: Images are not extracted from AEDT projects by default. To configure EKM to do so, refer to Extracting Images from ANSYS Electronics Desktop (AEDT) Projects.
ansys.app.xml: This is the
ANSYS executable and is used for extracting metadata and reports from
Mechanical APDL files. You will need to specify the correct location
of this application on the server.
cfx5dfile.app.xml: This application
is part of the CFX installation and is used for extracting metadata
and reports from CFX files. You will need to specify the correct location
of this application on the server.
cfx5post.app.xml: This is
the CFD Post executable and is used for extracting images from CFX
files. You will need to specify the correct location of this application
on the server.
cfx5pre.app.xml: This application
is part of the CFX installation and is used for extracting images
from CFX files. You will need to specify the correct location of this
application on the server.
extractCaxImage.app.xml:
This application is used to extract VCollab’s CAX file from
simulation files for 3D visualization. To make CAX extraction possible,
you need to have VMoveCAE installed on the EKM server.
Note that this not the default image extractor in EKM. In order
to extract CAX files you must specify image attributes for each built-in
or custom file type from which you want to extract CAX images. For
details see Using VCollab for 3D Visualization in EKM.
fluent.app.xml: This is the Fluent executable
and is used for extracting reports from Fluent files. You must specify
the correct location of this application on the server. You will also
need to specify the appropriate command line parameters for running
this application in the background. The –hidden parameter is used for running it in the background on a Windows
server. You will need to change this parameter to –g for Linux. The –post parameter is
used for running Fluent in postprocessing mode, only. You will need
to remove this parameter or create a new application definition if
you need to run the Fluent solver.
icepakMetaData.app.xml: This application is
used to extract metadata from Icepak files. You will need to specify the
correct location of this application on the server.
jython.app.xml: This application
is bundled with EKM and is used to execute Python scripts. You
do not need to configure this application.
polyflowReport.app.xml: This
application is bundled with EKM and is used to extract reports
from Polyflow files. You don’t need to configure this application.
vrml2gltf.app.xml: This application
is bundled within EKM and is used to convert VRML models extracted
from Fluent and MAPDL files to the glTF format that is used by EKM’s
3D image viewer.
workbench.app.xml: This is
the Workbench executable that is used for extracting metadata and
reports from Mechanical Database (.dsdb, .mechdb, .mechdat) and Workbench
Project Archive (.wbpz) files.
You should not edit the files in the
EKM_HOME/conf/applications folder
because the changes will not be applied to instances of those files in
EKM. If you want to make changes to an application definition, you
should do so only from within EKM using either the
> or >
action.
You should not change the application key name for any of the predefined applications. If the key name is changed, EKM will be unable to find the application.
The next sections, Defining External Applications Using XML and Defining External Applications Directly in EKM, describe two methods of creating your own external application definitions.