Install Workfront for Experience Manager enhanced connector assets-integration-overview
A user with administrator access in Adobe Experience Manager as a Cloud Service installs the enhanced connector. Before you install, review the platform support and other prerequisites for the connector.
-
Adobe requires deployment and configuration of the Adobe Workfront for Experience Manager enhanced connector only via certified partners or Adobe Professional Services. If deployed and configured without a certified partner or Adobe Professional Services, it is not supported by Adobe.
-
Adobe may release updates to Adobe Workfront and Adobe Experience Manager that make this connector redundant; if this occurs, customers may be required to transition from the use of this connector.
-
Adobe supports enhanced connector versions 1.7.4 and higher. Previous prerelease and custom versions are not supported. To check the enhanced connector version, see step 5(a) of enhanced connector installation instructions.
-
See Partner certification exam for Workfront for Experience Manager Assets enhanced connector. For information about the exam, see Exam Guide.
Before you install the connector, follow these pre-installation steps:
-
If your AEM as a Cloud Service Program has configured Advanced Networking and enabled IP Allow-Listing, then you need to add the Workfront IPs to this allow-list to permit Event Subscriptions and various API calls to pass through into AEM.
-
Workfront Cluster IPs. To know the IP cluster in Workfront, navigate to Setup > System > Customer Info.
note important IMPORTANT -
If you have Advanced Networking configured for your program and are using IP Allow Listing, then due to a limitation with the Enhanced Workfront Connector architecture you also need to add the program egress IP to the allow-list in Cloud Manager.
-
p{PROGRAM_ID}.external.adobeaemcloud.com
-
To find the IP of your program, open a terminal window and run a command, such as:
code language-none dscacheutil -q host -a name p{PROGRAM_ID}.external.adobeaemcloud.com
-
-
Ensure that the following overlays do not exist in Experience Manager repository. If you have pre-existing overlays on these paths you either need to remove the overlays, or merge the delta of changes between the two:
/apps/dam/gui/coral/components/admin/schemaforms/formbuilder
/apps/dam/gui/coral/components/admin/folderschemaforms/formbuilder
/apps/dam/gui/content/foldermetadataschemaeditor
/apps/dam/cfm/models/editor/components/datatypeproperties
/apps/settings/dam/cfm/models/formbuilderconfig
/apps/dam/gui/content/assets/jcr:content/actions/secondary/create/items/fileupload
-
This installation requires the knowledge to set a Maven project in Experience Manager as a Cloud Service. Use the following resources to understand how to include a third-party package in your Maven project:
To install the add-on in Experience Manager as a Cloud Service, follow these steps:
-
Download the enhanced connector from Adobe Software Distribution.
-
Access and clone your AEM as a Cloud Service repository from Cloud Manager.
-
Open the cloned AEM as a Cloud Service repository using an IDE of your choice.
-
Place the enhanced connector zip file downloaded in Step 1 at the following path:
code language-txt /ui.apps/src/main/resources/<zip file>
note note NOTE If the resources
folder does not exist, create the folder. -
Add
pom.xml
dependencies:-
Add a dependency in parent
pom.xml
.code language-xml <dependency> <groupId>digital.hoodoo</groupId> <artifactId>workfront-tools.ui.apps</artifactId> <type>zip</type> <version>enhanced connector version number</version> <scope>system</scope> <systemPath>${project.basedir}/ui.apps/src/main/resources/workfront-tools.ui.apps.zip</systemPath> </dependency>
note note NOTE Ensure to update the enhanced connector version number before copying the dependency to the parent pom.xml
. -
Add a dependency in
all module pom.xml
.code language-xml <dependency> <groupId>digital.hoodoo</groupId> <artifactId>workfront-tools.ui.apps</artifactId> <type>zip</type> <scope>system</scope> <systemPath>${project.basedir}/../ui.apps/src/main/resources/workfront-tools.ui.apps.zip</systemPath> </dependency>
-
-
Add
pom.xml
embeds. Add the Workfront for Experience Manager enhanced connector packages toembeddeds
section of thepom.xml
of all your subproject. Needs it embedded in the all modulepom.xml
.code language-xml <!-- Workfront Tools --> <embedded> <groupId>digital.hoodoo</groupId> <artifactId>workfront-tools.ui.apps</artifactId> <type>zip</type> <target>/apps/<path-to-project-install-folder>/install</target> </embedded>
The target of the embedded section is set to
/apps/<path-to-project-install-folder>/install
. This JCR path/apps/<path-to-project-install-folder>
must be included in the filter rules in theall/src/main/content/META-INF/vault/filter.xml
file. The filter rules for the repository are usually derived from the program name. Use the name of the folder as the target in the existing rules. -
Push the changes to the repository.
-
Run the pipeline to deploy the changes to Cloud Manager.
-
To create a system user configuration, create
wf-workfront-users
in Experience Manager User Group and assign the permissionjcr:all
to/content/dam
. A system userworkfront-tools
is automatically created and the required permissions are managed automatically. All users from Workfront who use the enhanced connector are automatically added as a part of this group.
For information to update the Workfront for Experience Manager enhanced connector from a previous version to the latest version, click here.
Configure the connection between Experience Manager as a Cloud Service and Workfront configure-connection
To create a connection with Workfront, follow these steps:
-
In Experience Manager, select Tools > Cloud Services > Workfront Tools Configuration.
-
Select
workfront-tools
in the left panel and select Create option in the upper-right area of the page. -
In the Workfront Connection dialog, provide the required details of your Workfront deployment, and select Connect to Workfront option. Once successfully connected, the Workfront document custom integration is auto-created in the Workfront environment.
-
Navigate to the Advanced tab and select the option Is the Server AEM as a Cloud Service.