Adobe Experience Manager (Preview)
Adobe Experience Manager integration allows access to Adobe Experience Manager Forms related services(e.g. Communications and more). This integration will also allow flows to be triggered when a form is submitted through Adobe Experience Manager Forms.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Adobe Experience Manager Forms |
| URL | https://www.adobe.com/go/adobe-experience-manager-forms-community |
| aem-pa@adobe.com |
| Connector Metadata | |
|---|---|
| Publisher | Adobe |
| Website | https://business.adobe.com/products/experience-manager/forms/aem-forms.html |
| Privacy policy | https://www.adobe.com/in/privacy/policy.html |
| Categories | Productivity; Business Management |
You can use Adobe Experience Manager connector to access Adobe Experience Manager Forms - Communication capabilities to create a PDF document that is based on a form design and XML form data or create PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL) and other Printer Definition Language documents.
Prerequisites
You require a license and access to Adobe Experience Manager Forms as a Cloud Service - Communication APIs to use the connector.
How to get credentials
You can get started with Adobe Experience Manager easily with just a few steps:
Generate the Service credentials
Use Adobe Experience Manager Developer Console to generate the service credentials.
Set up your connection
Add your service credentials to the Adobe Experience Manager Connector. You can get credentials from service credential JSON and copy these credential details to your one-time connection setup:
- Organization ID
- Client ID
- Client Secret
- Technical Account ID
- Meta Scopes
- Private Key
- Adobe IMS Host URL
For AEM Server, specify URL of your Adobe Experience Manager Cloud Service Author or Publish instance. For example, https://publish-pXXXX-eXXXXX.adobeaemcloud.com
Get started with your connector
The connector supports the following operations:
Generate a PDF Document from a template and merge data
You can create a PDF document that is based on a form design and XML form data. It helps you create brand-approved, personalized, and standardized documents such as business correspondences, statements, claim processing letters, benefit notices, monthly bills, or welcome kits.
A basic workflow is to merge XML form data with a form design to create a PDF document. You can create a template in Adobe Experience Manager Forms Designer.
The output of the operation is a non-interactive PDF document. That is, users cannot enter or modify the form data. You can specify the following parameters to configure various options for the operation:
| Parameter | Mandatory (Required) | Description |
|---|---|---|
| Template | Yes | The template defines appearance and behavior of the PDF document. The API supports templates of format: XDP and PDF document. You can specify a fully qualified path, reference path of your Adobe Experience Manager Repository, or a binary file. |
| Data | Yes | An XML file containing the data to be merged with template. You can specify a fully qualified HTTP location or a binary file. |
| XCI configuration | No | The service uses an XCI configuration file to configure various properties of the PDF document. The XCI parameter has an effect only when the template is of type XDP or an XDP-based PDF document. You can specify a fully qualified path, reference path of your Adobe Experience Manager Repository, or a binary file. |
| Locale | No | Locale in which pdf should be rendered. |
| Content root | No | Location of template resources (images, fragments, and more). This path is relative to template location. |
| Add tags to PDF | No | Specify to create a PDF with tags to optimize it for use with screen readers and other assistive technology. |
| Embed fonts to PDF | No | When you embed a font, the embedded font looks the same across all devices as well, but a larger output file is produced. |
| Linearize PDF (Fast Web View) | No | Choose to optimize the PDF for Fast Web View |
| Retain state | No | An interactive PDF document contains various elements that constitute a form. These elements may include fields (to accept or display data), buttons (to trigger events), and scripts (commands to perform a specific action). Clicking a button may trigger an event that changes the state of a field. For example, choosing a gender option may change the color of a field or the appearance of the form. This is an example of a manual event causing the form state to change. When such an interactive PDF document is flattened using Adobe Experience Manager Forms Communication capabilities, the state of the form is not retained. To ensure that the state of the form is retained even after the form is flattened, set the Boolean value Retain state to True to save and retain the state of the form. |
| Retain unsigned signature fields | No | Specifies whether signed and unsigned signature fields are kept when a PDF file is flattened |
| Adobe Acrobat Reader version | No | Specifies the minimum version of Acrobat Reader required to open the PDF document. The default version is Adobe Acrobat 11. |
Generate a PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL), DPL (Datamax Programming Language), IPL (Intermec Printer Language), TPCL (TEC Printer Command Language) files from a template and data
You can use document generation APIs to create PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL), DPL (Datamax Programming Language), IPL (Intermec Printer Language), TPCL (TEC Printer Command Language) document that are based on an XDP form design or PDF document. These APIs help to merge a form design with form data to generate a document. You can save the document to a file and use Power Automate to send it to a printer. You can specify the following parameters to configure various options for the operation:
| Parameter | Mandatory (Required) | Description |
|---|---|---|
| Template | Yes | The template defines appearance and behavior of the PDF document. The API supports templates of format: XDP and PDF document. You can specify a fully qualified path, reference path of your Adobe Experience Manager Repository, or a binary file. |
| Data | Yes | An XML file containing the data to be merged with template. You can specify a fully qualified HTTP location or a binary file. |
| Printer profile | Yes | Specifies the XDC file to use. XDC files are printer description files in XML format. Adobe Experience Manager Forms Communications capability uses XDC files to output documents to formats such as, PostScript, PCL, DPL, TPCL, and ZPL. XDC files are also used to specify print options such as number of copies, whether duplex printer is used, or stapler options. |
| Output type | Yes | Specifies the output file type for the operation. The supported options are PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL), DPL (Datamax Programming Language), IPL (Intermec Printer Language), TPCL (TEC Printer Command Language). |
| XCI configuration | No | Specifies the XCI file to use. XCI files are used to describe fonts that are used for form design elements. You can specify a fully qualified path, reference path of your Adobe Experience Manager Repository, or a binary file. |
| Locale | No | Locale in which output should be rendered. |
| Content root | No | Location of template resources (images, fragments, and more).This path is relative to template location. |
| Number of copies | No | Specifies the number of copies of the output file to produce. |
| Pagination | No | Specifies whether to use two-sided or single-sided printing. Printers that support PostScript and PCL use this value. |
Common errors and remedies
| Error Code | Description | Resolution |
|---|---|---|
| 403 | Forbidden. You should be a member of forms-users group to perform use the API. | Make the technical account member of the forms-users group, publish both the user (technical account) and group (forms-users). |
| 400 | The specified template is not valid. Specify a valid template and retry. | When the value of the template parameter is plain text and not a URL, convert the data xml string to binary. You can use the binary() expression of Microsoft Power Automate to make the conversion. When you use JCR path, add crx:// prefix to the path. |
| 400 | The specified data is invalid. Retry with a valid data file. | When the value of the data parameter is plain text and not a URL, convert the data xml string to binary. You can use the binary() expression of Microsoft Power Automate to make the conversion. |
| 400 | The specified XCI configuration contains some invalid values. Fix the configuration file and retry. | When the value of the XCI configuration parameter is plain text and not a URL, convert the data xml string to binary. You can use the binary() expression of Microsoft Power Automate to make the conversion |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| AEM Server | string | Specify the URL of your AEM Author or Publish instance. | True |
| Organization ID (org) | string | Specify your Organization ID. | True |
| Client ID (clientId) | string | Specify the Client ID from your service credentials. | True |
| Client Secret (clientSecret) | securestring | Specify the Client Secret from your service credentials. | True |
| Technical Account ID (id) | string | Specify the ID of your AEM technical account. | True |
| Meta Scopes (metascopes) | string | Specify Meta Scopes from your service credentials. | True |
| Private Key (privateKey) | securestring | Provide the Private Key. It is included in the service credentials. | True |
| Adobe IMS Host URL (imsEndpoint) | string | Provide host URL of the Adobe Identity Management service. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Generate a PDF from a template and data (Preview) |
Generate a PDF Document from a PDF or XDP template and merge XML data to it. |
| Generate a PS, PCL, ZPL, DPL, IPL, or TPCL file from a template and data (Preview) |
Generate a PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL), DPL (Datamax Programming Language), IPL (Intermec Printer Language) or TPCL (TEC Printer Command Language) document from an XDP file or PDF document and merge XML data to it. |
Generate a PDF from a template and data (Preview)
Generate a PDF Document from a PDF or XDP template and merge XML data to it.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template
|
template | True | binary |
Provide the binary file or location of the XDP or PDF template. |
|
Data
|
data | True | binary |
Provide the binary file or location of the XML data to be merged with the template. |
|
XCI configuration
|
xci | binary |
Provide the binary file or location of the XCI configurations file. |
|
|
Locale
|
locale | string |
Select a locale for the PDF document. |
|
|
Content root
|
contentRoot | string |
Specify the URI, absolute reference, or location to retrieve assets used in the template. |
|
|
Add tags to PDF
|
isTagged | boolean |
Create a PDF with Tags to optimize PDF for those who use screen readers and other assistive technology. |
|
|
Embed fonts to PDF
|
embedFonts | boolean |
Embed fonts in PDF for a consistent look across devices and screens |
|
|
Linearize PDF (Fast Web View)
|
linearizedPDF | boolean |
Choose to optimize the PDF for Fast Web View |
|
|
Retain state
|
retainFormState | boolean |
Choose to retain the state of the document after it is flattened. |
|
|
Retain unsigned signature fields
|
retainUnsignedSignatureFields | boolean |
Select to retain or remove the unsigned signature fields |
|
|
Adobe Acrobat Reader version
|
acrobatVersion | string |
Select the minimum version of Acrobat Reader required to open the PDF document. |
Returns
- response
- PDFResult
Generate a PS, PCL, ZPL, DPL, IPL, or TPCL file from a template and data (Preview)
Generate a PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL), DPL (Datamax Programming Language), IPL (Intermec Printer Language) or TPCL (TEC Printer Command Language) document from an XDP file or PDF document and merge XML data to it.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template
|
template | True | binary |
Provide the binary file or location of the XDP or PDF template. |
|
Data
|
data | True | binary |
Provide the binary file or location of the XML data to be merged with the template. |
|
XCI configuration
|
xci | binary |
Provide the binary file or location of the XCI configurations file. |
|
|
Locale
|
locale | string |
Select the locale for the output file. |
|
|
Content root
|
contentRoot | string |
Specify the URI, absolute reference, or location to retrieve assets used in the template. |
|
|
Number of copies
|
copies | integer |
Specify the number of copies to produce. |
|
|
Pagination
|
paginationOverride | string |
Set the option to print on one side or both the sides of a page. |
|
|
Printer profile
|
xdcUri | True | string |
Choose an XDC file describing printer capabilities such as the printer features and the paper types. |
|
Output type
|
renderType | True | string |
Choose from the available output types. |
Returns
- response
- PrintedResult
Definitions
PDFResult
- PDFOutput
- binary
PrintedResult
- PrintedOutput
- binary