Home
Batch processing
Process accumulated requests from EngageOne™ Interactive, or process your own multiple or individual files, in a scheduled, or ad hoc manner.
Non-accumulated batch
In NA batch, which is a traditional batch process, the batch process accepts one or more input files containing document data sets, as well as optional processing instructions.
Express Batch
Express Batch processing can significantly improve NA batch performance; in this mode NA batch skips additional configurations provided by EngageOne™ Server during delivery channel definition, thus reducing I/O operations. Resources such as Keymaps, Journals and, Lookup Tables can be assigned to the template in Designer or defined/overridden via OPS settings in EngageOne™ Server as described below.
Using symbols

Overview
Configure and manage operating modes and user roles.
Getting started
Information on creating and configuring communities, running the EngageOne™ Server Administration and common features available in the web application.
Template management
Template management allows you to create and organize folders that contain templates and Active Content, created in EngageOne™ Designer and imported into EngageOne™.
External File management
External resources not contained in the template, succh as images (key maps or keyed images), lookup tables, and RTF files.
Delivery management
Before you can use a template in EngageOne™ Administration you must define a device for viewing and define at least one delivery option.
Community Administration
Features for managing shared community document classes, retention policies, spelling dictionaries, data maps, and diagnostics.
System administration
As an EngageOne™ Server system administrator you will be responsible for configuration, diagnostics and account activities.
Event Monitor
Events related to the document cycle and administration, these are captured throughout the system and sent to the Event Monitor.
Batch processing
Process accumulated requests from EngageOne™ Interactive, or process your own multiple or individual files, in a scheduled, or ad hoc manner.
- Accumulated batch
  The process of submitting documents for batch delivery in EngageOne™ Interactive is referred to as accumulated batch.
- Non-accumulated batch
  In NA batch, which is a traditional batch process, the batch process accepts one or more input files containing document data sets, as well as optional processing instructions.
  - Modes and features
    Batch operating modes presented in the table below are in order of performance, from left (fastest) to right.
  - Setup
    Batch capabilities are packaged in the batch bundle and are installed at the batch.install.dir location configured in deploy.properties.
  - Input files
    NA batch works with both interactive templates and non-interactive templates. Interactive templates always use the interactive data model. Non-interactive templates can use one of the following data models: keyed record, delimited, or custom XML.
  - Using interactive templates
    Each template has its own unique answer file, which contains the data that will be used in the generated document. Within the <answer> nodes are CDATA blocks that contain answer file XML for the given template. Before developing your own input XML, you will need to make sure that you can produce the answer file XML with the intended data.
  - Using non-interactive templates
    NA batch can process non-interactive templates that include an input file that contains data in any format supported by Designer and generate the appropriate content as defined by the selected output channels. A non-interactive template refers to an EngageOne™ template that represents a publication that is intended for non-interactive, batch processing.
  - EngageOne™ Video PURL generation
  - NA batch and XML processing files
    The input folder contains an XML processing file just as it does for the Interactive Data Model. This file provides process-specific values for the template, template effective date, and delivery option for a given records section. The XML also identifies the data file that is to be used for the batch/records instance.
  - NA batch and native input file support
    NA batch supports the processing of keyed record and delimited-format data model types directly as input files. This eliminates the need for an XML processing file to provide control information for the non-XML data file.
  - Running the non-accumulated batch job
    A single batch run constitutes a set of files (one to many) where each file can have multiple records.
  - Express Batch
    Express Batch processing can significantly improve NA batch performance; in this mode NA batch skips additional configurations provided by EngageOne™ Server during delivery channel definition, thus reducing I/O operations. Resources such as Keymaps, Journals and, Lookup Tables can be assigned to the template in Designer or defined/overridden via OPS settings in EngageOne™ Server as described below.
    - Publishing in Designer and template import in Server Admin
    - Using overrides
      You can either specify resources used by the template in Designer in the Publish for EngageOne task or by using an override production settings (OPS) file; this allows you to specify supplements and alternatives to some of the job settings that were used in EngageOne™ Designer. Note that the use of overrides is valid only for templates run Express Batch processing mode.
    - XML processing file
      The standard XML processing file has been extended to cater for the definition of the OPS file used in Express Batch process via the additionalOptions construct.
    - Using symbols
    - Input file definition and order of priority
  - Running multiple batch programs on the same server
    You can concurrently execute multiple non-accumulated batch instances on the same machine without any additional configuration.
  - Running batch on a different machine
    The batch programs can run on a separate machine other than the EngageOne™ Server provided that it has access to the database, the EngageOne™ Server' s JNDI, and the EngageOne™ Server repository.
  - Batch configuration
    These are the non-accumulated batch thread size settings that are used to control the configuration in the com.pb.engageone.server.batch.na namespace.
- NA batch setup and performance optimization
- Purging using batch
  Running purge is an important maintenance activity to prevent gradual performance degradation due to the build-up of data in the database tables. Make sure you implement a purge routine as part of your EngageOne™ Server maintenance plan.
- Log file location
- Logging information (accumulated and non-accumulated batch)
- Modifying log file count
- Batch error handling
  Error handling for accumulated and non-accumulated batch have some differences.
- Batch threshold settings
  The threshold level is the limit where a running batch will terminate, if the number of processed documents that have errors has been reached.
- Setting up the batch programs on a separate machine
- Running batch with integrated security database connections
Managing your EngageOne™ environment
Best practices for managing your EngageOne™ and safeguarding your environment.
EngageOne™ Server system monitoring
This section describes how to monitor the EngageOne™ Server system.
Notices

Using symbols

Symbols are used to dynamically assign values to corresponding items in the OPS file. Use the –symbols switch, as shown below:

run-na-batch -dir D:\Shares\ExpressBatch\Invoice\data -domain e1Domain
-symbols "datafile=ST053_20231207_0000002380-0002.xml 
data_dir=D:\Shares\cycles\cycle0002\input 
output_dir=D:\Shares\cycles\cycle0002\output"

In this example, three symbols are used to dynamically resolve the paths for:

datafile the input data file.
data_dir - the directory where the data file is located.
output_dir - the output directory where the output file will be written to.

For formatting reasons in the example above, symbols are presented on a separate lines. However, the run-na-batch command is entered as a single line with a space between each symbol. When referenced in the OPS file the symbol names must be enclosed in percent (%) characters as shown in the example below:

<symbols>
datafile=default.xml

base_dir=D:\Shares\ExpressBatch
data_dir=%base_dir%\Invoice\data
output_dir=%base_dir%\PDF_Output
logs_dir=%output_dir%\logs

<input>
DataInput=%data_dir%\%datafile%
MessagesFile=%base_dir%\messages\*.him

<Output>
PDF-Merged=%output_dir%\%datafile%.pdf
 
<Journal>
Journal1=%output_dir%\%datafile.jr1
Journal2=%output_dir%\%datafile.jr2

<Advanced>
LogFile=%logs_dir%\%datafile%_pdf.log

<DIJ>
PDF-Merged=%output_dir%\%datafile%.dij

;<trace>
;Outputfile=%logs_dir%\%datafile%_trace.log
;TraceLevel=verbose
;outputcodepage=utf8
;memlimit=0
;supporttrace=on

Note: in the previous example, the file assignment made in the Output section - PDF-Merged must be the same name as the output device name defined in Designer as the selected Supported Output Device:

In EngageOne Server Admin, the device name is also presented in the selected Delivery Option → Delivery Channel specified in the XML processing file: