com.adobe.livecycle.centralmigrationbridge.client
Class CentralMigrationBridgeServiceClient

java.lang.Object
  com.adobe.livecycle.centralmigrationbridge.client.CentralMigrationBridgeServiceClient

public class CentralMigrationBridgeServiceClient
extends java.lang.Object

The CentralMigrationBridgeServiceClient class lets you create a CentralMigrationBridgeServiceClient object that invokes operations supported by the CentralMigrationBridge service. This service lets your organization perform the following operations:

• Merge data in various formats with electronic form templates for printing.
• Take information from a single transaction file and present the information in different views on different printers.
• Print multiple copies of electronic templates by including data for more than a single template in one transaction file.
• Load and unload macros in printers to make the most effective use of printer memory in printers that support managed memory.
• Converts data in a transaction file from one format to another.

This class was added in LiveCycle ES2.

Constructor Summary

CentralMigrationBridgeServiceClient(ServiceClientFactory serviceClientFactory)
A constructor that creates a CentralMigrationBridgeServiceClient object.

Method Summary

Document	centralDataAccess(Document inData, int maxBytesToProcess) Converts a Central Field Nominated data file (DAT file)to XML data.
CentralResult	centralMerge(Document inTemplateDoc, Document inDataDoc, Document inPreambleDoc, java.lang.String inDestination, java.lang.String inIniFilePath, java.lang.String inAllOtherOptions) Merges data in various formats with electronic templates for printing.
CentralResult	centralTransformation(Document inDataDoc, Document inDataModelDoc, java.lang.String inIniFilePath, java.lang.String inAllOtherOptions) Reformats a data file into accepted data formats, which include field-nominated, fixed record, comma-delimited, or XML data by executing the jfTrans command.
CentralResult	centralXMLImport(Document inDataDoc, java.lang.String inXCIFilePath, java.lang.String inAllOtherOptions) Transforms well-formed XML data into a field-nominated format.
boolean	isSynchronous() For internal use only.
void	setSynchronous(boolean synchronous) Sets the CentralMigrationBridge service to be invoked synchronously.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CentralMigrationBridgeServiceClient

public CentralMigrationBridgeServiceClient(ServiceClientFactory serviceClientFactory)

A constructor that creates a CentralMigrationBridgeServiceClient object.

Parameters:

serviceClientFactory - A ServiceClientFactory object that contains connection properties. For information about setting connection properties, see Invoking LiveCycle Services using APIs in Programming with LiveCycle ES4.

Method Detail

isSynchronous

public boolean isSynchronous()

For internal use only.

setSynchronous

public void setSynchronous(boolean synchronous)

Sets the CentralMigrationBridge service to be invoked synchronously. A synchronous request is blocked until the service finishes processing the request and returns the result back to the caller.

Parameters:

synchronous - A Boolean value that specifies whether the service is invoked synchronously.

centralMerge

public CentralResult centralMerge(Document inTemplateDoc,
                                  Document inDataDoc,
                                  Document inPreambleDoc,
                                  java.lang.String inDestination,
                                  java.lang.String inIniFilePath,
                                  java.lang.String inAllOtherOptions)
                           throws CentralMigrationBridgeException,
                                  com.adobe.idp.dsc.DSCException

Merges data in various formats with electronic templates for printing. For example, invoke this method to merge a form design with data to create a PDF or PCL file, which contains the form with filled-in values.

Parameters:

inTemplateDoc - A com.adobe.idp.Document object that stores an input MDF template.

inDataDoc - A com.adobe.idp.Document object that stores data to merge with the MDF template.

inPreambleDoc - A com.adobe.idp.Document object that stores the preamble file to merge with the output file..

inDestination - A string value that specifies a location to send the output file to. When a file location is specified, the file is saved to the location on the LiveCycle ES server or network location. A file location, such as C:\mergedFiles\newmergefile.pcl is saved on the LiveCycle ES server. When a printer location is specified, it must be an absolute address such as \\myprintername.

inIniFilePath - 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 located in the Central Pro Output Server installation folder is used.

inAllOtherOptions - A string value that represents additional command line options that can be added to affect the processing of the jfMerge command. Each command line option must be separated by a space. You can specify any command line options other than -apr,-all,-z.

Returns:

A com.adobe.idp.Document object that represents the merged document if printerLocation is not specified, otherwise null.

Throws:

CentralMigrationBridgeException - If invalid operation specific values are specified such as specifying invalid input data.

com.adobe.idp.dsc.DSCException - If a general exception is thrown due to invalid settings such as invalid connection properties.

centralTransformation

public CentralResult centralTransformation(Document inDataDoc,
                                           Document inDataModelDoc,
                                           java.lang.String inIniFilePath,
                                           java.lang.String inAllOtherOptions)
                                    throws CentralMigrationBridgeException,
                                           com.adobe.idp.dsc.DSCException

Reformats a data file into accepted data formats, which include field-nominated, fixed record, comma-delimited, or XML data by executing the jfTrans command. For example, use this method to reformat an existing data file in a format so that you can merge it with a form design. You can also use this method to change existing data, such as dates from MM-DD-YYYY to DD-MM-YYYY format.

This method converts data created in ASCII format, including fixed length, character-delimited, overlay, and central proprietary field-nominated format.

Parameters:

inDataDoc - A com.adobe.idp.Document object that represents the data to transform.

inDataModelDoc - A document value that represents definition file describing how to reformat the data file.

inIniFilePath - A string value that represents the location of a custom ini file for the jfTrans command, such as C:\Custom\customjfTrans.ini.

inAllOtherOptions - A string value that represents additional command line options that can be added to affect the processing of the jfTrans command. Each command line option must be separated by a space. You can specify any command line options other than -apr,-all,-z.

Returns:

A com.adobe.idp.Document object that represents the transformed data.

Throws:

CentralMigrationBridgeException - If invalid operation specific values are specified such as specifying invalid data to convert.

com.adobe.idp.dsc.DSCException - If a general exception is thrown due to invalid settings such as invalid connection properties.

centralXMLImport

public CentralResult centralXMLImport(Document inDataDoc,
                                      java.lang.String inXCIFilePath,
                                      java.lang.String inAllOtherOptions)
                               throws CentralMigrationBridgeException,
                                      com.adobe.idp.dsc.DSCException

Transforms well-formed XML data into a field-nominated format. This operation enables the creation of external documents, such as invoices, statements, and packing slips in a variety of formats.

Parameters:

inDataDoc - A com.adobe.idp.Document object that represents XML data to transform.

inXCIFilePath - A string value that represents the path to a XCI file used in the transformation process.

inAllOtherOptions - A string value that represents additional command line options that can be added to affect the processing of the xmlImport command. Each command line option must be separated by a space. You can specify any command line options other than -config command line option.

Returns:

A CentralResult object that stores the results of the operation.

Throws:

CentralMigrationBridgeException - If invalid operation specific values are specified such as specifying XML data that is not well formatted.

com.adobe.idp.dsc.DSCException - If a general exception is thrown due to invalid settings such as invalid connection properties.

centralDataAccess

public Document centralDataAccess(Document inData,
                                  int maxBytesToProcess)
                           throws CentralMigrationBridgeException,
                                  com.adobe.idp.dsc.DSCException

Converts a Central Field Nominated data file (DAT file)to XML data. The XML data that is created can be used by other LiveCycle ES services.

Parameters:

inData - A com.adobe.idp.Document object that represents the Central field nominated data file (DAT file).

maxBytesToProcess - An integer value that specifies the number of bytes in the data file to process.

Returns:

A com.adobe.idp.Document that contains XML data.

Throws:

CentralMigrationBridgeException - If invalid operation specific values are specified such as specifying an invalid central field nominated data file.

com.adobe.idp.dsc.DSCException - If a general exception is thrown due to invalid settings such as invalid connection properties.