Broadcast Agent scripts: Using Broadcast Agent scripts

About Broadcast Agent scripts

Broadcasting the configuration

Removing the configuration

XML Parameters

Broadcasting scripts

Removal scripts

Installation script

Uninstallation script

About Broadcast Agent scripts

The script files correspond to object life cycle commands available in AccountingIntegrator Enabler Rule Engine [FOR DETAILS: Object life cycle and statuses]

The script files are written in XML using ANT-based grammar and vocabulary. As a result, they are portable and can be executed transparently on either UNIX or Windows platforms. The ANT utility is delivered with the product.

To automate the processing sequence, you can customize script files in the Shell directory of the AccountingIntegrator Enabler Rule Engine environment

The next section provides a description of the contents and function of each XML file. You can find the commands and syntax for customizing the XML files on various ANT websites including http://ant.apache.org/manual/index.html

Broadcasting the configuration

In AccountingIntegrator Enabler, use the SendToProduction or SendToProduction Complete operations to generate objects in a given transformation environment. You can only perform these operations on the Input-Event, Processing-Context-In, and Processing-Context-Out objects. Because most of the other objects are implicitly linked to these three objects, AccountingIntegrator Enabler generates them at the same time via an object cluster that it calculates at the start of the transaction.

Example

When AccountingIntegrator Enabler executes a SendToProduction action on an Input-Event:

  1. At the start of the transaction, AccountingIntegrator Enabler calculates the cluster of objects linked to the given Input-Event. That is, the Business-Documents, Business-Fields, Rules, Transformation-Domains and so on.
  2. The Broadcast Agent then generates the configuration of each linked object in the form of two configuration files ctx.mvt and mvt.mvt.

Because the object cluster mechanism generates the Input-Event configuration in parallel with the rest of the configuration required to execute the object, this mechanism ensures data consistency.

Exceptions to the object cluster mechanism

There are certain exceptions to the object cluster mechanism:

AccountingIntegrator Enabler Table

You can generate a Table in a target transformation environment and send it directly to Production via the SendToProduction command.

UNIX environments: Special characters are interpreted when the table is sent to production if the locale settings for the session are the same as the Encoding value of the XrdjAgent.fileEncodingName property defined in the AccountingIntegratorBroadcastAgent.properties file.

For example:

  1. Change the locale settings for the current session with the following command: export LANG=en_US.iso88591
  2. Make sure that you have the XrdjAgent.fileEncodingName=ISO8859-1 value in the AccountingIntegratorBroadcastAgent.properties file.

Processing-Context-In and Processing-Context-Out objects

When you select an Input-Event to send to Production, AccountingIntegrator Enabler does not automatically select the Processing-Context-In and Processing-Context-Out objects that it is linked to. This is because the link between the Input-Event and each of these objects is only a reference link. This means the Processing-Context objects and the Input-Event can potentially work together, but their life-cycles are distinct and separate.

Therefore, to send an Input-Event to Production, you must also select the Processing-Context objects required to complete the execution of the initial Input-Event you selected.

How AccountingIntegrator Enabler calculates the object cluster

When AccountingIntegrator Enabler initializes the transaction that the Broadcast Agent executes to send a given object to Production, it calculates the cluster of linked objects it must generate to fully execute the initial object you selected.

Performing SendToProduction in differential mode

To save time, send objects to Production in differential mode. This method only generates the configuration of those objects with the Checked or Ready for Production status. The system stores the configuration files it generates in a specific directory named Committed.

Running the script

At the end of the current transaction, the Broadcast Agent runs the AutoCommit.xml script. Although you can customize this script, it is recommended that you only customize the Common.xml script.

Removing the configuration

If you need to modify the contents of an object currently in Production, Use the BackToDesign action. This generates the necessary configuration and removes the object from AccountingIntegrator Enabler Rule Engine.

When you remove an object from an Axway Server, the Broadcast Agent automatically removes the objects linked to it. For example, when you remove the configuration of a Business-Field, the Broadcast Agent also removes the configuration of:

  • The Business-Documents to which the Business-Field is attached
  • The Rule versions to which the Business-Documents are attached
  • and so on, until the uppermost parent object, the Input-Event

Note on removing Input-Events

When the system removes an Input-Event, after it removes one of its Rule versions, this:

  • Does not remove any of the other objects that are linked to the Input-Event
  • Can lead to objects becoming orphaned in the AccountingIntegrator Enabler Rule Engine repository and therefore not used.

You must identify these objects and run a BackToDesign action on each of them.

Calculating the object cluster

When AccountingIntegrator Enabler executes a BackToDesign action on an object:

  1. At the start of the transaction, AccountingIntegrator Enabler calculates the cluster of linked objects it must remove to fully remove the initial object you selected.
  2. The Broadcast Agent then generates the delete configuration for each linked object in the form of two configuration files ctx.mvt and mvt.mvt.
    The system stores the configuration files it generated in a specific directory named Committed.

Running the script

At the end of the current transaction, the Broadcast Agent runs the BackToDesign.xml script. Although you can customize this script, it is recommended that you only customize the Common.xml script.

XML Parameters

The Broadcast Agent uses two sets of parameters defined in each XML file:

Core XML parameters

The parameters common to all the XML files in the AccountingIntegrator Enabler repository are described in the following table:

Parameter Description

AGENT_PATH

Path to where you installed the Broadcast Agent.

…\Designer\lib\axway\misc\xrdj\agent

TRAD_PATH

Path to where Broadcast Agent installed the execution environment, that is the AccountingIntegrator Enabler Rule Engine associated with the Axway Server. The path name is the concatenation of the following parameters you entered in the AccountingIntegrator Enabler Axway Server object:

Agent path parameter +"\" + Axway product Name parameter

DATA_TSTAMP

Name of the sub-directory in the Committed directory where the system stores the AccountingIntegrator Enabler Rule Engine repository update configuration:

Use the format: yyyyyMMddAM/PMhhmmssTimeZone

XIP_COMPONENT_HOST

Name of Host used in the AccountingIntegrator Enabler Axway Server object specified as either of the following values:

  • Name of the Host object referenced in the AccountingIntegrator Enabler Rule Engine object, if you selected the Remote  Rule Engine check box.
  • localhost

XIP_COMPONENT_HOST_TYPE

Type of operating system running on the Host object: Win32, Win9x, UNIX and so on

XIP_COMPONENT_PATH_EXE

Directory path to where you installed AccountingIntegrator Enabler Rule Engine. It is the value of the Operating path [RDJ_EXEC] parameter defined in the AccountingIntegrator Axway Server object.

XIP_COMPONENT_PATH_HOME

Directory path to where you installed AccountingIntegrator Enabler Rule Engine. It is the value of the Installation path [RDJ_HOME] parameter defined in the AccountingIntegrator Axway Server object.

XIP_COMPONENT_USER

Value of the Host user name parameter in the AccountingIntegrator Enabler Axway Server object.

XIP_COMPONENT_PWD

Value of the Host password parameter in the AccountingIntegrator Enabler Axway Server object.

 

File-specific XML parameters

Refer to the individual XML files for file-specific parameters.

Broadcasting scripts

The Broadcasting scripts comprise:

SendToProduction

Overview

When you run a SendToProduction operation on an AccountingIntegrator Enabler object, the Broadcast Agent then performs the following task sequence:

  1. Creates a log file in which it writes a header in the following format to denote the start of the operation:
    XRDJ_AutoCommit_trc_yyyyy_MM_dd at AM/PM_hh_mm_ss_TimeZone.txt
  2. Loads the target transformation environment:
    • Initializes the target transformation environment
    • Creates the transformation environment if it does not exist
    • Verifies that the transformation environment is valid
  3. Initializes the sections in the ctx.mvt configuration file it needs to generate
  4. For each object linked to the one(s) you selected, it exports the associated update configuration
  5. Formats and writes the ctx.mvt and mvt.mvt files to the Tmp  directory.
  6. Runs the AutoCommit.xml script to create the Commited directory where it places the ctx.mvt and mvt.mvt files when it finishes running the script.
  7. Writes the end of operation header in the log file and closes the log file.

Script: AutoCommit.xml

Description

The AutoCommit.xml script:

  • Creates the [TRAD_PATH]\Tmp\[DATA_TSTAMP] directory in which to store the data
  • Sorts the mvt.mvt file
  • Copies the data files in the [TRAD_PATH]\[DATA_TSTAMP] directory
  • Copies the [TRAD_PATH]\Tmp\[DATA_TSTAMP] directory to the [TRAD_PATH]\Committed directory
  • Deletes all files and directories present in [TRAD_PATH]\Tmp

[FOR DETAILS Sending objects to Production]

Update Server

Overview

You can only perform an UpdateServer operation on AccountingIntegrator Enabler Table objects with the status Checked that belong to a given AccountingIntegrator Enabler Axway Server. Composer provides a dialog box where you specify the AccountingIntegrator Axway Server(s) where you want to update the Table configuration.

The UpdateServer action only sends the Table once. This action is only available of you set the Send Table contents to serveroption for the Table to indicate that Composer manages the contents of the Table.

AccountingIntegrator Enabler can work with Table file descriptions generated by third-party applications. In these cases, Composer only requires the description of the Table structure to be able to Check the Rule mappings that reference the Table.

When you run the UpdateServer action, the Broadcast Agent then performs the following task sequence:

  1. Creates a log file in which it writes a header in the following format to denote the start of the operation:
    XRDJ_UpdateProduction_trc_yyyyy_MM_dd at AM/PM_hh_mm_ss_TimeZone.txt
  2. Loads the target transformation environment:
    • initializes the target transformation environment
    • creates the transformation environment if it does not exist
    • verifies that the transformation environment is valid
  3. For each Table object you selected:
    • Verifies the coherence of statuses and generates an error if it encounters an inconsistency.
    • Exports the associated configuration to each AccountingIntegrator Enabler Table.
  4. Initializes the Tmp working directory
  5. Formats and writes the mvt.mvt file to the Tmp  directory.
  6. Runs the UpdateProduction.xml script to create the Commited directory where it places the mvt.mvt file when it finishes running the script.
  7. Writes the end of operation header and closes the log file.

Script: UpdateProduction.xml

Description

The UpdateProduction.xml script:

  • Creates the [TRAD_PATH]\Tmp\[DATA_TSTAMP] directory
  • Sorts the mvt.mvt file
  • Copies the mvt.mvt file to the [TRAD_PATH]\[DATA_TSTAMP] directory
  • Copies the [TRAD_PATH]\Tmp\[DATA_TSTAMP] directory to the [TRAD_PATH]\Committed directory
  • Deletes all files and directories present in [TRAD_PATH]\Tmp

[FOR DETAILS Updating Table objects in Production]

Removal scripts

BackToDesign

Overview

You can perform a BackToDesign operation on all AccountingIntegrator Enabler objects with the status Checked that belong to a given AccountingIntegrator Enabler Axway Server.

Composer provides a dialog box in which you specify the AccountingIntegrator Enabler Axway Server(s) from which you want to remove the selected AccountingIntegrator objects. The Broadcast Agent then performs the following task sequence:

  1. Creates a log file where it writes a header in the following format to denote the start of the operation:
    XRDJ_BackToDesign_trc_yyyyy_MM_dd at AM/PM_hh_mm_ss_TimeZone.txt
  2. Loads the target transformation environment:
    • Initializes the target transformation environment
    • Creates the transformation environment if it does not exist
    • Verifies that the transformation environment is valid
  3. For each object you selected:
    • Initializes the sections in the ctx.mvt configuration file it needs to generate
    • Exports the associated deletion configuration for each of the objects linked to the one you selected
  4. Initializes the Tmp working directory
  5. Formats and writes the ctx.mvt and mvt.mvt files to the Tmp  directory.
  6. Runs the BackToDesign.xml script to create the Commited directory where it places the ctx.mvt and mvt.mvt files when it finishes running the script.
  7. Writes the end of operation header and closes the log file.

Script: BackToDesign.xml

Description

The BackToDesign.xml script:

  • Creates the [TRAD_PATH]\Tmp\[DATA_TSTAMP]directory.
  • Sorts the mvt.mvt file.
  • Copies the [TRAD_PATH]\Tmp\[DATA_TSTAMP] directory to the [TRAD_PATH]\Committed directory.
  • Deletes all files and directories present in [TRAD_PATH]\Tmp.

[FOR DETAILS: Sending objects back to Design]

Installation script

Script: Create_Product.xml

Description

The Create_Product.xml script installs an execution environment, that is an AccountingIntegrator Enabler Rule Engine associated with an AccountingIntegrator Axway Server that is managed by the Broadcast Agent. The system executes the script from the Topography workbench in Composer when you select the Install option from the Other actions section in the Axway Server contextual menu.

Uninstallation script

Script: Remove_Product.xml

Description

The Remove_Product.xml script uninstalls the execution environment, that is the AccountingIntegrator Enabler Rule Engine associated with an AccountingIntegrator Axway Server that is managed by the Broadcast Agent. The system executes the script from the Topography workbench in Composer when you select the Uninstall option from the Other actions section in the Axway Server contextual menu.

Back to top

Related Links