Central Migration Bridge

The Central Migration Bridge service invokes a subset of Adobe Central Pro Output Server (Central) functionality, which includes the JFMERGE, JFTRANS, and XMLIMPORT commands. Central Migration Bridge service operations allow you to reuse the following Central assets in LiveCycle:

  • template design (*.ifd)

  • output templates (*.mdf)

  • data files (*.dat files)

  • preamble files (*.pre files)

  • data definition files (*.tdf)

For more information, see “Central Migration Bridge Service” in Adobe LiveCycle ES3.

Note: Before you use Central Migration Bridge service operations, configure the service to reference an installation of Central. (See Central Migration Bridge service configuration.)

    Central Migration Bridge service configuration

    To use the Central Migration Bridge service, edit service configuration to provide the location of an existing Central installation. (See Editing service configurations.)

    Central Install Directory
    Specifies the location where Central is installed, such as C:\Program Files\Adobe\Central.

    The Central installation must exist on the same computer where the LiveCycle Server is installed.

    centralDataAccess operation

    Extracts the ^form, ^global, ^field, and ^job commands from the specified data file (*.dat) and transforms the commands to XML data.

    For example, your application must use information from a DAT file to determine the next steps in the process. You can use the centralDataAccess operation to transform the data file to XML data and store it in a process variable. Then, you can manipulate and access information about the DAT file by using XPath to determine the next steps in the process.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Properties for specifying the DAT file and the number of bytes to process from the specified file.

    Data File

    A documentvalue that represents the data file (*.dat) to be processed. The data file is a field-nominated file.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset).

    Bytes To Be Processed

    An int value that specifies the number of bytes to process from the provided data file (*.dat). The default is 10000. The number of bytes determines the number of ^form, ^global, ^field, and ^job commands that are extracted from the data file.

    Output properties

    Property for storing the result of the operation.

    Output XML

    The location in the process data model to store the file containing the XML data. The data type is document.

    Exceptions

    This operation can throw a Central Migration Bridge exception exception.

    centralMerge operation

    Merges the template design (*.ifd) or output template (*.mdf) with the provided data file (*.dat) by invoking the JFMERGE command. Use this command to merge the template design or output template with the data file. Use this operation to create files in formats supported by Central, such as, IPL, ZPL, PDF, PS, or PCL file.

    For example, you have a data file that contains customer information, such as the name, address, and invoice number. Your application takes the data file, fills in a form defined by the template design, and sends the output to a printer. You can use the centralMerge operation to merge the data file with the template design. The result of the operation is an output file containing forms that are filled in with information about each customer.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Properties for specifying the input template, data file (*.dat) to be merged, preamble file, and printer location to send the output file to. In addition, you can specify a custom jfmerge.ini file and additional command line options for the JFMERGE command.

    Output Template

    A document value that represents the output template (*.mdf) file.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset).

    Data File

    A document value that represents the data file (*.dat) to be merged with the output template(*.mdf).

    Preamble File

    A document value that represents the preamble file to use. The preamble file (*.pre) contains commands or data that the Print Agent executes on the data file contents before merging with an output template (*.mdf).

    Location

    A string value that represents the location to send the output file to. When a file location is specified, the file is saved to a location on the LiveCycle Server or in a network location. A file location, such as C:\mergedFiles\newmergefile.pcl is saved on the LiveCycle Server. When a printer location is specified, for a shared queue, use the shared queue name and server name, such as \\server-name\sharedqueue. When the printer location is local to the LiveCycle Server, you can use just the shared queue name.

    INI File Path

    A string value that represents the location on the server or network of a custom jfmerge.ini file, such as C:\custom\customjfmerge.ini. When no value is provided, the default jfmerge.ini file in the Central installation folder is used.

    Other Command Line Options

    A string value that represents additional command line options to affect the processing of the JFMERGE command. When you specify multiple command line options, separate each option with a space. If your option contains spaces, enclose the space with double quotation marks. (““). You can specify any command line options other than -apr,-all,-z.

    For more information about the JFMERGE command and the available command line options, see Print Agent Reference.

    Output properties

    Properties for storing the result of the operation.

    Central Result

    The location in the process data model to store the results of the operation. The data type is CentralResult.

    Log Document

    The location in the process data model to store the log file that contains entries for all activities that occur when Central is invoked. The log file includes trace, informational, warning, error, and severe messages from the Central Print Agent. The data type is document.

    Response Document

    The location in the process data model to store the response file to record an exit status. By default, the name of the response file the that Print Agent creates is jetform.rsp. This file is created in the same location as the Print Agent executable. The data type is document.

    For information about response files, see “-arx (Response File)” in the Print Agent Reference.

    Trace Document

    The location in the process data model to store the trace file. The trace facility is commonly used for troubleshooting. However, it can also be used to generate data files that can be used as preamble for subsequent processing. The data type is document.

    For information about trace files, see “-atf (Trace File Name)” in the Print Agent Reference.

    Merged Result Document

    The location in the process data model to store the resulting merged PDF or PCL file. The data type is document.

    Exceptions

    This operation can throw a Central Migration Bridge exception exception.

    centralTransformation operation

    Reformats a file into an accepted formatted data file by invoking the JFTRANS command. The formats include field-nominated, fixed record, overlay, or comma-delimited data.

    For example, you have an ASCII file containing customer information, such as the name, address, and invoice number. Your application converts the ASCII file to a data file that is formatted for use with the centralMergecentralMerge operation operation. You use the centralTransformation operation to reformat the ASCII file to a field-nominated data file (*.dat).

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Properties for specifying the input data file and the definition file. In addition, you can specify a custom jftrans.ini file and additional command line options.

    Data File

    A document value that represents the data file (*.dat) to be transformed.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset).

    Data Definition File

    A document value that represents definition file (*.tdf) describing how to reformat the data file (*.dat). The data file is created using a text editor or Visual Transformation Editor. The data file describes the incoming data file and defines how to write the data to an output file.

    INI File Path

    A string value that represents the location of a custom INI file for the JFTRANS command, such as C:\Custom\customjftrans.ini. When no value is provided, the default jtrans.ini file in the Central installation folder is used.

    Other Command Line Options

    A string value that represents additional command line options that can be added to affect the processing of the JFTRANS command. When you specify multiple command line options, separate each option with a space. You can specify any command line options other than -apr,-all,-z.

    For information about the JFTRANS command and the available command line options, see Developing Data Transfromations.

    Output properties

    Properties for storing the result of the operation.

    Central Result

    The location in the process data model to store the results of the operation. The data type is CentralResult.

    Log Document

    The location in the process data model to store the log file that contains entries for all activities that occur when Central is invoked. The log file includes trace, informational, warning, error, and severe messages from the Central Print Agent. The data type is document.

    Response Document

    The location in the process data model to store the response file to record an exit status. By default, the name of the response file the that Print Agent creates is jetform.rsp. This file is created in the same location as the Print Agent executable. The data type is document.

    Trace Document

    The location in the process data model to store the trace file. The trace facility is commonly used for troubleshooting. The data type is document.

    For information about trace files, see “-atf (Trace File Name)” in Print Agent Reference.

    Transformed Result Document

    The location in the process data model to store the data file (*.dat). The data type is document.

    Exceptions

    This operation can throw a Central Migration Bridge exception exception.

    centralXMLImport operation

    Transforms XML data into a field-nominated data file (*.dat) by invoking the XMLIMPORT command.

    For example, you have an XML file containing customer information, such as the name, address, credit card number, and invoice number. Your applications extracts the XML data, transforms it to a data file, fills in a form defined by the output template (*.mdf), and sends the output to a printer. You can use the centralXMLImport operation to extract the XML and transform it into a data file (*.dat).

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Properties for specifying the input XML file, custom XCI files, and additional command line options for the XMLIMPORT command.

    Data File

    A document value that represents the XML file to transform, such as C:\xmldata.xml.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset).

    XCI File Path

    A string value that represents the location of a custom XCI file for the XMLIMPORT command, such as C:\Custom\customxmlimport.xci. When no value is provided, the default xmlimport.xci file in the Central installation folder is used. No default value is provided.

    Other Command Line Options

    A string value that represents additional command line options that can be added to affect the processing of the XMLIMPORT command. When you specify multiple command line options, separate each option with a space. You can specify any command line options other than -config. No default value is provided.

    For information about the XMLIMPORT command and the available command line options, see XML Import Agent Reference XML Import Agent Reference.

    Output properties

    Properties for storing the result of the operation.

    Central Result

    The location in the process data model to store the results of the operation. The data type is CentralResult.

    Log Document

    The location in the process data model to store the log file that contains entries for all activities that occur when Central is invoked. The log file includes trace, informational, warning, error, and severe messages from the Central Print Agent. The data type is document.

    Response Document

    The location in the process data model to store the response file to record an exit status. By default, the name of the response file the that Print Agent creates is jetform.rsp. This file is created in the same location as the Print Agent executable. The data type is document.

    Trace Document

    The location in the process data model to store the trace file. The trace facility is commonly used for troubleshooting. The data type is document.

    Test Result Document

    The location in the process data model to store the field-nominated data file (*.dat). The data type is document.

    Exceptions

    This operation can throw a Central Migration Bridge exception exception.

    Central Migration Bridge exception

    The Central Migration Bridge service provides the following exceptions for throwing exception events.

    CentralMigrationBridgeException

    Thrown if an error occurs during a Central Migration Bridge operation for one of the following reasons:

    • The configured Central installation directory is not valid.

    • An error occurred starting the JFMERGE, JFTRANS, or XMLIMPORT command.

    • An unexpected error occurred during the processing of an operation.

    • An interruption occurred when processing an operation.

    // Ethnio survey code removed