Folders and Files in Exported Data

Folder or File name Description
<root folder>
build.properties ANT properties file containing information such as the TIBCO_HOME to be used for running import.
build.xml

This is the main top-level ANT build file; it is the main entry point. This file has three main operations or ANT targets - create, start, and clean.

The default target is the usage target. It provides a list of available targets along with their description.

If you run the ant command from the root folder (that is, ant create), it calls all the sub-build files (auto-discovered) with the same create target. This starts a chain creation of all enterprise-wide objects. The same applies for start and clean.

Note: All build files in the exported archive have the same structure. This means, each of them has create, start, and clean ant targets. What these targets do differs depending on which file they are found in.
common.xml This is a common ANT file. Mainly, it has ANT scripts that various build files use to run import (for logging, discovering their dependency, and so on).
remote_props.properties Property file containing connectivity information for Administrator server where you want import this exported data into.
Export.report.txt This file contain a summary report of the export process in a text format. It contains details such as who started the export, when was the export started, what export options were selected, what data was exported (their counts), and so on.
import.summary.log This file contains a summary report of the import process. It provides a summary of the end results such as how many nodes/environments were created, deleted, or started, and so on.
AdminConfig Folder that contains build and data files for AMX Admin related configuration.
admin_config_build.xml Build file that is used during import.
admin_config_data.xml Data file containing enterprise level configuration values. That is Notification Server and so on.
Environments

Folder that has the build and data files pertaining to various Environments in addition to Nodes and Applications that each Environment has.

The number of sub-folders under Environments is equal to the number of environments in the source AMX Admin.

build.xml

This is the main build file but in the scope of the Environments folder only. The main purpose of this build file is to drive all sub-build files found under the Environments folder.

Depending on the target this build file was called, it will call the same target on sub-build files found in sub-folders.

During import, the processing is based on the alphabetical order of the name of the environment.

Note that import processes each environment, its nodes, and application together. This means, during import, the environment is processed first, followed by the Nodes, and then the Application. After completion, processing of the next environment starts.

MyEnvironment

Sub folder under "Environments". In this case it is named as "MyEnvironment" because that was the name of Environment in the source AMX Admin.

Under this folder, there are two main sub-folders "Nodes" and "Apps". Each of them has build files for creating, starting, and cleaning Nodes and Apps respectively.

If you do not want to create, start, or clean a Node or Application, delete the Build file pertaining to that Node or Application and it is skipped.

env_build.xml

Build file that is responsible for creating environment, setting the messaging bus, substitution variables, Environment level Resource templates, and so on. It also starts the process of creating Nodes and eventually applications via calling "create" on their respective build files. The same applies for "start".

For "clean", the order is reverse. It stops and undeploys the applications, stops and uninstall nodes, uninstalls the Environment, and deletes it.

env_data.xml This is the data file that has all the configuration data related "MyEnvironment".
Apps

Sub folder under "MyEnvironment". This folder has all the build and data files pertaining to applications that were a part of above environment at the time of export.

The number of sub folders under "Apps" is equal to the number of Application folders in the source AMX Admin.

build.xml This is the main build file but in scope of the Apps folder only. The main purpose of this build file is to drive all sub-build files that are found under various sub folders or at the root level of this folder.
2_MyApp1.app_build.xml

Application build file for application named "MyApp1".

  • create — create the application, all needed Substitution variables, Resource templates scope at application level, loggers, bindings, Node mapping, and so on.
  • start — It is split into two sub actions. The first one deploys the application but does not start it. The second one starts the application.
  • clean — undeploys the application and then deletes the application.

The numeric prefix at the beginning of the file determines the order in which the application gets deployed or started. The application with the lowest numerical prefix gets deployed/started first and undeployed last.

For clean, the order is the reverse.

2_MyApp1.app_data.xml Data file that has configuration data related to this application.
appFolderRoot Sub folder representing Application Folder from source ActiveMatrix Administrator.
1_MyApp2.app_build.xml

Application build file for application named "MyApp1".

  • create — create the application, all needed Substitution variables, Resource templates scoped at application level, loggers, bindings, Node mapping, and so on
  • start — It is split into two sub actions. The first one deploys the application but does not start it. The second one starts the application.
  • clean — undeploys the application and then deletes the application.

The numeric prefix at the beginning of file determines the order in which the application gets deployed or started. The application with the lowest numerical prefix gets deployed/started first and undeployed last.

For clean, the order is the reverse.

1_MyApp2.app_data.xml Data file that has configuration data related to this application.
Nodes Sub folder under "MyEnvironment". This folder has all the build and data files pertaining to Nodes that were a part of the above environment at the time of export.
build.xml This is the main build file but in the scope of the Nodes folder only. The main purpose of this build file is to drive all sub-build files that are at the root level of this folder.
MyNode.node_build.xml

Build file for node named "MyNode".

  • create — creates the Node, node-level Substitution variables, adds loggers, installs Nodes, installs Shared library (custom features), installs Resource instance, and so on.
  • start — starts the Node. Once the Node is running, it proceeds with installing the Shared library, Resource instances, and so on.
  • clean — uninstalls Resource instances, disables features (Shared library), uninstalls the node, and then deletes the node.
MyNode.node_data.xml Data file that has the configuration data related to the "MyNode" Node.
Hosts

All the configuration data of the ActiveMatrix Host from the source ActiveMatrix Administrator exists in this folder.

The number of sub folders under "Hosts" is equal to the number of Hosts in the source ActiveMatrix Administrator.

build.xml

This is the main build file but in scope of only Hosts. The main purpose of this build file is to drive all sub-build files that are found under sub folders.

The create target creates all the Hosts. With this release, you can create Hosts on remote machines (provided one Host already exists). The ActiveMatrix Administrator picks an existing Host on remote machine and uses it to run the "add" host action on it.

MyHost Sub folder under "Hosts". In this case, it is named as "MyHost" because that was the name of the Host in the source ActiveMatrix Administrator.
host_build.xml

Host build file.

  • create — creates the Host if does not exist in the target ActiveMatrix Administrator. After the host is created, it sets loggers, substitution variables, and so on.
  • start — starts the Host and if this was first time this host is being started (unbounded), this action is also bind the host.
  • clean — unregisters the host and then deletes the host.
host_data.xml Data file that has configuration data related to this Host.
SharedObjects This folder has information related to all global resources such as Resource templates, Substitution variables, and loggers.
global_resource_template_build.xml

Resource template build file.

  • create — creates all the Resource templates that were scoped at 'Global' level in source ActiveMatrix Administrator
  • clean — removes all the Resource templates
global_resource_template_data.xml Data file that has all configuration data related to Global Resource templates.
global_svars_build.xml Global substitution variables build.
global_svars_data.xml Data file that has all the configuration data related to Global substitution variables.
global_log_appender_build.xml Log appender build file.
global_log_appender_data.xml Data file that has all the configuration data related to log appender.
UserDaas This folder has build and data files related to the DAAs that were exported. You will also find DAA archive files here.
MyApp1.daa

DAA file that could be used to create App MyApp1.

The number of DAAs is equal to the number of applications or shared libraries that were exported during the export process.

daa_build.xml

Build file for DAAs.

  • create — uploads all the DAA to the target ActiveMatrix Administrator
  • clean — deletes DAAs from the ActiveMatrix Administrator, provided they are not in use.
daa_data.xml Data file that has all the locations for the DAA to be uploaded.
UsersAndGroups This folder has build and data file related to Users and Groups.
topLevelPermission_build.xml

Build file for Top Level Permissions for ActiveMatrix Administrator (Enterprise permissions).

  • Create — adds Enterprise permissions for existing users
  • Clean — deletes Enterprise permission
Note: When this build file is run, users must exist in the target ActiveMatrix Administrator.
topLevelPermission_data.xml Data file that has all the Enterprise permissions configuration data (users and group names and "allow" attribute specifying permissions).