Hostek.com Wiki - User contributions [en]

Mura

2016-08-18T15:35:25Z

Kylet:

=Introduction=

Here you'll find a compilation of issues or tips related to the Mura content management system.

To fix many Mura issues, upgrading Mura itself may be your best solution. Find more on that below.

==Upgrading Mura==

If your ColdFusion site runs Mura CMS, you should ensure it's "Core Files" are always up-to-date. This is easy to do from the Mura Admin section and will help improve performance and security. Follow the directions below to update your Mura Core Files:

'''Update/Upgrade Mura by running the auto-aupdate feature from your admin section''':
*Click the '''Settings''' link at the very top of the Mura admin page.
*Click '''Update Mura Core''' in the dropdown menu that appears
*In the popup that appears, click '''Yes''' to proceed with the automatic upgrade.

Mura will confirm when the update completes. Please note, this will not update your site files. 
For more info on this topic, see the '''[http://docs.getmura.com/index.cfm/developer-guides/best-practices/ Mura Best Practices Guide]'''.

=Editing Mura SEO SEF URLs - Overview=

How to enable different SEO/SEF URL settings for Mura

The URLs used by Mura are controlled by two settings in the configuration file '''/config/settings.ini.cfm''':
siteidinurls=0
indexfileinurls=0

A settings of''' '0' '''disables the option, and a setting of''' '1' '''enables the option.

===siteidinurls===

This option tells Mura to put the '''siteid''' in the URLs for links. Enable this option if you would like the name of the site to appear in the URL. Otherwise, disable it.

===indexfileinurls===

This option controls whether Mura puts '''index.cfm''' in the URLs for links. Enable this option if you want '''index.cfm''' to appear in the URL or do not want to use URL rewriting. Disable this option if you would like to use URL rewriting or do not want '''index.cfm''' shown in the URL.

==Site ID and index.cfm in URLs==

This option is easy to enable. Simply configure both URL settings in the '''/config/settings.ini.cfm''' as follows:
siteidinurls=1
indexfileinurls=1

==Remove Site ID and index.cfm from URLs==

This is the most common SEO/SEF setting. Configure both URL settings in the '''/config/settings.ini.cfm''' as follows:
siteidinurls=0
indexfileinurls=0

Then, do one of the following:

'''IIS 6:'''

Rename the file '''htaccess.txt''' to '''.htaccess'''.

'''IIS 7+:'''

Rename the file '''web.config.txt''' to '''web.config'''.

==Remove Site ID from URLs but include index.cfm in URLs==

This option is easy to enable. Simply configure both URL settings in the '''/config/settings.ini.cfm''' as follows:
siteidinurls=0
indexfileinurls=1

==Include Site IDs in URLs but remove index.cfm from URLs==

Configure both URL settings in the '''/config/settings.ini.cfm''' as follows:
siteidinurls=1
indexfileinurls=0

Then, do one of the following:

'''IIS 6:'''

Rename the file '''htaccess.txt''' to '''.htaccess'''. Then, edit the '''.htaccess''' file and follow the instructions in the file for enabling SiteIDs in URLs.

'''IIS 7+:'''

Rename the file '''web.config.txt''' to '''web.config'''. Then, edit the '''.htaccess''' file and follow the instructions in the file for enabling SiteIDs in URLs.

=Mura Problems and Solutions=
==Fixing Mura links with Hyphens in the URL==

When enabling SEO-friendly URLs, sometimes you run into pages that need multiple words in the URL. This requires the use of a hyphen, which often breaks Mura's redirection system. Below is an overview on the problem.

===Overview===

Example situation:

http://www.example.com/ has a few pages on their Mura site that look like this:
 
http://www.example.com/mura-page 
http://www.example.com/links-and-examples 
 
With the default Mura redirection rules, these links will cause IIS to parse the links instead of the Mura CMS, which takes the user to a 404 page. The fix is simple, but can be tricky to implement if you're unfamiliar with .htaccess files.

===.htaccess Fix===

The hyphen has to be the last character in the .htaccess character expression. Otherwise, it signifies a range between two characters.

So, you just have to move the hyphen to the end of the character expression in your .htaccess rewrite rules. Below is what the .htaccess file should look like with the change:
<pre>
# This is for rewriting urls "WITHOUT" siteIDs
# To remove the Mura siteID directory and index.cfm from urls you must also set both siteIDInURLS and indexFileInURLs to 0 in your /config/setting.ini.cfm and reload Mura.
Options +FollowSymLinks
RewriteEngine On
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
RewriteRule ^([a-zA-Z0-9/-]+/tag/.+|tag/.+)$ /index.cfm%{REQUEST_URI} [PT]
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
RewriteRule ^([a-zA-Z0-9/-\s-]+)$ /index.cfm%{REQUEST_URI} [PT]
</pre>

The last line has a hyphen added right after the 's':

<pre>
RewriteRule ^([a-zA-Z0-9/-\s-]+)$ ...
</pre>

Once this change has been made your URLs with hyphens should now be functional! Below is a full, fixed .htaccess file. Make sure to remove the single #'s for whichever rewrite is currently enabled on your site:

<pre>
## This is for rewriting urls "WITHOUT" siteIDs
## To remove the Mura siteID directory and index.cfm from urls you must also set both siteIDInURLS and indexFileInURLs to 0 in your /config/setting.ini.cfm and reload Mura.
# Options +FollowSymLinks
# RewriteEngine On
# RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
# RewriteRule ^([a-zA-Z0-9/-]+/tag/.+|tag/.+)$ /index.cfm%{REQUEST_URI} [PT]
# RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
# RewriteRule ^([a-zA-Z0-9/-\s-]+)$ /index.cfm%{REQUEST_URI} [PT]

## This is for rewriting urls "WITH" siteIDs
## To remove the Mura siteID directory and index.cfm from urls you must also set siteIDInURLS to 1 and indexFileInURLs to 0 in your /config/setting.ini.cfm and reload Mura.
# RewriteEngine On
# RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
# RewriteRule ^([a-zA-Z0-9-]{1,})/^([a-zA-Z0-9/-]+/tag/.+|tag/.+)$ /$1/index.cfm/$2 [PT]
# RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
# RewriteRule ^([a-zA-Z0-9-]{1,})/([a-zA-Z0-9/-\s-]+)$ /$1/index.cfm/$2 [PT]
</pre>
==Mura loading incorrect URL==
If your Mura site redirects to an invalid URL or the wrong domain, use the steps below to correct the issue.
===How to Change Domain Via Mura Admin===
'''Steps:'''
#Log into your site's Mura Admin
#Hover over the ''Site Config'' icon, then click the ''Site Settings'' link
#In the '''Primary Domain''' field, enter the correct domain ''(without the http:// prefix or trailing slash)''
#Scroll to the bottom of the page and click the ''Update'' button.
#Hover over the ''Settings'' link at the very top of the page, and click the ''Reload Application'' link

Mura should respond as expected when you visit the correct domain now.
===How to Change Domain When Mura Admin Won't Load===
If your Mura Admin site won't load because of this issue, you can change the domain in the database. Mura stores its domain name in the ‘tsettings’ table of its database.

'''Steps:'''
#Log into phpMyAdmin ''(mysql)'' or myLittleAdmin ''(ms sql)''
#Find the '''tsettings''' table and edit it
#Edit the '''domain''' field and change its value to the correct domain name ''(don't put the http:// prefix or trailing slash)''
#After saving your changes reload Mura ''(hit the URL with /?appreload at the end)''

The site should now load from the correct domain.

==Mura 404 Errors==
===Ensure the Page Exists Within Mura Site Manager===
If you encounter a 404 error on a Mura site, the first thing to check is that the page giving the error is actually created in Mura. A common example of this is some links on Mura's default site (the sample site loaded upon installation) such as the Sitemap link will give a 404 error. This is because the page needs to be created within Mura's Site Manager.
===Check the Site's Rewrite Rules===
If you've already made sure the URL giving the 404 has a corresponding page within Mura's Site Manager, then you'll need to make sure your rewrite rules are correct. If the page giving a 404 consists of two words, then you may just need to implement the ".htaccess" fix described above to ensure Mura rewrites the dashes between words properly.

==Mura Error - Element SERVICEFACTORY is undefined in APPLICATION==
When this error occurs, you'll need to manually update your Mura files for the version running on your site.
===Finding your site's Mura version===
To find the version of Mura running on your site, open the '''/requirements/mura/configBean.cfc'''.

Around line 51 of that file, you should see your site's version listed within a tag that looks like:
<syntaxhighlight lang="cfm" >
<cfset variables.instance.version="6.1"/>
</syntaxhighlight>

The line could read ''6.1'', ''6.0'', ''5.6'', ''etc''. This is your site's Mura version.

===Manually update Mura 6.1+ files===
#[https://github.com/blueriver/MuraCMS/archive/master.zip Download the latest version of Mura]
#Back up your ''/config/settings.ini.cfm'' file
#Unzip the Mura Master zip then copy and paste everything '''except''' the ''default'' directory over your existing Mura install.
#Make a Reload/DBUpdate request to the Mura root ''(eg. http://yousite.com/?appreload&applydbupdates)''
===Manually update Mura 6.0 files===
#[https://github.com/blueriver/MuraCMS/archive/6.0.zip Download Mura 6.0]
#Back up your ''/config/settings.ini.cfm'' file
#Unzip the Mura 6.0 zip then copy and paste everything '''except''' the ''default'' directory over your existing Mura install.
#Make a Reload request to the Mura root ''(eg. http://yousite.com/?appreload)''
===Manually update Mura 5.x files===
#[https://github.com/blueriver/MuraCMS/archive/5.x.zip Download Mura 5.x]
#Back up your ''/config/settings.ini.cfm'' file
#Unzip the Mura 5.x zip then copy and paste everything '''except''' the ''default'' directory over your existing Mura install.
#Make a Reload request to the Mura root ''(eg. http://yousite.com/?appreload)''

After performing those steps you should no longer see the ''Element SERVICEFACTORY is undefined in APPLICATION'' error.
==Mura Error - key [FIELDNAMES] doesn't exist in struct (keys)==
When uploading items through the Mura file uploader, you may encounter the error: '''''key [FIELDNAMES] doesn't exist in struct (keys)'''''

This error means that the buffer size for your Web server connector is larger than the buffer size for your servlet container (''Tomcat in Railo and ColdFusion 10+''). This means that the Web server sends more data in a POST request than Railo/ColdFusion can handle, and the POST request fails.

Our shared servers have been configured to prevent this from happening, but if your VPS has custom settings for its Web server connector and Tomcat AJP connector, check the following:
===Railo VPS and Dedicated Servers===
*Open the open the configuration file for the BonCode IIS/Tomcat connector which ships with Railo. This is located at '''''C:\Windows\BonCodeAJP13.settings'''''
*Check for a '''PacketSize''' setting. It may look like this: ''<PacketSize>'''65536'''</PacketSize>''
*Now open the Tomcat '''server.xml''' configuration file located here: '''''{Railo Install Dir}/tomcat/conf/server.xml'''''
*Find the line for the AJP/1.3 connector. Ensure the '''packetSize''' attribute is present and that it is set to the same value as the Boncode connector.
*;Example: ''<Connector port="8009" protocol="AJP/1.3" redirectPort="8443" maxThreads="250" connectionTimeout="120001" '''packetSize="65536"'''/>''
*After making the packet size the same within the Boncode connector and Tomcat, restart IIS and Railo for the new settings to take effect
===ColdFusion 10+ VPS and Dedicated Servers===
*Open the open the configuration file for the JK IIS/Tomcat connector which ships with ColdFusion 10+. By default, this is located at '''''{CF Install Dir}/config/wsconfig/1/workers.properties'''''
*Check for a '''max_packet_size''' setting. It may look like this: ''max_packet_size='''65536'''''
*Now open the Tomcat '''server.xml''' configuration file located here: '''''{CF Install Dir}/cfusion/runtime/conf/server.xml'''''
*Find the line for the AJP/1.3 connector. Ensure the '''packetSize''' attribute is present and that it is set to the same value as the JK connector.
*;Example: ''<Connector port="8012" protocol="AJP/1.3" redirectPort="8445" maxThreads="250" '''packetSize="65536"'''/>''
*After making the packet size the same within the JK connector and Tomcat, restart IIS and ColdFusion for the new settings to take effect

==java.lang.IllegalArgumentException: wrong number of arguments==

[https://github.com/blueriver/MuraCMS/issues/2113 Fixed Issue for CF2016 in Mura]

CF2016 has some compatibility problems with how JavaLoader.cfc works. This has been fixed in Mura, but some plugins for Slatwall and Mura may include their own JavaLoader.cfc that needs the fix.

JavaProxy.cfc around line 67

<syntaxhighlight lang="diff">
constructor = _resolveMethodByParams("Constructor", _getClass().getConstructors(), arguments);

- instance = constructor.newInstance(_buildArgumentArray(arguments));
+ if (StructCount(arguments) > 0){
+ instance = constructor.newInstance(_buildArgumentArray(arguments));
+ } else {
+ instance = constructor.newInstance(JavaCast("null", 0));
+ }

_setClassInstance(instance);
</syntaxhighlight>

[[Category:Mura]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:VPS]]
[[Category:ColdFusion-VPS]]
[[Category:Railo-VPS]]

ColdFusion Tips & Tricks

2016-03-28T14:01:32Z

Kylet: remove dead links and ColdFusion 32bit reference.

==Converting Application.cfm to Application.cfc==
Using an '''Application.cfc''' configuration file offers some advantages over the older style '''Application.cfm''' configuration files. Some of the main features that an Application.cfc file give you are "functions triggered by Application, Session, Request, and Error events" and "Application-Level Mappings and Custom Tag Paths".

There are only a few steps required to convert an application to use an Application.cfc file:

NOTE: You should ensure that you have a backup of any files before making changes to them.

===Create an '''Application.cfc''' file===

Below is an example '''Application.cfc''' file with the minimum requirements:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfscript>
this.name = hash( getCurrentTemplatePath() ); // unique app name
</cfscript>
</cfcomponent>
</syntaxhighlight>
Setup '''onRequest''' function in '''Application.cfc''' to include the '''Application.cfm''' file

This step is only necessary if an Application.cfm file already exists in the root of the application. Below is what the Application.cfc file will look like after this addition:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfscript>
this.name = hash( getCurrentTemplatePath() ); // unique app name
</cfscript>

<cffunction name="onRequest" returnType="void">
<cfargument name="targetPage" type="string" required="true" />


<cfinclude template="Application.cfm" />


<cfinclude template="#ARGUMENTS.targetPage#" />
</cffunction>
</cfcomponent>
</syntaxhighlight>

===Copy application settings from the '''cfapplication''' tag and remove the '''cfapplication''' tag===

This step is only necessary if a cfapplication tag is used within the application. Each attribute of the cfapplication tag will need to be copied into the cfscript section at the top of the Application.cfc with the pattern [this.attributeName = "value";].

For example. The below cfapplication tag would be converted into our Application.cfc example as follows:

'''cfapplication''' tag:
<syntaxhighlight lang="cfm">
<cfapplication
name = "my_app_name"
sessionManagement = "Yes"
sessionTimeout = "#createTimeSpan(0,0,20,0)#"
setClientCookies = "Yes">
</syntaxhighlight>

'''Application.cfc''':
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfscript>
this.name = "my_app_name"; // app name from old cfapplication tag
this.sessionManagement = "Yes";
this.sessionTimeout = CreateTimeSpan(0,0,20,0);
this.setClientCookies = "Yes";
</cfscript>

<cffunction name="onRequest" returnType="void">
<cfargument name="targetPage" type="string" required="true" />


<cfinclude template="Application.cfm" />


<cfinclude template="#ARGUMENTS.targetPage#" />
</cffunction>
</cfcomponent>
</syntaxhighlight>

'''NOTE''': Do not forget to remove the '''cfapplication''' tag after copying the settings into the '''Application.cfc''' file.

Now that the change is complete, this is a good time to test the application to ensure everything is working correctly with the new setup.

==Per-Application ColdFusion Mappings==
In ColdFusion 8 and above, it is possible to create per-application mappings through your site's Application.cfc file. If you wish to convert to using an Application.cfc file, follow the steps [[ColdFusion_Tips_%26_Tricks#Converting_Application.cfm_to_Application|here]].

Once you have your Application.cfc created, you will insert the following line:
<syntaxhighlight lang="cfm">
<cfset this.mappings["/test"]="d:\home\yourdomainname.com\wwwroot\test">
</syntaxhighlight>

On your site though, you would change "/test" to the name of your mapping. IMPORTANT: You need to include the forward slash before the name of your mapping. Also, change "d:\home\yourdomainname.com\wwwroot\test" to the full physical path to the folder you wish to map.
'''Note''': The physical path to your FTP root is listed in the "Site Settings" of your control panel at wcp.hostek.com.

To call a template named "testing.cfm" in the "test" directory we just mapped, you would use this line:
<syntaxhighlight lang="cfm">
<cfinclude template="/test/testing.cfm">
</syntaxhighlight>

==Per-Application Custom Tag Paths==
Starting in ColdFusion 8, ColdFusion allows creation of Custom Tag Paths in each site's Application.cfc file. This allows you to create and manage your Custom Tag Paths without having to use CF Administrator (ie. submit a support ticket). The following steps will help you create a Custom Tag Path:

If you do not already have an Application.cfc file in your site's Web root, create one now.
Place the following code in the Application.cfc file and save:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfset THIS.customtagpaths="d:\home\yourdomain.com\wwwroot\customtagfolder">
</cfcomponent>
</syntaxhighlight>

In this case, you'd replace "yourdomain.com" with your domain name, and "customtagfolder" with the name of the folder you created for your custom tags.

Now you have successfully added your custom tag path. If you have multiple tag paths to add, try using the following code instead:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfset THIS.customtagpaths=ListAppend(THIS.customtagpaths, "d:\home\yourdomain.com\wwwroot\customtagfolder")>
</cfcomponent>
</syntaxhighlight>
==Per-application Robust Exception Information Settings==
To enable Robust Exception Information on a ColdFusion application, you will need to add the following to the top of the site's ''Application.cfc'' file:
<syntaxhighlight lang="cfm"><cfset this.enablerobustexception = true /></syntaxhighlight>
Alternatively, if you wish to ensure Robust Exception Information is ''always'' disabled for an application, add this to the site's ''Application.cfc'':
<syntaxhighlight lang="cfm"><cfset this.enablerobustexception = false /></syntaxhighlight>

==Per-application JSON Prefix==
To enable the JSON Prefix for your application add the following to the site's '''Application.cfc''' file, and adjust the '''secureJSONPrefix''' as desired:
<syntaxhighlight lang="cfm">
<cfset this.secureJSON = true>
<cfset this.secureJSONPrefix = "//">
</syntaxhighlight>

Alternatively, you can disable this feature using the following code instead:
<syntaxhighlight lang="cfm">
<cfset this.secureJSON = false>
</syntaxhighlight>

==Restart a ColdFusion Application==
If you ever need to restart your site's ColdFusion application (to pick up a setting change, etc), you can do so via the ApplicationStop() function in ColdFusion 9+.

To use this you can create a file (ex: restart.cfm) containing the following code:
<syntaxhighlight lang="cfm">
<cfset ApplicationStop() />
<cflocation url="index.cfm" addtoken="false" />
</syntaxhighlight>
When you run the file containing that code your ColdFusion Application will be stopped (flushing your application scope), and when the browser is redirected to the index page the application will start again.
==CFHTTP Connection Failures over HTTPS==
===Fixing cfhttp Failures on Shared Hosting===
If you try to use <cfhttp> to connect to a secure site (over HTTPS), you may receive the following error: "Connection Failure: Status code unavailable"

To fix this add the following code to your site's "Application.cfm" file (below the 'cfapplication' tag):
<syntaxhighlight lang="cfm">

<cfif NOT isDefined("Application.sslfix")>
<cfset objSecurity = createObject("java", "java.security.Security") />
<cfset objSecurity.removeProvider("JsafeJCE") />
<cfset Application.sslfix = true />
</cfif>
</syntaxhighlight>
If your site uses an "Application.cfc" file instead, then just place that code in the "'onApplicationStart()" method of that file. After making that adjustment you'll need to restart your ColdFusion application as [[ColdFusion_Tips_%26_Tricks#Restart_a_ColdFusion_Application|shown here]]. If you still run into issues though, you will need to [https://support.hostek.com/ submit a support ticket] asking our team to install the remote site's SSL certificate into ColdFusion's Java Certificate Store.

===Fixing cfhttp Failures on VPS Hosting===
If you are having issues connecting to a site or file from with ColdFusion over HTTPS, you can import the remote site's SSL certificate into the the Java SSL Certificate Store used by ColdFusion.
====Fixing cfhttp Connection Failures with Keytool====
'''1) Set Java environment''' 
First, you'll need to find the version of Java being used by ColdFusion. To do this, open the jvm.config for your server. Depending on your server's version of ColdFusion, that file is at one of the following locations: 
 '''ColdFusion 9 single-instance''': C:\ColdFusion9\runtime\bin 
'''ColdFusion 9 multi-instance''': C:\ColdFusion9\bin 
'''ColdFusion 10''': C:\ColdFusion10\cfusion\bin 

''Note:'' If your server is a '''Linux/cPanel''' server, the jvm.config file will be in one of the following locations:
'''ColdFusion 9''': /usr/local/coldfusion9/bin
'''ColdFusion 10''': /opt/coldfusion10/cfusion/bin
 
Once opened, look for "java.home" at toward the top of the ''jvm.config'' file. You use the value of that variable in the next command. For '''example''', you may see this:
java.home=C:\\ColdFusion10\\jre
In that case, you would use '''C:\ColdFusion10\jre''' as the value of JAVA_HOME as shown below. Open a command prompt and issue the following commands:
C:\ColdFusion10\jre>set JAVA_HOME=C:\ColdFusion10\jre
C:\ColdFusion10\jre>set PATH=%PATH%;%JAVA_HOME%\bin

''Note:'' If your server is a '''Linux/cPanel''' server, use the following commands (case-sensitive) in your terminal:
This '''example''' assumes that the JRE is located at ''/opt/coldfusion10/jre''
export JAVA_HOME=/opt/coldfusion10/jre
export PATH=$PATH:/opt/coldfusion10/jre

'''2) List the Keystore Contents''' 

If your Java installation is at ''C:\ColdFusion10\jre'', then navigate to '''C:\ColdFusion10\jre\bin''':
cd C:\ColdFusion10\jre\bin
If you're using a '''Linux/cPanel''' server, use this command instead:
cd /opt/coldfusion10/jre/bin

Now you can list the keystore contents ''(Windows & Linux)'':
keytool -list -storepass changeit -keystore ../lib/security/cacerts

Example output:
Keystore type: JKS
Keystore provider: SUN
Your keystore contains 76 entries

'''3) Import certificate in to keystore and list to check added ''' 
''(assumes you've downloaded the certificate to '''c:\temp\inet.cer''' (Windows) or '''/temp/inet.cer''' (Linux/cPanel)'' 
'''Windows'''
keytool -importcert -storepass changeit -alias inet -keystore ../lib/security/cacerts -trustcacerts -file c:\temp\inet.cer

'''Linux'''
keytool -importcert -storepass changeit -alias inet -keystore ../lib/security/cacerts -trustcacerts -file /temp/inet.cer
Trust this certificate? [no]: y
Certificate was added to keystore

Now verify the keystore contains your new certificate
keytool -list -storepass changeit -keystore ../lib/security/cacerts
Example output:
Keystore type: JKS
Keystore provider: SUN
Your keystore contains 77 entries

'''4) Restart the ColdFusion application service so the keystore is re-read.''' 

'''5) Run your cfhttp request - HTTPS works now!'''

====Fixing cfhttp Connection Failures with Portecle====
If you'd rather import certificates into the Java SSL Keystore through a GUI, follow these directions to use a tool named Portecle to do so:

#Ensure your JAVA_HOME variable is set correctly as described above.
#Download Portecle from Sourceforge: [http://sourceforge.net/projects/portecle/ Portecle Project Homepage]
#Extract the files
#Open a Command Prompt and navigate to the extracted directory
#Issue this command to launch Portecle: <pre>java -jar portecle.jar</pre>
#In Notepad, open your jvm.config file to find the JVM PATH for ColdFusion's JVM; look for '''java.home={path here}'''
#In Portecle click ''File'', ''Open Keystore File''
#Browse to {JVM PATH}\jre\lib\security to the path, and open the cacerts file; Enter Password: '''changeit'''
#Click on '''Tools''', '''Import Trusted Certificate''', select the certificate you wish to import.
#*To obtain the certificate, you can navigate in a browser to the site where the certificate resides, then download the certificate to a .CER file, in the '''DER''' format (or the '''X.509''' format) through the browser.
#*#In IE on the server where you will import the certificate into ColdFusion, browse to the site where you will import the cert from.
#*#Click on the lock, then view the certificate.
#*#Click the details, click "Copy to file" click through.
#*#Select DER format, then save to "D:\certs" or "C:\certs" (if the folder isn't there, simply create it).
#Click '''OK''' to import and '''YES''' to accept the certificate as ''trusted''.
#Click '''OK''' again, usually you won't need to change the Alias name; click '''OK''' to finish.
#Click '''File''', '''Save Keystore'''.
#Close Portecle.
*'''Important:''' A ColdFusion Restart is necessary for this to take effect.

====Fixing CFHTTP Failures Related to Cached DNS Records====
This solution will prevent Java from caching DNS records for the life of the ColdFusion process. Instead, Java will refresh its records periodically.

First, you'll need to find the version of Java being used by ColdFusion. To do this, open the jvm.config for your server. Depending on your server's version of ColdFusion, that file is at one of the following locations: 
'''ColdFusion 9 single-instance''': C:\ColdFusion9\runtime\bin 
'''ColdFusion 9 multi-instance''': C:\ColdFusion9\bin 
'''ColdFusion 10''': C:\ColdFusion10\cfusion\bin 

''Note:'' If your server is a '''Linux/cPanel''' server, the jvm.config file will be in one of the following locations:
'''ColdFusion 9''': /usr/local/coldfusion9/bin
'''ColdFusion 10''': /opt/coldfusion10/cfusion/bin
 
Once opened, look for "java.home" at toward the top of the ''jvm.config'' file. You use the value of that variable to find the location of the Java installation used by ColdFusion.

For '''example''', on '''Windows''' you may see this:
java.home=C:\\ColdFusion10\\jre
On '''Linux''' you may see this:
java.home=/opt/coldfusion10/jre

Navigate to the '''security''' folder within the Java installation used by ColdFusion. For '''example''': 
'''Windows''' ''(open in Windows Explorer)''
C:\ColdFusion10\jre\lib\security\
'''Linux\cPanel'''
cd /opt/coldfusion10/jre/lib/security/

Back-up, then edit the '''java.security''' file within that folder and change the following line: 
'''From'''
#networkaddress.cache.ttl=-1
'''To'''
networkaddress.cache.ttl=600

''Note:'' The above value refreshes DNS records every 600 seconds ''(10 minutes)''. You may adjust it to whatever you feel is appropriate for your server.

Now '''Save''' the file then '''Restart ColdFusion''', and the new DNS caching setting will take effect.

==CFMAIL Multi-Part Emails==
Sending emails with both Text and HTML parts helps reduce the chance of your messages getting caught by a mail server's spam filter. It also helps ensure your recipients can read the message regardless of the mail client being used. The easiest way to do this is to store your message in a variable using <cfsavecontent> then adding it to <cfmail> using <cfmailpart> as shown in the example below:
<syntaxhighlight lang="cfm">

<cfsavecontent variable="myemailcontent">
Hello,

This is some plain text. 
And this is some more text in HTML. It will appear in plain-text for anyone who views the Text part of this email, though.
</cfsavecontent>


<cffunction name= "textMessage" access= "public" returntype= "string" hint= "Converts an html email message into a nicely formatted with line breaks plain text message">
<cfargument name= "string" required= "true" type= "string">
<cfscript>
var pattern = " ";
var CRLF = chr( 13) & chr( 10);
var message = ReplaceNoCase(arguments.string, pattern, CRLF , "ALL");
pattern = "<[^>]*>";
</cfscript>
<cfreturn REReplaceNoCase(message, pattern, "" , "ALL")>
</cffunction>


<cfmail from="sender@domain.com" to="recipient@anotherdomain.com" subject="Multi-part Email with CFMAIL" type="html">
<cfmailpart type= "text/plain" charset= "utf-8">#textmessage(myemailcontent)#</cfmailpart>
<cfmailpart type= "text/html" charset= "utf-8">#myemailcontent#</cfmailpart>
</cfmail>
</syntaxhighlight>

Reference: [http://cookbooks.adobe.com/post_CFMAIL_the_right_way-17875.html CFMAIL the right way]

==Scheduling Tasks in ColdFusion==
On occasion shared ColdFusion hosting customers need to setup Scheduled Task to run files on a cycle.

This can be done with the following steps, making use of ColdFusion's <cfschedule> tag:

#Create a file locally using any text editor, save the file with the .CFM extension (example: setschedule_example.cfm).
#Copy and past in the code example below taken from ''ColdFusion's Documentation'' and save.
#Replace the data in the example note the following recommendations. !- Name each file made for creating a schedule with the name of the task so you can reference the task later if needed. Specific naming will also make it more difficult for someone to randomly run the file. !- If you need to schedule a job to run monthly on any date in the range 28-31, read about how ColdFusion will handle the scheduling in the ColdFuison8 documentation referenced below.
#Working example, the code example below is a working tested solution for getting the weather for a specific zip code and the task to email the results.

'''Scheduled Task'''
<syntaxhighlight lang="cfm">

<cfschedule action = "update"
task = "Weather_Send"
operation = "HTTPRequest"
url = "http://test.hostek.net/weather_send.cfm"
startDate = "7/6/09"
startTime = "09:30 AM"
interval = "3600"
resolveURL = "Yes"
requestTimeOut = "600"
mode = "application">









</syntaxhighlight>

'''Weather Collector'''
<syntaxhighlight lang="cfm">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CF External Weather Checker</title>
</head>

<body>

<cfset zip="12345">

<cfinvoke webservice="http://ws.cdyne.com/WeatherWS/Weather.asmx?wsdl" method="getCityWeatherByZIP" returnvariable="aWeatherReturn">
<cfinvokeargument name="ZIP" value="#zip#"/>
</cfinvoke>

<cfif aWeatherReturn.temperature EQ "">
<cfoutput> I cannot get the weather for #zip# external http connections must be DOWN.</cfoutput>
<cfelse>
<cfset message="The temperature for #zip# (Your city) is #aWeatherReturn.temperature# degrees.">
</cfif>

<cfif message NEQ "">

<cfmail from = "weather.server@test.com" to = "test@test.com" subject = "Weather checker">

#message#

</cfmail>

</cfif>

</body>
</html>
</syntaxhighlight>

'''Note''': We highly recommend setting the ''mode'' attribute of cfschedule to ''application''. This will ensure your site's application is the only one allowed to modify the task. 
'''More information on using CFSchedule''' 
*[https://wikidocs.adobe.com/wiki/display/coldfusionen/cfschedule Adobe ColdFusion Documentation - CFSchedule]
*[http://www.isummation.com/blog/configuring-coldfusion-scheduled-tasks-using-the-cfschedule-tag/ iSummation Blog - Configuring ColdFusion Scheduled Tasks using the CFSCHEDULE tag]

==Session Management - Handling Bots and Spiders==
===Robots.txt File===
First and foremost we suggest creating a robots.txt file in the web root of the domain to address two issues. First to control the rate at which the website is being crawled which can help prevent a bot/spider from creating a massive number of database connections at the same time. Second to prevent specific bots from crawling the website.

Please see our [[Robots|robots.txt article]] for more information on implementing a robots.txt on your site.

===Lower Session Timeouts for Bots and Spiders===
Next we suggest setting your session timeout specifically lower for bots and spiders. These spiders and bots will crawl a page and when a session (ColdFusion) is created, it will persist during then entire page load. The page fully loaded allows the bot or spider to get the information from the Web page AND allows the session to expire quickly protecting ColdFusion from effects similar to a memory leak.

To do this, implement the appropriate solution for your site below:

====If using '''Application.cfm'''====
Place this code at the top of your Application.cfm file:
<syntaxhighlight lang="cfm">

<cfif StructKeyExists(cookie, "cfid") or StructKeyExists(cookie, "jsessionid")>
<cfset REQUEST.sessionTimeout = CreateTimeSpan(0,0,30,0) />
<cfelse>
<cfset REQUEST.sessionTimeout = CreateTimeSpan(0,0,0,2) />
</cfif>
</syntaxhighlight>
Then use the '''REQUEST.sessionTimeout''' variable to specify the session timeout period in your '''cfapplication''' tag:
<syntaxhighlight lang="cfm">
<cfapplication name="myawesomeapp"
sessionmanagement="Yes"
sessiontimeout="#REQUEST.sessionTimeout#">
</syntaxhighlight>

====If using '''Application.cfc''' (tag-based)====
If you primarily use cfml tags in your Application.cfc, you can set the Session Timeout like this:
<syntaxhighlight lang="cfm">

<cfif StructKeyExists(cookie, "cfid") or StructKeyExists(cookie, "jsessionid")>
<cfset this.sessiontimeout = CreateTimeSpan(0,0,30,0) />
<cfelse>
<cfset this.sessiontimeout = CreateTimeSpan(0,0,0,2) />
</cfif>
</syntaxhighlight>

====If using '''Application.cfc''' (cfscript)====
If instead, you're using cfscipt in your Application.cfc, you'll set the custom Session Timeout like this:
<syntaxhighlight lang="cfm">
// This checks if a cookie is created, for bots this will return false and use the low session timeout
if (StructKeyExists(cookie, "cfid") || StructKeyExists(cookie, "jsessionid")){
this.sessionTimeout = createTimeSpan(0,0,30,0);
} else {
this.sessionTimeout = createTimeSpan(0,0,0,2);
}
</syntaxhighlight>

'''Reference''': [http://www.bennadel.com/blog/1083-ColdFusion-Session-Management-And-Spiders-Bots.htm Session Management code examples for the Application.cfm]

==Creating Client Variables Tables for MySQL Databases==
If you need your datasource set up as a ColdFusion Client Variables Store, you can enable the '''Client Variables'' option in your ColdFusion datasource within the WCP control panel.

Please note, if your datasource MySQL DSN, you'll need to create the necessary tables prior to using the Client Variable Store. To do this you would need to create two tables, one named "cdata" and one named "cglobal". The SQL you'd use to create those tables is below:

Table: '''cdata'''
<syntaxhighlight lang="mysql">
CREATE TABLE IF NOT EXISTS cdata (
cfid varchar(64) NOT NULL default '',
app varchar(64) NOT NULL default '',
data longtext NOT NULL,
PRIMARY KEY (cfid,app)
);
</syntaxhighlight>
Table: '''cglobal'''
<syntaxhighlight lang="mysql">
CREATE TABLE IF NOT EXISTS cglobal (
cfid varchar(64) NOT NULL default '',
data longtext NOT NULL,
lvisit timestamp,
KEY cfid (cfid),
KEY lvisit (lvisit)
);
</syntaxhighlight>

==Output CF Error details without CFDump==
It is common in an error handler that you want to output all of the error details to the screen, a file, or an email. Therefore, the cfdump tag is commonly used for this; and, while this works well in development, it is not always the best practice on a production site because of the performance of the cfdump tag due to its use of reflection (Runtime type introspection).

A better performing alternative is to output the information you want directly from the Error/Exception struct within a 'cfoutput' tag. This can be done by looking up the cferror structure or the cfcatch structure in the ColdFusion docs to see what is available and what values you might want to output: 
'''Error''': https://wikidocs.adobe.com/wiki/display/coldfusionen/cferror 
'''CFCatch''': https://wikidocs.adobe.com/wiki/display/coldfusionen/cfcatch

===Cfdump Custom Tag Alternative===
You can also use the following link to download an example CF custom tag that will give a similar error output as when using the cfdump tag on an error variable: 
[http://hostek.com/tutorials/ColdFusion/CF_OutputError.zip http://hostek.com/tutorials/ColdFusion/CF_OutputError.zip]

Below is the custom tag's usage:

In the error handler specified in your 'cferror' tag:
<syntaxhighlight lang="cfm">
<cf_OutputError Error="#Error#" />
</syntaxhighlight>

The above code would replace:
<syntaxhighlight lang="cfm">
<cfdump var="#Error#" />
</syntaxhighlight>

Or, in a cfcatch block:
<syntaxhighlight lang="cfm">
<cftry>
...
<cfcatch>
<cf_OutputCFCatch CFCatch="#CFCatch#" />
</cfcatch>
</cftry>
</syntaxhighlight>

==Configure ColdFusion to Handle html and htm Files==
===Enable HTML/HTM as CFML on Shared Accounts===
On our ColdFusion servers, the best way to process HTML files (.html, .htm) as ColdFusion/CFML (.cfm files) is by using a set of rewrite rules that route the HTML files through a ColdFusion "controller" script. The main benefits of this approach are that it is easy to implement on a site-by-site basis, and it works with any version of ColdFusion. To implement this approach on your site, follow the steps below:
====Step 1: Add Rewrite Rules to Route HTML Files through the CFM Controller====
If you have a '.htaccess' file in your webroot, add the rules below to the top of that file. Otherwise, create a file named '.htaccess' in your site's web root and place these rules within it:
=====For Sites Using .HTML Files=====
<syntaxhighlight lang="apache">
#Rewrite requests without script name to index.html
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*) /index.html [R]

# REDIRECT to change the address in the browser address bar
RewriteRule ^/htmlcontrol.cfm$ /$1.html [R]

# REWRITE so that the correct page executes when /cart is the URL
RewriteRule ^(.*)\.html htmlcontrol.cfm/?pageName=$1 [L]
</syntaxhighlight>
=====For Sites Using .HTM Files=====
'''NOTE:''' If your site uses ''.htm'' files instead of ''.html'' files, use this set of rules instead. The only difference is ''html'' is replaced with ''.htm''.
<syntaxhighlight lang="apache">
#Rewrite requests without script name to index.html
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*) /index.htm [R]

# REDIRECT to change the address in the browser address bar
RewriteRule ^/htmlcontrol.cfm$ /$1.htm [R]

# REWRITE so that the correct page executes when /cart is the URL
RewriteRule ^(.*)\.htm htmlcontrol.cfm/?pageName=$1 [L]
</syntaxhighlight>
====Step 2: Create the ColdFusion Controller Script (htmlcontrol.cfm)====
Now we just need to create a ColdFusion script that will process the HTML files. To do this, create a file named '''htmlcontrol.cfm''' within your site's web root. Place this CFML code within the file:
=====CFML for Sites Using .HTML Files=====
<syntaxhighlight lang="cfm">
<cfinclude template="#URL.pageName#.html" >
</syntaxhighlight>
=====CFML for Sites Using .HTM Files=====
<syntaxhighlight lang="cfm">
<cfinclude template="#URL.pageName#.htm" >
</syntaxhighlight>

Once you save the controller script, your site will begin processing any ColdFusion/CFML code within your HTML files.
===Enable HTML/HTM as CFML on a VPS===
In case you need to process ColdFusion code in your .htm or .html files, here is what you will need to do to get this to work. This is based on using ColdFusion on one of our dedicated server hosting accounts on a Windows server.

'''NOTE''': This will affect every site on the server, so use cautiously.

First, you will need to edit the web.xml file located generally at C:\ColdFusion10\cfusion\wwwroot\WEB-INF

Open this file and look for '''coldfusion_mapping_1'''.

Scroll down the file until you see the last number increment like:
<syntaxhighlight lang="xml">
<servlet-mapping id="macromedia_mapping_15">
</syntaxhighlight>
Then add the following right below the closing </servlet-mapping> of the last number increment item:

<syntaxhighlight lang="xml">
<servlet-mapping id="coldfusion_mapping_16">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.html</url-pattern>
</servlet-mapping>
<servlet-mapping id="coldfusion_mapping_17">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.html/*</url-pattern>
</servlet-mapping>
<servlet-mapping id="coldfusion_mapping_18">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.htm</url-pattern>
</servlet-mapping>
<servlet-mapping id="coldfusion_mapping_19">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.htm/*</url-pattern>
</servlet-mapping>
</syntaxhighlight>
Save this file and exit.

Now in IIS, setup a mapping for the site:
#In IIS 7+ click the server name section (right below the '''Start Page''' in the left-hand navigation), then double-click the '''Handler Mappings''' icon.
#Select and "edit" the '''*.cfm''' record and copy the value of "executable". Now hit Cancel and then click '''Add Script Map'''.
#Paste the executable value copied from the '''*.cfm''' record and type '''*.htm''' into the '''Request Path''' and hit OK.
#Repeat the above steps to add a handler for '''*.html'''

Lastly, open the '''uriworkermap.properties''' file for your ColdFusion 10 IIS Connector in a text editor such as Notepad. On a standard ColdFusion installation this is located at: <pre>C:\ColdFusion10\config\wsconfig\1\uriworkermap.properties</pre>
Copy the following lines, paste them at the bottom of the file, then save and close the file: <pre>/*.html = cfusion
/*.htm = cfusion</pre>

Now restart the ColdFusion service and IIS. ColdFusion should begin processing CFML within htm/html files now.

==Increase the ColdFusion Post Parameters Limit==
===ColdFusion 10+===
In ColdFusion 10 and higher, you can easily increase the value of ColdFusion's '''postParametersLimit''' via the ColdFusion Administrator. Once logged into the ColdFusion Administrator, click the '''Settings''' link then scroll to the bottom of the page. Set the value for the Post Parameters Limit to the desired limit and click the submit button.

===ColdFusion 9 and below===
To adjust the Post Parameters Limit setting in ColdFusion 9 and below, you will have to edit the server's '''neo-runtime.xml''' file which is located here on a standard installation: <pre>C:\ColdFusion9\lib</pre>

Open that file in a text editor such as Notepad, then search for the '''postSizeLimit''' tag. It will look similar to this:
<syntaxhighlight lang="xml"><var name='postSizeLimit'><number>100.0</number></var></syntaxhighlight>

Immediately after that set of tags, paste this chunk of text:
<syntaxhighlight lang="xml"><var name='postParametersLimit'><number>1000.0</number></var></syntaxhighlight>
Once you've adjusted the file, you'll just need to save your changes and restart ColdFusion for the new setting to go into effect. '''Note''': The value of '''1000''' is just an example, so you can increase it as needed.

==Loading custom Java library or Java Libraries (jar or class files) in ColdFusion 10==
ColdFusion 10 makes it easy to load Java libraries into your ColdFusion application without having to restart ColdFusion. All that's required is your application define the 'THIS.javaSettings' attribute within the site's Application.cfc like below:
<syntaxhighlight lang="cfm">
<cfset THIS.javaSettings = {LoadPaths = ["/javafiles/"], loadColdFusionClassPath = true, reloadOnChange=false}/>
</syntaxhighlight>

The above code will check the ''javafiles'' directory in your Web root for 'jar' and 'class' files and make any libraries within the directory accessible from your ColdFusion application. If you modify the JAR files in your ''javafiles'' directory though, ColdFusion will need to be restarted to load the new versions of the JAR files.

*Alternative Option to Restarting ColdFusion:
#Instead of Restarting ColdFusion we've seen success in just restarting a client's specific application, here is how:
#*[https://wiki.hostek.com/ColdFusion_Tips_%26_Tricks#Restart_a_ColdFusion_Application How to Restart a ColdFusion Application]

'''References''':
*[https://wikidocs.adobe.com/wiki/display/coldfusionen/Enhanced+Java+integration+in+ColdFusion+10 Adobe ColdFusion Documentation - Enhanced Java Integration in ColdFusion]

==How to handle ColdFusion Error ''Permission denied for creating Java object: coldfusion.server.ServiceFactory''==
===When using Mura or using Transfer ORM===
====Issue====
If you are using '''Mura''' or using '''Transfer ORM''' and you get this error, ''Permission denied for creating Java object: coldfusion.server.ServiceFactory'', you are likely using an outdated version of Mura and also are probably on a ColdFusion 9 server. The Transfer ORM component causing this issue has not been updated to work with ColdFusion 9. There is a quick fix though:
====Solution====
Find the file named CFMLVersion.cfc which should be at '''/wwwroot/requirements/transfer/com/factory'''.

Edit that file and find the line that has:
<syntaxhighlight lang="cfm">
if(server.coldfusion.productversion.startsWith("8"))
</syntaxhighlight>
And change that to:
<syntaxhighlight lang="cfm">
if(server.coldfusion.productversion.startsWith("8") OR server.coldfusion.productversion.startsWith("9"))
</syntaxhighlight>
Save the file and it should now work.

'''NOTE''': Since this is likely running an outdated version of Mura, we highly recommend updating Mura to the latest version to take advantage of numerous performance and security enhancements.
===When using DataMgr===
If you get this error while using DataMgr.cfc, the changes described below will solve this problem:

Here is the section of code from the original DataMgr.cfc:

<syntaxhighlight lang="cfm">
<cffunction name="getDataBase" access="public" returntype="string" output="no" hint="I return the database platform being used.">

<cfset var connection = 0>
<cfset var db = "">
<cfset var type = "">
<cfset var qDatabases = getSupportedDatabases()>

<cfif Len(variables.datasource)>
<cfset connection = getConnection()>
<cfset db = connection.getMetaData().getDatabaseProductName()>
<cfset connection.close()>

<cfswitch expression="#db#">
<cfcase value="Microsoft SQL Server">
<cfset type = "MSSQL">
</cfcase>
<cfcase value="MySQL">
<cfset type = "MYSQL">
</cfcase>
<cfcase value="PostgreSQL">
<cfset type = "PostGreSQL">
</cfcase>
<cfcase value="Oracle">
<cfset type = "Oracle">
</cfcase>
<cfcase value="MS Jet">
<cfset type = "Access">
</cfcase>
<cfcase value="Apache Derby">
<cfset type = "Derby">
</cfcase>
<cfdefaultcase>
<cfif ListFirst(db,"/") EQ "DB2">
<cfset type = "DB2">
<cfelse>
<cfset type = "unknown">
<cfset type = db2>
</cfif>
</cfdefaultcase>
</cfswitch>
<cfelse>
</syntaxhighlight>

Here is what the modified code should look like (this sample assume MySQL)

<syntaxhighlight lang="cfm">
<cffunction name="getDataBase" access="public" returntype="string" output="no" hint="I return the database platform being used.">

<cfset var connection = 0>
<cfset var db = "">
<cfset var type = "">
<cfset var qDatabases = getSupportedDatabases()>

<cfif Len(variables.datasource)>




<cfswitch expression="#db#">
<cfcase value="Microsoft SQL Server">
<cfset type = "MSSQL">
</cfcase>
<cfcase value="MySQL">
<cfset type = "MYSQL">
</cfcase>
<cfcase value="PostgreSQL">
<cfset type = "PostGreSQL">
</cfcase>
<cfcase value="Oracle">
<cfset type = "Oracle">
</cfcase>
<cfcase value="MS Jet">
<cfset type = "Access">
</cfcase>
<cfcase value="Apache Derby">
<cfset type = "Derby">
</cfcase>
<cfdefaultcase>
<cfif ListFirst(db,"/") EQ "DB2">
<cfset type = "DB2">
<cfelse>
<cfset type = "unknown">
<cfset type = "db2">
</cfif>
</cfdefaultcase>
</cfswitch>
<cfset type = "MYSQL">
<cfelse>
</syntaxhighlight>

'''Summary of changes''':

These 3 lines were commented out:
<syntaxhighlight lang="cfm">



</syntaxhighlight>

This line needed quotes around db2:
<syntaxhighlight lang="cfm">
<cfset type = "db2">
</syntaxhighlight>

And lastly, this line needed added:
<syntaxhighlight lang="cfm">

<cfset type = "MYSQL">
</syntaxhighlight>

'''NOTE''': If you are using an ''MS Access'' database instead of ''MySQL'', replace '''MYSQL''' with '''msaccessjet''' on the line that is added.

==How to handle ColdFusion Error ''Security: The requested template has been denied access to {file/directory}''==
===Issue===
Our shared servers have ColdFusion Sandbox Security enabled, which requires absolute filesystem paths to be provided to tags and functions that interact with the filesystem. If you receive an error that starts with ''Security: The requested template has been denied access to ...'', then it is followed by a relative path, you'll need to replace the relative path with a full path.

===Solution===
One way to do this is to hard-code the path (''d:\home\sitename.com\wwwroot\filename.jpg''), but that can cause portability problems if your site is ever moved to a different environment.

A better way to do this would be to "wrap" your relative path with the '''ExpandPath()''' function. The ''ExpandPath()'' function will automatically detect the absolute filesystem path to the file, and ColdFusion will no longer give you a permissions error.

'''More info''': [https://wikidocs.adobe.com/wiki/display/coldfusionen/ExpandPath Adobe Documentation - ExpandPath]

==How to handle ColdFusion COM Object Error ''java.lang.RuntimeException: Can not use native code: Initialisation failed''==
The error ''java.lang.RuntimeException: Can not use native code: Initialisation failed'' is related to calling a 32-bit COM object from within a 64-bit ColdFusion installation.

The simplest way to bypass this error is to write a small ASP Webservice to proxy the call to the COM object as shown in '''Option 2''' of this blog post: [http://coldfusion9.blogspot.com/2010/05/32-bit-components-on-64-bit-coldfusion.html 32-bit Components on 64-bit ColdFusion]

==Using SeeFusion to Monitor ColdFusion Performance on a VPS/Dedicated Server==
To use Seefusion, visit the address mentioned in your server's Welcome email.

Once loaded, you'll see a summary of memory consumption, average response time, number of requests processed by ColdFusion per second, and a view of currently running ColdFusion requests.
===Finding Scripts to Optimize===
When using Seefusion it is helpful to look at the '''Slow''' section of the request monitor. This will show you recent requests that took longer than 8 seconds to complete, giving you a good idea of what scripts need optimization.
===Stack Tracing with Seefusion===
Additionally, when a request is running in the '''Active''' section of Seefusion's request monitor, you can click the paper stack icon to the left of the request to view a stack trace of the request. A stack trace tells you what line of code is currently being processed by the request.

Once the stack trace loads, start at the top and work your way down until you find a recognizable path to a ColdFusion template (''eg. c:\home\mysite.com\wwwroot\index.cfm: 47''). This tells you the template currently being executed followed by the line number being processed at that moment in time. If a request consistently shows the same line of code in subsequent stack traces, then you've found the main area to focus on optimizing.

To make deciphering stack traces easier, you can also click the '''Seestack''' button at the top of the stack trace window. This will send the stack trace to a service that will analyze the trace and attempt to tell you where you need to focus.

===Viewing Metrics over Time===
If you want to watch how response times and memory utilization in a more granular manner than the dashboard graphs show, you'll want to click the '''Counters''' button at the top of SeeFusion. Once on the Counters page you can select a time interval, then have Seefusion display performance metrics at the interval you selected. This is helpful to ensure requests are completing quickly and not exhausting ColdFusion's memory.

==How to Wrap Your ColdFusion DSN with Seefusion==
If you wish to have Seefusion monitor your server's query activity, you'll need to "wrap" your DSN with SeeFusion's JDBC driver so Seefusion can monitor the DSN's activity.
===Install SeeDSN===
SeeDSN is a plugin for ColdFusion Administrator that makes it easy to wrap a DSN with Seefusion. Follow these directions to install SeeDSN:
#Download the SeeDSN archive [http://www.seefusion.com/seedsn_v1.1.zip here].
#Extract the '''seedsn''' folder within the archive to your '''/CFIDE/Administrator/''' folder. This means it will be located at ''/CFIDE/Administrator/seedsn'' once extracted.
#Move ''/CFIDE/Administrator/seedsn/custommenu.xml'' to ''/CFIDE/Administrator/custommenu.xml''
===Add Seefusion.jar to the ColdFusion Classpath===
In order for ColdFusion to use Seefusion's JDBC driver, you'll need to ensure '''seefusion.jar''' is on your ColdFusion class path. Follow these directions to add seefusion.jar to the Coldfusion class path:
#Log into your server's ColdFusion Administrator
#Click the '''Java and JVM''' link on the left, under Server Settings.
#In the box labeled '''ColdFusion Class Path''' add the path to your '''seefusion.jar''' file and click ''Submit Changes''. For example, if it is located in ColdFusion's "WEB-INF\lib" folder, you can add this to the Class Path: '''{application.home}/wwwroot/WEB-INF/lib/seefusion.jar'''.
#*Each path in the ColdFusion Class Path is separated by a comma, so be sure to add a comma right before the path to seefusion.jar (do not add any spaces).
#Restart ColdFusion after modifying the class path

===Wrap a DSN using SeeDSN===
Once you've installed SeeDSN and restarted ColdFusion, you can wrap a DSN with the SeeFusion JDBC driver. Follow these instructions to do so:
#Log into ColdFusion Administrator
#Expand the ''SeeFusion'' navigation menu on the left and click '''Datasource Wrapper'''
#On the ''Datasource Wrapper'' page, you'll see a list of DSNs on your server. To wrap a DSN, click the ''Start'' [[File:Start.png]] icon next to your DSN. SeeDSN will automatically wrap your DSN with the SeeFusion driver and display '''OK''' if it is successful.

'''Reference''': [http://www.webapper.com/blog/index.php/2009/06/08/seedsn-a-jdbc-wrapping-tool-for-use-with-seefusion/ WebApper Blog - Using SeeDSN JDBC Wrapping Tool]

==Using fckEditor on ColdFusion 10 or Higher==
When getting the following error for fckEditor:
'''"The server didn't reply with a proper XML data. Please check your configuration."'''

If you are on a ColdFusion 10+ server this will be cause by the '''FileUpload()''' function that is being used.
In ColdFusion 10+ ''FileUpload'' is a built-in function name, so you'll need to rename the ''FileUpload'' function used in fckeditor.
You can update the text for fckeditor by changing all instances of "FileUpload" to "fckFileUpload" to remove this conflict.

==Optimze CFIMAGE Rendering in Three Steps==
===USE===
When full size images are required, re-sized images need to be used for displaying smaller images or thumbnails and the application needs to perform at optimal speed for displaying images in a browser.

===KEY POINTS===
Except for during development cfimage '''action="writeToBrowser"''' should not be used to display images.
Use CFIMAGE to resize images ''ONCE'', if possible during upload but if page timeouts make this impossible break up the task by using a CFC to check and re-size images as needed.

===SUMMARY===
Those sites that display many images often times also upload many photos via form or via FTP and need to display both the FULL size images and smaller images for thumb nails or ''(small, med, large)'' optional sizes. The process of uploading images using CFFile can impose time constraints specifically for large files, or if the coldfusion page timeouts are set lower than is possible for large file upload and re-size jobs. To overcome this issue we can write a simple CFC for resizing the images after the upload is complete and the page is run for the first time. This will be ideal for either form based upload or FTP upload making this solution very versatile.

====Step 1 - Create the CFC for re-sizing and writing images to disk====

Create file "GetResizedImage.cfc" in the directory with the CFM files that display images.
Use the code below for the contents of this file and modify as needed.
<syntaxhighlight lang="cfm">
<cfcomponent>
<cffunction name="GetImage" hint="Re-sizes images for display in album">

<cfset imgpath = "imgdir/"/>

<cfset domain = "domain.com"/>

<cfset rfile= "#REReplace("#img#",".(jpg|JPG|JPEG|jpeg)","_resized.jpg")#">

<cfif FileExists("d:\home\#domain#\wwwroot\" &"#imgpath#" & "#rfile#")>
<cfset myImage="http://#domain#/#imgpath##rfile#">
<cfelse>

<cfset myImage=ImageNew(URLDecode("d:\home\#domain#\wwwroot\" & "#imgpath#" & "#img#"))>
<cfset ImageResize(myImage,"175","175","bilinear")>

<cfimage source="#myImage#" action="write" overwrite=true destination="d:\home\#domain#\wwwroot\#imgpath##REReplace("#rfile#","%20"," ","ALL")#">

<cfset myImage="http://#domain#/#imgpath##rfile#">
</cfif>

<cfreturn myImage>
</cffunction>
</cfcomponent>
</syntaxhighlight>

====Step 2 - Invoke the CFC====
<syntaxhighlight lang="cfm">

<cfoutput query="MyEvent">

<cfinvoke component="GetResizedImage"

method="GetImage"

returnvariable="myImage">
<cfinvokeargument name="img" value="#event.Pic#"/>
</cfinvoke>

<img src="#myImage#" alt="" />
</cfoutput>
</syntaxhighlight>
====Step 3 - Test====
The proposed solution cut page load times from 20+ seconds to below one second after the first page load. During the FIRST or FIRST FEW times the page loads all the re-sizing will be done.

===Q and A===
'''Question''': Checking if a file exists each time the page loads is excessive. 
'''Answer''': We agree but it's much better than resizing every image each time the page loads.

==How to create Services for Additional ColdFusion Instances==
If you've created additional ColdFusion instances on your VPS/Dedicated Server, and ColdFusion was unable to create the Services for those instances just do the following:

#Open a Command Prompt as Administrator
#Run this command, replacing INSTANCE with the actual name of your new ColdFusion instance: <pre style="white-space: pre-wrap">sc create "ColdFusion 10 INSTANCE Application Server" binPath= "C:\ColdFusion10\INSTANCE\bin\coldfusionsvc.exe" displayname= "ColdFusion 10 INSTANCE Application Server" start= auto</pre>

Now you will be able to start your instance through the Windows Services Manager. If you need to know how to create additional ColdFusion instances, please see this guide from Adobe: [http://help.adobe.com/en_US/ColdFusion/10.0/Admin/WSAB4367BA-6D91-4c69-8DBA-E2839394658A.html Defining Additional ColdFusion Instances]

Once you've created the instances, you can attach them to your Web server as described here: [http://help.adobe.com/en_US/ColdFusion/10.0/Admin/WSc3ff6d0ea77859461172e0811cbf363a5d-7ffc.html Web Server Configuration]

If you're using IIS, this video has a great walkthrough for using the ColdFusion Web Server Connector tool: [http://blogs.coldfusion.com/post.cfm/video-learn-about-iis-connectors-in-coldfusion10 Learn About ColdFusion IIS Connectors]

==How to Fix Error: Value '0000-00-00' can not be represented as java.sql.Date==
If your application has null values in a MySQL datetime/date column you may encounter the error "Value '0000-00-00' can not be represented as java.sql.Date". The easiest way to fix this is by adding the parameter '''zeroDateTimeBehavior=convertToNull''' to your site's DSN [http://helpx.adobe.com/coldfusion/kb/mysql-error-java-sql-sqlexception.html as recommended by Adobe].
===How to Fix Null DateTime Error - '''Shared Hosting'''===
#Log into your site's WCP control panel
#Click the ''DataSources (DSNs)'' button
#Click the ''Edit'' icon next to your DataSource (DSN)
#Add the following to the '''JDBC Query Parameters''' field: <pre>zeroDateTimeBehavior=convertToNull</pre>

''Note:'' To add multiple JDBC Query Parameters, separate each name/value pair by an ''''&''''.
''Example: zeroDateTimeBehavior=convertToNull&characterEncoding=UTF-8''
===How to Fix Null DateTime Error - '''VPS Hosting'''===
If your site uses WCP to manage its DSNs, you may utilize the Shared Hosting solution. Otherwise, follow the steps below:
#Log into ColdFusion Administrator on your VPS/Dedicated Server.
#Navigate to the "Data Sources" page and click your site's DSN name.
#On the page that opens add '''?zeroDateTimeBehavior=convertToNull''' to the end of the JDBC URL field.
#Click '''Submit''' and your site should no longer display the date representation error.

==Find the Java Version Used by ColdFusion or Railo==
This CFML code will report the version of Java used by your ColdFusion or Railo server:
<syntaxhighlight lang="cfm">
<cfoutput>#CreateObject("java", "java.lang.System").getProperty("java.version")#</cfoutput>
</syntaxhighlight>

'''Reference:''' [http://www.petefreitag.com/item/743.cfm Pete Freitag's Blog - What Version of Java is ColdFusion Using?]

==Reset ColdFusion Admin Password on CF 10+ VPS==
===Reset CF Admin Password - Windows VPS===
*On your VPS, open a command prompt window as Administrator
*Issue the following command to change to the ColdFusion ''bin'' directory ''replace ColdFusion10 with the actual path to your ColdFusion installation''': <pre>cd C:\ColdFusion10\cfusion\bin</pre>
*Execute the ''passwordreset.bat'' script: <pre>.\passwordreset.bat</pre>
*Enter '''1'' to change your ColdFusion administrator password
*Enter a new strong password, then enter it again to confirm the password
*The next section will ask for a new RDS password. If you're not using RDS you may leave the password and confirmation blank, or you can enter a secure password if you like.
*Restart ColdFusion to force the new password into effect

===Reset CF Admin Password - cPanel/Linux VPS===
*SSH into your VPS
*Issue the following command to change to the ColdFusion ''bin'' directory ''replace ColdFusion10 with the actual path to your ColdFusion installation''': <pre>cd /opt/ColdFusion10/cfusion/bin</pre>
*Execute the ''passwordreset.sh'' script: <pre>./passwordreset.sh</pre>
*Enter '''1'' to change your ColdFusion administrator password
*Enter a new strong password, then enter it again to confirm the password
*The next section will ask for a new RDS password. If you're not using RDS you may leave the password and confirmation blank, or you can enter a secure password if you like.
*Restart ColdFusion to force the new password into effect

==ColdFusion 11+ PDF Generation: How to Fix 'No Service Manager is Available' Error==
If you receive the error '''No Service Manager is Available''' when trying to generate PDFs or use the cfhtmltopdf tag on your ColdFusion 11+ VPS, do the following to fix it:
#Log into your server's ColdFusion Administrator
#Expand ''Data & Services'', then click the '''PDF Service''' link
#On the next page, you should see an entry for ''localhost'' under the list of PDF Service Managers
#If the localhost service manager is not enabled, click the ''Enable'' button to the left of the manager name. (The button looks like a ''play'' button)
#Try using cfhtmlpdf now, and see if it works.

If you still have any issues after enabling the service manager, try restarting the '''ColdFusion Addon Services''' Windows service and test again.

There was a problem with ColdFusion 11's PDF Generation with Update 5 and has been fixed in Update 7. You can apply the hotfix or contact support to install the hotfix on your server.

==HTML5 Audio Player with ColdFusion==
This player uses an list named ''Tunes'' within the ''session'' scope to store a list of mp3 names. After populating the list, you can use this code as the foundation for an HTML audio player that plays each song in the list.
<syntaxhighlight lang="cfm">
<cfif action is "play_next_tune">

<cfset myArray=ListtoArray(session.Tunes)>
<cfset T_max=Arraylen(myArray)>
<cfset session.track=session.track+1>
<cfif session.track GT T_max>
<cfset session.track="false">
<cflocation url="tunespage.cfm" addtoken="false">
</cfif>

<cfoutput>
<audio controls id="myVideo" autoplay>
<source src="path/#myarray[session.track]#" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
</cfoutput>

<script language="JavaScript">
document.getElementById('myVideo').addEventListener("ended",function() {
window.location.href="tunespage.cfm?action=play_next_tune";
});
</script>
</cfif>
</syntaxhighlight>

==Cfchart error: Could not locate the style file ''style.xml''==
In ColdFusion 11 the ability to specify styles in an XML file was removed. As such, you will need to convert any XML stylesheets to json files. To do this, you'll need to do the following:
*Install a trial edition of ColdFusion 11 on your local computer
*Open a command prompt and run this command:
**<pre>C:\ColdFusion11\cfusion\bin\cfchart_xmltojson.bat C:\sites\mysite.com\cfchartstyle.xml</pre>
**Be sure to replace the paths above with the actual path to "cfchart_xmltojson.bat" as well as the path to your XML stylesheet.
*When the conversion is done you will end up with a new file with the same name as the XML stylesheet, however there will not be a file extension. To simplify things, add a '''.json''' extension to the converted file.
*Update the path to the stylesheet in the ''cfchart'' tag to have a ''.json'' extension instead of ''.xml''.
*Update the path to the stylesheet to use relative paths instead of absolute paths from the webroot.
**Example: If the stylesheet file and the ''.cfm'' template with the ''cfchart'' code are in the webroot, change '''/cfchartstyle.json''' to '''../cfchartstyle.json'''

More details on this are available in the [https://wikidocs.adobe.com/wiki/display/coldfusionen/cfchart Cfchart documentation]. Be sure to check the comments of the documentation for more helpful cfchart troubleshooting tips.

==CGI.PATH_INFO is Empty After ColdFusion Upgrade==
If CGI.PATH_INFO is empty after you upgrade your server to ColdFusion 10 or higher, change the variable to CGI.SCRIPT_NAME.

==Connecting to RDS on your Coldfusion VPS==
RDS is not enabled on our Shared Servers and is not supported on them. If you wish to use RDS on your Coldfusion VPS you must first enable it and use the correct connection settings for it to work. Follow the below steps to do so.

#Log in to the Coldfusion Administrator
#Go to the 'Security Section'
#Click on 'RDS'
#Check the box to enable it
#Check the box to use single password
#Submit the changes
#Restart Coldfusion
#Using your client enter for the host your servers CFAdmin URL (typically "cf.vps-yourservername-com.ezhostingserver.com)
#The port is port 80
#Username is Admin
#Password is your CFAdmin password

With these settings you will be able to connect using RDS and a client such as Coldfusion Builder to build sites and administrate Coldfusion.
[[Category:ColdFusion]]
[[Category:ColdFusion-VPS]]

ColdFusion 2016

2016-02-18T16:53:45Z

Kylet: Created page with "__FORCETOC__ == Known Incompatibilities == === Mura throws 500 invalid arguments === It appears JavaProxy will need to be modified for ColdFusion 2016. The quick fix if they..."

__FORCETOC__

== Known Incompatibilities ==

=== Mura throws 500 invalid arguments ===
It appears JavaProxy will need to be modified for ColdFusion 2016. The quick fix if they don't require Java in Mura is to change the true to false for <code>javaenabled</code> in their <code>settings.ini.cfm</code>. Alternatively, you can change update the specific line causing the issue following the second comment on issue [https://github.com/blueriver/MuraCMS/issues/2113 #2113]

[[Category:ColdFusion]]

ColdFusion Performance

2015-12-17T17:57:43Z

Kylet: added note about increasing G1 Heap Size if there are too many humongous allocations

When analyzing ColdFusion's performance, There are several things to keep in mind including JVM (memory) settings, slowness on the database tier, and memory leaks that can be easily avoided.

==JVM Settings==
===Sizing the Heap===
====Memory Allocation====
Trying to find the right size for your server's ColdFusion memory heap is an iterative process. However, the following memory allocation arguments will give you a good start: <pre style="white-space: pre-wrap">java.args=-server -XX:+UseCompressedOops -XX:+DisableExplicitGC -Xms1024m -Xmx2048m -XX:NewSize=256m -XX:MaxNewSize=512m -XX:SurvivorRatio=8 -XX:PermSize=128m -XX:MaxPermSize=512m</pre>

''Note: The above arguments only control memory allocation. You should still retain any garbage collector and class-related arguments.''

The settings shown above specify a maximum ColdFusion heap of 2 GB ''(2048 MB)'', an Eden/New space ''(where Java creates new objects)'' that starts at 256 MB and can grow to 512 MB, and a non-heap Perm space with a maximum of 512 MB. If your application needs a bit more memory, you can adjust the "-Xmx" and "-Xms" values as needed. Setting the maximum heap argument ''(-Xmx)'' to a value higher than the minimum heap argument ''(-Xms)'' will allow ColdFusion to utilize more RAM during times of peak activity. This will increase startup time slightly, but it gives the server more stability when your sites are busy.

====Choosing a Garbage Collector====
After specifying good memory settings for your ColdFusion server, you'll want to ensure it uses an appropriate garbage collector for the work being done on your sites.
=====Mostly Concurrent Collector=====
If the sites on your server are primarily lightweight request/response applications where response times are critical, then the ''mostly'' concurrent garbage collector is a great choice for your server. This collector does its best to collect dead objects from memory while applications on the server are still processing data. This adds a small bit of overhead for transactional applications, but it helps such applications maintain their response-time SLAs. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseConcMarkSweepGC -XX:+UseCMSInitiatingOccupancyOnly -XX:+CMSClassUnloadingEnabled -XX:+CMSScavengeBeforeRemark -XX:CMSInitiatingOccupancyFraction=68 -XX:+UseParNewGC</pre>

''Note:'' The main downside of this collector is that it can consume too much CPU when memory-intensive applications run on the server. Servers running such applications would want to use the ''throughput collector'' mentioned below.
=====Throughput/Parallel Collector=====
If the applications on your server are memory intensive and allocate a lot of objects, then the throughput/parallel garbage collector would be a great choice for your server. Any application performing image manipulation or creating a lot of objects would be a great candidate for the throughput collector. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseParallelOldGC -XX:YoungGenerationSizeIncrement=50 -XX:TenuredGenerationSizeIncrement=25 -XX:AdaptiveSizeDecrementScaleFactor=10 -XX:MaxGCPauseMillis=10000 -XX:GCTimeRatio=19</pre>

The first thing to note about this collector is the ''-XX:+UseParallelOldGC'' name. This doesn't mean you're using old garbage collection techniques; rather it mean that both the ''old'' (or ''tenured'') and the ''new'' (or ''eden'') sections of memory are collected in parallel. This allows Java to perform collections much faster than normal. One thing to keep in mind is that with this collector when the heap fills up Java will pause all application processing for a short period of time to clean up memory. The above settings act to minimize the time of such pauses so your end users typically won't notice any slowness.

=====Garbage First Garbage Collector=====
If you are running the latest Java 8 JVM on your servers, you can take advantage of G1GC. G1GC was introduced before Java 8; however unless you have a support contract with Oracle for Java 7, Oracle only recommends using it with Java 8. This garbage collector works best on larger heaps (3GB+). The goal off this collector is to reduce GC pauses by doing more collections and marking objects concurrently with the running application. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseG1GC -XX:MaxGCPauseMillis=200 -XX:+ParallelRefProcEnabled -XX:+AggressiveOpts -XX:ParallelGCThreads=4 -XX:ConcGCThreads=2</pre> You will want to to make ParallelGCThreads to the number of cores you have and make ConcGCThreads half of ParallelGCThreads. You may also need to adjust the G1 Heap Size manually if you notice too many "humongous" allocations.

You will notice more CPU being used by this collector, but you should notice better performance with less latency between requests. This collector uses ~2048 regions of memory instead of 4 regions of memory. Oracle's documentation explains this is great detail at http://www.oracle.com/technetwork/articles/java/g1gc-1984535.html

====References====
*Tuning ColdFusion 10 for performance and stability: [http://cfwhisperer.com/post.cfm/coldfusion-10-enhanced-performance-settings ColdFusion 10 Enhanced Performance Settings]
*Optimizing Garbage Collection Pause Times: [http://wouterzelle.wordpress.com/2008/07/28/advanced-java-memory-tuning/ Advanced Java Memory Tuning]
*Oracle Java Garbage Collection Tuning Guidelines: [http://www.oracle.com/technetwork/java/javase/gc-tuning-6-140523.html Java Garbage Collection Tuning]

===Garbage Collection Performance Logging===
Because a lot of the JVM's processing time can be spent in garbage collection of memory, it can be helpful to enable Garbage Collection Logging to your server. In order to do so, just add the following arguments to your ColdFusion server's ''jvm.config'' file: <pre style="white-space: pre-wrap">-Xloggc:gc-1.log -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps</pre>

If you wish to change the name of the log file, just change 'gc-1.log' to the filename you wish. By default, this file will be created in the same folder as your ''jvm.config'' file.
 ''If Using Railo'': When using Railo it's more reliable to specify a full path to the GC log file like this:
-Xloggc:C:\railo\gc-1.log
 
 
''NOTE'': This section primarily applies to VPS/Dedicated customers only. Our administrators make sure the Heap is properly sized on our shared ColdFusion servers.

==Tuning the Database Tier==
===Add Indexes===
Make sure all database fields are indexed properly. At the minimum your tables should have a primary (unique) key and indexes for any columns used in a WHERE clause.

For your reference, this video from Percona describes how to make the most of table indexes: [https://www.youtube.com/watch?v=zeRqU0SlJa4 MySQL Indexing Best Practices]

===Tune Your Queries===
Be sure to remove any 'SELECT *' statements in the code. Instead, explicitly name each column used in a query. Also, make use of query advisors such as the following:
*'''MySQL - Percona Query Advisor''': https://tools.percona.com/query-advisor
*'''MS SQL Server - Database Engine Tuning Advisor''': http://www.mssqltips.com/sqlservertutorial/286/database-engine-tuning-advisor/

===Cache Queries (cfquery / cfstoredproc) Where Possible===
Does your application have queries that are ran often and the data rarely changes? If so, enable caching on those queries as shown here: [http://www.coldfusionmuse.com/index.cfm/2010/9/19/safe.caching Good Developers Practice Safe Query Caching]

The main takeaway is that your application should use the '''cachedwithin''' attribute on as many cfquery and cfstoredproc tags as possible. Query caching helps reduce the load on the database server and improves page response time noticeably.

To enable this attribute on your queries, just add the '''cachedwithin''' attribute to your cfquery or cfstoredproc tags. This example will cache a query for 15 minutes:<pre><cfquery name="myquery" datasource="mydsn" cachedwithin="#createTimespan(0,0,15,0)#"></pre>
''Note'': It is not recommended to cache queries for very long periods of time, so try to keep the timespan to an hour or less.

==Preventing Known Memory 'Leaks'==
===Specify CFFunction Output Attribute===
For any <cffunction> and <cfcomponent> tags, make sure that you have '''output="false"''' specified. If for some reason you do need output from the function, be sure to explicitly add the output="true" attribute. There is a bug in CF that leaks memory when the output function is left of function and component declarations.

===Use Var Scope for Variables within CFFunction===
Make sure all functions have their variables in the "var" scope, including queries. The varscoper utility here will check your code for any missing var statements in your code: http://varscoper.riaforge.org/
We highly recommend using this on a regular basis for all your sites.

===Handle Bots and Spiders Properly===
Because bots and spiders can create a lot of useless sessions when indexing sites, we recommend setting a custom session timeout as shown here: [[ColdFusion_Tips_%26_Tricks#Lower_Session_Timeouts_for_Bots_and_Spiders|Lower Session Timeouts for Bots and Spiders]]

==Debugging Individual Scripts==
During non-peak hours for your site, try enabling the ColdFusion debug output and adding your IP to the remote debug IP list. Then load the most frequently accessed pages and grab the debug output. Once you have this, focus on improving the slowest sections of code first.

Additionally, if you have '''Seefusion''' on your VPS, it will hightlight the server's slowest scripts. You can also obtain stack traces of running scripts to find the root cause of any slowness. 
'''More info''': [[ColdFusion_Tips_%26_Tricks#Using_SeeFusion_to_Monitor_ColdFusion_Performance_on_a_VPS.2FDedicated_Server|Using SeeFusion to Monitor ColdFusion Performance on a VPS/Dedicated_Server]]
 
 
''NOTE'': This section primarily applies to VPS/Dedicated customers only. We do not allow debugging on our shared ColdFusion servers, as it negatively impacts server performance. Also, Seefusion is not available to our shared hosting customers.

[[Category:ColdFusion]]
[[Category:VPS]]

ColdFusion Performance

2015-12-17T17:55:25Z

Kylet: fix copypaste mistake on the header...

When analyzing ColdFusion's performance, There are several things to keep in mind including JVM (memory) settings, slowness on the database tier, and memory leaks that can be easily avoided.

==JVM Settings==
===Sizing the Heap===
====Memory Allocation====
Trying to find the right size for your server's ColdFusion memory heap is an iterative process. However, the following memory allocation arguments will give you a good start: <pre style="white-space: pre-wrap">java.args=-server -XX:+UseCompressedOops -XX:+DisableExplicitGC -Xms1024m -Xmx2048m -XX:NewSize=256m -XX:MaxNewSize=512m -XX:SurvivorRatio=8 -XX:PermSize=128m -XX:MaxPermSize=512m</pre>

''Note: The above arguments only control memory allocation. You should still retain any garbage collector and class-related arguments.''

The settings shown above specify a maximum ColdFusion heap of 2 GB ''(2048 MB)'', an Eden/New space ''(where Java creates new objects)'' that starts at 256 MB and can grow to 512 MB, and a non-heap Perm space with a maximum of 512 MB. If your application needs a bit more memory, you can adjust the "-Xmx" and "-Xms" values as needed. Setting the maximum heap argument ''(-Xmx)'' to a value higher than the minimum heap argument ''(-Xms)'' will allow ColdFusion to utilize more RAM during times of peak activity. This will increase startup time slightly, but it gives the server more stability when your sites are busy.

====Choosing a Garbage Collector====
After specifying good memory settings for your ColdFusion server, you'll want to ensure it uses an appropriate garbage collector for the work being done on your sites.
=====Mostly Concurrent Collector=====
If the sites on your server are primarily lightweight request/response applications where response times are critical, then the ''mostly'' concurrent garbage collector is a great choice for your server. This collector does its best to collect dead objects from memory while applications on the server are still processing data. This adds a small bit of overhead for transactional applications, but it helps such applications maintain their response-time SLAs. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseConcMarkSweepGC -XX:+UseCMSInitiatingOccupancyOnly -XX:+CMSClassUnloadingEnabled -XX:+CMSScavengeBeforeRemark -XX:CMSInitiatingOccupancyFraction=68 -XX:+UseParNewGC</pre>

''Note:'' The main downside of this collector is that it can consume too much CPU when memory-intensive applications run on the server. Servers running such applications would want to use the ''throughput collector'' mentioned below.
=====Garbage First Garbage Collector=====
If the applications on your server are memory intensive and allocate a lot of objects, then the throughput/parallel garbage collector would be a great choice for your server. Any application performing image manipulation or creating a lot of objects would be a great candidate for the throughput collector. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseParallelOldGC -XX:YoungGenerationSizeIncrement=50 -XX:TenuredGenerationSizeIncrement=25 -XX:AdaptiveSizeDecrementScaleFactor=10 -XX:MaxGCPauseMillis=10000 -XX:GCTimeRatio=19</pre>

The first thing to note about this collector is the ''-XX:+UseParallelOldGC'' name. This doesn't mean you're using old garbage collection techniques; rather it mean that both the ''old'' (or ''tenured'') and the ''new'' (or ''eden'') sections of memory are collected in parallel. This allows Java to perform collections much faster than normal. One thing to keep in mind is that with this collector when the heap fills up Java will pause all application processing for a short period of time to clean up memory. The above settings act to minimize the time of such pauses so your end users typically won't notice any slowness.

=====Throughput/Parallel Collector=====
If you are running the latest Java 8 JVM on your servers, you can take advantage of G1GC. G1GC was introduced before Java 8; however unless you have a support contract with Oracle for Java 7, they recommend only using it with Java 8. This garbage collector works best on larger heaps (3GB+). The goal off this collector is to reduce GC pauses by doing more collections and marking objects concurrently with the running application. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseG1GC -XX:MaxGCPauseMillis=200 -XX:+ParallelRefProcEnabled -XX:+AggressiveOpts -XX:ParallelGCThreads=4 -XX:ConcGCThreads=2</pre> You will want to to make ParallelGCThreads to the number of cores you have and make ConcGCThreads half of ParallelGCThreads.

You will notice more CPU being used by this collector, but you should notice better performance with less latency between requests. This collector uses ~2048 regions of memory instead of 4 regions of memory. Oracle's documentation explains this is great detail at http://www.oracle.com/technetwork/articles/java/g1gc-1984535.html
====References====
*Tuning ColdFusion 10 for performance and stability: [http://cfwhisperer.com/post.cfm/coldfusion-10-enhanced-performance-settings ColdFusion 10 Enhanced Performance Settings]
*Optimizing Garbage Collection Pause Times: [http://wouterzelle.wordpress.com/2008/07/28/advanced-java-memory-tuning/ Advanced Java Memory Tuning]
*Oracle Java Garbage Collection Tuning Guidelines: [http://www.oracle.com/technetwork/java/javase/gc-tuning-6-140523.html Java Garbage Collection Tuning]

===Garbage Collection Performance Logging===
Because a lot of the JVM's processing time can be spent in garbage collection of memory, it can be helpful to enable Garbage Collection Logging to your server. In order to do so, just add the following arguments to your ColdFusion server's ''jvm.config'' file: <pre style="white-space: pre-wrap">-Xloggc:gc-1.log -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps</pre>

If you wish to change the name of the log file, just change 'gc-1.log' to the filename you wish. By default, this file will be created in the same folder as your ''jvm.config'' file.
 ''If Using Railo'': When using Railo it's more reliable to specify a full path to the GC log file like this:
-Xloggc:C:\railo\gc-1.log
 
 
''NOTE'': This section primarily applies to VPS/Dedicated customers only. Our administrators make sure the Heap is properly sized on our shared ColdFusion servers.

==Tuning the Database Tier==
===Add Indexes===
Make sure all database fields are indexed properly. At the minimum your tables should have a primary (unique) key and indexes for any columns used in a WHERE clause.

For your reference, this video from Percona describes how to make the most of table indexes: [https://www.youtube.com/watch?v=zeRqU0SlJa4 MySQL Indexing Best Practices]

===Tune Your Queries===
Be sure to remove any 'SELECT *' statements in the code. Instead, explicitly name each column used in a query. Also, make use of query advisors such as the following:
*'''MySQL - Percona Query Advisor''': https://tools.percona.com/query-advisor
*'''MS SQL Server - Database Engine Tuning Advisor''': http://www.mssqltips.com/sqlservertutorial/286/database-engine-tuning-advisor/

===Cache Queries (cfquery / cfstoredproc) Where Possible===
Does your application have queries that are ran often and the data rarely changes? If so, enable caching on those queries as shown here: [http://www.coldfusionmuse.com/index.cfm/2010/9/19/safe.caching Good Developers Practice Safe Query Caching]

The main takeaway is that your application should use the '''cachedwithin''' attribute on as many cfquery and cfstoredproc tags as possible. Query caching helps reduce the load on the database server and improves page response time noticeably.

To enable this attribute on your queries, just add the '''cachedwithin''' attribute to your cfquery or cfstoredproc tags. This example will cache a query for 15 minutes:<pre><cfquery name="myquery" datasource="mydsn" cachedwithin="#createTimespan(0,0,15,0)#"></pre>
''Note'': It is not recommended to cache queries for very long periods of time, so try to keep the timespan to an hour or less.

==Preventing Known Memory 'Leaks'==
===Specify CFFunction Output Attribute===
For any <cffunction> and <cfcomponent> tags, make sure that you have '''output="false"''' specified. If for some reason you do need output from the function, be sure to explicitly add the output="true" attribute. There is a bug in CF that leaks memory when the output function is left of function and component declarations.

===Use Var Scope for Variables within CFFunction===
Make sure all functions have their variables in the "var" scope, including queries. The varscoper utility here will check your code for any missing var statements in your code: http://varscoper.riaforge.org/
We highly recommend using this on a regular basis for all your sites.

===Handle Bots and Spiders Properly===
Because bots and spiders can create a lot of useless sessions when indexing sites, we recommend setting a custom session timeout as shown here: [[ColdFusion_Tips_%26_Tricks#Lower_Session_Timeouts_for_Bots_and_Spiders|Lower Session Timeouts for Bots and Spiders]]

==Debugging Individual Scripts==
During non-peak hours for your site, try enabling the ColdFusion debug output and adding your IP to the remote debug IP list. Then load the most frequently accessed pages and grab the debug output. Once you have this, focus on improving the slowest sections of code first.

Additionally, if you have '''Seefusion''' on your VPS, it will hightlight the server's slowest scripts. You can also obtain stack traces of running scripts to find the root cause of any slowness. 
'''More info''': [[ColdFusion_Tips_%26_Tricks#Using_SeeFusion_to_Monitor_ColdFusion_Performance_on_a_VPS.2FDedicated_Server|Using SeeFusion to Monitor ColdFusion Performance on a VPS/Dedicated_Server]]
 
 
''NOTE'': This section primarily applies to VPS/Dedicated customers only. We do not allow debugging on our shared ColdFusion servers, as it negatively impacts server performance. Also, Seefusion is not available to our shared hosting customers.

[[Category:ColdFusion]]
[[Category:VPS]]

ColdFusion Performance

2015-12-17T17:39:58Z

Kylet:

When analyzing ColdFusion's performance, There are several things to keep in mind including JVM (memory) settings, slowness on the database tier, and memory leaks that can be easily avoided.

==JVM Settings==
===Sizing the Heap===
====Memory Allocation====
Trying to find the right size for your server's ColdFusion memory heap is an iterative process. However, the following memory allocation arguments will give you a good start: <pre style="white-space: pre-wrap">java.args=-server -XX:+UseCompressedOops -XX:+DisableExplicitGC -Xms1024m -Xmx2048m -XX:NewSize=256m -XX:MaxNewSize=512m -XX:SurvivorRatio=8 -XX:PermSize=128m -XX:MaxPermSize=512m</pre>

''Note: The above arguments only control memory allocation. You should still retain any garbage collector and class-related arguments.''

The settings shown above specify a maximum ColdFusion heap of 2 GB ''(2048 MB)'', an Eden/New space ''(where Java creates new objects)'' that starts at 256 MB and can grow to 512 MB, and a non-heap Perm space with a maximum of 512 MB. If your application needs a bit more memory, you can adjust the "-Xmx" and "-Xms" values as needed. Setting the maximum heap argument ''(-Xmx)'' to a value higher than the minimum heap argument ''(-Xms)'' will allow ColdFusion to utilize more RAM during times of peak activity. This will increase startup time slightly, but it gives the server more stability when your sites are busy.

====Choosing a Garbage Collector====
After specifying good memory settings for your ColdFusion server, you'll want to ensure it uses an appropriate garbage collector for the work being done on your sites.
=====Mostly Concurrent Collector=====
If the sites on your server are primarily lightweight request/response applications where response times are critical, then the ''mostly'' concurrent garbage collector is a great choice for your server. This collector does its best to collect dead objects from memory while applications on the server are still processing data. This adds a small bit of overhead for transactional applications, but it helps such applications maintain their response-time SLAs. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseConcMarkSweepGC -XX:+UseCMSInitiatingOccupancyOnly -XX:+CMSClassUnloadingEnabled -XX:+CMSScavengeBeforeRemark -XX:CMSInitiatingOccupancyFraction=68 -XX:+UseParNewGC</pre>

''Note:'' The main downside of this collector is that it can consume too much CPU when memory-intensive applications run on the server. Servers running such applications would want to use the ''throughput collector'' mentioned below.
=====Throughput/Parallel Collector=====
If the applications on your server are memory intensive and allocate a lot of objects, then the throughput/parallel garbage collector would be a great choice for your server. Any application performing image manipulation or creating a lot of objects would be a great candidate for the throughput collector. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseParallelOldGC -XX:YoungGenerationSizeIncrement=50 -XX:TenuredGenerationSizeIncrement=25 -XX:AdaptiveSizeDecrementScaleFactor=10 -XX:MaxGCPauseMillis=10000 -XX:GCTimeRatio=19</pre>

The first thing to note about this collector is the ''-XX:+UseParallelOldGC'' name. This doesn't mean you're using old garbage collection techniques; rather it mean that both the ''old'' (or ''tenured'') and the ''new'' (or ''eden'') sections of memory are collected in parallel. This allows Java to perform collections much faster than normal. One thing to keep in mind is that with this collector when the heap fills up Java will pause all application processing for a short period of time to clean up memory. The above settings act to minimize the time of such pauses so your end users typically won't notice any slowness.
=====Throughput/Parallel Collector=====
If you are running the latest Java 8 JVM on your servers, you can take advantage of G1GC. G1GC was introduced before Java 8; however unless you have a support contract with Oracle for Java 7, they recommend only using it with Java 8. This garbage collector works best on larger heaps (3GB+). The goal off this collector is to reduce GC pauses by doing more collections and marking objects concurrently with the running application. To enable this garbage collector, add the following JVM arguments after your memory allocation settings: <pre style="white-space: pre-wrap">-XX:+UseG1GC -XX:MaxGCPauseMillis=200 -XX:+ParallelRefProcEnabled -XX:+AggressiveOpts -XX:ParallelGCThreads=4 -XX:ConcGCThreads=2</pre> You will want to to make ParallelGCThreads to the number of cores you have and make ConcGCThreads half of ParallelGCThreads.

You will notice more CPU being used by this collector, but you should notice better performance with less latency between requests. This collector uses ~2048 regions of memory instead of 4 regions of memory. Oracle's documentation explains this is great detail at http://www.oracle.com/technetwork/articles/java/g1gc-1984535.html
====References====
*Tuning ColdFusion 10 for performance and stability: [http://cfwhisperer.com/post.cfm/coldfusion-10-enhanced-performance-settings ColdFusion 10 Enhanced Performance Settings]
*Optimizing Garbage Collection Pause Times: [http://wouterzelle.wordpress.com/2008/07/28/advanced-java-memory-tuning/ Advanced Java Memory Tuning]
*Oracle Java Garbage Collection Tuning Guidelines: [http://www.oracle.com/technetwork/java/javase/gc-tuning-6-140523.html Java Garbage Collection Tuning]

===Garbage Collection Performance Logging===
Because a lot of the JVM's processing time can be spent in garbage collection of memory, it can be helpful to enable Garbage Collection Logging to your server. In order to do so, just add the following arguments to your ColdFusion server's ''jvm.config'' file: <pre style="white-space: pre-wrap">-Xloggc:gc-1.log -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps</pre>

If you wish to change the name of the log file, just change 'gc-1.log' to the filename you wish. By default, this file will be created in the same folder as your ''jvm.config'' file.
 ''If Using Railo'': When using Railo it's more reliable to specify a full path to the GC log file like this:
-Xloggc:C:\railo\gc-1.log
 
 
''NOTE'': This section primarily applies to VPS/Dedicated customers only. Our administrators make sure the Heap is properly sized on our shared ColdFusion servers.

==Tuning the Database Tier==
===Add Indexes===
Make sure all database fields are indexed properly. At the minimum your tables should have a primary (unique) key and indexes for any columns used in a WHERE clause.

For your reference, this video from Percona describes how to make the most of table indexes: [https://www.youtube.com/watch?v=zeRqU0SlJa4 MySQL Indexing Best Practices]

===Tune Your Queries===
Be sure to remove any 'SELECT *' statements in the code. Instead, explicitly name each column used in a query. Also, make use of query advisors such as the following:
*'''MySQL - Percona Query Advisor''': https://tools.percona.com/query-advisor
*'''MS SQL Server - Database Engine Tuning Advisor''': http://www.mssqltips.com/sqlservertutorial/286/database-engine-tuning-advisor/

===Cache Queries (cfquery / cfstoredproc) Where Possible===
Does your application have queries that are ran often and the data rarely changes? If so, enable caching on those queries as shown here: [http://www.coldfusionmuse.com/index.cfm/2010/9/19/safe.caching Good Developers Practice Safe Query Caching]

The main takeaway is that your application should use the '''cachedwithin''' attribute on as many cfquery and cfstoredproc tags as possible. Query caching helps reduce the load on the database server and improves page response time noticeably.

To enable this attribute on your queries, just add the '''cachedwithin''' attribute to your cfquery or cfstoredproc tags. This example will cache a query for 15 minutes:<pre><cfquery name="myquery" datasource="mydsn" cachedwithin="#createTimespan(0,0,15,0)#"></pre>
''Note'': It is not recommended to cache queries for very long periods of time, so try to keep the timespan to an hour or less.

==Preventing Known Memory 'Leaks'==
===Specify CFFunction Output Attribute===
For any <cffunction> and <cfcomponent> tags, make sure that you have '''output="false"''' specified. If for some reason you do need output from the function, be sure to explicitly add the output="true" attribute. There is a bug in CF that leaks memory when the output function is left of function and component declarations.

===Use Var Scope for Variables within CFFunction===
Make sure all functions have their variables in the "var" scope, including queries. The varscoper utility here will check your code for any missing var statements in your code: http://varscoper.riaforge.org/
We highly recommend using this on a regular basis for all your sites.

===Handle Bots and Spiders Properly===
Because bots and spiders can create a lot of useless sessions when indexing sites, we recommend setting a custom session timeout as shown here: [[ColdFusion_Tips_%26_Tricks#Lower_Session_Timeouts_for_Bots_and_Spiders|Lower Session Timeouts for Bots and Spiders]]

==Debugging Individual Scripts==
During non-peak hours for your site, try enabling the ColdFusion debug output and adding your IP to the remote debug IP list. Then load the most frequently accessed pages and grab the debug output. Once you have this, focus on improving the slowest sections of code first.

Additionally, if you have '''Seefusion''' on your VPS, it will hightlight the server's slowest scripts. You can also obtain stack traces of running scripts to find the root cause of any slowness. 
'''More info''': [[ColdFusion_Tips_%26_Tricks#Using_SeeFusion_to_Monitor_ColdFusion_Performance_on_a_VPS.2FDedicated_Server|Using SeeFusion to Monitor ColdFusion Performance on a VPS/Dedicated_Server]]
 
 
''NOTE'': This section primarily applies to VPS/Dedicated customers only. We do not allow debugging on our shared ColdFusion servers, as it negatively impacts server performance. Also, Seefusion is not available to our shared hosting customers.

[[Category:ColdFusion]]
[[Category:VPS]]

Lucee

2015-11-22T23:33:28Z

Kylet: add troubleshooting tip for Lucee rest not working.

__FORCETOC__
[[File:Luceelogo.png]] 
[http://lucee.org/ Lucee] is an open-source CFML engine and the successor of Railo. We proudly support Lucee in our environment, and more info about its background and usage is below.

==Background==
The Lucee project was forked from Railo 4.2 in January 2015 and is owned by Lucee Association Switzerland. Though development on Railo has halted, Lucee will eventually inherit the enhancements planned for Railo 5. Currently Lucee operates the same as the latest available version of Railo, so you can migrate your Railo codebase to it without any surprises.

See these blogs for more info on the switch from Railo to Lucee:
*[http://blog.adamcameron.me/2015/01/lucee.html Lucee - Adam Cameron's Dev Blog]
*[http://www.codersrevolution.com/blog/railo-and-lucee-hunka-hunka-burning-questions Railo and Lucee ... - Coder's Revolution]

==Usage / Resources==
For information about Lucee please reference [https://bitbucket.org/lucee/lucee/wiki/ the Lucee wiki]. Specifically, the [https://bitbucket.org/lucee/lucee/wiki/Cookbook Lucee Cookbook] has lots of good info about getting started.

If you're new to CFML in general, the following resources will help you get learn the basics:
*[http://www.trycf.com/tutorials TryCF.com Tutorials]
*[http://bittersweetryan.github.io/ColdFusion-Koans/ ColdFusion Koans]
*[https://github.com/cfjedimaster/ColdFusion-UI-the-Right-Way ColdFusion UI the Right Way]
*[https://github.com/daccfml/cfscript/blob/master/cfscript.md CFScript Documentation]

==How do I access my Lucee Web Administator page?==
The preferred way to access your site's Lucee Web Administrator is by clicking the '''''Web Administrator''''' link within your control panel. Alternatively, you may access it by appending '''''/lucee/admin/web.cfm''''' to the end of your site's domain name or testing URL.
===I'm redirected to another page on my site when accessing the Lucee Web Administrator===
If your site uses rewrite rules to make your site's links search-engine-friendly, then you'll need to make a small adjustment to your rewrite rules. Add the following line to your site's ''.htacess'' file to allow your Lucee Web Administrator to load properly:
<syntaxhighlight lang="apache">
RewriteEngine On

RewriteCond %{REQUEST_URI} !^.*/(lucee)($|/.*$) [NC]
RewriteRule ^(.*)$ - [NC,L]
</syntaxhighlight>

That code will tell the rewrite engine to ignore requests that contain the word ''lucee''. If your site already has a similar ''RewriteCond'' in its .htacess file ''(common with CF Wheels or ColdBox)'', then just add ''lucee'' to the list of URIs to bypass.

==How do I create a datasource within Lucee?==
You may create Lucee datasources (DSNs) either withing your site's Lucee Web Administrator or within the site's Application.cfc. More info on creating Lucee datasources is in this Lucee Cookbook entry: [https://bitbucket.org/lucee/lucee/wiki/Cookbook_Datasource_Define_Datasource How to define a Datasource]

==How do I apply updates to Lucee?==
On a VPS you would apply updates to Lucee through your Lucee Server Administrator. This can be accessed via the shortcut on your server's desktop (Windows), or by visiting http://ServerIP/lucee/admin/server.cfm. ''(replace '''ServerIP''' with your server's public IP address)''

*Once logged-in, click the '''Update''' link under '''Services'''.
*If an update is available, it will be displayed under the ''Info'' section of that page.
*To apply the update, scroll to the bottom of the page and click the '''Execute Update''' button.
**Once finished, you will be logged-out of the Lucee Server Administrator.
**Once you log-in again, you should see the new version number listed.

If the update breaks part of your site, you can remove it from within the '''Services-->Update''' page as well. Just scroll to the bottom of that page and click the '''Remove Latest Patch''' button.

==Troubleshooting Lucee Errors==
===Lucee Web Admin - The DNS for this domain is not pointed to this server===
'''Error:''' 
When accessing the Lucee Web Admin via the cPanel plugin, you receive this error:
The DNS for this domain is not pointed to this server. Please check the DNS settings to make sure it is pointed to the correct IP.

'''Solution:''' 
Wait for a moment then reload the page in your browser. This error happens when your Web Admin takes longer than expected to initialize, but reloading the page will allow the Lucee Web Admin to load as expected.

===Rest service not working===
'''Error:''' 
no rest service for [PATH_HERE] found
Lucee was recently restarted and the web context for your site has not initialized fully.

'''Solution:''' 
Browse to a page that is not part of the rest service and it will kick start the web context creation. Afterward, you should be able to use your rest service.

ColdFusion Tips & Tricks

2015-11-18T19:32:22Z

Kylet: add note about Update 5 breaking PDF Generation and note about the hotfix that fixes this issue.

==Converting Application.cfm to Application.cfc==
Using an '''Application.cfc''' configuration file offers some advantages over the older style '''Application.cfm''' configuration files. Some of the main features that an Application.cfc file give you are "functions triggered by Application, Session, Request, and Error events" and "Application-Level Mappings and Custom Tag Paths".

There are only a few steps required to convert an application to use an Application.cfc file:

NOTE: You should ensure that you have a backup of any files before making changes to them.

===Create an '''Application.cfc''' file===

Below is an example '''Application.cfc''' file with the minimum requirements:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfscript>
this.name = hash( getCurrentTemplatePath() ); // unique app name
</cfscript>
</cfcomponent>
</syntaxhighlight>
Setup '''onRequest''' function in '''Application.cfc''' to include the '''Application.cfm''' file

This step is only necessary if an Application.cfm file already exists in the root of the application. Below is what the Application.cfc file will look like after this addition:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfscript>
this.name = hash( getCurrentTemplatePath() ); // unique app name
</cfscript>

<cffunction name="onRequest" returnType="void">
<cfargument name="targetPage" type="string" required="true" />


<cfinclude template="Application.cfm" />


<cfinclude template="#ARGUMENTS.targetPage#" />
</cffunction>
</cfcomponent>
</syntaxhighlight>

===Copy application settings from the '''cfapplication''' tag and remove the '''cfapplication''' tag===

This step is only necessary if a cfapplication tag is used within the application. Each attribute of the cfapplication tag will need to be copied into the cfscript section at the top of the Application.cfc with the pattern [this.attributeName = "value";].

For example. The below cfapplication tag would be converted into our Application.cfc example as follows:

'''cfapplication''' tag:
<syntaxhighlight lang="cfm">
<cfapplication
name = "my_app_name"
sessionManagement = "Yes"
sessionTimeout = "#createTimeSpan(0,0,20,0)#"
setClientCookies = "Yes">
</syntaxhighlight>

'''Application.cfc''':
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfscript>
this.name = "my_app_name"; // app name from old cfapplication tag
this.sessionManagement = "Yes";
this.sessionTimeout = CreateTimeSpan(0,0,20,0);
this.setClientCookies = "Yes";
</cfscript>

<cffunction name="onRequest" returnType="void">
<cfargument name="targetPage" type="string" required="true" />


<cfinclude template="Application.cfm" />


<cfinclude template="#ARGUMENTS.targetPage#" />
</cffunction>
</cfcomponent>
</syntaxhighlight>

'''NOTE''': Do not forget to remove the '''cfapplication''' tag after copying the settings into the '''Application.cfc''' file.

Now that the change is complete, this is a good time to test the application to ensure everything is working correctly with the new setup.

==Per-Application ColdFusion Mappings==
In ColdFusion 8 and above, it is possible to create per-application mappings through your site's Application.cfc file. If you wish to convert to using an Application.cfc file, follow the steps [[ColdFusion_Tips_%26_Tricks#Converting_Application.cfm_to_Application|here]].

Once you have your Application.cfc created, you will insert the following line:
<syntaxhighlight lang="cfm">
<cfset this.mappings["/test"]="d:\home\yourdomainname.com\wwwroot\test">
</syntaxhighlight>

On your site though, you would change "/test" to the name of your mapping. IMPORTANT: You need to include the forward slash before the name of your mapping. Also, change "d:\home\yourdomainname.com\wwwroot\test" to the full physical path to the folder you wish to map.
'''Note''': The physical path to your FTP root is listed in the "Site Settings" of your control panel at wcp.hostek.com.

To call a template named "testing.cfm" in the "test" directory we just mapped, you would use this line:
<syntaxhighlight lang="cfm">
<cfinclude template="/test/testing.cfm">
</syntaxhighlight>

==Per-Application Custom Tag Paths==
Starting in ColdFusion 8, ColdFusion allows creation of Custom Tag Paths in each site's Application.cfc file. This allows you to create and manage your Custom Tag Paths without having to use CF Administrator (ie. submit a support ticket). The following steps will help you create a Custom Tag Path:

If you do not already have an Application.cfc file in your site's Web root, create one now.
Place the following code in the Application.cfc file and save:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfset THIS.customtagpaths="d:\home\yourdomain.com\wwwroot\customtagfolder">
</cfcomponent>
</syntaxhighlight>

In this case, you'd replace "yourdomain.com" with your domain name, and "customtagfolder" with the name of the folder you created for your custom tags.

Now you have successfully added your custom tag path. If you have multiple tag paths to add, try using the following code instead:
<syntaxhighlight lang="cfm">
<cfcomponent>
<cfset THIS.customtagpaths=ListAppend(THIS.customtagpaths, "d:\home\yourdomain.com\wwwroot\customtagfolder")>
</cfcomponent>
</syntaxhighlight>
==Per-application Robust Exception Information Settings==
To enable Robust Exception Information on a ColdFusion application, you will need to add the following to the top of the site's ''Application.cfc'' file:
<syntaxhighlight lang="cfm"><cfset this.enablerobustexception = true /></syntaxhighlight>
Alternatively, if you wish to ensure Robust Exception Information is ''always'' disabled for an application, add this to the site's ''Application.cfc'':
<syntaxhighlight lang="cfm"><cfset this.enablerobustexception = false /></syntaxhighlight>

==Per-application JSON Prefix==
To enable the JSON Prefix for your application add the following to the site's '''Application.cfc''' file, and adjust the '''secureJSONPrefix''' as desired:
<syntaxhighlight lang="cfm">
<cfset this.secureJSON = true>
<cfset this.secureJSONPrefix = "//">
</syntaxhighlight>

Alternatively, you can disable this feature using the following code instead:
<syntaxhighlight lang="cfm">
<cfset this.secureJSON = false>
</syntaxhighlight>

==Restart a ColdFusion Application==
If you ever need to restart your site's ColdFusion application (to pick up a setting change, etc), you can do so via the ApplicationStop() function in ColdFusion 9+.

To use this you can create a file (ex: restart.cfm) containing the following code:
<syntaxhighlight lang="cfm">
<cfset ApplicationStop() />
<cflocation url="index.cfm" addtoken="false" />
</syntaxhighlight>
When you run the file containing that code your ColdFusion Application will be stopped (flushing your application scope), and when the browser is redirected to the index page the application will start again.
==CFHTTP Connection Failures over HTTPS==
===Fixing cfhttp Failures on Shared Hosting===
If you try to use <cfhttp> to connect to a secure site (over HTTPS), you may receive the following error: "Connection Failure: Status code unavailable"

To fix this add the following code to your site's "Application.cfm" file (below the 'cfapplication' tag):
<syntaxhighlight lang="cfm">

<cfif NOT isDefined("Application.sslfix")>
<cfset objSecurity = createObject("java", "java.security.Security") />
<cfset objSecurity.removeProvider("JsafeJCE") />
<cfset Application.sslfix = true />
</cfif>
</syntaxhighlight>
If your site uses an "Application.cfc" file instead, then just place that code in the "'onApplicationStart()" method of that file. After making that adjustment you'll need to restart your ColdFusion application as [[ColdFusion_Tips_%26_Tricks#Restart_a_ColdFusion_Application|shown here]]. If you still run into issues though, you will need to [https://support.hostek.com/ submit a support ticket] asking our team to install the remote site's SSL certificate into ColdFusion's Java Certificate Store.

===Fixing cfhttp Failures on VPS Hosting===
If you are having issues connecting to a site or file from with ColdFusion over HTTPS, you can import the remote site's SSL certificate into the the Java SSL Certificate Store used by ColdFusion.
====Fixing cfhttp Connection Failures with Keytool====
'''1) Set Java environment''' 
First, you'll need to find the version of Java being used by ColdFusion. To do this, open the jvm.config for your server. Depending on your server's version of ColdFusion, that file is at one of the following locations: 
 '''ColdFusion 9 single-instance''': C:\ColdFusion9\runtime\bin 
'''ColdFusion 9 multi-instance''': C:\ColdFusion9\bin 
'''ColdFusion 10''': C:\ColdFusion10\cfusion\bin 

''Note:'' If your server is a '''Linux/cPanel''' server, the jvm.config file will be in one of the following locations:
'''ColdFusion 9''': /usr/local/coldfusion9/bin
'''ColdFusion 10''': /opt/coldfusion10/cfusion/bin
 
Once opened, look for "java.home" at toward the top of the ''jvm.config'' file. You use the value of that variable in the next command. For '''example''', you may see this:
java.home=C:\\ColdFusion10\\jre
In that case, you would use '''C:\ColdFusion10\jre''' as the value of JAVA_HOME as shown below. Open a command prompt and issue the following commands:
C:\ColdFusion10\jre>set JAVA_HOME=C:\ColdFusion10\jre
C:\ColdFusion10\jre>set PATH=%PATH%;%JAVA_HOME%\bin

''Note:'' If your server is a '''Linux/cPanel''' server, use the following commands (case-sensitive) in your terminal:
This '''example''' assumes that the JRE is located at ''/opt/coldfusion10/jre''
export JAVA_HOME=/opt/coldfusion10/jre
export PATH=$PATH:/opt/coldfusion10/jre

'''2) List the Keystore Contents''' 

If your Java installation is at ''C:\ColdFusion10\jre'', then navigate to '''C:\ColdFusion10\jre\bin''':
cd C:\ColdFusion10\jre\bin
If you're using a '''Linux/cPanel''' server, use this command instead:
cd /opt/coldfusion10/jre/bin

Now you can list the keystore contents ''(Windows & Linux)'':
keytool -list -storepass changeit -keystore ../lib/security/cacerts

Example output:
Keystore type: JKS
Keystore provider: SUN
Your keystore contains 76 entries

'''3) Import certificate in to keystore and list to check added ''' 
''(assumes you've downloaded the certificate to '''c:\temp\inet.cer''' (Windows) or '''/temp/inet.cer''' (Linux/cPanel)'' 
'''Windows'''
keytool -importcert -storepass changeit -alias inet -keystore ../lib/security/cacerts -trustcacerts -file c:\temp\inet.cer

'''Linux'''
keytool -importcert -storepass changeit -alias inet -keystore ../lib/security/cacerts -trustcacerts -file /temp/inet.cer
Trust this certificate? [no]: y
Certificate was added to keystore

Now verify the keystore contains your new certificate
keytool -list -storepass changeit -keystore ../lib/security/cacerts
Example output:
Keystore type: JKS
Keystore provider: SUN
Your keystore contains 77 entries

'''4) Restart the ColdFusion application service so the keystore is re-read.''' 

'''5) Run your cfhttp request - HTTPS works now!'''

====Fixing cfhttp Connection Failures with Portecle====
If you'd rather import certificates into the Java SSL Keystore through a GUI, follow these directions to use a tool named Portecle to do so:

#Ensure your JAVA_HOME variable is set correctly as described above.
#Download Portecle from Sourceforge: [http://sourceforge.net/projects/portecle/ Portecle Project Homepage]
#Extract the files
#Open a Command Prompt and navigate to the extracted directory
#Issue this command to launch Portecle: <pre>java -jar portecle.jar</pre>
#In Notepad, open your jvm.config file to find the JVM PATH for ColdFusion's JVM; look for '''java.home={path here}'''
#In Portecle click ''File'', ''Open Keystore File''
#Browse to {JVM PATH}\jre\lib\security to the path, and open the cacerts file; Enter Password: '''changeit'''
#Click on '''Tools''', '''Import Trusted Certificate''', select the certificate you wish to import.
#*To obtain the certificate, you can navigate in a browser to the site where the certificate resides, then download the certificate to a .CER file, in the '''DER''' format (or the '''X.509''' format) through the browser.
#*#In IE on the server where you will import the certificate into ColdFusion, browse to the site where you will import the cert from.
#*#Click on the lock, then view the certificate.
#*#Click the details, click "Copy to file" click through.
#*#Select DER format, then save to "D:\certs" or "C:\certs" (if the folder isn't there, simply create it).
#Click '''OK''' to import and '''YES''' to accept the certificate as ''trusted''.
#Click '''OK''' again, usually you won't need to change the Alias name; click '''OK''' to finish.
#Click '''File''', '''Save Keystore'''.
#Close Portecle.
*'''Important:''' A ColdFusion Restart is necessary for this to take effect.

====Fixing CFHTTP Failures Related to Cached DNS Records====
This solution will prevent Java from caching DNS records for the life of the ColdFusion process. Instead, Java will refresh its records periodically.

First, you'll need to find the version of Java being used by ColdFusion. To do this, open the jvm.config for your server. Depending on your server's version of ColdFusion, that file is at one of the following locations: 
'''ColdFusion 9 single-instance''': C:\ColdFusion9\runtime\bin 
'''ColdFusion 9 multi-instance''': C:\ColdFusion9\bin 
'''ColdFusion 10''': C:\ColdFusion10\cfusion\bin 

''Note:'' If your server is a '''Linux/cPanel''' server, the jvm.config file will be in one of the following locations:
'''ColdFusion 9''': /usr/local/coldfusion9/bin
'''ColdFusion 10''': /opt/coldfusion10/cfusion/bin
 
Once opened, look for "java.home" at toward the top of the ''jvm.config'' file. You use the value of that variable to find the location of the Java installation used by ColdFusion.

For '''example''', on '''Windows''' you may see this:
java.home=C:\\ColdFusion10\\jre
On '''Linux''' you may see this:
java.home=/opt/coldfusion10/jre

Navigate to the '''security''' folder within the Java installation used by ColdFusion. For '''example''': 
'''Windows''' ''(open in Windows Explorer)''
C:\ColdFusion10\jre\lib\security\
'''Linux\cPanel'''
cd /opt/coldfusion10/jre/lib/security/

Back-up, then edit the '''java.security''' file within that folder and change the following line: 
'''From'''
#networkaddress.cache.ttl=-1
'''To'''
networkaddress.cache.ttl=600

''Note:'' The above value refreshes DNS records every 600 seconds ''(10 minutes)''. You may adjust it to whatever you feel is appropriate for your server.

Now '''Save''' the file then '''Restart ColdFusion''', and the new DNS caching setting will take effect.

==CFMAIL Multi-Part Emails==
Sending emails with both Text and HTML parts helps reduce the chance of your messages getting caught by a mail server's spam filter. It also helps ensure your recipients can read the message regardless of the mail client being used. The easiest way to do this is to store your message in a variable using <cfsavecontent> then adding it to <cfmail> using <cfmailpart> as shown in the example below:
<syntaxhighlight lang="cfm">

<cfsavecontent variable="myemailcontent">
Hello,

This is some plain text. 
And this is some more text in HTML. It will appear in plain-text for anyone who views the Text part of this email, though.
</cfsavecontent>


<cffunction name= "textMessage" access= "public" returntype= "string" hint= "Converts an html email message into a nicely formatted with line breaks plain text message">
<cfargument name= "string" required= "true" type= "string">
<cfscript>
var pattern = " ";
var CRLF = chr( 13) & chr( 10);
var message = ReplaceNoCase(arguments.string, pattern, CRLF , "ALL");
pattern = "<[^>]*>";
</cfscript>
<cfreturn REReplaceNoCase(message, pattern, "" , "ALL")>
</cffunction>


<cfmail from="sender@domain.com" to="recipient@anotherdomain.com" subject="Multi-part Email with CFMAIL" type="html">
<cfmailpart type= "text/plain" charset= "utf-8">#textmessage(myemailcontent)#</cfmailpart>
<cfmailpart type= "text/html" charset= "utf-8">#myemailcontent#</cfmailpart>
</cfmail>
</syntaxhighlight>

Reference: [http://cookbooks.adobe.com/post_CFMAIL_the_right_way-17875.html CFMAIL the right way]

==Scheduling Tasks in ColdFusion==
On occasion shared ColdFusion hosting customers need to setup Scheduled Task to run files on a cycle.

This can be done with the following steps, making use of ColdFusion's <cfschedule> tag:

#Create a file locally using any text editor, save the file with the .CFM extension (example: setschedule_example.cfm).
#Copy and past in the code example below taken from ''ColdFusion's Documentation'' and save.
#Replace the data in the example note the following recommendations. !- Name each file made for creating a schedule with the name of the task so you can reference the task later if needed. Specific naming will also make it more difficult for someone to randomly run the file. !- If you need to schedule a job to run monthly on any date in the range 28-31, read about how ColdFusion will handle the scheduling in the ColdFuison8 documentation referenced below.
#Working example, the code example below is a working tested solution for getting the weather for a specific zip code and the task to email the results.

'''Scheduled Task'''
<syntaxhighlight lang="cfm">

<cfschedule action = "update"
task = "Weather_Send"
operation = "HTTPRequest"
url = "http://test.hostek.net/weather_send.cfm"
startDate = "7/6/09"
startTime = "09:30 AM"
interval = "3600"
resolveURL = "Yes"
requestTimeOut = "600"
mode = "application">









</syntaxhighlight>

'''Weather Collector'''
<syntaxhighlight lang="cfm">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CF External Weather Checker</title>
</head>

<body>

<cfset zip="12345">

<cfinvoke webservice="http://ws.cdyne.com/WeatherWS/Weather.asmx?wsdl" method="getCityWeatherByZIP" returnvariable="aWeatherReturn">
<cfinvokeargument name="ZIP" value="#zip#"/>
</cfinvoke>

<cfif aWeatherReturn.temperature EQ "">
<cfoutput> I cannot get the weather for #zip# external http connections must be DOWN.</cfoutput>
<cfelse>
<cfset message="The temperature for #zip# (Your city) is #aWeatherReturn.temperature# degrees.">
</cfif>

<cfif message NEQ "">

<cfmail from = "weather.server@test.com" to = "test@test.com" subject = "Weather checker">

#message#

</cfmail>

</cfif>

</body>
</html>
</syntaxhighlight>

'''Note''': We highly recommend setting the ''mode'' attribute of cfschedule to ''application''. This will ensure your site's application is the only one allowed to modify the task. 
'''More information on using CFSchedule''' 
*[https://wikidocs.adobe.com/wiki/display/coldfusionen/cfschedule Adobe ColdFusion Documentation - CFSchedule]
*[http://www.isummation.com/blog/configuring-coldfusion-scheduled-tasks-using-the-cfschedule-tag/ iSummation Blog - Configuring ColdFusion Scheduled Tasks using the CFSCHEDULE tag]

==Session Management - Handling Bots and Spiders==
===Robots.txt File===
First and foremost we suggest creating a robots.txt file in the web root of the domain to address two issues. First to control the rate at which the website is being crawled which can help prevent a bot/spider from creating a massive number of database connections at the same time. Second to prevent specific bots from crawling the website.

Please see our [[Robots|robots.txt article]] for more information on implementing a robots.txt on your site.

===Lower Session Timeouts for Bots and Spiders===
Next we suggest setting your session timeout specifically lower for bots and spiders. These spiders and bots will crawl a page and when a session (ColdFusion) is created, it will persist during then entire page load. The page fully loaded allows the bot or spider to get the information from the Web page AND allows the session to expire quickly protecting ColdFusion from effects similar to a memory leak.

To do this, implement the appropriate solution for your site below:

====If using '''Application.cfm'''====
Place this code at the top of your Application.cfm file:
<syntaxhighlight lang="cfm">

<cfif StructKeyExists(cookie, "cfid") or StructKeyExists(cookie, "jsessionid")>
<cfset REQUEST.sessionTimeout = CreateTimeSpan(0,0,30,0) />
<cfelse>
<cfset REQUEST.sessionTimeout = CreateTimeSpan(0,0,0,2) />
</cfif>
</syntaxhighlight>
Then use the '''REQUEST.sessionTimeout''' variable to specify the session timeout period in your '''cfapplication''' tag:
<syntaxhighlight lang="cfm">
<cfapplication name="myawesomeapp"
sessionmanagement="Yes"
sessiontimeout="#REQUEST.sessionTimeout#">
</syntaxhighlight>

====If using '''Application.cfc''' (tag-based)====
If you primarily use cfml tags in your Application.cfc, you can set the Session Timeout like this:
<syntaxhighlight lang="cfm">

<cfif StructKeyExists(cookie, "cfid") or StructKeyExists(cookie, "jsessionid")>
<cfset this.sessiontimeout = CreateTimeSpan(0,0,30,0) />
<cfelse>
<cfset this.sessiontimeout = CreateTimeSpan(0,0,0,2) />
</cfif>
</syntaxhighlight>

====If using '''Application.cfc''' (cfscript)====
If instead, you're using cfscipt in your Application.cfc, you'll set the custom Session Timeout like this:
<syntaxhighlight lang="cfm">
// This checks if a cookie is created, for bots this will return false and use the low session timeout
if (StructKeyExists(cookie, "cfid") || StructKeyExists(cookie, "jsessionid")){
this.sessionTimeout = createTimeSpan(0,0,30,0);
} else {
this.sessionTimeout = createTimeSpan(0,0,0,2);
}
</syntaxhighlight>

'''Reference''': [http://www.bennadel.com/blog/1083-ColdFusion-Session-Management-And-Spiders-Bots.htm Session Management code examples for the Application.cfm]

==Creating Client Variables Tables for MySQL Databases==
If you need your datasource set up as a ColdFusion Client Variables Store, you can enable the '''Client Variables'' option in your ColdFusion datasource within the WCP control panel.

Please note, if your datasource MySQL DSN, you'll need to create the necessary tables prior to using the Client Variable Store. To do this you would need to create two tables, one named "cdata" and one named "cglobal". The SQL you'd use to create those tables is below:

Table: '''cdata'''
<syntaxhighlight lang="mysql">
CREATE TABLE IF NOT EXISTS cdata (
cfid varchar(64) NOT NULL default '',
app varchar(64) NOT NULL default '',
data longtext NOT NULL,
PRIMARY KEY (cfid,app)
);
</syntaxhighlight>
Table: '''cglobal'''
<syntaxhighlight lang="mysql">
CREATE TABLE IF NOT EXISTS cglobal (
cfid varchar(64) NOT NULL default '',
data longtext NOT NULL,
lvisit timestamp,
KEY cfid (cfid),
KEY lvisit (lvisit)
);
</syntaxhighlight>

==Output CF Error details without CFDump==
It is common in an error handler that you want to output all of the error details to the screen, a file, or an email. Therefore, the cfdump tag is commonly used for this; and, while this works well in development, it is not always the best practice on a production site because of the performance of the cfdump tag due to its use of reflection (Runtime type introspection).

A better performing alternative is to output the information you want directly from the Error/Exception struct within a 'cfoutput' tag. This can be done by looking up the cferror structure or the cfcatch structure in the ColdFusion docs to see what is available and what values you might want to output: 
'''Error''': https://wikidocs.adobe.com/wiki/display/coldfusionen/cferror 
'''CFCatch''': https://wikidocs.adobe.com/wiki/display/coldfusionen/cfcatch

===Cfdump Custom Tag Alternative===
You can also use the following link to download an example CF custom tag that will give a similar error output as when using the cfdump tag on an error variable: 
[http://hostek.com/tutorials/ColdFusion/CF_OutputError.zip http://hostek.com/tutorials/ColdFusion/CF_OutputError.zip]

Below is the custom tag's usage:

In the error handler specified in your 'cferror' tag:
<syntaxhighlight lang="cfm">
<cf_OutputError Error="#Error#" />
</syntaxhighlight>

The above code would replace:
<syntaxhighlight lang="cfm">
<cfdump var="#Error#" />
</syntaxhighlight>

Or, in a cfcatch block:
<syntaxhighlight lang="cfm">
<cftry>
...
<cfcatch>
<cf_OutputCFCatch CFCatch="#CFCatch#" />
</cfcatch>
</cftry>
</syntaxhighlight>

==Configure ColdFusion to Handle html and htm Files==
===Enable HTML/HTM as CFML on Shared Accounts===
On our ColdFusion servers, the best way to process HTML files (.html, .htm) as ColdFusion/CFML (.cfm files) is by using a set of rewrite rules that route the HTML files through a ColdFusion "controller" script. The main benefits of this approach are that it is easy to implement on a site-by-site basis, and it works with any version of ColdFusion. To implement this approach on your site, follow the steps below:
====Step 1: Add Rewrite Rules to Route HTML Files through the CFM Controller====
If you have a '.htaccess' file in your webroot, add the rules below to the top of that file. Otherwise, create a file named '.htaccess' in your site's web root and place these rules within it:
=====For Sites Using .HTML Files=====
<syntaxhighlight lang="apache">
#Rewrite requests without script name to index.html
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*) /index.html [R]

# REDIRECT to change the address in the browser address bar
RewriteRule ^/htmlcontrol.cfm$ /$1.html [R]

# REWRITE so that the correct page executes when /cart is the URL
RewriteRule ^(.*)\.html htmlcontrol.cfm/?pageName=$1 [L]
</syntaxhighlight>
=====For Sites Using .HTM Files=====
'''NOTE:''' If your site uses ''.htm'' files instead of ''.html'' files, use this set of rules instead. The only difference is ''html'' is replaced with ''.htm''.
<syntaxhighlight lang="apache">
#Rewrite requests without script name to index.html
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*) /index.htm [R]

# REDIRECT to change the address in the browser address bar
RewriteRule ^/htmlcontrol.cfm$ /$1.htm [R]

# REWRITE so that the correct page executes when /cart is the URL
RewriteRule ^(.*)\.htm htmlcontrol.cfm/?pageName=$1 [L]
</syntaxhighlight>
====Step 2: Create the ColdFusion Controller Script (htmlcontrol.cfm)====
Now we just need to create a ColdFusion script that will process the HTML files. To do this, create a file named '''htmlcontrol.cfm''' within your site's web root. Place this CFML code within the file:
=====CFML for Sites Using .HTML Files=====
<syntaxhighlight lang="cfm">
<cfinclude template="#URL.pageName#.html" >
</syntaxhighlight>
=====CFML for Sites Using .HTM Files=====
<syntaxhighlight lang="cfm">
<cfinclude template="#URL.pageName#.htm" >
</syntaxhighlight>

Once you save the controller script, your site will begin processing any ColdFusion/CFML code within your HTML files.
===Enable HTML/HTM as CFML on a VPS===
In case you need to process ColdFusion code in your .htm or .html files, here is what you will need to do to get this to work. This is based on using ColdFusion on one of our dedicated server hosting accounts on a Windows server.

'''NOTE''': This will affect every site on the server, so use cautiously.

First, you will need to edit the web.xml file located generally at C:\ColdFusion10\cfusion\wwwroot\WEB-INF

Open this file and look for '''coldfusion_mapping_1'''.

Scroll down the file until you see the last number increment like:
<syntaxhighlight lang="xml">
<servlet-mapping id="macromedia_mapping_15">
</syntaxhighlight>
Then add the following right below the closing </servlet-mapping> of the last number increment item:

<syntaxhighlight lang="xml">
<servlet-mapping id="coldfusion_mapping_16">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.html</url-pattern>
</servlet-mapping>
<servlet-mapping id="coldfusion_mapping_17">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.html/*</url-pattern>
</servlet-mapping>
<servlet-mapping id="coldfusion_mapping_18">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.htm</url-pattern>
</servlet-mapping>
<servlet-mapping id="coldfusion_mapping_19">
<servlet-name>CfmServlet</servlet-name>
<url-pattern>*.htm/*</url-pattern>
</servlet-mapping>
</syntaxhighlight>
Save this file and exit.

Now in IIS, setup a mapping for the site:
#In IIS 7+ click the server name section (right below the '''Start Page''' in the left-hand navigation), then double-click the '''Handler Mappings''' icon.
#Select and "edit" the '''*.cfm''' record and copy the value of "executable". Now hit Cancel and then click '''Add Script Map'''.
#Paste the executable value copied from the '''*.cfm''' record and type '''*.htm''' into the '''Request Path''' and hit OK.
#Repeat the above steps to add a handler for '''*.html'''

Lastly, open the '''uriworkermap.properties''' file for your ColdFusion 10 IIS Connector in a text editor such as Notepad. On a standard ColdFusion installation this is located at: <pre>C:\ColdFusion10\config\wsconfig\1\uriworkermap.properties</pre>
Copy the following lines, paste them at the bottom of the file, then save and close the file: <pre>/*.html = cfusion
/*.htm = cfusion</pre>

Now restart the ColdFusion service and IIS. ColdFusion should begin processing CFML within htm/html files now.

==Increase the ColdFusion Post Parameters Limit==
===ColdFusion 10+===
In ColdFusion 10 and higher, you can easily increase the value of ColdFusion's '''postParametersLimit''' via the ColdFusion Administrator. Once logged into the ColdFusion Administrator, click the '''Settings''' link then scroll to the bottom of the page. Set the value for the Post Parameters Limit to the desired limit and click the submit button.

===ColdFusion 9 and below===
To adjust the Post Parameters Limit setting in ColdFusion 9 and below, you will have to edit the server's '''neo-runtime.xml''' file which is located here on a standard installation: <pre>C:\ColdFusion9\lib</pre>

Open that file in a text editor such as Notepad, then search for the '''postSizeLimit''' tag. It will look similar to this:
<syntaxhighlight lang="xml"><var name='postSizeLimit'><number>100.0</number></var></syntaxhighlight>

Immediately after that set of tags, paste this chunk of text:
<syntaxhighlight lang="xml"><var name='postParametersLimit'><number>1000.0</number></var></syntaxhighlight>
Once you've adjusted the file, you'll just need to save your changes and restart ColdFusion for the new setting to go into effect. '''Note''': The value of '''1000''' is just an example, so you can increase it as needed.

==Loading custom Java library or Java Libraries (jar or class files) in ColdFusion 10==
ColdFusion 10 makes it easy to load Java libraries into your ColdFusion application without having to restart ColdFusion. All that's required is your application define the 'THIS.javaSettings' attribute within the site's Application.cfc like below:
<syntaxhighlight lang="cfm">
<cfset THIS.javaSettings = {LoadPaths = ["/javafiles/"], loadColdFusionClassPath = true, reloadOnChange=false}/>
</syntaxhighlight>

The above code will check the ''javafiles'' directory in your Web root for 'jar' and 'class' files and make any libraries within the directory accessible from your ColdFusion application. If you modify the JAR files in your ''javafiles'' directory though, ColdFusion will need to be restarted to load the new versions of the JAR files.

*Alternative Option to Restarting ColdFusion:
#Instead of Restarting ColdFusion we've seen success in just restarting a client's specific application, here is how:
#*[https://wiki.hostek.com/ColdFusion_Tips_%26_Tricks#Restart_a_ColdFusion_Application How to Restart a ColdFusion Application]

'''References''':
*[https://wikidocs.adobe.com/wiki/display/coldfusionen/Enhanced+Java+integration+in+ColdFusion+10 Adobe ColdFusion Documentation - Enhanced Java Integration in ColdFusion]
*[http://www.raymondcamden.com/2014/6/16/Issue-with-ColdFusion-JavaSettings-and-ReloadOnChange Ray Camden's Blog - Issue with ColdFusion JavaSettings and ReloadOnChange]

==How to handle ColdFusion Error ''Permission denied for creating Java object: coldfusion.server.ServiceFactory''==
===When using Mura or using Transfer ORM===
====Issue====
If you are using '''Mura''' or using '''Transfer ORM''' and you get this error, ''Permission denied for creating Java object: coldfusion.server.ServiceFactory'', you are likely using an outdated version of Mura and also are probably on a ColdFusion 9 server. The Transfer ORM component causing this issue has not been updated to work with ColdFusion 9. There is a quick fix though:
====Solution====
Find the file named CFMLVersion.cfc which should be at '''/wwwroot/requirements/transfer/com/factory'''.

Edit that file and find the line that has:
<syntaxhighlight lang="cfm">
if(server.coldfusion.productversion.startsWith("8"))
</syntaxhighlight>
And change that to:
<syntaxhighlight lang="cfm">
if(server.coldfusion.productversion.startsWith("8") OR server.coldfusion.productversion.startsWith("9"))
</syntaxhighlight>
Save the file and it should now work.

'''NOTE''': Since this is likely running an outdated version of Mura, we highly recommend updating Mura to the latest version to take advantage of numerous performance and security enhancements.
===When using DataMgr===
If you get this error while using DataMgr.cfc, the changes described below will solve this problem:

Here is the section of code from the original DataMgr.cfc:

<syntaxhighlight lang="cfm">
<cffunction name="getDataBase" access="public" returntype="string" output="no" hint="I return the database platform being used.">

<cfset var connection = 0>
<cfset var db = "">
<cfset var type = "">
<cfset var qDatabases = getSupportedDatabases()>

<cfif Len(variables.datasource)>
<cfset connection = getConnection()>
<cfset db = connection.getMetaData().getDatabaseProductName()>
<cfset connection.close()>

<cfswitch expression="#db#">
<cfcase value="Microsoft SQL Server">
<cfset type = "MSSQL">
</cfcase>
<cfcase value="MySQL">
<cfset type = "MYSQL">
</cfcase>
<cfcase value="PostgreSQL">
<cfset type = "PostGreSQL">
</cfcase>
<cfcase value="Oracle">
<cfset type = "Oracle">
</cfcase>
<cfcase value="MS Jet">
<cfset type = "Access">
</cfcase>
<cfcase value="Apache Derby">
<cfset type = "Derby">
</cfcase>
<cfdefaultcase>
<cfif ListFirst(db,"/") EQ "DB2">
<cfset type = "DB2">
<cfelse>
<cfset type = "unknown">
<cfset type = db2>
</cfif>
</cfdefaultcase>
</cfswitch>
<cfelse>
</syntaxhighlight>

Here is what the modified code should look like (this sample assume MySQL)

<syntaxhighlight lang="cfm">
<cffunction name="getDataBase" access="public" returntype="string" output="no" hint="I return the database platform being used.">

<cfset var connection = 0>
<cfset var db = "">
<cfset var type = "">
<cfset var qDatabases = getSupportedDatabases()>

<cfif Len(variables.datasource)>




<cfswitch expression="#db#">
<cfcase value="Microsoft SQL Server">
<cfset type = "MSSQL">
</cfcase>
<cfcase value="MySQL">
<cfset type = "MYSQL">
</cfcase>
<cfcase value="PostgreSQL">
<cfset type = "PostGreSQL">
</cfcase>
<cfcase value="Oracle">
<cfset type = "Oracle">
</cfcase>
<cfcase value="MS Jet">
<cfset type = "Access">
</cfcase>
<cfcase value="Apache Derby">
<cfset type = "Derby">
</cfcase>
<cfdefaultcase>
<cfif ListFirst(db,"/") EQ "DB2">
<cfset type = "DB2">
<cfelse>
<cfset type = "unknown">
<cfset type = "db2">
</cfif>
</cfdefaultcase>
</cfswitch>
<cfset type = "MYSQL">
<cfelse>
</syntaxhighlight>

'''Summary of changes''':

These 3 lines were commented out:
<syntaxhighlight lang="cfm">



</syntaxhighlight>

This line needed quotes around db2:
<syntaxhighlight lang="cfm">
<cfset type = "db2">
</syntaxhighlight>

And lastly, this line needed added:
<syntaxhighlight lang="cfm">

<cfset type = "MYSQL">
</syntaxhighlight>

'''NOTE''': If you are using an ''MS Access'' database instead of ''MySQL'', replace '''MYSQL''' with '''msaccessjet''' on the line that is added.

==How to handle ColdFusion Error ''Security: The requested template has been denied access to {file/directory}''==
===Issue===
Our shared servers have ColdFusion Sandbox Security enabled, which requires absolute filesystem paths to be provided to tags and functions that interact with the filesystem. If you receive an error that starts with ''Security: The requested template has been denied access to ...'', then it is followed by a relative path, you'll need to replace the relative path with a full path.

===Solution===
One way to do this is to hard-code the path (''d:\home\sitename.com\wwwroot\filename.jpg''), but that can cause portability problems if your site is ever moved to a different environment.

A better way to do this would be to "wrap" your relative path with the '''ExpandPath()''' function. The ''ExpandPath()'' function will automatically detect the absolute filesystem path to the file, and ColdFusion will no longer give you a permissions error.

'''More info''': [https://wikidocs.adobe.com/wiki/display/coldfusionen/ExpandPath Adobe Documentation - ExpandPath]

==How to handle ColdFusion COM Object Error ''java.lang.RuntimeException: Can not use native code: Initialisation failed''==
The error ''java.lang.RuntimeException: Can not use native code: Initialisation failed'' is related to calling a 32-bit COM object from within a 64-bit ColdFusion installation.

The simplest way to bypass this error is to write a small ASP Webservice to proxy the call to the COM object as shown in '''Option 2''' of this blog post: [http://coldfusion9.blogspot.com/2010/05/32-bit-components-on-64-bit-coldfusion.html 32-bit Components on 64-bit ColdFusion]

Alternatively, you can [https://support.hostek.com/ ask Support] to move your site to a 32-bit ColdFusion server.

==Using SeeFusion to Monitor ColdFusion Performance on a VPS/Dedicated Server==
To use Seefusion, visit the address mentioned in your server's Welcome email.

Once loaded, you'll see a summary of memory consumption, average response time, number of requests processed by ColdFusion per second, and a view of currently running ColdFusion requests.
===Finding Scripts to Optimize===
When using Seefusion it is helpful to look at the '''Slow''' section of the request monitor. This will show you recent requests that took longer than 8 seconds to complete, giving you a good idea of what scripts need optimization.
===Stack Tracing with Seefusion===
Additionally, when a request is running in the '''Active''' section of Seefusion's request monitor, you can click the paper stack icon to the left of the request to view a stack trace of the request. A stack trace tells you what line of code is currently being processed by the request.

Once the stack trace loads, start at the top and work your way down until you find a recognizable path to a ColdFusion template (''eg. c:\home\mysite.com\wwwroot\index.cfm: 47''). This tells you the template currently being executed followed by the line number being processed at that moment in time. If a request consistently shows the same line of code in subsequent stack traces, then you've found the main area to focus on optimizing.

To make deciphering stack traces easier, you can also click the '''Seestack''' button at the top of the stack trace window. This will send the stack trace to a service that will analyze the trace and attempt to tell you where you need to focus.

===Viewing Metrics over Time===
If you want to watch how response times and memory utilization in a more granular manner than the dashboard graphs show, you'll want to click the '''Counters''' button at the top of SeeFusion. Once on the Counters page you can select a time interval, then have Seefusion display performance metrics at the interval you selected. This is helpful to ensure requests are completing quickly and not exhausting ColdFusion's memory.

==How to Wrap Your ColdFusion DSN with Seefusion==
If you wish to have Seefusion monitor your server's query activity, you'll need to "wrap" your DSN with SeeFusion's JDBC driver so Seefusion can monitor the DSN's activity.
===Install SeeDSN===
SeeDSN is a plugin for ColdFusion Administrator that makes it easy to wrap a DSN with Seefusion. Follow these directions to install SeeDSN:
#Download the SeeDSN archive [http://www.seefusion.com/seedsn_v1.1.zip here].
#Extract the '''seedsn''' folder within the archive to your '''/CFIDE/Administrator/''' folder. This means it will be located at ''/CFIDE/Administrator/seedsn'' once extracted.
#Move ''/CFIDE/Administrator/seedsn/custommenu.xml'' to ''/CFIDE/Administrator/custommenu.xml''
===Add Seefusion.jar to the ColdFusion Classpath===
In order for ColdFusion to use Seefusion's JDBC driver, you'll need to ensure '''seefusion.jar''' is on your ColdFusion class path. Follow these directions to add seefusion.jar to the Coldfusion class path:
#Log into your server's ColdFusion Administrator
#Click the '''Java and JVM''' link on the left, under Server Settings.
#In the box labeled '''ColdFusion Class Path''' add the path to your '''seefusion.jar''' file and click ''Submit Changes''. For example, if it is located in ColdFusion's "WEB-INF\lib" folder, you can add this to the Class Path: '''{application.home}/wwwroot/WEB-INF/lib/seefusion.jar'''.
#*Each path in the ColdFusion Class Path is separated by a comma, so be sure to add a comma right before the path to seefusion.jar (do not add any spaces).
#Restart ColdFusion after modifying the class path

===Wrap a DSN using SeeDSN===
Once you've installed SeeDSN and restarted ColdFusion, you can wrap a DSN with the SeeFusion JDBC driver. Follow these instructions to do so:
#Log into ColdFusion Administrator
#Expand the ''SeeFusion'' navigation menu on the left and click '''Datasource Wrapper'''
#On the ''Datasource Wrapper'' page, you'll see a list of DSNs on your server. To wrap a DSN, click the ''Start'' [[File:Start.png]] icon next to your DSN. SeeDSN will automatically wrap your DSN with the SeeFusion driver and display '''OK''' if it is successful.

'''Reference''': [http://www.webapper.com/blog/index.php/2009/06/08/seedsn-a-jdbc-wrapping-tool-for-use-with-seefusion/ WebApper Blog - Using SeeDSN JDBC Wrapping Tool]

==Using fckEditor on ColdFusion 10 or Higher==
When getting the following error for fckEditor:
'''"The server didn't reply with a proper XML data. Please check your configuration."'''

If you are on a ColdFusion 10+ server this will be cause by the '''FileUpload()''' function that is being used.
In ColdFusion 10+ ''FileUpload'' is a built-in function name, so you'll need to rename the ''FileUpload'' function used in fckeditor.
You can update the text for fckeditor by changing all instances of "FileUpload" to "fckFileUpload" to remove this conflict.

==Optimze CFIMAGE Rendering in Three Steps==
===USE===
When full size images are required, re-sized images need to be used for displaying smaller images or thumbnails and the application needs to perform at optimal speed for displaying images in a browser.

===KEY POINTS===
Except for during development cfimage '''action="writeToBrowser"''' should not be used to display images.
Use CFIMAGE to resize images ''ONCE'', if possible during upload but if page timeouts make this impossible break up the task by using a CFC to check and re-size images as needed.

===SUMMARY===
Those sites that display many images often times also upload many photos via form or via FTP and need to display both the FULL size images and smaller images for thumb nails or ''(small, med, large)'' optional sizes. The process of uploading images using CFFile can impose time constraints specifically for large files, or if the coldfusion page timeouts are set lower than is possible for large file upload and re-size jobs. To overcome this issue we can write a simple CFC for resizing the images after the upload is complete and the page is run for the first time. This will be ideal for either form based upload or FTP upload making this solution very versatile.

====Step 1 - Create the CFC for re-sizing and writing images to disk====

Create file "GetResizedImage.cfc" in the directory with the CFM files that display images.
Use the code below for the contents of this file and modify as needed.
<syntaxhighlight lang="cfm">
<cfcomponent>
<cffunction name="GetImage" hint="Re-sizes images for display in album">

<cfset imgpath = "imgdir/"/>

<cfset domain = "domain.com"/>

<cfset rfile= "#REReplace("#img#",".(jpg|JPG|JPEG|jpeg)","_resized.jpg")#">

<cfif FileExists("d:\home\#domain#\wwwroot\" &"#imgpath#" & "#rfile#")>
<cfset myImage="http://#domain#/#imgpath##rfile#">
<cfelse>

<cfset myImage=ImageNew(URLDecode("d:\home\#domain#\wwwroot\" & "#imgpath#" & "#img#"))>
<cfset ImageResize(myImage,"175","175","bilinear")>

<cfimage source="#myImage#" action="write" overwrite=true destination="d:\home\#domain#\wwwroot\#imgpath##REReplace("#rfile#","%20"," ","ALL")#">

<cfset myImage="http://#domain#/#imgpath##rfile#">
</cfif>

<cfreturn myImage>
</cffunction>
</cfcomponent>
</syntaxhighlight>

====Step 2 - Invoke the CFC====
<syntaxhighlight lang="cfm">

<cfoutput query="MyEvent">

<cfinvoke component="GetResizedImage"

method="GetImage"

returnvariable="myImage">
<cfinvokeargument name="img" value="#event.Pic#"/>
</cfinvoke>

<img src="#myImage#" alt="" />
</cfoutput>
</syntaxhighlight>
====Step 3 - Test====
The proposed solution cut page load times from 20+ seconds to below one second after the first page load. During the FIRST or FIRST FEW times the page loads all the re-sizing will be done.

===Q and A===
'''Question''': Checking if a file exists each time the page loads is excessive. 
'''Answer''': We agree but it's much better than resizing every image each time the page loads.

==How to create Services for Additional ColdFusion Instances==
If you've created additional ColdFusion instances on your VPS/Dedicated Server, and ColdFusion was unable to create the Services for those instances just do the following:

#Open a Command Prompt as Administrator
#Run this command, replacing INSTANCE with the actual name of your new ColdFusion instance: <pre style="white-space: pre-wrap">sc create "ColdFusion 10 INSTANCE Application Server" binPath= "C:\ColdFusion10\INSTANCE\bin\coldfusionsvc.exe" displayname= "ColdFusion 10 INSTANCE Application Server" start= auto</pre>

Now you will be able to start your instance through the Windows Services Manager. If you need to know how to create additional ColdFusion instances, please see this guide from Adobe: [http://help.adobe.com/en_US/ColdFusion/10.0/Admin/WSAB4367BA-6D91-4c69-8DBA-E2839394658A.html Defining Additional ColdFusion Instances]

Once you've created the instances, you can attach them to your Web server as described here: [http://help.adobe.com/en_US/ColdFusion/10.0/Admin/WSc3ff6d0ea77859461172e0811cbf363a5d-7ffc.html Web Server Configuration]

If you're using IIS, this video has a great walkthrough for using the ColdFusion Web Server Connector tool: [http://blogs.coldfusion.com/post.cfm/video-learn-about-iis-connectors-in-coldfusion10 Learn About ColdFusion IIS Connectors]

==How to Fix Error: Value '0000-00-00' can not be represented as java.sql.Date==
If your application has null values in a MySQL datetime/date column you may encounter the error "Value '0000-00-00' can not be represented as java.sql.Date". The easiest way to fix this is by adding the parameter '''zeroDateTimeBehavior=convertToNull''' to your site's DSN [http://helpx.adobe.com/coldfusion/kb/mysql-error-java-sql-sqlexception.html as recommended by Adobe].
===How to Fix Null DateTime Error - '''Shared Hosting'''===
#Log into your site's WCP control panel
#Click the ''DataSources (DSNs)'' button
#Click the ''Edit'' icon next to your DataSource (DSN)
#Add the following to the '''JDBC Query Parameters''' field: <pre>zeroDateTimeBehavior=convertToNull</pre>

''Note:'' To add multiple JDBC Query Parameters, separate each name/value pair by an ''''&''''.
''Example: zeroDateTimeBehavior=convertToNull&characterEncoding=UTF-8''
===How to Fix Null DateTime Error - '''VPS Hosting'''===
If your site uses WCP to manage its DSNs, you may utilize the Shared Hosting solution. Otherwise, follow the steps below:
#Log into ColdFusion Administrator on your VPS/Dedicated Server.
#Navigate to the "Data Sources" page and click your site's DSN name.
#On the page that opens add '''?zeroDateTimeBehavior=convertToNull''' to the end of the JDBC URL field.
#Click '''Submit''' and your site should no longer display the date representation error.

==Find the Java Version Used by ColdFusion or Railo==
This CFML code will report the version of Java used by your ColdFusion or Railo server:
<syntaxhighlight lang="cfm">
<cfoutput>#CreateObject("java", "java.lang.System").getProperty("java.version")#</cfoutput>
</syntaxhighlight>

'''Reference:''' [http://www.petefreitag.com/item/743.cfm Pete Freitag's Blog - What Version of Java is ColdFusion Using?]

==Reset ColdFusion Admin Password on CF 10+ VPS==
===Reset CF Admin Password - Windows VPS===
*On your VPS, open a command prompt window as Administrator
*Issue the following command to change to the ColdFusion ''bin'' directory ''replace ColdFusion10 with the actual path to your ColdFusion installation''': <pre>cd C:\ColdFusion10\cfusion\bin</pre>
*Execute the ''passwordreset.bat'' script: <pre>.\passwordreset.bat</pre>
*Enter '''1'' to change your ColdFusion administrator password
*Enter a new strong password, then enter it again to confirm the password
*The next section will ask for a new RDS password. If you're not using RDS you may leave the password and confirmation blank, or you can enter a secure password if you like.
*Restart ColdFusion to force the new password into effect

===Reset CF Admin Password - cPanel/Linux VPS===
*SSH into your VPS
*Issue the following command to change to the ColdFusion ''bin'' directory ''replace ColdFusion10 with the actual path to your ColdFusion installation''': <pre>cd /opt/ColdFusion10/cfusion/bin</pre>
*Execute the ''passwordreset.sh'' script: <pre>./passwordreset.sh</pre>
*Enter '''1'' to change your ColdFusion administrator password
*Enter a new strong password, then enter it again to confirm the password
*The next section will ask for a new RDS password. If you're not using RDS you may leave the password and confirmation blank, or you can enter a secure password if you like.
*Restart ColdFusion to force the new password into effect

==ColdFusion 11+ PDF Generation: How to Fix 'No Service Manager is Available' Error==
If you receive the error '''No Service Manager is Available''' when trying to generate PDFs or use the cfhtmltopdf tag on your ColdFusion 11+ VPS, do the following to fix it:
#Log into your server's ColdFusion Administrator
#Expand ''Data & Services'', then click the '''PDF Service''' link
#On the next page, you should see an entry for ''localhost'' under the list of PDF Service Managers
#If the localhost service manager is not enabled, click the ''Enable'' button to the left of the manager name. (The button looks like a ''play'' button)
#Try using cfhtmlpdf now, and see if it works.

If you still have any issues after enabling the service manager, try restarting the '''ColdFusion Addon Services''' Windows service and test again.

There was a problem with ColdFusion 11's PDF Generation with Update 5 and has been fixed in Update 7. You can apply the hotfix or contact support to install the hotfix on your server.

==HTML5 Audio Player with ColdFusion==
This player uses an list named ''Tunes'' within the ''session'' scope to store a list of mp3 names. After populating the list, you can use this code as the foundation for an HTML audio player that plays each song in the list.
<syntaxhighlight lang="cfm">
<cfif action is "play_next_tune">

<cfset myArray=ListtoArray(session.Tunes)>
<cfset T_max=Arraylen(myArray)>
<cfset session.track=session.track+1>
<cfif session.track GT T_max>
<cfset session.track="false">
<cflocation url="tunespage.cfm" addtoken="false">
</cfif>

<cfoutput>
<audio controls id="myVideo" autoplay>
<source src="path/#myarray[session.track]#" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
</cfoutput>

<script language="JavaScript">
document.getElementById('myVideo').addEventListener("ended",function() {
window.location.href="tunespage.cfm?action=play_next_tune";
});
</script>
</cfif>
</syntaxhighlight>

==Cfchart error: Could not locate the style file ''style.xml''==
In ColdFusion 11 the ability to specify styles in an XML file was removed. As such, you will need to convert any XML stylesheets to json files. To do this, you'll need to do the following:
*Install a trial edition of ColdFusion 11 on your local computer
*Open a command prompt and run this command:
**<pre>C:\ColdFusion11\cfusion\bin\cfchart_xmltojson.bat C:\sites\mysite.com\cfchartstyle.xml</pre>
**Be sure to replace the paths above with the actual path to "cfchart_xmltojson.bat" as well as the path to your XML stylesheet.
*When the conversion is done you will end up with a new file with the same name as the XML stylesheet, however there will not be a file extension. To simplify things, add a '''.json''' extension to the converted file.
*Update the path to the stylesheet in the ''cfchart'' tag to have a ''.json'' extension instead of ''.xml''.
*Update the path to the stylesheet to use relative paths instead of absolute paths from the webroot.
**Example: If the stylesheet file and the ''.cfm'' template with the ''cfchart'' code are in the webroot, change '''/cfchartstyle.json''' to '''../cfchartstyle.json'''

More details on this are available in the [https://wikidocs.adobe.com/wiki/display/coldfusionen/cfchart Cfchart documentation]. Be sure to check the comments of the documentation for more helpful cfchart troubleshooting tips.

==CGI.PATH_INFO is Empty After ColdFusion Upgrade==
If CGI.PATH_INFO is empty after you upgrade your server to ColdFusion 10 or higher, change the variable to CGI.SCRIPT_NAME.

==Connecting to RDS on your Coldfusion VPS==
RDS is not enabled on our Shared Servers and is not supported on them. If you wish to use RDS on your Coldfusion VPS you must first enable it and use the correct connection settings for it to work. Follow the below steps to do so.

#Log in to the Coldfusion Administrator
#Go to the 'Security Section'
#Click on 'RDS'
#Check the box to enable it
#Check the box to use single password
#Submit the changes
#Restart Coldfusion
#Using your client enter for the host your servers CFAdmin URL (typically "cf.vps-yourservername-com.ezhostingserver.com)
#The port is port 80
#Username is Admin
#Password is your CFAdmin password

With these settings you will be able to connect using RDS and a client such as Coldfusion Builder to build sites and administrate Coldfusion.
[[Category:ColdFusion]]
[[Category:ColdFusion-VPS]]

About Hosted Exchange

2015-10-21T14:05:48Z

Kylet: Redirected page to SmarterMail

#REDIRECT [[SmarterMail]]

Main Page

2015-10-21T13:59:14Z

Kylet: /* Start Here */

__NOTOC__
== About This Site ==

Welcome to the Hostek.com wiki based knowledge base for Hostek.com customers.

Keeping with the nature of a great wiki, anyone can read articles and comments and any Hostek.com customer can create new articles and update existing ones. NOTE: This is not the place to ask a question. Since a customer can create/edit, some of the articles may be incomplete or incorrect; but that doesn't mean that it will stay that way very long. So if you are a customer and find a mistake, feel free to correct the mistake.

== Start Here ==

Get some help by browsing the categories here:


{| width="100%" align="left" style="background: #fdfdfd; border: 1px solid #eee; padding: 1em;"
|-
| '''General'''
| '''Shared Hosting'''
| '''Email'''
| '''Databases'''
| '''VPS / Virtual Servers'''
|-
| • [[:Category:Getting Started|Getting Started]]
| • [[:Category:ColdFusion|ColdFusion]]
| • [[:Category:SmarterMail|SmarterMail]]
| • [[:Category:Databases-MySQL|MySQL]]
| • [[:Category:VPS|VPS]]
|-
| • [[:Category:Tutorials|Tutorials]]
| • [[:Category:Linux|Linux]]
| • [[:Category:Configuring-Email-Clients|Configuring Email Clients]]
| • [[:Category:Databases-MSSQL|MS SQL]]
| • [[:Category:ColdFusion-VPS|ColdFusion VPS]]
|-
| • [[:Category:Control-Panels|Control Panels]]
| • [[:Category:Railo|Railo]]
| • [[:Category:Databases-Access|MS Access]]
| • [[:Category:Linux-VPS|Linux VPS]]
|-
| • [[:Category:Domain-Names|Domain Names]]
| • [[:Category:Windows|Windows]]
| • [[Dedicated-Email-Server|Dedicated Email Server]]
|
| • [[:Category:Railo-VPS|Railo VPS]]
|-
| • [[:Category:Sales|Sales]]
| • [[:Category:Resellers|Resellers]]
| • [[:Category:Misc-Email|Misc Email Items]]
|
| • [[:Category:Windows-VPS|Windows VPS]]
|-
| • [[:Category:Billing|Billing]]
|
| • [[:Category:cPanel-Mail|cPanel Mail]]
|
| • [[:Category:Email-VPS|SmarterMail VPS]]
|-
| • [[:Category:Infrastructure|Infrastructure]]
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|}

== Contribute ==

If you would like to contribute to this wiki, please first search and make sure the content does not already exist.

If the content does not exist, login using your cp.hostek.com login information.

Please follow the policies and guidelines when adding or editing an article. Thank you for contributing and sharing your knowledge with the rest of us.

NOTE: This is not a place to add spam or to try to promote your business. Any user doing such will be banned from editing/contributing.

==Official Guides==
* [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page Quick Guide]
* [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide WikiMedia User's Guide]
* [http://meta.wikimedia.org/wiki/Help:Editing MediaWiki editing help]

ColdFusion FAQs

2015-09-21T16:32:53Z

Kylet: use wayback machine to fix link timeouts for cfx_imagecr3.

=ColdFusion Frequently Asked Questions (FAQ)=
==Do you support cfform?==
Yes, this is supported.
==Do you support ColdFusion Report Builder==
The ColdFusion Report Builder uses RDS for the Query Builder. We have RDS disabled for security purposes as recommended by Adobe / Macromedia.

We suggest downloading the developer edition of ColdFusion and Report builder, installing locally. Build the reports with the local development environment and upload the ColdFusion Report Files (CFR files) to our servers. Specify the path to your pre-built report files from within the cfreport tag which is NOT disabled.

==Do you support ColdFusion Builder / RDS==
You may use ColdFusion Builder to transfer files to your site via FTP as mentioned in the [[ColdFusion_Builder|ColdFusion Builder]] wiki.

However, because RDS is disabled on our shared servers as mentioned above, you may not use ColdFusion's Remote Development Services with our shared servers. Instead, please either use the ColdFusion server shipped with ColdFusion Builder, a separate local ColdFusion installation, or one of our VPS/Dedicated servers to take advantage of advanced development features within ColdFusion Builder.

==Do you support Custom Tags with your ColdFusion Hosting?==
We do support custom tags, but not all .cfx custom tags, which may require additional server installs of .dll's, etc. If it is a commercially available tag, we'll consider installing it.

Standard .cfm custom tags, yes.

Custom Tag directories for your site can be created through the site's Application.cfc file as shown in the [[ColdFusion_Tips_%26_Tricks#Per-Application_Custom_Tag_Paths|ColdFusion Tips & Tricks]] wiki.
==Do you support the tags CFFILE, CFDIRECTORY and CFOBJECT?==
Yes, these are supported.
==Do you Support CFSchedule for Scheduled Tasks in Coldfusion?==
Yes, ColdFusion Scheduled Tasks are supported.

To setup a schedule task in ColdFusion, you can use the CFSCHEDULE tag to create the scheduled task the first time. The [[ColdFusion_Tips_%26_Tricks#Scheduling_Tasks_in_ColdFusion|ColdFusion Tips & Tricks]] wiki shows how to use the CFSCHEDULE tag.

==Do you support the CFX_IMAGE tag?==
No, this tag is not supported. Instead you may use the built-in [https://wikidocs.adobe.com/wiki/display/coldfusionen/cfimage cfimage] tag, [http://www.kolumbus.fi/jukka.manner/cfx_openimage/ cfx_openimage], or Efflaire's [http://efflare.com/docs/CFX_ImageCR3/reference/index.html cfx_imagecr3].

==How do I use the CFX_ImageCR3 tag?==
This article from Efflaire shows examples of how to use the CFX_ImageCR3 custom tag: https://web.archive.org/web/20150501054920/http://efflare.com/docs/CFX_ImageCR3/reference/examples/

The full tag documentation is here: https://web.archive.org/web/20150501054920/http://efflare.com/docs/CFX_ImageCR3/

==Do you support the CFX_Google API for ColdFusion?==
Yes, we support CFX_Google on our ColdFusion servers.

''Note: This tag was written for Google's deprecated version 2 API. If you do not have a version 2 API key you can still obtain a console key that works with version 2. Information on getting a Console Key can be found here: [https://developers.google.com/maps/documentation/javascript/tutorial#api_key Google: Obtaining an API Key]''
==Do you support the CFCONTENT tag?==
Yes, we support CFCONTENT.
==Do you support CF Shopkart?==
Yes, we support CF Shopkart on our coldfusion servers.
==Do you support Flash Remoting?==
Yes, this is automatically enabled for all sites on our ColdFusion servers.

Please use <nowiki>http://domainname.com/flex2gateway/</nowiki> or <nowiki>http://domainname.com/flashservices/gateway/</nowiki> as the gateway URL for your application. ''(replacing domainname.com with your actual domain)''

==Do your ColdFusion servers support Verity and SOLR?==
Yes, both Verity (K2) and SOLR are supported on ColdFusion versions 7-9. Verity is not available in ColdFusion 10.

==Are any ColdFusion tags/features restricted? What tags/features are allowed?==
Most tags and functions are allowed, however we disable the following ColdFusion features / tags on our shared hosting accounts:

*Access To Internal ColdFusion Java Components*
*Remote Development Services (RDS)
*CFExecute
*CFRegistry

All other tags are supported, including ''CreateObject()''. The only restriction on ''CreateObject'' is that it may not be used with Internal ColdFusion Java Objects as mentioned above. If you are experiencing any difficulty with another ColdFusion tag or feature, please contact our customer support.

 
<nowiki>*</nowiki>''Prevents CFML code from accessing and creating Java objects that are part of the internal ColdFusion implementation. This prevents a non-authenticated CFML template from reading or modifying administration and configuration information for this server. [http://www.adobe.com/products/coldfusion-family.html Adobe] suggests these tags be disabled for production servers.''

==May I Access the ColdFusion Administrator on my Shared Server==
No; we do not allow access to the ColdFusion Administrator on our shared servers. Our control panel allows our customers to add and edit DSNs, and the Windows Control Panel also allows you to view ColdFusion error logs.

With our Shared Railo plans, though, each account has access to their site's Railo Web Administrator through the link in their Control Panel.

==Do You Support .java or .jar files?==
No, we do not support .java or .jar files. The exception is with ColdFusion 10+ you may add .jar files to your application as shown here: [[ColdFusion_Tips_%26_Tricks#Loading_custom_Java_library_or_Java_Libraries_.28jar_or_class_files.29_in_ColdFusion_10|Loading Custom Java Libraries in ColdFusion 10]]

==Can I use CFExecute?==
No, that tag is disabled.
==Is the CFMAIL tag enabled?==
Yes, the CFMAIL tag is enabled on all of our ColdFusion servers. See the [[Cfmail|cfmail]] wiki for details on how to use it in our environment.
==Is CFX_JpegResize allowed on your ColdFusion servers?==
Yes, this is installed and allowed on our 32-bit ColdFusion servers.

==Will you deploy my (CAR) file from the Coldfusion Administrator?==
We will not deploy it that way, as that is a default method that wouldn't benefit you on our shared servers. Instead, please deploy your application through FTP and create the datasource (DSN) through your control panel at wcp.hostek.com. Please see the [[WCP_(Windows_based_Control_Panel)#DataSources.28DSN.27s.29|WCP DataSources]] wiki for instructions on how to create a datasource.

''Note'': If you have a VPS or Dedicated server at Hostek.com, you can deploy your application how you wish. Please see our [http://hostek.com/hosting/vps/best-vps-hosting.asp VPS Plans] page for more info on our VPS options, and our [http://hostek.com/hosting/dedicated/virtual-dedicated-hosting.asp Virtual Dedicated Plans] page for details on our virtual dedicated servers.

==Can I use J2EE Session Variables?==
Yes, we are now supporting J2EE Session Variables.

==With ColdFusion, how can I see the real error, while the visitor sees a page without the error?==
In this example error template, be sure to replace 123.123.123.123 with your IP. You can get your IP using our [http://hostek.com/ip/ IP lookup tool].
<pre style="white-space: pre-wrap"
<cfset aIP = cgi.REMOTE_ADDR>

<cfif aIP is "123.123.123.123">

<cfoutput>
 
#error.Diagnostics#
 
 
#TimeFormat(error.DateTime,"hh:mm tt")# - #DateFormat(error.DateTime,"MMMM
D, YYYY")#
 
 
#error.Browser#
 
IP ADDRESS:
#error.RemoteAddress#
 
TEMPLATE: #error.Template#?#error.QueryString#
 
#error.ValidationHeader#
 
#error.InvalidFields#
 
#error.ValidationFooter#
</cfoutput>
<cfelse>
Enter any text or formatting here that you want to display to your visitor instead of
them seeing the error.
</cfif>
</pre>

==How do I get Google Maps to work with CFMAP?==
The common problem is placing your googlemapkey in your application.cfm file. Instead, place the googlemapkey in an application.cfc file. You can leave your application.cfm as it is, and just create an application.cfc if you don't have one, and take the googlemapkey out of your application.cfm file and place it in your application.cfc file.

For example, this would go in your application.cfc file:
<pre><cfset this.googlemapkey="abc123...your google key here...789xyz"></pre>

Then in your cfm template where the cfmap is called, you would add code to it like:
<pre><cfmap name="themap" centeraddress="Tulsa, OK" width="400" height="400" zoomlevel="9"></pre>
==How do I enable the CFCHART tag?==
This is already enabled on all new accounts, but if CFCHART does not work on your site please do the following:
*Create a folder named CFIDE off of the root level.
*Create a blank file (0 bytes) named GraphData.cfm
*Create a directory called main off of CFIDE
*Navigate to the new directory at CFIDE/main
*Create a blank file (0 bytes) named ide.cfm

The CFCHART tag should now work.

==How do I enable / disable Robust Exception Information on my site?==
This can be accomplished through the code shown in this wiki: [[ColdFusion_Tips_%26_Tricks#Per-application_Robust_Exception_Information_Settings|Per-application Robust Exception Information Settings]]

==Is Coldfusion Request Debug Output Available?==
On our shared servers this is not allowed, because this feature can have a negative performance impact for the entire server. This is only allowed in our VPS/Dedicated environment.

==How do I adjust the JSON Prefix for my site==
If you wish to control ColdFusion JSON Prefix settings for your site, you can follow the guide here: [[ColdFusion_Tips_%26_Tricks#Per-application_JSON_Prefix|Per-Application ColdFusion JSON Prefix]]

==What do I set as the "Destination" attribute for cffile?==
For the "Destination" attribute, you should use the FULL path to the folder to which you wish the documents to be uploaded. You can make use of the [http://help.adobe.com/en_US/ColdFusion/10.0/CFMLRef/WSc3ff6d0ea77859461172e0811cbec22c24-7c67.html expandpath] function to obtain the full path dynamically.
==How can I limit the tools available using the cftextarea FCKEditor toolbar?==
There are two variations of the toolbar which can be specified in the <cftextarea> tag. If the '''toolbar''' attribute is un-specified, the toolbar set is "Default". If specified, you can use either "Default" or "Basic" this is case sensitive. See the tag options here for more information: [http://help.adobe.com/en_US/ColdFusion/10.0/CFMLRef/WSc3ff6d0ea77859461172e0811cbec22c24-7afd.html cftextarea docs]

The [http://help.adobe.com/en_US/ColdFusion/10.0/Developing/WSc3ff6d0ea77859461172e0811cbec22c24-7a01.html#WSc3ff6d0ea77859461172e0811cbec22c24-6f1b Using the rich text editor] article from Adobe has more info on its usage.

==How do I install Mura (previously known as Sava) CMS on your servers?==
If your account uses our wcp.hostek.com control panel, you can install Mura through the Applications section of the control panel.

If your account is on Linux, or you prefer to perform a manual installation you can follow the steps below:

===Requirements===
*Must have a Coldfusion or Railo hosting plan. Blue River (the makers of Mura) recommend the Silver plan.

===Installation===
#Put the contents of "mura[version]\www" directory into your webroot, (should be ''wwwroot'' on Windows and ''public_html'' on Linux). This includes the following directories and files: admin, config, default, fckeditor, requirements, tasks, Application.cfc, contentServer.cfm, index.cfm.
#Create a database (MySQL or MSSQL) using Helm either MS SQL or MySQL named "SomethingUnique_muraDB" and run then import/run the appropriate script (found in /db) against the database you created. For MySQL use PHPMyAdmin (Available in WCP and cPanel.) For MSSQL use Query Analyzer, SQL Management Studio or sqlcmd.
#Create a Datasource (DSN) for connecting to the database you created in the step above.
#Navigate to your domain name, and you should see the auto-installer form appear. ''Note: The email settings are not required to get mura up and running but you may get errors when running mura if they are not set. These, of course, pertain only to functionality that uses email.''
#In your browser go to http://[domain]/admin/ and login. - Username: admin - Password: admin
#You're done installing mura. Enjoy!

===Troubleshooting===
If you receive the message "Application Starting. This site is currently loading.", mura needs to be reloaded by appending "?appreload&override" to the url. For example: <pre>http://[domain]/admin/index.cfm?appreload&override</pre>

If you have any questions regarding installation, please visit our Support Forum at the [http://http://getmura.com/forum/ Mura Forum].

Mura can be downloaded at: [http://getmura.com/download/mura-downloads/ getmura.com]

==How can I disable ScriptProtect?==
ColdFusion versions MX7 and higher support a feature called ScriptProtect which helps prevent XSS (cross site scripting) attacks. This feature is helpful as it strips certain HTML entities from user input, but it can also affect your Web app's functionality. A common example of this is "<embed>" tags being removed when a user tries to post a YouTube video to their blog.

This feature is enabled on our servers, but its value can be modified in your "Application.cfc" or "Application.cfm" file.
===If Using Application.cfm===
Add the following attribute to your '''<cfapplication>''' tag:
<pre>
scriptProtect = "none"
</pre>
===If Using Application.cfc===
Place the following code within the '''<cfcomponent>''' section of your Application.cfc
====If using tag-based Application.cfc====
<pre>
<cfset this.scriptProtect = "false">
</pre>
====If using <cfscript> Application.cfc====
<pre>this.scriptProtect = "false"</pre>
==Settings you should enable within your local ColdFusion Administrator==
When developing on a local ColdFusion server, most developers accept the default Coldfusion Administrator settings that are set by the ColdFusion installer. This is fine for development servers, but it can cause some problems when moving a ColdFusion application into production in a shared hosting enviroment. To ensure your code runs well when you move it to our servers, we recommend you make the following adjustments within your local ColdFusion Administrator:

First, on the Settings page make sure you enable the setting that says: "Disable access to internal ColdFusion Java components" (pictured below)

[[File:Cfadminsettings1.jpg]]

Second, under the Security Tab click the Sandbox Security link then click the box to "Enable ColdFusion Security". (pictured below)

[[File:Cfadminsettings2.jpg]]

Once Sandbox Security is enabled, you'll need to create a sandbox for your local site. To do this, add the full path to your site below where it says "Add Security Sandbox", then click "Add". For example if you are using the default site location for IIS, you would use 'C:\inetpub\wwwroot' as shown below:

[[File:Cfadminsettings4.jpg]]

The last thing to do is add the correct paths and permissions. By default, ColdFusion will add the path to your site, but you'll also want to make sure the following paths/permissions are added too (permissions are listed in parentheses next to path):

C:\ColdFusion10\cache\- (Read,Write,Delete)
C:\WINDOWS\Fonts\- (Read)
C:\ColdFusion10\cfusion\wwwroot\WEB-INF\cfclasses\- (Read,Write)
C:\ColdFusion10\cfusion\wwwroot\WEB-INF\cftags\interface.cfc (Read)
C:\ColdFusion10\cfusion\tmpCache (Read)
C:\ColdFusion10\cfusion\tmpCache\- (Read,Write,Delete)
C:\ColdFusion10\cfusion\runtime\servers\coldfusion\SERVER-INF\temp\wwwroot-tmp\- (Read,Write,Delete)
C:\ColdFusion10\cfusion\runtime\servers\coldfusion\SERVER-INF\temp\wwwroot-tmp (Read)
C:\ColdFusion10\cfusion\tmpCache\CFFileServlet\_cf_image\- (Read,Write,Delete)
C:\Users\USERNAME\AppData\Local\Temp\- (Read,Write,Delete)*

Please note, this assumes you're using a recent version of Windows (Vista or newer), and that ColdFusion is installed to 'C:\ColdFusion10'. If on an earlier version of Windows, the only thing you'll do differently is replace 'C:\Users\USERNAME\AppData\Local\Temp\-'* above with this path: 'C:\DOCUME~1\USERNAME\LOCALS~1\Temp\-'*

*Replace USERNAME with the actual name of your ColdFusion runtime user.

==How do I disable / enable Sandbox Security on my ColdFusion VPS?==
Sandbox Security is great for development or multi-site servers, but it causes ColdFusion requests to run a bit slower than they normally would. If you’re not actively using this security feature, you can disable it within the '''Security > Sandbox Security''' page within your server’s ''ColdFusion Administrator''.

''Important'': You must restart ColdFusion after disabling or enabling Sandbox Security for it to take effect.

[[File:Cfadminsettings2.jpg]]

''Reference: [https://wikidocs.adobe.com/wiki/display/coldfusionen/Administering+ColdFusion+Security#AdministeringColdFusionSecurity-Usingsandboxsecurity Adobe - Using Sandbox Security]''
==Using ColdFusion Builder to Syncronize Files via FTP==
===Creating the FTP connection===
Open ColdFusion Builder
#From the left lower panel right-click on the world icon labeled '''FTP'''
#Select '''Add New FTP Site'''
#Enter the ''Server'', ''Username'', and ''Password'', click '''Test''' to confirm settings are correct
#Enter the ''Remote Path'', this can either be the root '''/''' or the webroot (either '''/wwwroot''' for Windows servers or '''/public_html''' for Linux servers)
#Click '''OK'''

===To configure a project to Synchronize===
#Right click on any project you wish to synchronize with over FTP. Hover over ''Synchronize'' and select '''Create New Synchronize Connection'''
#Make sure the path for the local project files is correct. For '''Remote''' select the newly created FTP Connection.
#Click ''OK''

===To Synchronize Files: Remote-to-Local or Local-to-Remote===
#Right click on any project you wish to synchronize with over FTP.
#Hover over Synchronize and select '''Synchronize''' and follow the prompts to confirm which files should be synchronized.

===Notes About Using Advanced ColdFusion Builder Development Features===
In order to use advanced development features within ColdFusion Builder, it should be used with a ColdFusion server that has RDS (''Remote Development Services'') enabled. Our shared servers do not have this feature enabled because it poses a security risk within production servers. As such, it is recommended to either [https://wikidocs.adobe.com/wiki/display/coldfusionen/Installing+the+Server+Configuration install a local copy of ColdFusion] or use one of our [http://hostek.com/hosting/coldfusion/vps/coldfusion-vps-hosting.htm ColdFusion VPS plans] for your development. If you install a local development ColdFusion installation, be sure to enable RDS during the install process. If you're using a ColdFusion VPS, you can enable RDS within the '''Security > RDS''' section of your ColdFusion Administrator.

Once you have RDP enabled on a local development installation of ColdFusion or your own VPS, you can enable RDS support within ColdFusion Builder as shown here: [https://wikidocs.adobe.com/wiki/display/coldfusionen/Eclipse+RDS+Support ColdFusion Builder RDS Support]

''Note:'' If you wish to have your local development ColdFusion server match our shared server settings, read the above entry for [[ColdFusion_FAQs#Settings you should enable within your local ColdFusion Administrator|Settings you should enable within your local ColdFusion Administrator]].
[[Category:ColdFusion]]

Getting Started

2015-05-04T16:23:39Z

Kylet: Redirected page to Category:Getting Started

#REDIRECT [[:Category:Getting Started]]

Topics on how to get started with your Hostek.com hosting account.

MySQL Workbench

2015-03-16T22:26:19Z

Kylet:

File:Mysqlworkbenchimportmenu.png

2015-03-16T22:21:34Z

Kylet:

File:Mysqlworkbenchexportmenu.png

2015-03-16T22:21:14Z

Kylet:

File:Mysqlworkbenchdataimport.png

2015-03-16T22:20:57Z

Kylet:

File:Mysqlworkbenchdataexport.png

2015-03-16T22:20:32Z

Kylet:

MySQL Workbench

2015-03-16T21:47:54Z

Kylet: /* How do I connect to my database using MySQL Workbench? */

__FORCETOC__

==What is MySQL Workbench?==
MySQL Workbench is a unified visual tool for database architects, developers, and DBAs. MySQL Workbench provides data modeling, SQL development, and comprehensive administration tools for server configuration, user administration, and much more. MySQL Workbench is available on Windows, Linux and Mac OS.
==Where can I get MySQL Workbench?==
You can obtain a copy of MySQL Workbench here: [http://dev.mysql.com/downloads/workbench/5.2.html MySQL Workbench Download]

==How do I connect to my database using MySQL Workbench? ==
Before connecting connecting to your database using MySQL Workbench, you'll have to first get the host name or the IP address of the Hostek MySQL server your database is on.

=== Windows ===

#Login to your control panel
#Under Databases, Click on MySQL. [[File:Mysqlicon.png|350px]]
#You can find the host next to the database name. [[File:Mysqlscreen.png|350px]]

=== Linux ===

You should be able to use your domain name as the host. However in order to connect externally to your database with programs such as MySQL workbench you'll need to enable remote MySQL access to your database.

Depending on your cPanel theme, the location and text may be different. The screenshots below are from the themes x3 and paper lantern.

#Login to your cPanel
#Under Databases go to Remote MySQL. [[File:Mysqlcpanelicon.png|350px|x3 Theme]] [[File:Mysqlcpanelicon_paper.png|350px|Paper Lantern Theme]]
#If you have a specific static IP you want to grant remote access to, you can enter it here and click on "Add Host". Otherwise you can grant remote access from any IP by entering % as the host and click on Add Host. [[File:Mysqlremoteaccess.png|350px|x3 Theme]] [[File:Mysqlremoteaccess_paper.png|350px|Paper Lantern Theme]]

=== Configuring MySQL Workbench ===

# Open MySQL Workbench on your local machine
# Click on the (+) icon [[File:Mysqlworkbench.png|350px]]
# Fill in the connection details and you can optionally store your password in the vault. [[File:Mysqlworkbenchlogin.png|350px]]

==How to use MySQL Workbench to backup your MySQL database==
Once you have installed MySQL Workbench launch it and under the "Server Administration" click on "New Server Instance". This will pull up a new Instance wizard.

Under the "Specify the Host Machine the Database Server is running on" click on "Remote Host" and for the address put an IP of the server that your database is on.

Under the "Set the Database Connection values" screen you can leave "Connection Name" the same as the server IP or change it to something more meaningful like "My wordpress database server". Leave "Connection Method" as "Standard (TCP/IP)". Under the "Parameters" tab make sure that hostname matches the IP from the previous step. Leave port as "3306" and enter your database username. Click on "Store in Vault" and enter the password for the above user. Leave "Default Schema" empty".

Testing the connection should give you three check marks and show "Database connection tested successfully." Click on "Next".

On "Set remote configuration parameters" UNCHECK "Enable SSH login based administration" and click on "Next".

Under "Create the Instance Profile" you can use something like "My backup" and click "Finish".

After the steps above your "Workbench Central" should now have new connection listed under the "Server Administration" on the right. Click on "Manage Import / Export" link and then from the pop-up window click the instance you created earlier.

Under the "Export to Disk" tab place a check-mark next to your database name. Under "Options" to the right check "Export to Self-Contained File" and click on "Start Export".

==How to use MySQL Workbench to Restore your MySQL database==
Once you have installed MySQL Workbench launch it and under the "Server Administration" click on "New Server Instance". This will pull up a new Instance wizard.

Under the "Specify the Host Machine the Database Server is running on" click on "Remote Host" and for the address put an IP of the server that your database is on.

Under the "Set the Database Connection values" screen you can leave "Connection Name" the same as the server IP or change it to something more meaningful like "My wordpress database server". Leave "Connection Method" as "Standard (TCP/IP)". Under the "Parameters" tab make sure that hostname matches the IP from the previous step. Leave port as "3306" and enter your database username. Click on "Store in Vault" and enter the password for the above user. Leave "Default Schema" empty".

Testing the connection should give you three check marks and show "Database connection tested successfully." Click on "Next".

On "Set remote configuration parameters" UNCHECK "Enable SSH login based administration" and click on "Next".

Under "Create the Instance Profile" you can use something like "My backup" and click "Finish".

After the steps above your "Workbench Central" should now have new connection listed under the "Server Administration" on the right. Click on "Manage Import / Export" link and then from the pop-up window click the instance you created earlier. You may need to enter your database password.

You will select "Import from Dump Project Folder" and you can select the location through the "Folder Path" field. You will then click on the Load Folder Contents Button

Click on the Start Import button, you may be asked for the database password again. The length of time it takes for the import depends on the size of the backup of your database.

[[Category:Databases-MySQL]]

MySQL Workbench

2015-03-16T19:07:17Z

Kylet: /* How do I connect to my database using MySQL Workbench? */

__FORCETOC__

==What is MySQL Workbench?==
MySQL Workbench is a unified visual tool for database architects, developers, and DBAs. MySQL Workbench provides data modeling, SQL development, and comprehensive administration tools for server configuration, user administration, and much more. MySQL Workbench is available on Windows, Linux and Mac OS.
==Where can I get MySQL Workbench?==
You can obtain a copy of MySQL Workbench here: [http://dev.mysql.com/downloads/workbench/5.2.html MySQL Workbench Download]

==How do I connect to my database using MySQL Workbench? ==
Before connecting connecting to your database using MySQL Workbench, you'll have to first get the host name or the IP address of the Hostek MySQL server your database is on.

=== Windows ===

#Login to your control panel
#Under Databases, Click on MySQL. [[File:Mysqlicon.png|350px]]
#You can find the host next to the database name. [[File:Mysqlscreen.png|350px]]

=== Linux ===

You should be able to use your domain name as the host. However in order to connect externally to your database with programs such as MySQL workbench you'll need to enable remote MySQL access to your database.

Depending on your cPanel theme, the location and text may be different. The screenshots below are from the themes x3 and paper lantern.

#Login to your cPanel
#Under Databases go to Remote MySQL. [[File:Mysqlcpanelicon.png|350px|x3 Theme]] [[File:Mysqlcpanelicon_paper.png|350px|Paper Lantern Theme]]
#If you have a specific static IP you want to grant remote access to, you can enter it here and click on "Add Host". Otherwise you can grant remote access from any IP by entering % as the host and click on Add Host. [[File:Mysqlremoteaccess.png|350px|x3 Theme]] [[File:Mysqlremoteaccess_paper.png|350px|Paper Lantern Theme]]

==How to use MySQL Workbench to backup your MySQL database==
Once you have installed MySQL Workbench launch it and under the "Server Administration" click on "New Server Instance". This will pull up a new Instance wizard.

Under the "Specify the Host Machine the Database Server is running on" click on "Remote Host" and for the address put an IP of the server that your database is on.

Under the "Set the Database Connection values" screen you can leave "Connection Name" the same as the server IP or change it to something more meaningful like "My wordpress database server". Leave "Connection Method" as "Standard (TCP/IP)". Under the "Parameters" tab make sure that hostname matches the IP from the previous step. Leave port as "3306" and enter your database username. Click on "Store in Vault" and enter the password for the above user. Leave "Default Schema" empty".

Testing the connection should give you three check marks and show "Database connection tested successfully." Click on "Next".

On "Set remote configuration parameters" UNCHECK "Enable SSH login based administration" and click on "Next".

Under "Create the Instance Profile" you can use something like "My backup" and click "Finish".

After the steps above your "Workbench Central" should now have new connection listed under the "Server Administration" on the right. Click on "Manage Import / Export" link and then from the pop-up window click the instance you created earlier.

Under the "Export to Disk" tab place a check-mark next to your database name. Under "Options" to the right check "Export to Self-Contained File" and click on "Start Export".

==How to use MySQL Workbench to Restore your MySQL database==
Once you have installed MySQL Workbench launch it and under the "Server Administration" click on "New Server Instance". This will pull up a new Instance wizard.

Under the "Specify the Host Machine the Database Server is running on" click on "Remote Host" and for the address put an IP of the server that your database is on.

Under the "Set the Database Connection values" screen you can leave "Connection Name" the same as the server IP or change it to something more meaningful like "My wordpress database server". Leave "Connection Method" as "Standard (TCP/IP)". Under the "Parameters" tab make sure that hostname matches the IP from the previous step. Leave port as "3306" and enter your database username. Click on "Store in Vault" and enter the password for the above user. Leave "Default Schema" empty".

Testing the connection should give you three check marks and show "Database connection tested successfully." Click on "Next".

On "Set remote configuration parameters" UNCHECK "Enable SSH login based administration" and click on "Next".

Under "Create the Instance Profile" you can use something like "My backup" and click "Finish".

After the steps above your "Workbench Central" should now have new connection listed under the "Server Administration" on the right. Click on "Manage Import / Export" link and then from the pop-up window click the instance you created earlier. You may need to enter your database password.

You will select "Import from Dump Project Folder" and you can select the location through the "Folder Path" field. You will then click on the Load Folder Contents Button

Click on the Start Import button, you may be asked for the database password again. The length of time it takes for the import depends on the size of the backup of your database.

[[Category:Databases-MySQL]]

File:Mysqlremoteaccess paper.png

2015-03-16T17:44:47Z

Kylet:

File:Mysqlremoteaccess.png

2015-03-16T17:44:28Z

Kylet:

File:Mysqlcpanelicon paper.png

2015-03-16T17:44:04Z

Kylet:

File:Mysqlcpanelicon.png

2015-03-16T17:43:49Z

Kylet:

MySQL Workbench

2015-03-16T15:50:53Z

Kylet: /* How do I connect to my database using MySQL Workbench? */

__FORCETOC__

==What is MySQL Workbench?==
MySQL Workbench is a unified visual tool for database architects, developers, and DBAs. MySQL Workbench provides data modeling, SQL development, and comprehensive administration tools for server configuration, user administration, and much more. MySQL Workbench is available on Windows, Linux and Mac OS.
==Where can I get MySQL Workbench?==
You can obtain a copy of MySQL Workbench here: [http://dev.mysql.com/downloads/workbench/5.2.html MySQL Workbench Download]

==How do I connect to my database using MySQL Workbench? ==
Before connecting connecting to your database using MySQL Workbench, you'll have to first get the host name or the IP address of the Hostek MySQL server your database is on.

=== Windows ===

#Login to your control panel
#Under Databases, Click on MySQL. [[File:Mysqlicon.png|350px]]
#You can find the host next to the database name. [[File:Mysqlscreen.png|350px]]

=== Linux ===

You should be able to use your domain name as the host. However in order to connect externally to your database with programs such as MySQL workbench you'll need to enable remote MySQL access to your database.
#Login to your cPanel
#Under Databases go to Remote MySQL. If you have a specific static IP you want to grant remote access to, you can enter it here and click on "Add Host". Otherwise you can grant remote access from any IP by entering % as the host and click on Add Host.

==How to use MySQL Workbench to backup your MySQL database==
Once you have installed MySQL Workbench launch it and under the "Server Administration" click on "New Server Instance". This will pull up a new Instance wizard.

Under the "Specify the Host Machine the Database Server is running on" click on "Remote Host" and for the address put an IP of the server that your database is on.

Under the "Set the Database Connection values" screen you can leave "Connection Name" the same as the server IP or change it to something more meaningful like "My wordpress database server". Leave "Connection Method" as "Standard (TCP/IP)". Under the "Parameters" tab make sure that hostname matches the IP from the previous step. Leave port as "3306" and enter your database username. Click on "Store in Vault" and enter the password for the above user. Leave "Default Schema" empty".

Testing the connection should give you three check marks and show "Database connection tested successfully." Click on "Next".

On "Set remote configuration parameters" UNCHECK "Enable SSH login based administration" and click on "Next".

Under "Create the Instance Profile" you can use something like "My backup" and click "Finish".

After the steps above your "Workbench Central" should now have new connection listed under the "Server Administration" on the right. Click on "Manage Import / Export" link and then from the pop-up window click the instance you created earlier.

Under the "Export to Disk" tab place a check-mark next to your database name. Under "Options" to the right check "Export to Self-Contained File" and click on "Start Export".

==How to use MySQL Workbench to Restore your MySQL database==
Once you have installed MySQL Workbench launch it and under the "Server Administration" click on "New Server Instance". This will pull up a new Instance wizard.

Under the "Specify the Host Machine the Database Server is running on" click on "Remote Host" and for the address put an IP of the server that your database is on.

Under the "Set the Database Connection values" screen you can leave "Connection Name" the same as the server IP or change it to something more meaningful like "My wordpress database server". Leave "Connection Method" as "Standard (TCP/IP)". Under the "Parameters" tab make sure that hostname matches the IP from the previous step. Leave port as "3306" and enter your database username. Click on "Store in Vault" and enter the password for the above user. Leave "Default Schema" empty".

Testing the connection should give you three check marks and show "Database connection tested successfully." Click on "Next".

On "Set remote configuration parameters" UNCHECK "Enable SSH login based administration" and click on "Next".

Under "Create the Instance Profile" you can use something like "My backup" and click "Finish".

After the steps above your "Workbench Central" should now have new connection listed under the "Server Administration" on the right. Click on "Manage Import / Export" link and then from the pop-up window click the instance you created earlier. You may need to enter your database password.

You will select "Import from Dump Project Folder" and you can select the location through the "Folder Path" field. You will then click on the Load Folder Contents Button

Click on the Start Import button, you may be asked for the database password again. The length of time it takes for the import depends on the size of the backup of your database.

[[Category:Databases-MySQL]]

File:Mysqlscreen.png

2015-03-16T15:23:52Z

Kylet: Kylet uploaded a new version of "File:Mysqlscreen.png"

File:Mysqlscreen.png

2015-03-16T15:23:01Z

Kylet: Kylet uploaded a new version of "File:Mysqlscreen.png"

File:Mysqlworkbenchlogin.png

2015-03-16T15:17:36Z

Kylet:

File:Mysqlworkbench.png

2015-03-16T15:17:15Z

Kylet:

File:Mysqlscreen.png

2015-03-16T15:16:46Z

Kylet:

File:Mysqlicon.png

2015-03-16T15:16:19Z

Kylet: