Error: Invalid spaceKey on retrieving a related space config.

Enabling binary payload deployment for a .war file-based mid tier deployments

Beginning with version 9.1.04, you can apply hotfixes with a binary payload deployment package. If you deployed your mid tier web server with a .war file, follow these instructions once for each mid tier to register the web server in the AR System Monitor form. This will enable you to apply a hotfix as a binary payload deployment package. Binary payload is a set of binary files, configuration files, batch or Shell scripts.  Binary payload deployment provides a single method for easily promoting binary related customization across the environments, consuming less time for applying the customization. 

If you do not perform the steps listed in this topic, you will not be able to apply the hotfixes that are shipped as binary payload.

  1. In a browser, type the following URL to open the BMC Remedy Mid Tier Configuration Tool: 
    Replace midTierServerName with your mid tier server name. 
  2. To review and update the AR details, perform the following steps:
    1. Click File Deployer Setting.
    2. Review the AR Server Details. If required, change the host name of the AR System server from which you will import the binary payload hotfix or patch package. 


      The File Deployer Setting page displays the AR System Server details if one of the following servers were set:

      • Centralized Configuration Server (CCS)
      • Authentication server in the General Settings section of Mid Tier Configuration Tool
      • Home Page server

      If all the three servers are configured, the File Deployer Settings page uses the CCS details. The server preference order is CCS, authentication server, and Home Page server.

    3. Click Save
  3. On your AR Server, navigate to the  AR System home directory > filedeployer  directory and copy the (UNIX) or (Windows) folder to the chosen location on the server where .war file based mid tier is installed.

  4. Extract the files from or folder. 


    After you extract the  on UNIX, grant the necessary permissions to the folder.

  5. Edit the armonitor.cfg (Windows) or armonitor.conf (UNIX) file in unzipped folder of filedeployer > Conf.
  6. To view the instructions relevant to environment variable values, open the Instruction.txt file in unzipped folder of filedeployer > Instruction.txt.

  7. In the web server, navigate to <MidTierHomeDirectory>\filedeployer\conf\armonitor.cfg or armonitor.conf file, update following environment variables as directed in the Instructions.txt file. The filedeployer  process uses the values set in the following variables. 

    Environment variableWindows e xample UNIX e xample
    BMC_MIDTIER_WAR_EXTRACT_DIR=<BMC_MIDTIER_WAR_EXTRACT_DIR>Environment variable: BMC_MIDTIER_WAR_EXTRACT_DIR=C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps\arsysEnvironment variable: BMC_MIDTIER_WAR_EXTRACT_DIR=/opt/jboss/eap7.0/standalone/deployments/arsys.war
    WEBSERVER_DEPLOYMENT_DIRECTORY=<WEBSERVER_DEPLOYMENT_DIRECTORY>Environment-variable: WEBSERVER_DEPLOYMENT_DIRECTORY=C:\Program Files\Apache Software Foundation\Tomcat 7.0\webappsEnvironment-variable: WEBSERVER_DEPLOYMENT_DIRECTORY=/opt/jboss/eap7.0/standalone/deployments


    Environment variable: BMC_MIDTIER_EXTERNAL_CONF_DIRECTORY=C:\Program Files\Apache Software Foundation\externalEnvironment variable: BMC_MIDTIER_EXTERNAL_CONF_DIRECTORY=<BMC_MIDTIER_EXTERNAL_CONF_DIRECTORY>
    JAVA_HOME=<JAVA_HOME>Environment-variable: JAVA_HOME= C:\Program Files\Java\jre1.8.0_131Environment-variable: JAVA_HOME=/opt/jdk/jre

    FILEDEPLOYER_PROPERTIES_DIRECTORY=<C:\Program Files\Apache Software Foundation\Tomcat 8.5\webapps\arsys\filedeployer This directory contains details needed for filedeployer, such as conf files, log files, and so on.

    Environment variable: FILEDEPLOYER_PROPERTIES_DIRECTORY=/opt/jboss/eap7.0/standalone/deployments/arsys.war/filedeployer
  8. Update the following configuration that would be used by the filedeployer:


    In the armonitor.conf file, update the External-Windows-Service with the service name of the app server, uncomment the line, and save the file.

    Example: External-Windows-Service: process-type = BMC:MidtierWebServer, service-name=Tomcat7

    Alternatively, you can update the  External-Process  with your app server's start and stop commands, uncomment the line, and save the file. 

    Update the External-Process with your app server's start and stop commands, uncomment the line, and save the file. 

    Example: External-Process: process-type=BMC:MidtierWebServer, start-command=/opt/jboss/eap7.0/bin/ -b &, stop-command=/opt/jboss/eap7.0/bin/ --connect --controller=localhost:9990 command=:shutdown, status-command=./

  9. Set the JAVA_HOME environment variable path. Example: JAVA_HOME= C:\Program Files\Java\jre1.8.0_131 (Windows).

  10. To start the filedeployer process, perform the following steps:

    If filedeployer service is already created, you need not run filedeployer.bat .

    If you have already run filedeployer.bat and want to re-run it with a different prompt or a remote desktop, check the logs and stop the previous filedeployer service.
    You can run the filedeployer as a Windows service or as an independependent process.

    To run the filedeployer as an independent process, run filedeployer.bat. To create a Windows service for the filedeployer, run filedeployerService.bat  as a service. The Windows service created for the filedeployer starts the filedeployer service.
    To run the filedeployer as an independent process, run

    Ensure that the owner of the filedeployer process can also start and stop the Tomcat process. To do so, you can run both Tomcat and filedeployer processes by using the same username.

    When the filedeployer process starts, an entry is created in the AR System Monitor form  for the mid tier that was deployed with a .war file. The AR System server specified in the File Deployer Settings page (see step 2) uses this mid tier entry to deploy hotfixes or patches. 

Related topic

Defining a custom binary payload

Was this page helpful? Yes No Submitting... Thank you