Ready to get started?

Learn more about the CData JDBC Driver for Alfresco or download a free trial:

Download Now

Query Alfresco Data in ColdFusion

Write standard ColdFusion data access code to connect to Alfresco data.

The CData JDBC Driver for Alfresco seamlessly integrates connectivity to Alfresco data with the rapid development tools in ColdFusion. This article shows how to connect to Alfresco data in ColdFusion and query Alfresco tables.

Create a JDBC Data Source for Alfresco in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:alfresco: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Alfresco JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.alfresco.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.alfresco.AlfrescoDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Alfresco data source in the Actions column. After reporting a status of OK, the Alfresco data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Alfresco. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="AlfrescoQuery" dataSource="CDataAlfresco"> SELECT * FROM Alfresco WHERE Column2 = <cfqueryparam value="#Column2#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#AlfrescoQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Alfresco WHERE Column2 = ?", 
  [
    { value="MyFilter", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAlfresco" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?Column2=MyFilter