LCCPLM

The Adobe Adobe LiveCycle ES4 - Connector for PLM (LCCPLM) 10 service enables processes to interact with a PLM (product life cycle management) system. PLM systems are designed to manage a product through its entire life cycle and integrate people, data, processes, and business systems. For example, PLM data for an engineering project can include documents, images, 2D drawings, and 3D designs.

A process can use the LCCPLM service to retrieve the information to create a PDF document that incorporates all the files associated with a PLM object (for example, an object that represents a specific project). LCCPLM service operations can also save the PDF created using PLM data, and any comments added to it, back into the PLM system. (See "LCCPLM" in Services Reference for Adobe LiveCycle ES4.)

getDataAndMetaData operation

Retrieves data and metadata for a specified PLM object by using its identifier. Metadata can include information such as a document status or comments.

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

Input properties

Property for specifying the PLM object to retrieve data and metadata for.

Request parameters

A string value that represents all the needed parameters in XML.

Output properties

Properties that specify the PLM object data and metadata.

MasterFile

(Optional) The file attached to the PLM object. The data type is document.

If you provide a variable, from the MasterFile list, select a variable. Click the plus sign button  to display the Variable dialog box to create a variable. (See Creating variables).

SecondaryFiles

(Optional) The list of files associated with the PLM object. The data type is list.

If you provide a variable, from the SecondaryFiles list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

Folder

(Optional) The folder where files are stored. The data type is string.

If you provide a variable, from the Folder list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

Doc3d

(Optional) A boolean value that specifies whether the master file is a 3D document.

If you provide a variable, from the Doc3d list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

Excluded

(Optional) A boolean value that specifies whether to convert the master file to PDF.

If you provide a variable, from the Excluded list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

ProcessName

(Optional) The name of a LiveCycle subprocess used to create the PDF. The data type is string.

If you provide a variable, from the ProcessName list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

TemplateName

(Optional) The name of the LiveCycle form template that adds metadata to the PDF. The data type is string.

If you provide a variable, from the TemplateName list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

MetadataMap

(Optional) The metadata map that contains the form data to merge and the DDX scripts (for example, to add a watermark) to execute. The data type is map.

If you provide a variable, from the MetadataMap list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

ErrorMessage

(Optional) The description of the error generated when the operation throws an exception. The description includes the message, the class name, and stack trace information. The data type is string.

If you provide a variable, from the ErrorMessage list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

Data and MetaData Descriptor

(Optional) The data and metadata retrieved by the operation. The data type is DataAndMetaDataDescriptor.

If you provide a variable, from the Data and MetaData Descriptor list, select a variable. Click the plus sign button to display the Variable dialog box to create a variable. (See Creating variables).

Exceptions

This operation can throw the LccplmException exception.

saveCommentsFromDocument operation

Saves comments associated with a PLM object that are captured as PDF data. The comments can be stored in the PLM system with the object.

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

Input properties

Properties for specifying the file that contains the comments to store in the PLM system.

XDPData

A document value that specifies the file that contains PDF data, including comments.

Exceptions

This operation can throw the LccplmException exception.

saveCommentsFromString operation

Saves comments associated with a PLM object that are captured as an XML string. The comments can be stored in the PLM system with the object. Reserved for use with a future release.

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

Input properties

Properties for specifying the comments to store in the PLM system.

XDPData

A string value that specifies the comments in XFDF (XML Forms Data Format), in Base64 encoding. Adobe Reader 9.2 or later allows you to export PDF content by using XFXF.

Exceptions

This operation can throw the LccplmException exception.

storePDF

Checks into the PLM system the PDF that was generated using a PLM object.

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

Input properties

Properties for specifying the PDF to check into the PLM system.

Request parameters

A string value that represents all the needed parameters in XML.

path of temporary folder containing the PDF

A string value that represents the folder that contains the PDF and associated files.

file

A document value that specifies the PDF file to check into the PLM system.

Output properties

Property to specify error message information for the storePDF operation.

ErrorMessage

(Optional) The description to generate when the operation throws an exception. The description includes the message, the class name, and stack trace information. The data type is string.

If you provide a variable, from the ErrorMessage list, select a variable. Click the plus sign button  to display the Variable dialog box to create a variable. (See Creating variables).

Exceptions

This operation can throw the LccplmException exception.

LCCPLM exceptions

The LCCPLM service provides the following exception for receiving exception events.

LccplmException

Thrown when an LCCPLM operation fails. Provides an error code that identifies the error.