SMAExeServer.properties File

The SMAExeServer.properties file lets you customize some settings for your 3DOrchestrate Distribution Server.

After you install the 3DOrchestrate Distribution Server, this properties file is located in the /config/ subdirectory: 

<install_dir>/config/SMAExeServer-xxxx.properties

The xxxx in the file name represents the name of the application in the Java application server. You can assign this name in the deployment utility.

Use a text editor to modify the property values. Any changes made to this file will not be recognized by the 3DOrchestrate Distribution Server until the application server is restarted.

Important: Always use forward slashes (/), not backslashes (\), when entering directory/folder/file paths in a property value, even for Windows folder paths.

The template copy of this file that is installed contains several defunct (deprecated) properties. The only supported properties that can be used are described in the table below.

Property Definition 
fiper.system.configpath
 Location of the configuration files. The installer usually sets this property. 
fiper.system.installpath
 Location of the application installation. The installer usually sets this property. 
fiper.system.filemgr.rootFilePath
 Location where file parameter data is stored. By default, it is set to the 3DOrchestrate server deploy directory. 
fiper.system.temp
 Sets the location of the temp directory for the 3DOrchestrate Server. This temp directory is the location where the results file, NRF, is created before it is loaded into 3DSpace.

Confirm that you have enough disk space to create the NRF file successfully. For most processes the disk space for the temp store is recommended to be at least 25GB. 

fiper.system.logfilter.1
fiper.system.logfilter.2
fiper.system.logfilter.3
 Deprecated.
fiper.jobsubmit.retry Sets the number of times that the 3DOrchestrate Distribution Server tries to submit an execution job when database contention occurs. The default value is 10.
fiper.security.runas.enabled Enables the 3DOrchestrate Distribution Server for the 3DOrchestrate Station run-as security feature. Allowed values are true or false.
fiper.security.runas.domain If run-as security is enabled, this property can be set to a Windows security domain name that the 3DOrchestrate Distribution Server will use to look up users and passwords. Unless a particular 3DOrchestrate Station is explicitly configured otherwise, this domain name will be used by all Windows-based stations. This setting is ignored on Linux. This property is used only with normal user credentials, not extended credentials.
fiper.system.drm.x

Enables the 3DOrchestrate Distribution Server to work with a DRM system; for example, an LSF cluster. See About Distributed Resource Management and Setting Server Properties for DRM Scripts.

Do not use the predefined names "fiper", "Lsf", or "Cloud" for a custom DRM system—these are reserved names.

 
fiper.system.bsubpath
fiper.system.bkillpath
fiper.system.bjobspath
fiper.system.lshostspath
fiper.system.bqueuespath
fiper.system.bmgrouppath

Optionally set these properties to point to their location in the LSF installation. By default, the 3DOrchestrate Distribution Server will use the LSF environment that should be configured for the OS user account under which the 3DOrchestrate Distribution Server is running.

For example:

fiper.system.bsubpath=<lsf_install_dir>/bin/bsub.exe
fiper.system.lsfQueueName Sets the default IBM Platform LSF queue name.
fiper.system.lsfExtraResources Sets the default resource string used by IBM Platform LSF. For example: bsub –R
fiper.system.lsfStationCommand Allows you to define either the absolute path to or a wrapper script for SMAExeTranstation.
smaexe.eed.id A unique name for this 3DOrchestrate Distribution Server. This name must match the value of the same property in the SMAExeConfiguration.properties file of the associated 3DOrchestrate Platform Services. See Installing the 3DOrchestrate Platform Services.
fiper.acs.isWindowsService Enables the 3DOrchesstrate Service to run as a service is now part of the deploy tool. It is recommended to use the deploy tool to enable the 3DOrchestrate Server to run as a service on Windows instead of setting this option manually.
fiper.stranded.workitem.interval Defines the interval between checks for work items left stranded in the PENDING state due to lack of the required affinities. If a work item is in the PENDING state for half the time specified in fiper.stranded.workitem.interval, the system generates a WARNING message in the job log, which indicates that a work item is waiting for a station that can process a workitem with the workitem's affinities.
fiper.system.drm.fipertimelimit Sets a time limit to how long a process will wait before it will time out.
fiper.acs.jms.persistent Deprecated
fiper.acs.jms.ttl Deprecated
fiper.acs.continueRunningJobs Enables jobs to continue to run across 3DOrchestrate Server restarts.
  • If FALSE, running jobs are canceled upon restart
  • If TRUE, running jobs are not canceled upon restart
The default value is TRUE
fiper.job.expirationdays This property manages how long a job will stay in the 3DOrchestrate database. The property is used to help manage database size. This property deletes all data of the job from the 3DOrcestrate database. By default, this property is blank, which means that the jobs are never deleted.

The format for this property is as follows:

  • left blank. Data never gets deleted from the database
  • 365-Days jobs get deleted in 1 year.
fiper.writestepcontext.debug Deprecated.
smaexe.eep.id Unique identifier used in the EEP to identify the 3DOrchestrate Server. This property is defined during installation and 
smaexe.keystore.eePId.publicKey
smaexe.keystore.eePId.file
smaexe.keystore.eepId.password
smaexe.keystore.eepId
 These properties are used to configure 3DOrchestrate Encryption. eePID is the value used in the server property smaexe.eep.id. There are no values after the = sign.
fiper.plmupldate.interval Time interval in minutes when parameters are updated in PLM. Default is 3 minutes.
fiper.plmupdate.paramfail.action Fails the job if the PLM parameter update fails. Default is TRUE
smaexe.cos.server.joblog.repository Used to FTP logs joblogs to a repository outside of 3DSpace
fiper.system.credentials.expiry Configures the lifecycle of the users credentials. By default, the user's credentials are set to expire at the end of the job; however, you can set the credentials to expire after a certain time period after the job has started. The following format is used:
  • JOB: credentials persist for the duration of the job (default)
  • ## -DAYS: credentials persist for a number of days
  • ##-MIN: credentials persist for a number of minutes
smaexe.privatestation.ports Specifies the allowable ports for private station connection.
smaexe.deploy.type Sets the deploy type of clustered environment or use of a single 3DOrchestrate Server.

Possible values for this property are single and cluster. 

smaexe.single.jms.port.tcp
smaexe.single.jms.port.http

ActiveMQ JMS connection port number.

The TCP transport allows clients to connect to a remote ActiveMQ broker using a TCP socket.

This allows the ActiveMQ client and broker to tunnel over HTTP
smaexe.cluster.member.id A unique id used to identify the server in the cluster. It is recommended to use the Deploy to set this property 
smaexe.cluster.jms.tcp.x
smaexe.cluster.jms.http.x
smaexe.cluster.jms.https.x

Defines ActiveMQ broker's hostname and port to define more brokers

Possible values are 'tcp', 'http', and 'https'

all transport mode must be defined

when <transport> is 'tcp' or 'http', this is a direct connection to the JMS Broker,

therefore it is defined as a 'socket' compliant with the following syntax: <hostname>:<port>

when <transport> is 'https', this is a indirect connection to the JMS Broker through Reverse Proxy,

therefore it is defined as an URL 'endpoint' which is basically a string with the following syntax: <hostname>:<port>