Contents of the server.components.yaml file

A server.components.yaml file is created when you optimize the start up time of an independent integration server.

A server.components.yaml is created when you optimize the start up time of an independent integration server by running the ibmint optimize server command, as described in ibmint optimize server command. For more information, see Optimizing the startup time for an independent integration server. If the command completes successfully, then a server.components.yaml file is written in the server's work directory. A message similar to the following example is output to the console:

BIP15237I: The components file 'C:\Work\Development\V13\Server1\server.components.yaml' was created. It can be further edited if required.

The server.components.yaml file is different from to the server.conf.yaml file as it indicates only which of the main components need be created or loaded when the server starts up. An example server.components.yaml file is shipped with the product in <product_install_directory>/server/sample/configuration/server.components.yaml. This file is a sample file that shows which components can be enabled or disabled and it is not used directly at run time. No components are disabled in the sample, as all are commented out. The sample file has the following entries for the main embedded run-times:

  • JVM: true/false
  • NodeJS: true/false
  • CLR: true/false
These entries indicate whether the server creates a JVM, NodeJS and/or. NETCLR run-times at server startup. .NET CLR is available on Windows only and is needed to run the .NET function.
The next entries are subsections of component switches:
  • Nodes: Message flow node functional areas that need the native run time and for which product LILs are loaded from the <product_install_directory>/server/bin directory.
  • JavaNodes: Message flow node functional areas that need the embedded JVM run time and for which JAR/PAR files are loaded from the <product_install_directory>/server/bin directory. If JVM is set to false, then all of the entries in the JavaNodes section are ignored.
  • JavaScriptNodes: Message flow node functional areas that need the embedded NodeJS run time. If NodeJS is set to false, then all of the entries in the JavaScriptNodes section are ignored.
  • ResourceManagers: A list of resource managers that can be chosen not to be created at startup.
  • FlowSecurityProviders: A list of message flow security providers that might or might not be needed at server startup. The list is made up from LSL files that are loaded from the <product_install_directory>/server/bin directory.
When a server.components.yaml file is created by the ibmint optimize server command, it also contains the following three fields:
  • optimizeComponents
  • optimizeVersion
  • serverComponentsVersion
These fields contain the optimization version information and you must not change these fields.

Sample server.components.yaml file:


# ACE Integration Server components file
#
# Created at 13.0.1.0 - ea79f52d3cb39a25157204509f9e022f-3aea14dc5eb1f6d1bb87dd2db20873e9
#
# General notes :
#  - Integration Server will load server.components.yaml from directory set via --work-dir
#  - To ensure valid YAML avoid any use of TAB characters
#  - File paths may be taken as absolute, or relative to the integration server's work directory

serverComponentsVersion: 1
# reportExcludedComponents: true # Controls whether messages are written on integration server startup indicating components are excluded. Default is true.

# Main embedded run-times
# JVM: false      # Do not create a JVM within the Integration Server
# NodeJS: false   # Do not create NodeJS run-time within the Integration Server
# CLR: false      # Do not create a .NET CLR run-time within the Integration Server

Nodes:
#  CallableFlow: false  # Controls whether the callable flow nodes are loaded.
#  Aggregation: false   # Controls whether the aggregation nodes are loaded.
#  Basic: false         # Controls whether the basic nodes are loaded.
#  Connector: false     # Controls whether the connector node framework is loaded.
#  .NET: false          # Controls whether the .NET nodes are loaded.
#  JMSTransform: false  # Controls whether the MQJMSTransform and JMSMQTransform nodes are loaded.
#  MQ: false            # Controls whether the IBM MQ nodes are loaded.
#  ESQL: false          # Controls if the Compute, Filter, Database, DatabaseInput and Traces nodes are loaded.
#  SecurityPEP: false   # Controls whether the SecurityPEP node is loaded.
#  Group: false         # Controls whether the GroupScatter, GroupGather and GroupComplete nodes are loaded.
#  REST: false          # Controls whether the RESTRequest, RESTAsyncRequest and RESTAsyncResponse nodes are loaded.
#  Timer: false         # Controls whether the TimeoutControl and TimeoutNotification nodes are loaded.

JavaNodes:              # If JVM is set to false then the JavaNodes section will not apply
#  Adapters: false      # Controls whether the SAP, Oracle JD Edwards, Oracle Peoplesoft and Oracle Siebel nodes are loaded.
#  CICS: false          # Controls whether the CICSRequest node is loaded.
#  Collection: false    # Controls whether the Collector, Sequence and Resequence nodes are loaded.
#  Email: false         # Controls whether the EmailInput and EmailOutput nodes are loaded.
#  File: false          # Controls whether the File, IBM Sterling C:D and FTE nodes are loaded.
#  CORBA: false         # Controls whether the CORBARequest node is loaded.
#  IMS: false           # Controls whether the IMSRequest node is loaded.
#  Mapping: false       # Controls whether the Mapping node is loaded.
#  ODM: false           # Controls whether the ODMRules node is loaded.
#  TCPIP: false         # Controls whether the TCPIP nodes are loaded.
#  XSLT: false          # Controls whether the XSLTransform nodes are loaded.
#  WSRR: false          # Controls whether the WSRR EndpointLookup and RegistryLookup nodes are loaded (if this component is installed).
#  MQTT: false          # Controls whether the MQTT connector is loaded.
#  Kafka: false         # Controls whether the KAFKA connector is loaded.
#  JavaCompute: false   # Controls whether the JavaCompute node is loaded.
#  JMS: false           # Controls whether the JMS nodes are loaded.
#  JDBC: false          # Controls whether the DatabaseRetrieve and DatabaseRoute nodes are loaded.

JavaScriptNodes:        # If NodeJS is set to false then the JavaScriptNodes section will not apply
#  Salesforce: false    # Controls if the Salesforce connector is loaded.
#  LoopBack:   false    # Controls if the LoopBack connector is loaded.

ResourceManagers:
#  GlobalCache: false   # Controls whether the GlobalCache resources are loaded.

FlowSecurityProviders:  
#  LDAP: false          # Controls whether the LDAP Security provider is loaded for message flow security.
#  TFIM: false          # Controls whether the TFIM Security provider is loaded for message flow security.
#  WS-Trust: false      # Controls whether the WS-Trust v1.3 STS Security provider is loaded for message flow security.
#  Local: false         # Controls whether the Local Security provider is loaded for message flow security.
#  ENV: false           # Controls whether the Environment variable Security provider is loaded for message flow security.