CMS Connector between FrameMaker 11 and CQ 5.5 now available. And it is open source!

Dear Framers,

We are happy to announce the availability of CMS connector between FM 11 and CQ 5.5. If you recall, in September 2012, we had released a sample CQ connector with FrameMaker 11, for which Kapil blogged here. The sample connector was based on the new CMS Connector Framework and was open source so that the developers can take the connector code and build more functionality.

The new CQ connector is also open source, but it is ready to use for production environment. We have enhanced several of the features of the sample connector and added new ones. This connector is as good as other CMS connectors such as SharePoint and Documentum in terms of functionality. Furthermore, since it is open source, you can customize this connector and build even more functionality on top of what is available out-of-the-box.

We have enhanced the following sample connector workflows and made them robust and scalable in the new CQ Connector

1. Create Session and Logout: User can create a CQ session with the help of connection manager UI. After successful login, user can work on various other features like checkin, checkout etc.

2. Repository Browser: The repository browsing functionality will help user in browsing the contents of the CQ Server. The content shown in the repository browser will be of following types.

3. Upload Functionality:

4. File related features:

5. Delete: User can delete a folder, a file or file with all dependents.

6. Create Folder: User will be able to create a new folder in the CQ server.

7. File Information Features:

8. Import References: FrameMaker will also allow importing and insertion of references from CQ Server itself for e.g. importing of graphics from repository, add a component to the checkout book, insertion of cross ref etc.

Apart from making the core features robust, we have added the following new features in the CQ Connector

1. Support of DAM Assets: FrameMaker provides support for CQ DAM (Digital Asset Management), in addition to other node types such as nt:file. DAM is a digital asset management tool that enables users across an organization to manage, store, and access images, videos, documents, audio clips, and rich media such as Flash files for use on the web, in print, and for digital distribution.

2. Advanced Search: The users can now do advance search where can specify the folder path, file types, CQ Tags, and the date range during which the file was modified.

3. CQ Preferences: The user can customize the user experience of the CQ Connector by modifying the CQPreference.xml file in the FM installed directory. Following customization are possible by changing the preference file.

4. Download Dependents: During the checkout user has the flexibility to download or not download the dependent files. This feature allows users to download the dependent files for those files which were checked-out without dependent files earlier.

**5. **Show Metadata: The Metadata dialog lists the metadata associated with a node such as node type, creator tool, modified dates etc. These properties are read only and cannot be edited from the connector.

6. Copy: This feature allows users to copy certain files from one CQ folder to another.

7. Move: This feature allows users to move/cut-paste certain files from one CQ folder to another.

**8. ****Resolve Missing File: **FrameMaker automatically resolves all dependencies for files uploaded outside FrameMaker when files are opened/checked-out from the connector. Hence, saving a lot of manual effort that goes into reference resolution.

Next Steps

You can download the Adobe CQ connector from here or simply visit the FrameMaker developer page and scroll down to the section titled “CMS Connector” to learn more about the connectors. After unzipping the contents, you can see the sample connector source, compiled DLLs, Readme etc.

Related Links

  1. FDK documentation: [_](
  2. Useful Adobe CQ/CRX resources:
  3. How to get started with CQ:
  4. CQ and CRX documentation:
  5. CRX 2.3 documentation:
  6. How to install, start, and stop CRX instances: starting.html

We hope that you will find this CQ connector useful. Please let us know your feedback once you have tried and used it.

Vikram Verma – Product Manager, Adobe’s Tech Comm Products

Anchal Arora – Sr. Software Engineer, FrameMaker Team