Agents can associate and execute post processing workflows on letters. Post process to be executed can be selected in the Properties view of the Letter template. You can set up post processes to email, print, fax, or archive your final letters.
To associate post processes with letters, you first need to set up the post processes. Two types of workflows can be executed on submitted letters:
To authenticate a process/service, copy the name of a process and go back to the Adobe Experience Manager Web Console Configurations page > Adobe LiveCycle Client SDK Configuration and add the process as a new service.
For example, if the drop-down in Properties page of letter displays name of the process as Forms Workflow -> ValidCCPostProcess/SaveXML, add a Service Name as ValidCCPostProcess/SaveXML.
To use LiveCycle workflows for post processing, set up the necessary parameters and outputs. Default values of the parameters are indicated below.
Go to the Adobe Experience Manager Web Console Configurations page > Correspondence Management Configurations and set up the following parameters:
- inPDFDoc (PDF document parameter): A PDF document as input. This input contains the rendered letter as input. The parameter names indicated are configurable. They can be configured from Correspondence Management configurations from configuration.
- inXMLDoc (XML data parameter): An XML document as input. This input contains data entered by user in the form of XML.
- inXDPDoc (XDP document parameter): An XML document as input. This input contains underlying layout (XDP).
- inAttachmentDocs (Attachment Documents parameter): A list input parameter. This input contains all the attachments as input.
- redirectURL (Redirect URL Output): An output type indicating the url to redirect to.
Your forms workflow must have either PDF document parameter or XML data parameter as input with the same name as specified in Correspondence Management Configurations. This is required for the process to be listed in the Post Process dropdown.
Click Tagging and then create a tag named Correspondence_Management under the Standard Tags folder, in case it does not already exist previously. For more information on creating tags, see Using and Managing Tags.
In the Step Properties dialog:
- On the Process tab, select the name of the custom process and check Handler Advance. For more information on creating custom workflow steps, see Extending Workflow Functionality.
- On the Common tab, give a title to the process step.
The workflow you created is now activated and appears in the list of workflows in the Post Process field with the prefix AEM Workflow -> when you try to create a letter or edit properties of a letter in your Correspondence Management implementation.
Once you select an AEM Workflow (here EMailWorkflow), the following new fields appear:
(The following fields appear in the interface only when you select Structure Payload as Folder.)
- Structure Payload as:
- Folder(Recommended): Structuring payload as folder saves the data, such as Data File, Attachment, Layout, and PDF, in folders as files. When you select Folder(Recommended), the following four fields appear: Data File Path, Attachment Path, Layout Path, and PDF Path.
- Letter Instance(Deprecated): Structuring payload as a letter Instance saves the data in a letter instance node on CRX. This option is not recommended.
- Data File Path: Specify the CRX path of the output file (JSON or XML) relative to the payload folder. This file contains the letter data as filled in by the user and can be utilized in the post process, such as for creating a document of record.
- Attachment Path: Specify the CRX path, relative to the payload folder, where the letter attachment will be saved for use in the post process, such as for sending attachments along with the letter for signing.
- Layout Path: Specify the CRX path, relative to the payload folder, of output layout (XDP) for utilizing in post processes, such as for rendering a PDF of the letter for review.
- PDF Path: Specify the CRX path of output PDF relative to the payload folder. The output PDF can be further used for processes, such as printing or storing.
- Structure Payload as:
Your integration of the letter and the post process is complete. You can now publish the letter by selecting it and clicking Publish. Further, you need to design the post process for e-mailing. Similarly, you can integrate other workflows and then go on to create the back-end workflows.
For more information on creating AEM Workflows, see the AEM Workbench documentation.
While using either Forms or AEM workflows, before you make any submission from the publish server, it is necessary to configure the DS settings service. Otherwise, the Form submission shall fail.
Saved letter instances can be manipulated further, such as retrieval of letter instances and deletion of letter instances, by using the following APIs defined in LetterInstanceService.
|Server-side API||Operation name||Description|
|getLetterInstance||Fetch the specified letter instance|
|Public void deleteLetterInstance(String letterInstanceId) throws ICCException;||deleteLetterInstance||Deleted the specified letter instance|
|List getAllLetterInstances(Query) throws ICCException;||getAllLetterInstances||This API fetches letter instances based on the input query parameter. To fetch all letter instances, query parameter can be passed as null.
|Public Boolean letterInstanceExists(String letterInstanceName) throws ICCException;||letterInstanceExists||Check if a LetterInstance exists by the given name|
A draft letter instance can be reloaded in user interface by using the following url:
LetterInstaceID: The unique ID of the submitted letter instance.
For more information on saving a draft letter, see Saving drafts and submitting letter instances.