=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?==
Yes, the CFX_Image tag is supported on our 32-bit ColdFusion servers. Efflaire's [http://efflare.com/docs/CFX_ImageCR3/reference/index.html cfx_imagecr3] is also installed, and it is available to both 32-bit ''and'' 64-bit servers.

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

The full tag documentation is here: 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]]

WCP (Windows based Control Panel)

2015-05-12T19:38:26Z

Jakeh: /* Add Domain */

==How To Login To My WCP Control Panel==
#To manage your domain, login to the WCP Control Panel, using the details below
#URL: '''https://wcp.hostek.com'''/
#Username:
#Password: ** same as your cp.hostek.com password **
*You can also login to the control panel through your billing control panel https://cp.hostek.com/clientarea.php
#Click on ''''My Services'''' 'Click the '''small Green arrow''' on the the notepad to the right'
#Now click the '''Login to Control Panel''' Icon'''

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Custom URL for the WCP Control Panel==
The WCP can als be accessed by wcp.your_domain.com

Setup wcp.your_domain.com as an A record for "184.175.108.65" or as a CName record for "wcp.ezhostingserver.com".

===Resellers and VPS - WCP White label Settings===
Resellers and VPS customers can setup their logo in their Reseller control panel, however those additional features will only be available when accessing the control panel using the specific domain they configured within the Reseller Setttings of the control panel. The Reseller settings will be available using '''any''' URL, and as mentioned within these settings the reseller '''URL''' can be setup and other whitelabel options (custom control panel logo, favicon, etc.) making WCP the ultimate Windows Control Panel.

[[Category: Windows VPS]]
[[Category:Resellers]]

==Adding Additional Control Panel Logins==
*This will allow you to set up additional control panel logins for you or for others involved in editing or managing your account. You can limit the Permissions or options available for them to manage.
#Login to the WCP Control Panel, using the details below
#URL: '''https://wcp.hostek.com'''/
#Username:
#Password: ** same as your cp.hostek.com password **
#Click on the '''Control panel Logins''' tab, then click on the '''Add''' icon.
#Put the "Username, Password and if you want them to have Limited Permission.
#If you want them to have Limited Permission then check the '''Limited Permission''' box. This will load a dropdown where you can select what privlages they have to manage.
#Once you are done click the '''Save''' icon at the bottom of the screen.
#Once it has been added you or they can login by going to https://wcp.hostek.com/Login.aspx and using the username and password that you set for it.
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:Lucee]]
==Unlimited Plans - Add Additional Domains==
You will want to follow these steps in to generate a +1 Control Panel for a separate Domain. (Please note the difference between Registration and Hosting: [https://wiki.hostek.com/Domain_Registration_and_Domain_Name_Management#Domain_Registration_Information_vs._Domain_Hosting_Information '''here''')] This would be under your Windows Unlimited account, or your Windows Business/Pro plan.

#Login to your WCP control panel
#*Windows Unlimited: For adding a third (or more) domain select any domain from the upper right hand corner dropdown box "Domains".
#Within the "Domains" box click the "Addon Domains" icon.
#Click "Add" and enter the following:
#*Domain Name
#*Username
#*Password
#Click "Save"
#To manage the domain, you can now select it from the '''Domains''' drop-down list/box.
[[Category:Windows]]

==Site Details==
We recommend you review the "Site Settings" which includes many important details about your domain including:

WCP (login and select domain) > Website Settings > '''Site Details'''

*Testing URL
*Primary and Secondary DNS
*Site IP
*Web Root Path
*FTP Root Path
===IIS Version & ColdFusion Version (if applicable)===
To get your domain's IIS Version and ColdFusion Version (if applicable) log in to WCP and under the Settings section, click on the Site Details option.

==FTP Accounts==
*Adding or editing FTP accounts.
#click on the '''FTP Accounts''' tab.
#To edit one click on the little '''Pencil Icon''' to the left, to add one click on the '''Add FTP User''' tab.
#If you are adding one you will set the Username:, Password: and folder then click the #Click on the '''Save''' Icon.

==Virtual Directories==
*Adding virtual directories to your site.
#Log in to WCP
#Click on Virtual Directories under the Files section
#Click Add
#Enter the virtual path you need
#Enter in the actual physical path it is mapped to
#If this is to be an application, check the Create Application Folder check box
#Click Save

==Application Folders==
To create and manage Application Folders on your site
#Log in to WCP
#Click on Application Folders under the Files section
#Select the site or sub-domain from the drop down box
#Click continue
#Select a folder
#Click Add Application to make it an application folder

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==File Manager==
*Basic File Operations, file uploading and editing now supported- Zip, GZip, and Tar Archive support.
#Click on the '''File Manager icon''', then the '''Login icon''' on the next screen.
#To create files or Directory's outside the WWW root folder right click and click on the '''Create File''' or '''Create Directory''' option.
#Click the '''Continue Icon''' to add this.
#To add/edit files in the WWWroot click on the '''wwwroot file'''.
#once you are in you can add, edit or delete by right clicking and clicking on the options given.

*Upload and Download functions
#To upload a file, right click the File Manager page, and click Upload
#Select the file you wish to upload by clicking Choose File
#Give this file a new name or keep the existing default name

#To download a file, right click the file you want to download
#Click Download File. Note: This will send you to a new page.
#Now your browser will be downloading the file in question. Simply check your Downloads folder or hit Ctrl+J to open the Downloads section of your browser and move this file where you want it.

*NEW: Use the search bar at the top of the File Manager to quickly search the file you're looking for.
[[Category:ColdFusion]]
[[Category:Windows]]

==Password Protect Folders==
#Under the Files section click on '''Password Protect'''.
#Click on '''Manage Protected Folders'''.
#Browse to and click on the folder that you want to set this up on and check '''Enable Protection'''.
#Select a user from the list or click on '''Manage Users''', then click '''Add''', and enter username and password then Save.

==IIS Settings==
*Setting up error pages, default pages, advanced settings, etc.
===Custom Error pages===
#Click on '''IIS Settings''' in your WCP
#Click the edit button next to the error page you want to change
#Uncheck the '''Use System Default''' checkbox
#Enter the path to your custom error page
#Click '''Save'''
===Mime Types===
#Click on '''IIS Settings''' in your WCP
#Scroll to the bottom of the window and click '''Add Mime Type'''
#Enter the extension for the Mime Type
#Enter the Mime Type information
#Click '''Save'''
*An example Mime Type is below:
<pre>
Extension: .mp3
Mime Type: audio/mpeg
</pre>

More information here: [https://wiki.hostek.com/Mime_types Mime Types]

===Default Docs===
*Select a default document and drag it to the top position to set it as top priority
*Click '''Add''' to add a default doc
*Click the red '''X''' to delete a default doc
*Click a default doc and change the name
*For example: change '''"index.htm"''' to '''"index.asp"'''

===URL Forwarding===
#In your [https://wcp.hostek.com/ '''WCP'''] click on the '''IIS Settings''' button
#Navigate to the '''Redirects''' tab
# If you need a specific folder to redirect somewhere, you can find it using the '''Browse''' button
##If you simply want the whole site to redirect, leave this box '''blank'''
#Click '''Save'''. (See below for details on the other options.)
*'''Permanent Redirect''': Specifies that the server should return the redirect status code 301 rather than the default 302. A 301 status code lets search engines know that the content has been permanently moved and that only the new URL should be indexed.
*'''Exact URL''': If this is unchecked, then the request URL without the server name is passed along with the query string to the destination URL. This is equivelent to appending the $V$Q variables at the end of the destination URL.
*'''Exclude Sub Directories''': This means that the folder you choose will not redirect.

===Advanced===
====Recycle Application Pool====
If you see a Service Unavailable message on your site, or have a general need to recycle a site's IIS Application Pool, you can do so through this section of WCP.
#Click the '''IIS Settings''' icon in WCP
#Click the '''Advanced''' tab in the '''IIS Settings''' section
#Click the '''Recycle''' button.

==PHP Settings==
If you notice you need a different version of php or want to check what version you are using you can update it to that version if it is installed to the server or can enable custom php.ini settings to use specifically for your domain.
#Click the configuration for the domain or subdomain you want updated.
#Select the version you wish to use.
#Check the checkbox if you want to enable a custom php.ini file
#Click save to save the settings.

==ColdFusion==
===ColdFusion Error Logs===
====Server Error Logs====
This section will show any recent errors for your site that were found within ColdFusion's server-wide exception log. Use the dropdown to choose how many hours back you'd like errors retrieved.
====Application Error Logs====
This section will show errors created via the cflog tag on your site. For security purposes, your cflog logs will only appear hear if you have given the file name in the cflog tag the name of your domain, ''without the www.'' For example, if your domain is ''your_domain.com'' you would set the file attribute for the cflog tag like: ''file="your_domain.com"''.
 
''Note'': Please set the ''type'' of the ''cflog'' tag to either '''error''' or '''fatal''' on our production servers. Use of the ''information'' type is strongly discouraged.
 
'''Reference''': [https://wikidocs.adobe.com/wiki/display/coldfusionen/cflog CFLog Documentation]

===Clear Template Cache===
Within this section you can click the '''Clear Template Cache''' button to clear cached ColdFusion pages for your site.

===ColdFusion Version===
Within this section of WCP, you can choose which version of ColdFusion you'd like your site to use.

''Note'': You can also specify different ColdFusion versions for different subdomains on your site.
[[Category:ColdFusion]]
[[Category:Windows]]

==DNS Editor==
'''READ FIRST''' When a new domain is added to WCP all DNS records are also created (in most cases). Clicking on the DNS Editor will open a window with these records, for editing, adding and deleting. Most times nothing needs to be done other than pointing your domain to the Primary and Secondary DNS Servers listed under [https://wiki.hostek.com/WCP_(Windows_based_Control_Panel)#Site_Details WCP Site Details].

===Create a new DNS record===
#Click '''Add DNS''' Record button
#Enter Name for record (If DNS record name is your domain name please leave this Name - text box blank as the control panel will automatically add your domain name)
#Choose the Record type (A, CNAME, MX, NS, TXT, SPF, SRV)
#Enter Data Type
#Generally leave the TTL (Time To Live) as the default 86400
#Click on the '''Save''' Icon.

===Update DNS records===
#To update an existing DNS record click the '''Pencil''' icon next to the record you would like to update.
#You will then be able to change the Name of the record, the Type of record, Data of the record, and Time to Live.
#Once updated Click on the '''Save''' Icon.

===SVR Record Fields===
*A SVR Record is a "'''S'''er'''v'''ice '''R'''ecord". It's a specification of data in the Domain Name System defining the location (i.e. the hostname and port number) of servers for specified services.

<pre>
Name: _service._protocol
Type: SRV
Data: Address/Hostname
Priority: Priority Number
Weight: Weight Number
Port: Port Number
TTL: 86400
</pre>

Example:
<pre>
Name: _sip._udp
Type: SRV
Data: sip.mydomain.com
Priority: 10
Weight: 5
Port: 4030
TTL: 86400
</pre>

*If you are a '''VPS Client''' with a Windows Server and a SmarterMail Active Sync license wanting to use Autodiscover for Outlook, please refer to this SmarterMail Article [https://portal.smartertools.com/kb/a2752/set-up-autodiscover-for-smartermail.aspx here].

===MX Records===
Here are steps to setup the correct MX Records for our MailSystem:
*Note: These are setup by Default, and shouldn't need to be added unless changes were made.
#Go into the '''DNS Editor''' in WCP.
#Click '''Add Record'''.
#In the '''Record Name''' form put " '''mail''' ".
#Beside '''Type''' select '''A'''.
#Beside '''Data''' put the IP Address of your MailServer.
##You can find your MailServer by clicking the '''Site Details''' button in WCP.
##The IP Address can be found by PINGing the server, or by performing a WHOIS search.
#Once this is done click '''Save'''. Now you have an '''A Record''' labeled "mail.'''yourdomain'''.com".
#You'll want to click '''Add Record''' again.
#Leave the Record Name blank this time.
#Beside '''Type''' select '''MX'''.
#Beside '''Data''' put "mail.'''yourdomain'''.com".
#Once you click '''Save''', you will then have an '''MX Record''', which points to "mail.'''yourdomain'''.com".
*Congratulations! Now all you need to do is wait for DNS Propagation, which is the 2-to-12hr time period it takes for the internet to update with these new changes.

===SPF Records===
An SPF Record (simply an entry into the DNS records) is used by mail servers to know if mail coming from an address at your domain is really allowed to be sent from the sending mail server.

To have WCP create an SPF record for you, you can click '''SPF Record''' under the '''Email Section''' and then click the '''Create''' button, or you can use the steps below to create one manually.

If you will be using our servers send email related to your domain, you would generally use an SPF record like the following:<pre>"v=spf1 a mx include:spf.hostek.com -all"</pre>

For our Resellers that don't want to use hostek.com, use an SPF Record like:<pre>"v=spf1 a mx include:spf.ezhostingserver.com -all"</pre>
'''Steps to add an SPF Record to your domain:'''
Assuming that your DNS is managed with us:
#Log in to your hosting control panel at wcp.hostek.com
#Open the DNS Editor (DNS Manager) section
#Click on Add Record.
#Leave the Name field blank.
#For the Type, choose TXT
#For the Data enter the SPF Record detail as you need, using the sample provided above.

'''Basic information related to some SPF Record options:'''

The '''"-all"''' may be adjusted on a per customer basis to any of the following depending on their needs:

'''-all''' = mail not sent from an address listed in the SPF record should be completely rejected (Hard Fail). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

'''~all''' = mail not sent from an address listed in the SPF record should be given a higher spam score(Soft Fail). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

'''?all''' = mail not sent from an address listed in the SPF record should be treated normally as if the domain did not have an spf record (Neutral). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Sub Domains==
*A sub-domain is like an extension of your domain name. For example, if your domain name were myfamily.com, a sub-domain would be in the following form: dad.myfamily.com or mom.myfamily.com etc.
*You can have a sub-domain pointed to any folder within your web site. If a visitor goes directly to that sub-domain he will be taken to that folder, not to your site's main page.
#Click on the '''Sub Domains icon'''
#Click "'''Add'''" sub Domain button
#Enter sub domain name in Name text box. This will automatically populate the Folder text box to a folder with the same name as the subdomain.
#If you wish this Subdomain to point to a different folder you can click on the folder icon and choose the directory you would like your Sub Domain to point to.
#Click on the "'''Save'''" Icon.
#This will create the sub domain record within your domains DNS zone,
*If the domains name servers are not pointed to us you will need to manually create this record where your domains DNS is hosted.
[[Category:Control-Panels]]
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Domain Alias==
*This will allow you to point 2 domains to the same website. How to create a Domain
#To create a domain alias you will click on the ''Domain Aliases icon''
#Click '''Add Domain Alias''' button
#Enter your Alias Name
#Click on the "'''Save'''" Icon.
*You will need to be sure that your Domain Alias has been registered and has the name servers pointed to the name servers found beneath the Site Details icon.

==Applications==
# Some helpful video tutorials showing how to install a select few applications easily within the WCP Control Panel are below:

*Joomla - [http://hostek.com/tutorials/joomla_Installation_tutorial.html Installing Joomla Application]

*Wordpress - [http://hostek.com/tutorials/wordpress_Installation_tutorial.html Installing Wordpress Application]

*Mura - [http://hostek.com/tutorials/mura_Installation_tutorial.html Installing Mura Application]

*Magento - [http://hostek.com/tutorials/magento_Installation_tutorial.html Installing Magento Application]

*Oscommerce - [http://hostek.com/tutorials/oscommerce_Installation_tutorial.html Installing OsCommerce Application]

==Email==
*Below is information on how to manage your email account within the WCP.
*'''FOR VPS''' You will also have "Admin" access to SmarterMail. Access webmail (click the webmail link in WCP) and login with user "admin" and the primary VPS password.

==Email Users==
*Allows you to create Email users as well as log directly into users Webmail account
#Once you are logged into your WCP account, under the Email Section
#Click '''Users''' icon
#Click '''Add Email User''' button
#Enter email user name (Example: if you need the email address "admin@domain.com" enter the user "admin")
#Enter password for Email user (**See note below regarding password requirements)
#Enter Display name (Usually set to the name of the person using the specific email account)
#Choose if you would like this user to have administrator rights
#Choose mail box size limit for this specific user
#Click on the '''Save'''
#'''NOTE Password requirements'''
*Minimum Length 6 Characters
*Must include Uppercase
*Must include Lowercase
*Must include Number
*Must include Special character
*Password cannot match username

==Edit existing Email user==
#Once you are logged into your WCP account, under the Email Section
#Click '''Users''' icon
#Click '''pencil icon''' next to user to update
#Update information
#Click '''Save'''

==Web mail==
#Once you are logged into your WCP account, under the Email Section
#Click '''Login button''' next to user you would like access the mail for
*Web Mail Provides links to access the Webmail program as well as to access mail before domain propagation to our mail server
#Click '''Web Mail icon'''
#If domain is propagated and pointed to our mail server you can click the '''webmail''' link to access the SmarterMail webmail log in screen.
#If you domain has not yet propagated to our mail server click the "Pr-Propagation Web Mail" link to access the SmarterMail webmail log in screen.

==Mail Forwarding==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up an email alias.
#Click on the '''Forwarding button'''
#Enter Alias name
#Enter address for email to this Alias to be forwarded to
#Click on the '''Save Icon'''

==SPF Records==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up a SPF record
#Click on the '''Advanced''' button and then the '''SPF Record''' button
#Click the '''Create''' button

==Domain Keys==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up Domain Keys
#Click on the '''Advanced''' button and then the '''Domain Keys''' button
#Click '''Enable'''

==Mail Logs==
#Once you are logged into your WCP account, under the Email Section
#Click on the '''Advanced''' button and then the '''Mail Logs''' button
#Select an email account
#Select a date and log type
#Click on Search

==MySQL database==
*MySQL Allow you to create a MySQL database under your domain
#Click on '''MySQL icon'''
#To add new database click '''Add MySQL Database'''
#Enter Database Name
#Enter Username
#Enter Password
#(If you need a coldfusion DSN place check in check box and provide Coldfusion DSN name)
#Click '''Save'''

*To create new user for existing database
#Click '''MySQL icon'''
#Click '''Add new user button'''
#Enter Username
#Enter Password
#Place check mark in check box for each database you would like this user to have access to.
#To update the password on existing database user.
#Click '''MySQL icon'''
#Click '''pencil icon next to Username'''
#enter new password
#Click on the '''Save Icon'''.

*To update the password on existing database user.
#Click '''MySQL icon'''
#Click pencil '''icon next to Username'''
#Enter new password
#Click on the '''Save''' Icon.

==PhpMyAdmin==
*Allows you to log directly into your MySQL database to manage.
#Click on '''PhpMyAdmin link'''
#If you are not logged directly into your MySQL database simply enter the server your database is located on (Can be found by clicking the MySQL icon) and enter your Username and Password.
#Once logged in your Databases will be displayed on the Left, click on '''database name''' to manage that database.
*Here is a Video that will show how to create a MySQL database and how to Backup / Restore the database through PhpMyAdmin: [http://hostek.com/tutorials/managing_mysql.html PhpMyAdmin Backup and Restore Video]

==MSSQL==
===To create MSSQL databases and users===
#Click '''MSSQL icon'''
#To add a new database click '''Add MSSQL''' database
#Enter Database Name
#Choose database size
#Enter or Choose existing Username
#Enter Password
#Choose '''Default Collation''' (Usually left as default)
#Choose '''Recovery Model''' (Usually left as Simple as we make daily full backups of all #databases which we keep for 7 days)
#Place a Check mark in the box for Coldfusion DataSource if ColdFusion DSN is needed.
#Enter ColdFusion DSN name.
#Click on the '''Save''' Icon.

===To edit an existing MSSQL database===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Edit field necessary
#Click on the '''Save''' Icon.

===Changing the MSSQL Transaction Log (Recovery Model) Settings===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Click the dropdown menu next to '''Recovery Model''' and select either '''Full''' or '''Simple'''
#Click on the '''Save''' Icon.

===To edit password for existing MSSQL user===
#Click '''MSSQL icon'''
#Click '''Pencil next''' to user to edit
#Update password
#Click on the '''Save''' Icon.

===To add new MSSQL user===
#Click '''MSSQL icon'''
#Click '''Add MSSQL''' User button
#Enter username
#Enter password
#Place checkmark next to each database this users needs access to
#Click on the '''Save''' Icon.

===To make an MS SQL user the DB Owner===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Select the owner you wish to be the DB Owner
#Click on the '''Save''' Icon.

==MSSQL Tools (Shared Hosting)==
*Allows you to log directly into MyLittleAdmin to manage your MSSQL database or MyLittleBackup to backup or restore your MSSQL database.
#Click '''MSSQL Tools''' icon
#Select database to Manage/Backup/Restore
#Select User with access to database needed
#Choose myLittleAdmin button to manage your MSSQL database
#Choose myLittleBackup button to backup/restore your database

===To Backup and Download Your MSSQL Database===

#Click '''MSSQL Tools''' icon
#Select database to Backup.
#Select User with access to database.
#Choose the myLittleBackup button.
#Click 'Backup Databases' at the top left of the new page.
#Select your database from the drop-down.
#Click 'OK' on Step 2 if the information looks correct.
#Name your backup and give it a description.
#Click 'Backup'.
#Click the link provided to download your SQL backup file.

===To Restore an MSSQL Backup===

#Click '''MSSQL Tools''' icon
#Select database to Backup.
#Select User with access to database.
#Choose the myLittleBackup button.
#Click 'Restore databases'
#Choose the database you want to restore into.
#Click 'Choose File' and select the SQL backup file on your computer. (Example SQL backup format: Backupname.bak)
#Click Upload.
#Click the backup file you just uploaded and press OK.
#Click Restore.

==DataSources(DSN's)==
===Create a MySQL or MS SQL Server DSN===
*Allows to create a DSN for an existing database for your domain.
#To create a MySQL or MSSQL DataSource
#Click '''DataSources''' (DSN's) icon
#Choose MySQL or MSSQL from drop down depending on the database this is connecting to
#Click '''Add DSN'''
#Choose DSN type Access/MySQL/MSSQL
#Enter DSN name
#Enter Database name DSN will be connecting to
#Enter Server (Can by found by viewing database DSN is for)
#Enter Username for database DSN is connecting to
#Enter Password for database DSN is connecting to
#Choose if it is a ColdFusion DSN
#Choose if you need Unicode Support
#Click on the '''Save''' Icon.
===Create an Access DSN===
*To create an Access DataSource
#Click '''DataSources''' (DSN's) icon
#Choose '''Access''' from drop down menu
#Enter DSN Name
#Click on Folder icon to choose correct directory Access Database is located in
#Enter Username (If one is set for your Access Database, if not this can be left blank)
#Enter Password (If one is protecting your Database, if not this can be left blank)
#Choose if it needs to be a ColdFusion DSN
#Click on the '''Save''' Icon.
===Editing DSNs===
*To edit existing DSN
#Click '''DataSources''' (DSN's) icon
#Click pencil next to DSN to edit
#Update information
#Click on the '''Save''' Icon.

==Lucee Web Administrator==
The Lucee Web Administrator gives you access to Lucee-specific settings for your account such as Lucee Datasources and other configuration options.
===Create a Lucee (formerly Railo) Datasource (DSN)===
#From within your control panel, click on the "Luce Web Administrator" icon
#Inside the Lucee Web Administrator click the "Datasources" link from the lefthand navigation menu.
#Select the database type, enter a name, and click ''Create''.
#Configure your datasource with all the correct server, username and password.
#*'''IMPORTANT''': If using MySQL also make sure the option for '''Alias Handling''' is enabled.
#Click the ''Create'' button, and your DSN will be available for use on your site.

==Security and SSL==
Installing a new certificate, or re-keying an existing certificate.

===Dedicated SSL===
'''VPS Hosting''' Request a static IP for sites added to your server which require SSL, we will provision the IP on the server and assign it in WCP for use with installing a Dedicated SSL.

'''Shared Hosting''' If ordering a new certificate from Hostek.com you will be assigned a static IP, if importing from another provider you will need to request a static IP be assigned before the certificate can be activated.

#Login to WCP, (select the domain, in some cases), Security and SSL, '''Dedicated SSL (click)'''
#Click '''Generate CSR (Certificate Signing Request)'''
#Fill in the requested information.
#Click Create
#Copy the '''Certificate Signing Request (CSR)''', which should be used when placing a new SSL order or re-keying an existing certificate.

===Shared SSL(shared hosting)===
#Login to WCP, (select the domain, in some cases), Security and SSL, '''Shared SSL (click)'''
#Click '''Enable'''
#The URL for your sites shared SSL will be provided.

===Manage IPs===
This tool allows you to specify if an IP is blocked or allowed, and whether your site is by default denying access.

To block an IP:
#Grab the IP you need blocked from a log or from an email
#In the Deny IPs tool click Add
#Paste or type in the IP
#Choose Block in the drop down menu (By default it's set to Block)
#Click Save

To block all IPs (Useful if your site is not live yet):
#Click the Settings tab at the top
#Open up the drop down menu next to Default Access
#Choose Block (By default this is Allow)

==Stats==
*SmarterStats provides very detailed traffic information about your site's day-to-day activities for up to 14-months.

===Enabling SmarterStats===
#Login to WCP here https://wcp.hostek.com/
#Click on the '''Stats''' button
#Click '''Enable SmarterStats'''
*This will start processing log information from now on, and will report it's findings for your review.

===Resetting a SmarterStats Account Password===
#Login to WCP here https://wcp.hostek.com/
#Click on the '''Stats''' button
#Select the '''Pencil''' icon on the left-side of the chosen user
#Type a new password in the password box and click '''Save'''
#Select '''Login''' (on the right-side of the chosen user)
#Type in the new password that was just setup and click '''Login'''

==Usage==
To view your account's quotas and how much resources you have available:
#Log in to WCP
#Click the '''Usage''' icon

Here you can see the limits and amount used for the following resources: '''Site Disk Space, Site Bandwidth, Mail Disk Space, MySQL Disk Space,''' and '''MS SQL Disk Space''' (if applicable)

==Cron Jobs==
To add Cron Jobs to your site:
#Log in to WCP
#Click on the Cron Jobs button under the ColdFusion section
#Click Add
#Enter a name
#Enter the URL to be executed
#Select a quick time interval or click advanced and set up your interval
#Click save

==VPS Manager (VPS Accounts)==

Overview of the '''VPS Manager''' section in the control panel.

===Service Groups===

The service groups section allows you to specify which services a domain should use when being created or when databases are added to the domain. If you only have a single VPS server, the default service group will usually be used for everything. However, if you have multiple servers, you can use this section to allow new domains to use services on both servers (I.E. Use one server for the website and another for the database). It is also possible to create service groups that offers fewer services in-case you want to create domains with no dns, no mail, or no website.

Options overview:
* '''Name''': A name you will use to reference this group of services when creating or modifying a domain
* '''Site Service''': The server on which the website for this domain will be created.
* '''Mail Service''': The server on which the mail account for this domain will be created.
* '''DNS Service''': The server on which the DNS zone for this domain will be created.
* '''MSSQL Service''': The server on which new MSSQL databases will be created.
* '''MySQL Service''': The server on which new MySQL databases will be created.

===Server Details===

This page gives a brief overview of resource resource usage on the server and the server's 'Computer Name' as configured in Windows.

===Firewall Management===
This page allows you to manage the Windows Firewall rules for some common ports.
[[File:Firewall mgmt.png]]

===Restricting Access to a Port===
If you wish to restrict access to a port on your VPS do the following
*Open the Firewall Management section within your control panel's VPS Manager
*Click the pencil icon (edit) next to the service you wish to secure ''(eg. SQL Server, MySQL, Remote Desktop)''
*In the window that appears, choose one of the following from the ''Port Status'' dropdown menu:
**'''Closed''': Prevent any public access to the port
**'''Restricted''': Only allow select IPs access to the port
*Click ''Save'' once you've made your changes. 
''Example: Restricting Access to SQL Server Port'' 
[[File:Firewall sql.png]]

===Service Manager===

This page allows you to start, restart, or stop some common services.

===Add Domain===

This section allows you to add new VPS domains (Web sites). 
[[File:Wcp-vps-add-domain.png]]

After clicking the ''Add Domain'' button enter your site's domain name, FTP username & password, then select the service group and IP address if applicable. Once you click '''Save''' your new domain will be added to the server.

===List Domains===

This page lists existing VPS domains and allows you to remove or modify them.

===Adding Static IPs===
#Click List Domains
#Click the Pencil icon next to the domain you want
#Under the IP click the drop down box (Note: you will need a static IP first. To order one, email support@hostek.com to request one added to your VPS)
#Click Save

[[Category:Control-Panels]]
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:ColdFusion-VPS]]
[[Category:Railo-VPS]]
[[Category:Windows-VPS]]

File:Wcp-vps-add-domain.png

2015-05-12T19:35:57Z

Jakeh:

ContentBox

2015-05-06T17:30:47Z

Jakeh: /* Additional Details about ContentBox */

This page contains instructions and links for configuring and using the ContentBox CMS.

All [http://hostek.com/hosting/coldfusion/contentbox-hosting.asp ContentBox CMS hosting] accounts will have the files and database automatically added to new sites. The ContentBox Installation Page section below has details on completing the initial setup screen.

==CFML versions supported==
NOTE: When the ContentBox hosting plan is selected, the appropriate version is selected and the application is auto installed, etc.

For those trying to get ContentBox working manually, the CFML versions supported are:
*ColdFusion 9.01
*ColdFusion 10 (but the upload feature will not work due to CF10 bug with J2EE sessions)
*Railo 4.0.X and above

==ContentBox Installation==

Instructions for completing the initial setup page for a new ContentBox CMS site.

'''Note that the best way to install ContentBox is via our WCP Applications installer.''' That takes all the manual part out of it. If you prefer to install manually, go to http://www.gocontentbox.org/download and download the latest version of ContentBox. Upload the file to your wwwroot folder to begin the installation.

'''NOTE: The information below is just to let you know the fields you will encounter. Do NOT enter your information on this page :)'''

===Administrator===

'''NOTE: Additional administrators can be added after installation.'''

* First Name
* Last Name
* Email
* Username -
* Password -
*It is recommended to use a '''strong password''', which should be remembered or kept in a secure place.

===Site Information===

* Populate Site With Sample Data - Adds a sample page, sample post, and sample comments to the site. '''This is usually best for first time users.'''
* Site Name - Description provided on installation page.
* Administrator Email - Description provided on installation page.
* Outgoing Email - Description provided on installation page.
* Site Tag Line - Description provided on installation page.
* Site Description - Description provided on installation page.
* Site Keywords - Description provided on installation page.

===Mail Server===

'''NOTE: All these settings should be left as-is. The ColdFusion installation will already have these mail settings configured correctly.

* Mail Server
* Mail Server Username - '''Leave Blank'''
* Mail Server Password - '''Leave Blank'''
* Mail SMTP Port - '''Leave Blank'''
* Use TLS - '''No'''
* Use SSL - '''No'''

===Site URL Rewrites===

* Enable Full URL Rewrites - Choose '''Yes''' and select '''iis7'''.

===Start Installation!===

* Click the '''Start Installation!''' button to complete the installation.

==Additional Details about ContentBox==

Official Site for [http://www.ortussolutions.com/products/contentbox ContentBox]

===ContentBox Errors and Solutions===
====Error in instantiating the cfc modules.contentbox.model.system.EventHandler====
If you come across this error and are running version 2.0 or lower, please upgrade your ContentBox installation to version 2.1. You can obtain the latest installer from the [http://www.ortussolutions.com/products/contentbox/download ContentBox Download Page].

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

Add New Site to Lucee (formerly Railo) VPS

2015-04-15T18:10:22Z

Jakeh: Jakeh moved page Add New Site to Railo VPS to Add New Site to Lucee (formerly Railo) VPS: updating to include Lucee references

__FORCETOC__
If your VPS has the WCP or cPanel installed, the server automatically configures a new site in Lucee (formerly Railo) when the domain is added through the control panel. However, if your server doesn't have a control panel and you need to add a site to your server manually, follow the appropriate instructions below.

==Windows VPS - IIS / Tomcat==
#Add the site in IIS.
#Add a new virtual directory named "jakarta" to your new site, and have it use "C:\railo\connector" as the physical path.
#Add the site as a "Host" in Railo's server.xml file, located at c:\railo\tomcat\conf\server.xml. (Be sure to make a backup of the file first.) When you open the file in notepad, press ctrl+f and search for "<Host name=" (no quotes). Then add the host entry for the new site to this section. For example, your new host entry would look similar to this:<pre style="white-space: pre-wrap"><nowiki><Host name="newdomainname.com" appBase="webapps" unpackWARs="false" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false"> <Alias></Alias> <Context path="" docBase="c:\home\newdomainname.com\wwwroot\"/> </Host></nowiki></pre>You'd just need to be sure to replace the host name and the path in the context docbase with the correct info.
#*If you need to add an alias to the domain, you would add it within the "Host" entry in an "Alias" tag like below" <pre><Alias>www.domain1.com</Alias></pre>
#Once this has been done, restart the Apache Tomcat Railo service and your site will begin processing CFML files through Railo.

==Linux VPS - Apache (httpd) / Tomcat==
#Add the site to Apache. If your server has cPanel but is not integrated with Railo, you can still [[Reseller_Management#Adding_New_Account.28s.29_to_your_Reseller|add the site to Apache via cPanel]].
#Open your server's Tomcat server.xml file (using vi, pico, etc). This currently defaults to '''/opt/railo/tomcat/conf/server.xml'''.
#Add a new host entry for the site similar to this: <pre style="white-space: pre-wrap"><nowiki><Host name="newdomainname.com" appBase="webapps" unpackWARs="false" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false"> <Alias></Alias> <Context path="" docBase="/home/newuser/public_html"/> </Host></nowiki></pre>Be sure to use the correct domain name/path in the example above.
#After saving the file, restart Railo using the command below, and your new domain will start processing CFML: <pre>service railo_ctl restart</pre>

==Accessing the Lucee (formerly Railo) Web Admin for my new site==
The URL for any new site (context) you add to Lucee, will be: http://newsite.com/railo-context/admin/web.cfm ''(replace newsite.com with the actual domain name)''

==What is the location for my Lucee (formerly Railo) Server Administrator==
On the desktop of your VPS, you can access the Lucee Server Administrator at this location: http://localhost/railo-context/admin/server.cfm

If your server still runs Railo, you would use this: http://localhost/railo-context/admin/server.cfm

If you are running Lucee on Linux or just wish to access the Server Administrator remotely, replace "localhost" with the IP of your server or a domain name running on your server.

[[Category:Lucee]]
[[Category:Railo]]
[[Category:VPS]]

Add New Site to Railo VPS

2015-04-15T18:10:22Z

Jakeh: Jakeh moved page Add New Site to Railo VPS to Add New Site to Lucee (formerly Railo) VPS: updating to include Lucee references

#REDIRECT [[Add New Site to Lucee (formerly Railo) VPS]]

Add New Site to Lucee (formerly Railo) VPS

2015-04-15T17:58:37Z

Jakeh:

WCP (Windows based Control Panel)

2015-04-08T15:15:28Z

Jakeh: /* Create a Lucee Datasource (DSN) */

==How To Login To My WCP Control Panel==
#To manage your domain, login to the WCP Control Panel, using the details below
#URL: '''https://wcp.hostek.com'''/
#Username:
#Password: ** same as your cp.hostek.com password **
*You can also login to the control panel through your billing control panel https://cp.hostek.com/clientarea.php
#Click on ''''My Services'''' 'Click the '''small Green arrow''' on the the notepad to the right'
#Now click the '''Login to Control Panel''' Icon'''

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Custom URL for the WCP Control Panel==
The WCP can als be accessed by wcp.your_domain.com

Setup wcp.your_domain.com as an A record for "184.175.108.65" or as a CName record for "wcp.ezhostingserver.com".

===Resellers and VPS - WCP White label Settings===
Resellers and VPS customers can setup their logo in their Reseller control panel, however those additional features will only be available when accessing the control panel using the specific domain they configured within the Reseller Setttings of the control panel. The Reseller settings will be available using '''any''' URL, and as mentioned within these settings the reseller '''URL''' can be setup and other whitelabel options (custom control panel logo, favicon, etc.) making WCP the ultimate Windows Control Panel.

[[Category: Windows VPS]]
[[Category:Resellers]]

==Adding Additional Control Panel Logins==
*This will allow you to set up additional control panel logins for you or for others involved in editing or managing your account. You can limit the Permissions or options available for them to manage.
#Login to the WCP Control Panel, using the details below
#URL: '''https://wcp.hostek.com'''/
#Username:
#Password: ** same as your cp.hostek.com password **
#Click on the '''Control panel Logins''' tab, then click on the '''Add''' icon.
#Put the "Username, Password and if you want them to have Limited Permission.
#If you want them to have Limited Permission then check the '''Limited Permission''' box. This will load a dropdown where you can select what privlages they have to manage.
#Once you are done click the '''Save''' icon at the bottom of the screen.
#Once it has been added you or they can login by going to https://wcp.hostek.com/Login.aspx and using the username and password that you set for it.
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:Lucee]]
==Unlimited Plans - Add Additional Domains==
You will want to follow these steps in to generate a +1 Control Panel for a separate Domain. (Please note the difference between Registration and Hosting: [https://wiki.hostek.com/Domain_Registration_and_Domain_Name_Management#Domain_Registration_Information_vs._Domain_Hosting_Information '''here''')] This would be under your Windows Unlimited account, or your Windows Business/Pro plan.

#Login to your WCP control panel
#*Windows Unlimited: For adding a third (or more) domain select any domain from the upper right hand corner dropdown box "Domains".
#Within the "Domains" box click the "Addon Domains" icon.
#Click "Add" and enter the following:
#*Domain Name
#*Username
#*Password
#Click "Save"
#To manage the domain, you can now select it from the '''Domains''' drop-down list/box.
[[Category:Windows]]

==Site Details==
We recommend you review the "Site Settings" which includes many important details about your domain including:

WCP (login and select domain) > Website Settings > '''Site Details'''

*Testing URL
*Primary and Secondary DNS
*Site IP
*Web Root Path
*FTP Root Path
===IIS Version & ColdFusion Version (if applicable)===
To get your domain's IIS Version and ColdFusion Version (if applicable) log in to WCP and under the Settings section, click on the Site Details option.

==FTP Accounts==
*Adding or editing FTP accounts.
#click on the '''FTP Accounts''' tab.
#To edit one click on the little '''Pencil Icon''' to the left, to add one click on the '''Add FTP User''' tab.
#If you are adding one you will set the Username:, Password: and folder then click the #Click on the '''Save''' Icon.

==Virtual Directories==
*Adding virtual directories to your site.
#Log in to WCP
#Click on Virtual Directories under the Files section
#Click Add
#Enter the virtual path you need
#Enter in the actual physical path it is mapped to
#If this is to be an application, check the Create Application Folder check box
#Click Save

==Application Folders==
To create and manage Application Folders on your site
#Log in to WCP
#Click on Application Folders under the Files section
#Select the site or sub-domain from the drop down box
#Click continue
#Select a folder
#Click Add Application to make it an application folder

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==File Manager==
*Basic File Operations, file uploading and editing now supported- Zip, GZip, and Tar Archive support.
#Click on the '''File Manager icon''', then the '''Login icon''' on the next screen.
#To create files or Directory's outside the WWW root folder right click and click on the '''Create File''' or '''Create Directory''' option.
#Click the '''Continue Icon''' to add this.
#To add/edit files in the WWWroot click on the '''wwwroot file'''.
#once you are in you can add, edit or delete by right clicking and clicking on the options given.

*Upload and Download functions
#To upload a file, right click the File Manager page, and click Upload
#Select the file you wish to upload by clicking Choose File
#Give this file a new name or keep the existing default name

#To download a file, right click the file you want to download
#Click Download File. Note: This will send you to a new page.
#Now your browser will be downloading the file in question. Simply check your Downloads folder or hit Ctrl+J to open the Downloads section of your browser and move this file where you want it.

*NEW: Use the search bar at the top of the File Manager to quickly search the file you're looking for.
[[Category:ColdFusion]]
[[Category:Windows]]

==Password Protect Folders==
#Under the Files section click on '''Password Protect'''.
#Click on '''Manage Protected Folders'''.
#Browse to and click on the folder that you want to set this up on and check '''Enable Protection'''.
#Select a user from the list or click on '''Manage Users''', then click '''Add''', and enter username and password then Save.

==IIS Settings==
*Setting up error pages, default pages, advanced settings, etc.
===Custom Error pages===
#Click on '''IIS Settings''' in your WCP
#Click the edit button next to the error page you want to change
#Uncheck the '''Use System Default''' checkbox
#Enter the path to your custom error page
#Click '''Save'''
===Mime Types===
#Click on '''IIS Settings''' in your WCP
#Scroll to the bottom of the window and click '''Add Mime Type'''
#Enter the extension for the Mime Type
#Enter the Mime Type information
#Click '''Save'''
*An example Mime Type is below:
<pre>
Extension: .mp3
Mime Type: audio/mpeg
</pre>

More information here: [https://wiki.hostek.com/Mime_types Mime Types]

===Default Docs===
*Select a default document and drag it to the top position to set it as top priority
*Click '''Add''' to add a default doc
*Click the red '''X''' to delete a default doc
*Click a default doc and change the name
*For example: change '''"index.htm"''' to '''"index.asp"'''

===URL Forwarding===
#In your [https://wcp.hostek.com/ '''WCP'''] click on the '''IIS Settings''' button
#Navigate to the '''Redirects''' tab
# If you need a specific folder to redirect somewhere, you can find it using the '''Browse''' button
##If you simply want the whole site to redirect, leave this box '''blank'''
#Click '''Save'''. (See below for details on the other options.)
*'''Permanent Redirect''': Specifies that the server should return the redirect status code 301 rather than the default 302. A 301 status code lets search engines know that the content has been permanently moved and that only the new URL should be indexed.
*'''Exact URL''': If this is unchecked, then the request URL without the server name is passed along with the query string to the destination URL. This is equivelent to appending the $V$Q variables at the end of the destination URL.
*'''Exclude Sub Directories''': This means that the folder you choose will not redirect.

===Advanced===
====Recycle Application Pool====
If you see a Service Unavailable message on your site, or have a general need to recycle a site's IIS Application Pool, you can do so through this section of WCP.
#Click the '''IIS Settings''' icon in WCP
#Click the '''Advanced''' tab in the '''IIS Settings''' section
#Click the '''Recycle''' button.

==PHP Settings==
If you notice you need a different version of php or want to check what version you are using you can update it to that version if it is installed to the server or can enable custom php.ini settings to use specifically for your domain.
#Click the configuration for the domain or subdomain you want updated.
#Select the version you wish to use.
#Check the checkbox if you want to enable a custom php.ini file
#Click save to save the settings.

==ColdFusion==
===ColdFusion Error Logs===
====Server Error Logs====
This section will show any recent errors for your site that were found within ColdFusion's server-wide exception log. Use the dropdown to choose how many hours back you'd like errors retrieved.
====Application Error Logs====
This section will show errors created via the cflog tag on your site. For security purposes, your cflog logs will only appear hear if you have given the file name in the cflog tag the name of your domain, ''without the www.'' For example, if your domain is ''your_domain.com'' you would set the file attribute for the cflog tag like: ''file="your_domain.com"''.
 
''Note'': Please set the ''type'' of the ''cflog'' tag to either '''error''' or '''fatal''' on our production servers. Use of the ''information'' type is strongly discouraged.
 
'''Reference''': [https://wikidocs.adobe.com/wiki/display/coldfusionen/cflog CFLog Documentation]

===Clear Template Cache===
Within this section you can click the '''Clear Template Cache''' button to clear cached ColdFusion pages for your site.

===ColdFusion Version===
Within this section of WCP, you can choose which version of ColdFusion you'd like your site to use.

''Note'': You can also specify different ColdFusion versions for different subdomains on your site.
[[Category:ColdFusion]]
[[Category:Windows]]

==DNS Editor==
'''READ FIRST''' When a new domain is added to WCP all DNS records are also created (in most cases). Clicking on the DNS Editor will open a window with these records, for editing, adding and deleting. Most times nothing needs to be done other than pointing your domain to the Primary and Secondary DNS Servers listed under [https://wiki.hostek.com/WCP_(Windows_based_Control_Panel)#Site_Details WCP Site Details].

===Create a new DNS record===
#Click '''Add DNS''' Record button
#Enter Name for record (If DNS record name is your domain name please leave this Name - text box blank as the control panel will automatically add your domain name)
#Choose the Record type (A, CNAME, MX, NS, TXT, SPF, SRV)
#Enter Data Type
#Generally leave the TTL (Time To Live) as the default 86400
#Click on the '''Save''' Icon.

===Update DNS records===
#To update an existing DNS record click the '''Pencil''' icon next to the record you would like to update.
#You will then be able to change the Name of the record, the Type of record, Data of the record, and Time to Live.
#Once updated Click on the '''Save''' Icon.

===SVR Record Fields===
*A SVR Record is a "'''S'''er'''v'''ice '''R'''ecord". It's a specification of data in the Domain Name System defining the location (i.e. the hostname and port number) of servers for specified services.

<pre>
Name: _service._protocol
Type: SRV
Data: Address/Hostname
Priority: Priority Number
Weight: Weight Number
Port: Port Number
TTL: 86400
</pre>

Example:
<pre>
Name: _sip._udp
Type: SRV
Data: sip.mydomain.com
Priority: 10
Weight: 5
Port: 4030
TTL: 86400
</pre>

*If you are a '''VPS Client''' with a Windows Server and a SmarterMail Active Sync license wanting to use Autodiscover for Outlook, please refer to this SmarterMail Article [https://portal.smartertools.com/kb/a2752/set-up-autodiscover-for-smartermail.aspx here].

===MX Records===
Here are steps to setup the correct MX Records for our MailSystem:
*Note: These are setup by Default, and shouldn't need to be added unless changes were made.
#Go into the '''DNS Editor''' in WCP.
#Click '''Add Record'''.
#In the '''Record Name''' form put " '''mail''' ".
#Beside '''Type''' select '''A'''.
#Beside '''Data''' put the IP Address of your MailServer.
##You can find your MailServer by clicking the '''Site Details''' button in WCP.
##The IP Address can be found by PINGing the server, or by performing a WHOIS search.
#Once this is done click '''Save'''. Now you have an '''A Record''' labeled "mail.'''yourdomain'''.com".
#You'll want to click '''Add Record''' again.
#Leave the Record Name blank this time.
#Beside '''Type''' select '''MX'''.
#Beside '''Data''' put "mail.'''yourdomain'''.com".
#Once you click '''Save''', you will then have an '''MX Record''', which points to "mail.'''yourdomain'''.com".
*Congratulations! Now all you need to do is wait for DNS Propagation, which is the 2-to-12hr time period it takes for the internet to update with these new changes.

===SPF Records===
An SPF Record (simply an entry into the DNS records) is used by mail servers to know if mail coming from an address at your domain is really allowed to be sent from the sending mail server.

To have WCP create an SPF record for you, you can click '''SPF Record''' under the '''Email Section''' and then click the '''Create''' button, or you can use the steps below to create one manually.

If you will be using our servers send email related to your domain, you would generally use an SPF record like the following:<pre>"v=spf1 a mx include:spf.hostek.com -all"</pre>

For our Resellers that don't want to use hostek.com, use an SPF Record like:<pre>"v=spf1 a mx include:spf.ezhostingserver.com -all"</pre>
'''Steps to add an SPF Record to your domain:'''
Assuming that your DNS is managed with us:
#Log in to your hosting control panel at wcp.hostek.com
#Open the DNS Editor (DNS Manager) section
#Click on Add Record.
#Leave the Name field blank.
#For the Type, choose TXT
#For the Data enter the SPF Record detail as you need, using the sample provided above.

'''Basic information related to some SPF Record options:'''

The '''"-all"''' may be adjusted on a per customer basis to any of the following depending on their needs:

'''-all''' = mail not sent from an address listed in the SPF record should be completely rejected (Hard Fail). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

'''~all''' = mail not sent from an address listed in the SPF record should be given a higher spam score(Soft Fail). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

'''?all''' = mail not sent from an address listed in the SPF record should be treated normally as if the domain did not have an spf record (Neutral). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Sub Domains==
*A sub-domain is like an extension of your domain name. For example, if your domain name were myfamily.com, a sub-domain would be in the following form: dad.myfamily.com or mom.myfamily.com etc.
*You can have a sub-domain pointed to any folder within your web site. If a visitor goes directly to that sub-domain he will be taken to that folder, not to your site's main page.
#Click on the '''Sub Domains icon'''
#Click "'''Add'''" sub Domain button
#Enter sub domain name in Name text box. This will automatically populate the Folder text box to a folder with the same name as the subdomain.
#If you wish this Subdomain to point to a different folder you can click on the folder icon and choose the directory you would like your Sub Domain to point to.
#Click on the "'''Save'''" Icon.
#This will create the sub domain record within your domains DNS zone,
*If the domains name servers are not pointed to us you will need to manually create this record where your domains DNS is hosted.
[[Category:Control-Panels]]
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Domain Alias==
*This will allow you to point 2 domains to the same website. How to create a Domain
#To create a domain alias you will click on the ''Domain Aliases icon''
#Click '''Add Domain Alias''' button
#Enter your Alias Name
#Click on the "'''Save'''" Icon.
*You will need to be sure that your Domain Alias has been registered and has the name servers pointed to the name servers found beneath the Site Details icon.

==Applications==
# Some helpful video tutorials showing how to install a select few applications easily within the WCP Control Panel are below:

*Joomla - [http://hostek.com/tutorials/joomla_Installation_tutorial.html Installing Joomla Application]

*Wordpress - [http://hostek.com/tutorials/wordpress_Installation_tutorial.html Installing Wordpress Application]

*Mura - [http://hostek.com/tutorials/mura_Installation_tutorial.html Installing Mura Application]

*Magento - [http://hostek.com/tutorials/magento_Installation_tutorial.html Installing Magento Application]

*Oscommerce - [http://hostek.com/tutorials/oscommerce_Installation_tutorial.html Installing OsCommerce Application]

==Email==
*Below is information on how to manage your email account within the WCP.
*'''FOR VPS''' You will also have "Admin" access to SmarterMail. Access webmail (click the webmail link in WCP) and login with user "admin" and the primary VPS password.

==Email Users==
*Allows you to create Email users as well as log directly into users Webmail account
#Once you are logged into your WCP account, under the Email Section
#Click '''Users''' icon
#Click '''Add Email User''' button
#Enter email user name (Example: if you need the email address "admin@domain.com" enter the user "admin")
#Enter password for Email user (**See note below regarding password requirements)
#Enter Display name (Usually set to the name of the person using the specific email account)
#Choose if you would like this user to have administrator rights
#Choose mail box size limit for this specific user
#Click on the '''Save'''
#'''NOTE Password requirements'''
*Minimum Length 6 Characters
*Must include Uppercase
*Must include Lowercase
*Must include Number
*Must include Special character
*Password cannot match username

==Edit existing Email user==
#Once you are logged into your WCP account, under the Email Section
#Click '''Users''' icon
#Click '''pencil icon''' next to user to update
#Update information
#Click '''Save'''

==Web mail==
#Once you are logged into your WCP account, under the Email Section
#Click '''Login button''' next to user you would like access the mail for
*Web Mail Provides links to access the Webmail program as well as to access mail before domain propagation to our mail server
#Click '''Web Mail icon'''
#If domain is propagated and pointed to our mail server you can click the '''webmail''' link to access the SmarterMail webmail log in screen.
#If you domain has not yet propagated to our mail server click the "Pr-Propagation Web Mail" link to access the SmarterMail webmail log in screen.

==Mail Forwarding==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up an email alias.
#Click on the '''Forwarding button'''
#Enter Alias name
#Enter address for email to this Alias to be forwarded to
#Click on the '''Save Icon'''

==SPF Records==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up a SPF record
#Click on the '''Advanced''' button and then the '''SPF Record''' button
#Click the '''Create''' button

==Domain Keys==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up Domain Keys
#Click on the '''Advanced''' button and then the '''Domain Keys''' button
#Click '''Enable'''

==Mail Logs==
#Once you are logged into your WCP account, under the Email Section
#Click on the '''Advanced''' button and then the '''Mail Logs''' button
#Select an email account
#Select a date and log type
#Click on Search

==MySQL database==
*MySQL Allow you to create a MySQL database under your domain
#Click on '''MySQL icon'''
#To add new database click '''Add MySQL Database'''
#Enter Database Name
#Enter Username
#Enter Password
#(If you need a coldfusion DSN place check in check box and provide Coldfusion DSN name)
#Click '''Save'''

*To create new user for existing database
#Click '''MySQL icon'''
#Click '''Add new user button'''
#Enter Username
#Enter Password
#Place check mark in check box for each database you would like this user to have access to.
#To update the password on existing database user.
#Click '''MySQL icon'''
#Click '''pencil icon next to Username'''
#enter new password
#Click on the '''Save Icon'''.

*To update the password on existing database user.
#Click '''MySQL icon'''
#Click pencil '''icon next to Username'''
#Enter new password
#Click on the '''Save''' Icon.

==PhpMyAdmin==
*Allows you to log directly into your MySQL database to manage.
#Click on '''PhpMyAdmin link'''
#If you are not logged directly into your MySQL database simply enter the server your database is located on (Can be found by clicking the MySQL icon) and enter your Username and Password.
#Once logged in your Databases will be displayed on the Left, click on '''database name''' to manage that database.
*Here is a Video that will show how to create a MySQL database and how to Backup / Restore the database through PhpMyAdmin: [http://hostek.com/tutorials/managing_mysql.html PhpMyAdmin Backup and Restore Video]

==MSSQL==
===To create MSSQL databases and users===
#Click '''MSSQL icon'''
#To add a new database click '''Add MSSQL''' database
#Enter Database Name
#Choose database size
#Enter or Choose existing Username
#Enter Password
#Choose '''Default Collation''' (Usually left as default)
#Choose '''Recovery Model''' (Usually left as Simple as we make daily full backups of all #databases which we keep for 7 days)
#Place a Check mark in the box for Coldfusion DataSource if ColdFusion DSN is needed.
#Enter ColdFusion DSN name.
#Click on the '''Save''' Icon.

===To edit an existing MSSQL database===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Edit field necessary
#Click on the '''Save''' Icon.

===Changing the MSSQL Transaction Log (Recovery Model) Settings===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Click the dropdown menu next to '''Recovery Model''' and select either '''Full''' or '''Simple'''
#Click on the '''Save''' Icon.

===To edit password for existing MSSQL user===
#Click '''MSSQL icon'''
#Click '''Pencil next''' to user to edit
#Update password
#Click on the '''Save''' Icon.

===To add new MSSQL user===
#Click '''MSSQL icon'''
#Click '''Add MSSQL''' User button
#Enter username
#Enter password
#Place checkmark next to each database this users needs access to
#Click on the '''Save''' Icon.

===To make an MS SQL user the DB Owner===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Select the owner you wish to be the DB Owner
#Click on the '''Save''' Icon.

==MSSQL Tools (Shared Hosting)==
*Allows you to log directly into MyLittleAdmin to manage your MSSQL database or MyLittleBackup to backup or restore your MSSQL database.
#Click '''MSSQL Tools''' icon
#Select database to Manage/Backup/Restore
#Select User with access to database needed
#Choose myLittleAdmin button to manage your MSSQL database
#Choose myLittleBackup button to backup/restore your database

===To Backup and Download Your MSSQL Database===

#Click '''MSSQL Tools''' icon
#Select database to Backup.
#Select User with access to database.
#Choose the myLittleBackup button.
#Click 'Backup Databases' at the top left of the new page.
#Select your database from the drop-down.
#Click 'OK' on Step 2 if the information looks correct.
#Name your backup and give it a description.
#Click 'Backup'.
#Click the link provided to download your SQL backup file.

===To Restore an MSSQL Backup===

#Click '''MSSQL Tools''' icon
#Select database to Backup.
#Select User with access to database.
#Choose the myLittleBackup button.
#Click 'Restore databases'
#Choose the database you want to restore into.
#Click 'Choose File' and select the SQL backup file on your computer. (Example SQL backup format: Backupname.bak)
#Click Upload.
#Click the backup file you just uploaded and press OK.
#Click Restore.

==DataSources(DSN's)==
===Create a MySQL or MS SQL Server DSN===
*Allows to create a DSN for an existing database for your domain.
#To create a MySQL or MSSQL DataSource
#Click '''DataSources''' (DSN's) icon
#Choose MySQL or MSSQL from drop down depending on the database this is connecting to
#Click '''Add DSN'''
#Choose DSN type Access/MySQL/MSSQL
#Enter DSN name
#Enter Database name DSN will be connecting to
#Enter Server (Can by found by viewing database DSN is for)
#Enter Username for database DSN is connecting to
#Enter Password for database DSN is connecting to
#Choose if it is a ColdFusion DSN
#Choose if you need Unicode Support
#Click on the '''Save''' Icon.
===Create an Access DSN===
*To create an Access DataSource
#Click '''DataSources''' (DSN's) icon
#Choose '''Access''' from drop down menu
#Enter DSN Name
#Click on Folder icon to choose correct directory Access Database is located in
#Enter Username (If one is set for your Access Database, if not this can be left blank)
#Enter Password (If one is protecting your Database, if not this can be left blank)
#Choose if it needs to be a ColdFusion DSN
#Click on the '''Save''' Icon.
===Editing DSNs===
*To edit existing DSN
#Click '''DataSources''' (DSN's) icon
#Click pencil next to DSN to edit
#Update information
#Click on the '''Save''' Icon.

==Lucee Web Administrator==
The Lucee Web Administrator gives you access to Lucee-specific settings for your account such as Lucee Datasources and other configuration options.
===Create a Lucee (formerly Railo) Datasource (DSN)===
#From within your control panel, click on the "Luce Web Administrator" icon
#Inside the Lucee Web Administrator click the "Datasources" link from the lefthand navigation menu.
#Select the database type, enter a name, and click ''Create''.
#Configure your datasource with all the correct server, username and password.
#*'''IMPORTANT''': If using MySQL also make sure the option for '''Alias Handling''' is enabled.
#Click the ''Create'' button, and your DSN will be available for use on your site.

==Security and SSL==
Installing a new certificate, or re-keying an existing certificate.

===Dedicated SSL===
'''VPS Hosting''' Request a static IP for sites added to your server which require SSL, we will provision the IP on the server and assign it in WCP for use with installing a Dedicated SSL.

'''Shared Hosting''' If ordering a new certificate from Hostek.com you will be assigned a static IP, if importing from another provider you will need to request a static IP be assigned before the certificate can be activated.

#Login to WCP, (select the domain, in some cases), Security and SSL, '''Dedicated SSL (click)'''
#Click '''Generate CSR (Certificate Signing Request)'''
#Fill in the requested information.
#Click Create
#Copy the '''Certificate Signing Request (CSR)''', which should be used when placing a new SSL order or re-keying an existing certificate.

===Shared SSL(shared hosting)===
#Login to WCP, (select the domain, in some cases), Security and SSL, '''Shared SSL (click)'''
#Click '''Enable'''
#The URL for your sites shared SSL will be provided.

===Manage IPs===
This tool allows you to specify if an IP is blocked or allowed, and whether your site is by default denying access.

To block an IP:
#Grab the IP you need blocked from a log or from an email
#In the Deny IPs tool click Add
#Paste or type in the IP
#Choose Block in the drop down menu (By default it's set to Block)
#Click Save

To block all IPs (Useful if your site is not live yet):
#Click the Settings tab at the top
#Open up the drop down menu next to Default Access
#Choose Block (By default this is Allow)

==Stats==
*SmarterStats provides very detailed traffic information about your site's day-to-day activities for up to 14-months.

===Enabling SmarterStats===
#Login to WCP here https://wcp.hostek.com/
#Click on the '''Stats''' button
#Click '''Enable SmarterStats'''
*This will start processing log information from now on, and will report it's findings for your review.

===Resetting a SmarterStats Account Password===
#Login to WCP here https://wcp.hostek.com/
#Click on the '''Stats''' button
#Select the '''Pencil''' icon on the left-side of the chosen user
#Type a new password in the password box and click '''Save'''
#Select '''Login''' (on the right-side of the chosen user)
#Type in the new password that was just setup and click '''Login'''

==Usage==
To view your account's quotas and how much resources you have available:
#Log in to WCP
#Click the '''Usage''' icon

Here you can see the limits and amount used for the following resources: '''Site Disk Space, Site Bandwidth, Mail Disk Space, MySQL Disk Space,''' and '''MS SQL Disk Space''' (if applicable)

==Cron Jobs==
To add Cron Jobs to your site:
#Log in to WCP
#Click on the Cron Jobs button under the ColdFusion section
#Click Add
#Enter a name
#Enter the URL to be executed
#Select a quick time interval or click advanced and set up your interval
#Click save

==VPS Manager (VPS Accounts)==

Overview of the '''VPS Manager''' section in the control panel.

===Service Groups===

The service groups section allows you to specify which services a domain should use when being created or when databases are added to the domain. If you only have a single VPS server, the default service group will usually be used for everything. However, if you have multiple servers, you can use this section to allow new domains to use services on both servers (I.E. Use one server for the website and another for the database). It is also possible to create service groups that offers fewer services in-case you want to create domains with no dns, no mail, or no website.

Options overview:
* '''Name''': A name you will use to reference this group of services when creating or modifying a domain
* '''Site Service''': The server on which the website for this domain will be created.
* '''Mail Service''': The server on which the mail account for this domain will be created.
* '''DNS Service''': The server on which the DNS zone for this domain will be created.
* '''MSSQL Service''': The server on which new MSSQL databases will be created.
* '''MySQL Service''': The server on which new MySQL databases will be created.

===Server Details===

This page gives a brief overview of resource resource usage on the server and the server's 'Computer Name' as configured in Windows.

===Firewall Management===
This page allows you to manage the Windows Firewall rules for some common ports.
[[File:Firewall mgmt.png]]

===Restricting Access to a Port===
If you wish to restrict access to a port on your VPS do the following
*Open the Firewall Management section within your control panel's VPS Manager
*Click the pencil icon (edit) next to the service you wish to secure ''(eg. SQL Server, MySQL, Remote Desktop)''
*In the window that appears, choose one of the following from the ''Port Status'' dropdown menu:
**'''Closed''': Prevent any public access to the port
**'''Restricted''': Only allow select IPs access to the port
*Click ''Save'' once you've made your changes. 
''Example: Restricting Access to SQL Server Port'' 
[[File:Firewall sql.png]]

===Service Manager===

This page allows you to start, restart, or stop some common services.

===Add Domain===

This page allows you to add new VPS domains.

===List Domains===

This page lists existing VPS domains and allows you to remove or modify them.

===Adding Static IPs===
#Click List Domains
#Click the Pencil icon next to the domain you want
#Under the IP click the drop down box (Note: you will need a static IP first. To order one, email support@hostek.com to request one added to your VPS)
#Click Save

[[Category:Control-Panels]]
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:ColdFusion-VPS]]
[[Category:Railo-VPS]]
[[Category:Windows-VPS]]

WCP (Windows based Control Panel)

2015-04-08T15:11:58Z

Jakeh:

==How To Login To My WCP Control Panel==
#To manage your domain, login to the WCP Control Panel, using the details below
#URL: '''https://wcp.hostek.com'''/
#Username:
#Password: ** same as your cp.hostek.com password **
*You can also login to the control panel through your billing control panel https://cp.hostek.com/clientarea.php
#Click on ''''My Services'''' 'Click the '''small Green arrow''' on the the notepad to the right'
#Now click the '''Login to Control Panel''' Icon'''

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Custom URL for the WCP Control Panel==
The WCP can als be accessed by wcp.your_domain.com

Setup wcp.your_domain.com as an A record for "184.175.108.65" or as a CName record for "wcp.ezhostingserver.com".

===Resellers and VPS - WCP White label Settings===
Resellers and VPS customers can setup their logo in their Reseller control panel, however those additional features will only be available when accessing the control panel using the specific domain they configured within the Reseller Setttings of the control panel. The Reseller settings will be available using '''any''' URL, and as mentioned within these settings the reseller '''URL''' can be setup and other whitelabel options (custom control panel logo, favicon, etc.) making WCP the ultimate Windows Control Panel.

[[Category: Windows VPS]]
[[Category:Resellers]]

==Adding Additional Control Panel Logins==
*This will allow you to set up additional control panel logins for you or for others involved in editing or managing your account. You can limit the Permissions or options available for them to manage.
#Login to the WCP Control Panel, using the details below
#URL: '''https://wcp.hostek.com'''/
#Username:
#Password: ** same as your cp.hostek.com password **
#Click on the '''Control panel Logins''' tab, then click on the '''Add''' icon.
#Put the "Username, Password and if you want them to have Limited Permission.
#If you want them to have Limited Permission then check the '''Limited Permission''' box. This will load a dropdown where you can select what privlages they have to manage.
#Once you are done click the '''Save''' icon at the bottom of the screen.
#Once it has been added you or they can login by going to https://wcp.hostek.com/Login.aspx and using the username and password that you set for it.
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:Lucee]]
==Unlimited Plans - Add Additional Domains==
You will want to follow these steps in to generate a +1 Control Panel for a separate Domain. (Please note the difference between Registration and Hosting: [https://wiki.hostek.com/Domain_Registration_and_Domain_Name_Management#Domain_Registration_Information_vs._Domain_Hosting_Information '''here''')] This would be under your Windows Unlimited account, or your Windows Business/Pro plan.

#Login to your WCP control panel
#*Windows Unlimited: For adding a third (or more) domain select any domain from the upper right hand corner dropdown box "Domains".
#Within the "Domains" box click the "Addon Domains" icon.
#Click "Add" and enter the following:
#*Domain Name
#*Username
#*Password
#Click "Save"
#To manage the domain, you can now select it from the '''Domains''' drop-down list/box.
[[Category:Windows]]

==Site Details==
We recommend you review the "Site Settings" which includes many important details about your domain including:

WCP (login and select domain) > Website Settings > '''Site Details'''

*Testing URL
*Primary and Secondary DNS
*Site IP
*Web Root Path
*FTP Root Path
===IIS Version & ColdFusion Version (if applicable)===
To get your domain's IIS Version and ColdFusion Version (if applicable) log in to WCP and under the Settings section, click on the Site Details option.

==FTP Accounts==
*Adding or editing FTP accounts.
#click on the '''FTP Accounts''' tab.
#To edit one click on the little '''Pencil Icon''' to the left, to add one click on the '''Add FTP User''' tab.
#If you are adding one you will set the Username:, Password: and folder then click the #Click on the '''Save''' Icon.

==Virtual Directories==
*Adding virtual directories to your site.
#Log in to WCP
#Click on Virtual Directories under the Files section
#Click Add
#Enter the virtual path you need
#Enter in the actual physical path it is mapped to
#If this is to be an application, check the Create Application Folder check box
#Click Save

==Application Folders==
To create and manage Application Folders on your site
#Log in to WCP
#Click on Application Folders under the Files section
#Select the site or sub-domain from the drop down box
#Click continue
#Select a folder
#Click Add Application to make it an application folder

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==File Manager==
*Basic File Operations, file uploading and editing now supported- Zip, GZip, and Tar Archive support.
#Click on the '''File Manager icon''', then the '''Login icon''' on the next screen.
#To create files or Directory's outside the WWW root folder right click and click on the '''Create File''' or '''Create Directory''' option.
#Click the '''Continue Icon''' to add this.
#To add/edit files in the WWWroot click on the '''wwwroot file'''.
#once you are in you can add, edit or delete by right clicking and clicking on the options given.

*Upload and Download functions
#To upload a file, right click the File Manager page, and click Upload
#Select the file you wish to upload by clicking Choose File
#Give this file a new name or keep the existing default name

#To download a file, right click the file you want to download
#Click Download File. Note: This will send you to a new page.
#Now your browser will be downloading the file in question. Simply check your Downloads folder or hit Ctrl+J to open the Downloads section of your browser and move this file where you want it.

*NEW: Use the search bar at the top of the File Manager to quickly search the file you're looking for.
[[Category:ColdFusion]]
[[Category:Windows]]

==Password Protect Folders==
#Under the Files section click on '''Password Protect'''.
#Click on '''Manage Protected Folders'''.
#Browse to and click on the folder that you want to set this up on and check '''Enable Protection'''.
#Select a user from the list or click on '''Manage Users''', then click '''Add''', and enter username and password then Save.

==IIS Settings==
*Setting up error pages, default pages, advanced settings, etc.
===Custom Error pages===
#Click on '''IIS Settings''' in your WCP
#Click the edit button next to the error page you want to change
#Uncheck the '''Use System Default''' checkbox
#Enter the path to your custom error page
#Click '''Save'''
===Mime Types===
#Click on '''IIS Settings''' in your WCP
#Scroll to the bottom of the window and click '''Add Mime Type'''
#Enter the extension for the Mime Type
#Enter the Mime Type information
#Click '''Save'''
*An example Mime Type is below:
<pre>
Extension: .mp3
Mime Type: audio/mpeg
</pre>

More information here: [https://wiki.hostek.com/Mime_types Mime Types]

===Default Docs===
*Select a default document and drag it to the top position to set it as top priority
*Click '''Add''' to add a default doc
*Click the red '''X''' to delete a default doc
*Click a default doc and change the name
*For example: change '''"index.htm"''' to '''"index.asp"'''

===URL Forwarding===
#In your [https://wcp.hostek.com/ '''WCP'''] click on the '''IIS Settings''' button
#Navigate to the '''Redirects''' tab
# If you need a specific folder to redirect somewhere, you can find it using the '''Browse''' button
##If you simply want the whole site to redirect, leave this box '''blank'''
#Click '''Save'''. (See below for details on the other options.)
*'''Permanent Redirect''': Specifies that the server should return the redirect status code 301 rather than the default 302. A 301 status code lets search engines know that the content has been permanently moved and that only the new URL should be indexed.
*'''Exact URL''': If this is unchecked, then the request URL without the server name is passed along with the query string to the destination URL. This is equivelent to appending the $V$Q variables at the end of the destination URL.
*'''Exclude Sub Directories''': This means that the folder you choose will not redirect.

===Advanced===
====Recycle Application Pool====
If you see a Service Unavailable message on your site, or have a general need to recycle a site's IIS Application Pool, you can do so through this section of WCP.
#Click the '''IIS Settings''' icon in WCP
#Click the '''Advanced''' tab in the '''IIS Settings''' section
#Click the '''Recycle''' button.

==PHP Settings==
If you notice you need a different version of php or want to check what version you are using you can update it to that version if it is installed to the server or can enable custom php.ini settings to use specifically for your domain.
#Click the configuration for the domain or subdomain you want updated.
#Select the version you wish to use.
#Check the checkbox if you want to enable a custom php.ini file
#Click save to save the settings.

==ColdFusion==
===ColdFusion Error Logs===
====Server Error Logs====
This section will show any recent errors for your site that were found within ColdFusion's server-wide exception log. Use the dropdown to choose how many hours back you'd like errors retrieved.
====Application Error Logs====
This section will show errors created via the cflog tag on your site. For security purposes, your cflog logs will only appear hear if you have given the file name in the cflog tag the name of your domain, ''without the www.'' For example, if your domain is ''your_domain.com'' you would set the file attribute for the cflog tag like: ''file="your_domain.com"''.
 
''Note'': Please set the ''type'' of the ''cflog'' tag to either '''error''' or '''fatal''' on our production servers. Use of the ''information'' type is strongly discouraged.
 
'''Reference''': [https://wikidocs.adobe.com/wiki/display/coldfusionen/cflog CFLog Documentation]

===Clear Template Cache===
Within this section you can click the '''Clear Template Cache''' button to clear cached ColdFusion pages for your site.

===ColdFusion Version===
Within this section of WCP, you can choose which version of ColdFusion you'd like your site to use.

''Note'': You can also specify different ColdFusion versions for different subdomains on your site.
[[Category:ColdFusion]]
[[Category:Windows]]

==DNS Editor==
'''READ FIRST''' When a new domain is added to WCP all DNS records are also created (in most cases). Clicking on the DNS Editor will open a window with these records, for editing, adding and deleting. Most times nothing needs to be done other than pointing your domain to the Primary and Secondary DNS Servers listed under [https://wiki.hostek.com/WCP_(Windows_based_Control_Panel)#Site_Details WCP Site Details].

===Create a new DNS record===
#Click '''Add DNS''' Record button
#Enter Name for record (If DNS record name is your domain name please leave this Name - text box blank as the control panel will automatically add your domain name)
#Choose the Record type (A, CNAME, MX, NS, TXT, SPF, SRV)
#Enter Data Type
#Generally leave the TTL (Time To Live) as the default 86400
#Click on the '''Save''' Icon.

===Update DNS records===
#To update an existing DNS record click the '''Pencil''' icon next to the record you would like to update.
#You will then be able to change the Name of the record, the Type of record, Data of the record, and Time to Live.
#Once updated Click on the '''Save''' Icon.

===SVR Record Fields===
*A SVR Record is a "'''S'''er'''v'''ice '''R'''ecord". It's a specification of data in the Domain Name System defining the location (i.e. the hostname and port number) of servers for specified services.

<pre>
Name: _service._protocol
Type: SRV
Data: Address/Hostname
Priority: Priority Number
Weight: Weight Number
Port: Port Number
TTL: 86400
</pre>

Example:
<pre>
Name: _sip._udp
Type: SRV
Data: sip.mydomain.com
Priority: 10
Weight: 5
Port: 4030
TTL: 86400
</pre>

*If you are a '''VPS Client''' with a Windows Server and a SmarterMail Active Sync license wanting to use Autodiscover for Outlook, please refer to this SmarterMail Article [https://portal.smartertools.com/kb/a2752/set-up-autodiscover-for-smartermail.aspx here].

===MX Records===
Here are steps to setup the correct MX Records for our MailSystem:
*Note: These are setup by Default, and shouldn't need to be added unless changes were made.
#Go into the '''DNS Editor''' in WCP.
#Click '''Add Record'''.
#In the '''Record Name''' form put " '''mail''' ".
#Beside '''Type''' select '''A'''.
#Beside '''Data''' put the IP Address of your MailServer.
##You can find your MailServer by clicking the '''Site Details''' button in WCP.
##The IP Address can be found by PINGing the server, or by performing a WHOIS search.
#Once this is done click '''Save'''. Now you have an '''A Record''' labeled "mail.'''yourdomain'''.com".
#You'll want to click '''Add Record''' again.
#Leave the Record Name blank this time.
#Beside '''Type''' select '''MX'''.
#Beside '''Data''' put "mail.'''yourdomain'''.com".
#Once you click '''Save''', you will then have an '''MX Record''', which points to "mail.'''yourdomain'''.com".
*Congratulations! Now all you need to do is wait for DNS Propagation, which is the 2-to-12hr time period it takes for the internet to update with these new changes.

===SPF Records===
An SPF Record (simply an entry into the DNS records) is used by mail servers to know if mail coming from an address at your domain is really allowed to be sent from the sending mail server.

To have WCP create an SPF record for you, you can click '''SPF Record''' under the '''Email Section''' and then click the '''Create''' button, or you can use the steps below to create one manually.

If you will be using our servers send email related to your domain, you would generally use an SPF record like the following:<pre>"v=spf1 a mx include:spf.hostek.com -all"</pre>

For our Resellers that don't want to use hostek.com, use an SPF Record like:<pre>"v=spf1 a mx include:spf.ezhostingserver.com -all"</pre>
'''Steps to add an SPF Record to your domain:'''
Assuming that your DNS is managed with us:
#Log in to your hosting control panel at wcp.hostek.com
#Open the DNS Editor (DNS Manager) section
#Click on Add Record.
#Leave the Name field blank.
#For the Type, choose TXT
#For the Data enter the SPF Record detail as you need, using the sample provided above.

'''Basic information related to some SPF Record options:'''

The '''"-all"''' may be adjusted on a per customer basis to any of the following depending on their needs:

'''-all''' = mail not sent from an address listed in the SPF record should be completely rejected (Hard Fail). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

'''~all''' = mail not sent from an address listed in the SPF record should be given a higher spam score(Soft Fail). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

'''?all''' = mail not sent from an address listed in the SPF record should be treated normally as if the domain did not have an spf record (Neutral). Mail that IS sent from an address in the SPF record may be given a lower spam score by some servers.

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Sub Domains==
*A sub-domain is like an extension of your domain name. For example, if your domain name were myfamily.com, a sub-domain would be in the following form: dad.myfamily.com or mom.myfamily.com etc.
*You can have a sub-domain pointed to any folder within your web site. If a visitor goes directly to that sub-domain he will be taken to that folder, not to your site's main page.
#Click on the '''Sub Domains icon'''
#Click "'''Add'''" sub Domain button
#Enter sub domain name in Name text box. This will automatically populate the Folder text box to a folder with the same name as the subdomain.
#If you wish this Subdomain to point to a different folder you can click on the folder icon and choose the directory you would like your Sub Domain to point to.
#Click on the "'''Save'''" Icon.
#This will create the sub domain record within your domains DNS zone,
*If the domains name servers are not pointed to us you will need to manually create this record where your domains DNS is hosted.
[[Category:Control-Panels]]
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]

==Domain Alias==
*This will allow you to point 2 domains to the same website. How to create a Domain
#To create a domain alias you will click on the ''Domain Aliases icon''
#Click '''Add Domain Alias''' button
#Enter your Alias Name
#Click on the "'''Save'''" Icon.
*You will need to be sure that your Domain Alias has been registered and has the name servers pointed to the name servers found beneath the Site Details icon.

==Applications==
# Some helpful video tutorials showing how to install a select few applications easily within the WCP Control Panel are below:

*Joomla - [http://hostek.com/tutorials/joomla_Installation_tutorial.html Installing Joomla Application]

*Wordpress - [http://hostek.com/tutorials/wordpress_Installation_tutorial.html Installing Wordpress Application]

*Mura - [http://hostek.com/tutorials/mura_Installation_tutorial.html Installing Mura Application]

*Magento - [http://hostek.com/tutorials/magento_Installation_tutorial.html Installing Magento Application]

*Oscommerce - [http://hostek.com/tutorials/oscommerce_Installation_tutorial.html Installing OsCommerce Application]

==Email==
*Below is information on how to manage your email account within the WCP.
*'''FOR VPS''' You will also have "Admin" access to SmarterMail. Access webmail (click the webmail link in WCP) and login with user "admin" and the primary VPS password.

==Email Users==
*Allows you to create Email users as well as log directly into users Webmail account
#Once you are logged into your WCP account, under the Email Section
#Click '''Users''' icon
#Click '''Add Email User''' button
#Enter email user name (Example: if you need the email address "admin@domain.com" enter the user "admin")
#Enter password for Email user (**See note below regarding password requirements)
#Enter Display name (Usually set to the name of the person using the specific email account)
#Choose if you would like this user to have administrator rights
#Choose mail box size limit for this specific user
#Click on the '''Save'''
#'''NOTE Password requirements'''
*Minimum Length 6 Characters
*Must include Uppercase
*Must include Lowercase
*Must include Number
*Must include Special character
*Password cannot match username

==Edit existing Email user==
#Once you are logged into your WCP account, under the Email Section
#Click '''Users''' icon
#Click '''pencil icon''' next to user to update
#Update information
#Click '''Save'''

==Web mail==
#Once you are logged into your WCP account, under the Email Section
#Click '''Login button''' next to user you would like access the mail for
*Web Mail Provides links to access the Webmail program as well as to access mail before domain propagation to our mail server
#Click '''Web Mail icon'''
#If domain is propagated and pointed to our mail server you can click the '''webmail''' link to access the SmarterMail webmail log in screen.
#If you domain has not yet propagated to our mail server click the "Pr-Propagation Web Mail" link to access the SmarterMail webmail log in screen.

==Mail Forwarding==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up an email alias.
#Click on the '''Forwarding button'''
#Enter Alias name
#Enter address for email to this Alias to be forwarded to
#Click on the '''Save Icon'''

==SPF Records==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up a SPF record
#Click on the '''Advanced''' button and then the '''SPF Record''' button
#Click the '''Create''' button

==Domain Keys==
#Once you are logged into your WCP account, under the Email Section
*Allows you to set up Domain Keys
#Click on the '''Advanced''' button and then the '''Domain Keys''' button
#Click '''Enable'''

==Mail Logs==
#Once you are logged into your WCP account, under the Email Section
#Click on the '''Advanced''' button and then the '''Mail Logs''' button
#Select an email account
#Select a date and log type
#Click on Search

==MySQL database==
*MySQL Allow you to create a MySQL database under your domain
#Click on '''MySQL icon'''
#To add new database click '''Add MySQL Database'''
#Enter Database Name
#Enter Username
#Enter Password
#(If you need a coldfusion DSN place check in check box and provide Coldfusion DSN name)
#Click '''Save'''

*To create new user for existing database
#Click '''MySQL icon'''
#Click '''Add new user button'''
#Enter Username
#Enter Password
#Place check mark in check box for each database you would like this user to have access to.
#To update the password on existing database user.
#Click '''MySQL icon'''
#Click '''pencil icon next to Username'''
#enter new password
#Click on the '''Save Icon'''.

*To update the password on existing database user.
#Click '''MySQL icon'''
#Click pencil '''icon next to Username'''
#Enter new password
#Click on the '''Save''' Icon.

==PhpMyAdmin==
*Allows you to log directly into your MySQL database to manage.
#Click on '''PhpMyAdmin link'''
#If you are not logged directly into your MySQL database simply enter the server your database is located on (Can be found by clicking the MySQL icon) and enter your Username and Password.
#Once logged in your Databases will be displayed on the Left, click on '''database name''' to manage that database.
*Here is a Video that will show how to create a MySQL database and how to Backup / Restore the database through PhpMyAdmin: [http://hostek.com/tutorials/managing_mysql.html PhpMyAdmin Backup and Restore Video]

==MSSQL==
===To create MSSQL databases and users===
#Click '''MSSQL icon'''
#To add a new database click '''Add MSSQL''' database
#Enter Database Name
#Choose database size
#Enter or Choose existing Username
#Enter Password
#Choose '''Default Collation''' (Usually left as default)
#Choose '''Recovery Model''' (Usually left as Simple as we make daily full backups of all #databases which we keep for 7 days)
#Place a Check mark in the box for Coldfusion DataSource if ColdFusion DSN is needed.
#Enter ColdFusion DSN name.
#Click on the '''Save''' Icon.

===To edit an existing MSSQL database===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Edit field necessary
#Click on the '''Save''' Icon.

===Changing the MSSQL Transaction Log (Recovery Model) Settings===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Click the dropdown menu next to '''Recovery Model''' and select either '''Full''' or '''Simple'''
#Click on the '''Save''' Icon.

===To edit password for existing MSSQL user===
#Click '''MSSQL icon'''
#Click '''Pencil next''' to user to edit
#Update password
#Click on the '''Save''' Icon.

===To add new MSSQL user===
#Click '''MSSQL icon'''
#Click '''Add MSSQL''' User button
#Enter username
#Enter password
#Place checkmark next to each database this users needs access to
#Click on the '''Save''' Icon.

===To make an MS SQL user the DB Owner===
#Click '''MSSQL icon'''
#Click '''Pencil icon''' next to database name to edit
#Select the owner you wish to be the DB Owner
#Click on the '''Save''' Icon.

==MSSQL Tools (Shared Hosting)==
*Allows you to log directly into MyLittleAdmin to manage your MSSQL database or MyLittleBackup to backup or restore your MSSQL database.
#Click '''MSSQL Tools''' icon
#Select database to Manage/Backup/Restore
#Select User with access to database needed
#Choose myLittleAdmin button to manage your MSSQL database
#Choose myLittleBackup button to backup/restore your database

===To Backup and Download Your MSSQL Database===

#Click '''MSSQL Tools''' icon
#Select database to Backup.
#Select User with access to database.
#Choose the myLittleBackup button.
#Click 'Backup Databases' at the top left of the new page.
#Select your database from the drop-down.
#Click 'OK' on Step 2 if the information looks correct.
#Name your backup and give it a description.
#Click 'Backup'.
#Click the link provided to download your SQL backup file.

===To Restore an MSSQL Backup===

#Click '''MSSQL Tools''' icon
#Select database to Backup.
#Select User with access to database.
#Choose the myLittleBackup button.
#Click 'Restore databases'
#Choose the database you want to restore into.
#Click 'Choose File' and select the SQL backup file on your computer. (Example SQL backup format: Backupname.bak)
#Click Upload.
#Click the backup file you just uploaded and press OK.
#Click Restore.

==DataSources(DSN's)==
===Create a MySQL or MS SQL Server DSN===
*Allows to create a DSN for an existing database for your domain.
#To create a MySQL or MSSQL DataSource
#Click '''DataSources''' (DSN's) icon
#Choose MySQL or MSSQL from drop down depending on the database this is connecting to
#Click '''Add DSN'''
#Choose DSN type Access/MySQL/MSSQL
#Enter DSN name
#Enter Database name DSN will be connecting to
#Enter Server (Can by found by viewing database DSN is for)
#Enter Username for database DSN is connecting to
#Enter Password for database DSN is connecting to
#Choose if it is a ColdFusion DSN
#Choose if you need Unicode Support
#Click on the '''Save''' Icon.
===Create an Access DSN===
*To create an Access DataSource
#Click '''DataSources''' (DSN's) icon
#Choose '''Access''' from drop down menu
#Enter DSN Name
#Click on Folder icon to choose correct directory Access Database is located in
#Enter Username (If one is set for your Access Database, if not this can be left blank)
#Enter Password (If one is protecting your Database, if not this can be left blank)
#Choose if it needs to be a ColdFusion DSN
#Click on the '''Save''' Icon.
===Editing DSNs===
*To edit existing DSN
#Click '''DataSources''' (DSN's) icon
#Click pencil next to DSN to edit
#Update information
#Click on the '''Save''' Icon.

==Lucee Web Administrator==
The Lucee Web Administrator gives you access to Lucee-specific settings for your account such as Lucee Datasources and other configuration options.
===Create a Lucee Datasource (DSN)===
#From within your control panel, click on the "Luce Web Administrator" icon
#Inside the Lucee Web Administrator click the "Datasources" link from the lefthand navigation menu.
#Select the database type, enter a name, and click ''Create''.
#Configure your datasource with all the correct server, username and password.
#*'''IMPORTANT''': If using MySQL also make sure the option for '''Alias Handling''' is enabled.
#Click the ''Create'' button, and your DSN will be available for use on your site.

==Security and SSL==
Installing a new certificate, or re-keying an existing certificate.

===Dedicated SSL===
'''VPS Hosting''' Request a static IP for sites added to your server which require SSL, we will provision the IP on the server and assign it in WCP for use with installing a Dedicated SSL.

'''Shared Hosting''' If ordering a new certificate from Hostek.com you will be assigned a static IP, if importing from another provider you will need to request a static IP be assigned before the certificate can be activated.

#Login to WCP, (select the domain, in some cases), Security and SSL, '''Dedicated SSL (click)'''
#Click '''Generate CSR (Certificate Signing Request)'''
#Fill in the requested information.
#Click Create
#Copy the '''Certificate Signing Request (CSR)''', which should be used when placing a new SSL order or re-keying an existing certificate.

===Shared SSL(shared hosting)===
#Login to WCP, (select the domain, in some cases), Security and SSL, '''Shared SSL (click)'''
#Click '''Enable'''
#The URL for your sites shared SSL will be provided.

===Manage IPs===
This tool allows you to specify if an IP is blocked or allowed, and whether your site is by default denying access.

To block an IP:
#Grab the IP you need blocked from a log or from an email
#In the Deny IPs tool click Add
#Paste or type in the IP
#Choose Block in the drop down menu (By default it's set to Block)
#Click Save

To block all IPs (Useful if your site is not live yet):
#Click the Settings tab at the top
#Open up the drop down menu next to Default Access
#Choose Block (By default this is Allow)

==Stats==
*SmarterStats provides very detailed traffic information about your site's day-to-day activities for up to 14-months.

===Enabling SmarterStats===
#Login to WCP here https://wcp.hostek.com/
#Click on the '''Stats''' button
#Click '''Enable SmarterStats'''
*This will start processing log information from now on, and will report it's findings for your review.

===Resetting a SmarterStats Account Password===
#Login to WCP here https://wcp.hostek.com/
#Click on the '''Stats''' button
#Select the '''Pencil''' icon on the left-side of the chosen user
#Type a new password in the password box and click '''Save'''
#Select '''Login''' (on the right-side of the chosen user)
#Type in the new password that was just setup and click '''Login'''

==Usage==
To view your account's quotas and how much resources you have available:
#Log in to WCP
#Click the '''Usage''' icon

Here you can see the limits and amount used for the following resources: '''Site Disk Space, Site Bandwidth, Mail Disk Space, MySQL Disk Space,''' and '''MS SQL Disk Space''' (if applicable)

==Cron Jobs==
To add Cron Jobs to your site:
#Log in to WCP
#Click on the Cron Jobs button under the ColdFusion section
#Click Add
#Enter a name
#Enter the URL to be executed
#Select a quick time interval or click advanced and set up your interval
#Click save

==VPS Manager (VPS Accounts)==

Overview of the '''VPS Manager''' section in the control panel.

===Service Groups===

The service groups section allows you to specify which services a domain should use when being created or when databases are added to the domain. If you only have a single VPS server, the default service group will usually be used for everything. However, if you have multiple servers, you can use this section to allow new domains to use services on both servers (I.E. Use one server for the website and another for the database). It is also possible to create service groups that offers fewer services in-case you want to create domains with no dns, no mail, or no website.

Options overview:
* '''Name''': A name you will use to reference this group of services when creating or modifying a domain
* '''Site Service''': The server on which the website for this domain will be created.
* '''Mail Service''': The server on which the mail account for this domain will be created.
* '''DNS Service''': The server on which the DNS zone for this domain will be created.
* '''MSSQL Service''': The server on which new MSSQL databases will be created.
* '''MySQL Service''': The server on which new MySQL databases will be created.

===Server Details===

This page gives a brief overview of resource resource usage on the server and the server's 'Computer Name' as configured in Windows.

===Firewall Management===
This page allows you to manage the Windows Firewall rules for some common ports.
[[File:Firewall mgmt.png]]

===Restricting Access to a Port===
If you wish to restrict access to a port on your VPS do the following
*Open the Firewall Management section within your control panel's VPS Manager
*Click the pencil icon (edit) next to the service you wish to secure ''(eg. SQL Server, MySQL, Remote Desktop)''
*In the window that appears, choose one of the following from the ''Port Status'' dropdown menu:
**'''Closed''': Prevent any public access to the port
**'''Restricted''': Only allow select IPs access to the port
*Click ''Save'' once you've made your changes. 
''Example: Restricting Access to SQL Server Port'' 
[[File:Firewall sql.png]]

===Service Manager===

This page allows you to start, restart, or stop some common services.

===Add Domain===

This page allows you to add new VPS domains.

===List Domains===

This page lists existing VPS domains and allows you to remove or modify them.

===Adding Static IPs===
#Click List Domains
#Click the Pencil icon next to the domain you want
#Under the IP click the drop down box (Note: you will need a static IP first. To order one, email support@hostek.com to request one added to your VPS)
#Click Save

[[Category:Control-Panels]]
[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:ColdFusion-VPS]]
[[Category:Railo-VPS]]
[[Category:Windows-VPS]]

Robots.txt

2015-03-25T18:41:39Z

Jakeh: /* Robots.txt File */

===Robots.txt File===
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. We suggest the following defaults, however you might want to add or remove the user agents denied, and adjust the crawl rate.
<pre style="white-space: pre-wrap">
User-agent: *
Crawl-delay: 2

User-agent: Baiduspider
Disallow: /

User-agent: Sosospider
Disallow: /
</pre>

[[Category:Windows]]
[[Category:ColdFusion]]
[[Category:Railo]]
[[Category:VPS]]

ColdFusion Tips & Tricks

2015-03-24T20:25:18Z

Jakeh: /* HTML5 Audio Player with ColdFusion */

==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 (X.509 format) file through the browser.
#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.
====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, 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.

'''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.

==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>

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

ColdFusion Tips & Tricks

2015-03-24T20:24:52Z

Jakeh: /* Reset ColdFusion Admin Password on CF 10+ VPS */

==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 (X.509 format) file through the browser.
#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.
====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, 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.

'''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.

===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>

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

Configuring php.ini

2015-03-17T22:00:52Z

Jakeh:

__FORCETOC__
==Configuring server-wide php.ini settings==
If you need to make adjustments to the php.ini file server-wide (affecting all sites on the VPS) then you could do this by logging into cPanel/WHM as root and clicking on the "PHP Configuration Editor".

==Creating a custom php.ini file==
Do not just create a blank php.ini file and add the settings you need. Doing this will ignore all of the other PHP configuration that was setup by the server such as extensions and modules. Be sure to copy the server's php.ini file and make the customizations in that file by following these steps.

If you need to make changes to php.ini for a specific site only follow these steps:
# SSH into the server
# Copy the server's php.ini file to the the site's public_html directory by running this command: <pre>cp /usr/local/lib/php.ini /home/username/public_html/</pre> *Replace username with the username of the site
# Edit the php.ini with your favorite text editor. For example: <pre>nano /home/username/public_html/php.ini</pre> and make the desired changes.
# Add the following to the /home/username/public_html/.htaccess file (create one if you don't have one): <pre> SetEnv PHPRC /home/username/public_html/php.ini</pre> *use the real path for your site

==Shared Hosting: Changing PHP settings for a site==
===cPanel===
You can change common PHP settings for a site within the ''Select PHP Version'' section of your cPanel account.

#Log into your cPanel account
#Click the '''Select PHP Version''' icon underneath the ''Software'' heading toward the bottom of the page
#On the next page, click the '''Switch To PHP Options''' link in the upper-right portion of the page
#On the PHP Options page, click the value you wish to edit.
#Enter the new value for the setting you wish to adjust
#Click the '''Save''' button at the bottom of the page
===Windows===
On our Windows-based shared hosting plans, you can enable custom PHP settings within the ''PHP Settings'' icon in your MochaPanel account.

#[https://wcp.hostek.com/ Log into your MochaPanel account]
#Click the '''PHP Settings''' icon under the ''Website Settings'' heading
#Click the '''Configuration''' button next to the site/subdomain to receive the new PHP settings
#Check the box for '''Custom php.ini'''
#Click the '''Save''' button

This will place a file named '''php.ini''' in your site's web root. You may edit that file to adjust specific PHP settings. If you do not see the new settings take effect immediately, try [[WCP_(Windows_based_Control_Panel)#Recycle_Application_Pool|recycling your site's application pool]].
[[Category:Linux-VPS]]
[[Category:Linux]]
[[Category:Windows]]

ColdFusion Tips & Tricks

2015-03-11T23:28:29Z

Jakeh: /* Scheduling Tasks in ColdFusion */

==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 (X.509 format) file through the browser.
#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.
====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, 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.

'''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

===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>

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

Lucee

2015-02-24T21:41:48Z

Jakeh: /* How do I access my Lucee Web Administator page? */

Cfwheels

2015-02-11T18:12:39Z

Jakeh: /* Installing CFWheels on ColdFusion / Railo */

__FORCETOC__
==Installing CFWheels on ColdFusion / Railo==
<ol>
<li>Download the latest version from http://cfwheels.org/download</li>
<li>Unzip the contents to a folder on your computer</li>
<li>'''Remove''' the ''web.config'' and ''IsapiRewrite4.ini'' files.</li>
<li>Edit the '''.htaccess''' with any plain text editor ''(I.E. notepad, wordpad, etc.)'' and replace the contents with the following:
<syntaxhighlight lang="apache">
RewriteEngine On

RewriteCond %{REQUEST_URI} !^.*/(flex2gateway|jrunscripts|cfide|cfformgateway|CFFileServlet|jakarta|railo-context|lucee|files|images|javascripts|miscellaneous|stylesheets|robots.txt|sitemap.xml|rewrite.cfm)($|/.*$) [NC]
RewriteRule ^(.*)$ /rewrite.cfm/$1 [L]
</syntaxhighlight></li>
<li>Setup a MySQL database and create a ColdFusion / Railo DSN for the database. Below are some tutorials on how to do this through your control panel:
<ul>
<li>[[WCP#MySQL_database|How to create a MySQL Database]]</li>
<li>[[WCP#Create_a_MySQL_or_MS_SQL_Server_DSN|How to create a ColdFusion DSN]]</li>
<li>[[WCP#Create_a_Railo_Datasource_.28DSN.29|How to create a Railo DSN]]</li>
</ul>
</li>
<li>Edit the '''config/settings.cfm''' file in a plain text editor and enter your datasource name and your database username and password. Also, remove the comments around that section:
 
''Example:''
<syntaxhighlight lang="cfm">
<cfset set(dataSourceName="MyDSNName")>
<cfset set(dataSourceUserName="MyDatabaseUsername")>
<cfset set(dataSourcePassword="MyDatabasePassword")>
</syntaxhighlight></li>
<li>Upload the files to your site. ''They must be inside the '''/wwwroot''' (Windows) or '''/public_html''' (cPanel/Linux) folder for URL rewriting to work properly.''</li>
</ol>
Browse to your site, and you should see the default CFWheels home page.

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

Lucee

2015-02-10T17:56:09Z

Jakeh: /* How do I create a datasource within Lucee? */

Lucee

2015-02-10T17:54:13Z

Jakeh:

File:Luceelogo.png

2015-02-10T17:50:09Z

Jakeh:

Lucee

2015-02-03T20:14:08Z

Jakeh: /* Coming Soon */

===Coming Soon===

We are preparing to support [http://lucee.org/ Lucee] in place of Railo, and our team is meeting about the finer points of this process. At this point that's the most detail we can provide, but we will post more info to our Server Status Page once we're ready to officially support '''Lucee'''.

*For your reference, our RSS Feed can be found here: https://hostek.com/serverstatus.asp
*This blog post covers a lot of questions related to Lucee: http://blog.adamcameron.me/2015/01/lucee.html

ColdFusion on Linux FAQs

2015-01-29T22:23:56Z

Jakeh: /* I unzipped an application like Mura, but its installer says it can't write to a folder. How do I fix this? */

__FORCETOC__
==I want to use cfhtmltopdf. Is the PDF Generation Service (PDFg) available?==
The <cfhmtltopdf> tag works on our Linux ColdFusion 11 servers, but it will only work for content generated within your application. At the moment there is an issue preventing the PDFg service from capturing PDFs of remote Web pages. If your application requires this functionality, please [https://support.hostek.com/ contact our support team] and ask to have your site moved to a Windows ColdFusion 11 server so you can capture PDFs of Web pages.

==How do I add a ColdFusion Datasource (DSN)?==
To add a ColdFusion Datasource (DSN) login to your cPanel account, then click the ''ColdFusion DSNs'' icon under the ''Databases'' section. Enter the info you used to create your database (the ''Server'' is ''localhost'' if you created the database in cPanel), then click the '''Create DSN''' button. Once the page has been submitted you'll be able to use the datasource within your ColdFusion application.

==I unzipped an application like Mura, but its installer says it can't write to a folder. How do I fix this?==
When unzipping an application or bundle of files through cPanel's File Manager, the folders will not automatically inherit the correct permissions for CF to write to subfolders.

If you're using Mura, the easiest way around this would be to use Softaculous within your cPanel account to install the Mura files to your account. You will still have to create a MySQL database and Datasource (DSN) within your control panel for Mura to use, but Softaculous will copy the files to your folder with the correct permissions in-place. Just click the Softaculous link within cPanel, search for Mura, and follow the directions to install it. Softaculous can also do this for ContentBox, and we will be adding more CFML applications to Softaculous over time.

Alternatively, you can just use your cPanel File Manager to edit the permissions on folders that need to be writable. Just click the folder, click the ''Change Permissions'' icon, and give the folder ''Group'' ''write'' permissions.

ColdFusion on Linux FAQs

2015-01-29T22:20:17Z

Jakeh: Created page with "__FORCETOC__ ==I want to use cfhtmltopdf. Is the PDF Generation Service (PDFg) available?== The <cfhmtltopdf> tag works on our Linux ColdFusion 11 servers, but it will only wo..."

Installing and Configuring FuseGuard

2015-01-29T21:25:46Z

Jakeh: /* If using Application.cfm */

==Installing the FuseGuard Web Application Firewall==
===Download Fuseguard===
To get started, [http://foundeo.com/security/eval/ | request an evaluation copy of FuseGuard] from the Foundeo Web site. Once approved, you'll receive an email containing a download link for Fuseguard.
===Installing FuseGuard on your Web Site===
====Extract FuseGuard====
*Once you've downloaded the FuseGuard ZIP file, extract it to your site's Web root.
====Create Database and Datasource====
*Next, create a MySQL or MS SQL Server database within your control panel.
**When creating the database, choose the option to create a ColdFusion datasource (DSN) for the database
 Now that you've created your database and DSN, we need to create the database schema. Follow the directions below for the database platform being used:
*'''MySQL'''
**Extract the ''sql/mysql.sql'' SQL file from the FuseGuard zip file to your computer.
**Log into your database via '''phpMyAdmin''' within your control panel
**Click your database name on the left-hand navigation within phpMyAdmin
**Click the '''Import''' tab at the top of the page
**On the next page, click the '''Choose file''' button then select the '''sql/mysql.sql''' file you extracted earlier.
**Click '''Go''' at the bottom of the page, and phpMyAdmin will create the tables for FuseGuard
*'''MS SQL Server'''
**Extract the ''sql/sqlserver.sql'' SQL file from the FuseGuard zip file to your computer.
**Log into your database via '''MyLittleAdmin''' within the SQL Tools section of your control panel
**Click the '''Tools''' link on the left-hand navigation, then click '''New Query'''
**Open the '''sql/sqlserver.sql''' SQL file you extracted earlier in a text editor such as Notepad or [http://notepad-plus-plus.org/download/v6.6.6.html Notepad++].
**Copy the text from the SQL file into the New Query window, then click '''Submit''' to have MyLittleAdmin create FuseGuard's tables.
====Create your FuseGuard Configurator====
Now we need to create a ''configurator'' for FuseGuard to use on your site. A configurator defines details about your FuseGuard installation such as what datasource to use and which firewall filters are in-place on the site.

To create your site's configurator, copy '''fuseguard/components/configurators/DefaultConfigurator.cfc''' to '''fuseguard/components/configurators/MyConfigurator.cfc''' on your site.

Now edit '''MyConfigurator.cfc''' (you can use the control panel's File Manager) and make the following changes:
*Set ''variables.email'' to your email address
*Set ''variables.datasource'' to the datasource (DSN) you created earlier
*Change ''variables.db_type'' from ''derby'' to the type of database you're using (''mysql'' or ''sqlserver'')

====Modify Application to utilize FuseGuard====
=====If using Application.cfc=====
If your site uses an Application.cfc file, you need to do two things:
*Add '''extends="fuseguard.components.FuseGuardApplication"''' to the ''cfcomponent'' tag
*Invoke ''fuseguard()'' within the ''onRequestStart()'' method

This example shows what the code will look like after both steps have been implemented:
<syntaxhighlight lang="cfm">
<cfcomponent extends="fuseguard.components.FuseGuardApplication">
<cffunction name="onRequestStart" returntype="boolean">
<cfset fuseguard(configurator="DefaultConfigurator", scope="application")>

<cfreturn true>
</cffunction>
</cfcomponent>
</syntaxhighlight>

'''''Note:''' Be sure not to have multiple onRequestStart() methods within your Application.cfc file''
=====If using Application.cfm=====
If your site uses an Application.cfm file, add the following code below the '''cfapplication''' tag:
<syntaxhighlight lang="cfm">
<cfif NOT IsDefined("application.fuseguard") OR application.fuseguard.shouldReInitialize()>
<cfinvoke component="fuseguard.components.firewall" method="init" returnvariable="application.fuseguard">
<cfinvokeargument name="configurator" value="MyConfigurator">
</cfinvoke>
</cfif>
<cfset application.fuseguard.processRequest()>
</syntaxhighlight>

After editing your Application.cfc/Application.cfm, you may log into the FuseGuard manager at http://yoursite.com/fuseguard/manager/ ''(user: admin, pass: admin)''

==Configuring FuseGuard==
===Disabling a FuseGuard Filter===
FuseGuard filters can be enabled/disabled as you wish. To do so, you'll need to edit your configurator then reload the configuration through the FuseGuard manager.
====Edit MyConfigurator.cfc====
*First, open ''MyConfigurator.cfc'' in a text editor. Anything below ~line 62 in this file is related to the filters enabled for your site.
*To disable a filter, find the section of code for the filter you want disabled, then surround the filter's code with ColdFusion comments.

For example:
<syntaxhighlight lang="cfm">


</syntaxhighlight>
====Reload Configuration====
*Once you've saved your changes to MyConfigurator.cfc, log into the FuseGuard manager at http://yoursite.com/fuseguard/manager/
*After logging into the manager, click the ''Configuration'' link at the top of the page.
*Click the '''Reinitialize and Reconfigure FuseGuard''' button to force-through your adjustments
[[File:Fuseguard-reloadconfig.png]]

==Related Resources==
*[http://foundeo.com/security/fuseguard/docs/2.4/ FuseGuard Documentation]
*[http://www.youtube.com/watch?v=ubESB87vl5U FuseGuard Installation and Usage video]
*[https://www.ortussolutions.com/products/fuseguard ColdBox/ContentBox FuseGuard Module]

Reset Coldfusion Password

2015-01-09T21:02:14Z

Jakeh: /* CF 10 Additional Options */

==Admin password reset==

You can reset your Coldfusion 8, ColdFusion 9, or Coldfusion 10 admin password by doing the following:

#Go to the ColdFusion installation directory (by default C:\ColdFusion8 or C:\ColdFusion9 or C:\ColdFusion10\cfusion\)
#Open the \Lib\ directory
#Locate the password.properties file and open this with notepad

* Make the following changes to the file, you will have to change the encrypted to false and then type a new password.
<pre>
#date/time
rdspassword=
password=TYPEYOURNEW-TEMPORARY-PASSWORDHERE
encrypted=FALSE
</pre>

*Save the file

===Restart CF and login===

#Restart the CF Application service. In cmd, type Services.msc or locate it in the Administrators Tools
#Once CF has restarted, login to CF Admin with the temporary password you set
#In Security, under administration, reset your password. The password.properties will set the password and encrypt it.

==CF 10 Additional Options==

* For ColdFusion 10 there is alternative option. Go t C:\ColdFusion10\cfusion\bin\ and run the passwordreset.bat (NOTE: leave RDS password blank)
** Full details and instructions are [[ColdFusion_Tips_%26_Tricks#Reset_ColdFusion_Admin_Password_on_CF_10.2B_VPS|here]].

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

SQL Injection

2014-11-18T23:25:31Z

Jakeh: /* ColdFusion - Prevent SQL Injection with cfqueryparam */

__FORCETOC__
==Tips on Preventing SQL Injection Attacks==

To sanitize form input for sending to a database, always be sure to escape the single quote by searching and replacing it with two single quotes. This will cause the database to send the quote string as a literal character rather than interpreting it as the closing of a string. Be aware, however, that since numeric input does not require quotes, this technique will not be effective. In the case of numeric input, simply check that the form input is indeed numeric.

One method of preventing SQL injection is to avoid the use of dynamically generated SQL in your code. By using parameterized queries and stored procedures, you then make it impossible for SQL injection to occur against your application.

<ul><li>Escape single quotation marks. Include code within your Web applications that replaces single apostrophes with double apostrophes. This will force the database server to recognize the apostrophe as a literal character rather than a string delimiter.</li><li>Filter user input. Filtering user input before it is passed into a SQL query will prevent the possibility of executing SQL commands. (ex. Strip input strings of all characters that are not alphanumeric (a-z, A-Z or 0-9))</li><li>Limit the privileges available to the account that executes Web application code. For example, if an account only had permission to perform the intended action (retrieving records from a table), then delete, insert or create queries would not be possible.</li><li>Reduce or eliminate debugging information. When an error condition occurs on your server, the Web user should not see technical details of the error. This type of information could aid an intruder seeking to explore the structure of your database.</li></ul>

*Note to PHP users connecting to MySQL databases

There are at least two ways to make MySQL queries safe using PHP. The first, and often simplest, method is to use mysql_real_escape_string on each variable used in a MySQL query. Please see the <a href="http://php.net/mysql_real_escape_string">PHP documentation</a> for more information.

The second method is to use prepared statements. You can do this using the MySQL Improved Extension in PHP 5. For more information, please refer to the <a href="http://php.net/manual/en/book.mysqli.php">PHP documentation</a> for more information.

===ColdFusion - Prevent SQL Injection with cfqueryparam===
By using cfqueryparam you can prevent SQL injection into your database via un-sanitized input.

Here is some sample code that is not safe:
<pre>
<cfquery name="myQueryName" DATASOURCE="#Application.MyDSN#">
INSERT INTO myTable(customer_fname) VALUES ('#form.customer_fname#')
</cfquery>
</pre>

The example above clearly just takes input from a form and inserts it into the database. That is VERY dangerous.

Instead, here is a the proper way to do this, by sanitizing the form input with cfqueryparam:
<pre>
<cfquery name="myQueryName" DATASOURCE="#Application.MyDSN#">
INSERT INTO myTable(customer_fname) VALUES (<cfqueryparam value='#form.customer_fname#' cfsqltype="cf_sql_varchar">)
</cfquery>
</pre>

NOTE: It is important to match the [https://wikidocs.adobe.com/wiki/display/coldfusionen/cfqueryparam cfsqltype] value with the proper data type for that field.

==Cleaning your MS SQL Database after a SQL Injection Attack==
To clean a MSSQL Database from SQL Injection, a Stored Procedure can be used.

1. Using SQL Server Management Studio, copy and paste the code below into the SQL tool and execute. This will create the SearchAndReplace stored procedure that will allow you to clean your MSSQL Database.
<pre>CREATE PROC SearchAndReplace
(
@SearchStr nvarchar(100),
@ReplaceStr nvarchar(100)
)
AS
BEGIN

-- Copyright c 2002 Narayana Vyas Kondreddi. All rights reserved.
-- Purpose: To search all columns of all tables for a given search string and replace it with another string
-- Written by: Narayana Vyas Kondreddi
-- Site: http://vyaskn.tripod.com
-- Tested on: SQL Server 7.0 and SQL Server 2000
-- Date modified: 2nd November 2002 13:50 GMT

SET NOCOUNT ON

DECLARE @TableName nvarchar(256), @ColumnName nvarchar(128), @SearchStr2 nvarchar(110), @SQL nvarchar(4000), @RCTR int
SET @TableName = ''
SET @SearchStr2 = QUOTENAME('%' + @SearchStr + '%','''')
SET @RCTR = 0

WHILE @TableName IS NOT NULL
BEGIN
SET @ColumnName = ''
SET @TableName =
(
SELECT MIN(QUOTENAME(TABLE_SCHEMA) + '.' + QUOTENAME(TABLE_NAME))
FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_TYPE = 'BASE TABLE'
AND QUOTENAME(TABLE_SCHEMA) + '.' + QUOTENAME(TABLE_NAME) > @TableName
AND OBJECTPROPERTY(
OBJECT_ID(
QUOTENAME(TABLE_SCHEMA) + '.' + QUOTENAME(TABLE_NAME)
), 'IsMSShipped'
) = 0
)

WHILE (@TableName IS NOT NULL) AND (@ColumnName IS NOT NULL)
BEGIN
SET @ColumnName =
(
SELECT MIN(QUOTENAME(COLUMN_NAME))
FROM INFORMATION_SCHEMA.COLUMNS
WHERE TABLE_SCHEMA = PARSENAME(@TableName, 2)
AND TABLE_NAME = PARSENAME(@TableName, 1)
AND DATA_TYPE IN ('char', 'varchar', 'nchar', 'nvarchar')
AND QUOTENAME(COLUMN_NAME) > @ColumnName
)

IF @ColumnName IS NOT NULL
BEGIN
SET @SQL= 'UPDATE ' + @TableName +
' SET ' + @ColumnName
+ ' = REPLACE(' + @ColumnName + ', '
+ QUOTENAME(@SearchStr, '''') + ', ' + QUOTENAME(@ReplaceStr, '''') +
') WHERE ' + @ColumnName + ' LIKE ' + @SearchStr2
EXEC (@SQL)
SET @RCTR = @RCTR + @@ROWCOUNT
END
END
END

SELECT 'Replaced ' + CAST(@RCTR AS varchar) + ' occurence(s)' AS 'Outcome'
END

GO</pre>

2. Within Management Studio type or copy/paste the following to replace all occurrences of '<script>badurl.com<script>' with '':
<pre>EXEC SearchAndReplace '<script>badurl.com<script>', ''</pre>

3. Execute the command above, note for smaller databases this will run quickly but for larger databases it could take a long time to complete.
[[category:Databases-MySQL]]

ColdFusion Tips & Tricks

2014-11-14T18:42:18Z

Jakeh: /* Per-application Robust Exception Information Settings */

==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 (X.509 format) file through the browser.
#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.
====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">









</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>

'''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, 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.

'''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

===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>

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

Enable Detailed Errors

2014-11-10T18:41:21Z

ColdFusion Tips & Tricks

2014-11-06T23:25:29Z

Jakeh:

==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>

'''Note:''' If your site uses ''Application.'''cfm''''' instead of ''Application.'''cfc''''', just add the above code to the top of the CFML template generating an error.

==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 (X.509 format) file through the browser.
#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.
====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">









</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>

'''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, 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.

'''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

===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>

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

Upgrading ColdFusion

2014-11-06T18:19:17Z

Jakeh: /* Post-Upgrade: Upgrade the IIS connector */

__FORCETOC__
==Upgrading ColdFusion 10+==
===Upgrading ColdFusion 10+ to the latest version===
In our experience it is most reliable to download the latest cumulative update through ColdFusion Administrator, then manually execute the update from the command line. Follow these steps to apply ColdFusion updates from the command line on your server:
====Step 1 - Install Java if not already installed====
Your VPS may be using the built-in Java JRE bundled with ColdFusion, but it is a good idea to use a separate version of Java for installing ColdFusion updates. You may download the latest version of Java from Oracle: [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html Java SE Development Kit 8 Downloads]

At the download page accept the license agreement, then download the appropriate version for your operating system. Most likely, you'll want the 64-bit version for your OS. During installation, it is a good idea to only install the development tools; the source code and public JRE are not needed. [[File:Jdk-options.png]]
====Step 2 - Ensure Java Bin Folder is in System Path====
#To check your path first open your system properties by right-clicking your VPS's '''Computer''' icon in '''Windows Explorer''', then clicking '''Propteries'''. [[File:Cf10updates-01.png]]
#In the window that opens, click the '''Advanced System Settings''' link off to the left. [[File:Cf10updates-02.png]]
#In the popup that appears, click the '''Environment Variables''' button toward the bottom right. [[File:Cf10updates-03.png]]
#In the next popup, select the '''Path''' variable under '''System Variables''', then click '''Edit'''. [[File:Cf10updates-04.png]]
#In the next popup, check the '''Variable value''' textbox to see if the path to a Java bin folder exists. If not, add a semicolon to the end of the line, followed by the path to your Java bin folder. For example, if you just installed Java as described above, you'd add a path like this: <pre>C:\Program Files\Java\jdk1.8.0_25\bin\</pre>[[File:Winpath.png]] 

Once you've updated your system's PATH variable, you can click OK on all the popup windows to save your changes.

====Step 3 - Download the ColdFusion Update====
#Log into ColdFusion Administrator for your server
#Navigate to the '''Server Update'''-->'''Updates''' section
##If you do not see an available update, click the '''Check for Updates''' button
##If you see an available update, click the '''Download''' button [[File:Cf10-update14.png]]
#ColdFusion will download the file to '''''<cf_home>''/hf-updates/''' (eg. C:\ColdFusion10\cfusion\hf-updates)
====Step 4 - Run the Update Installer====
#Stop ColdFusion. This will help ensure the update will install properly.
#Open a command prompt window on your server as ''Administrator''. You can do this by right-clicking on the ''CMD'' icon in the Start Menu, then choosing ''Run As Administrator''
#Navigate to the location where ColdFusion downloaded your update. ''CF 10 Example:'' <pre>cd c:\ColdFusion10\cfusion\hf-updates</pre> ''CF 11 Example:'' <pre>cd c:\ColdFusion11\cfusion\hf-updates</pre>
#Launch your update via the following command: <pre>javaw -jar hotfix_0XX.jar</pre> (replace '''0XX''' with the actual update number)
#Your CF update will be launched in a GUI. Just follow the prompts to install the update, and it will take care of the rest. If you are running a multi-instance ColdFusion server, ensure the boxes for all your instances are checked, and the updater will patch each instance automatically for you.

Once the update has completed, just log into ColdFusion Administrator and go back to the Server Updates section. If it shows the update you applied in the '''Installed Updates''' tab, your ColdFusion installation has been updated successfully.

===Post-Upgrade: Upgrade the IIS connector===
The ColdFusion to IIS connector must be upgraded after applying most ColdFusion 10+ updates. After applying the latest update for ColdFusion 10 or 11, perform the following steps:
#Open a command prompt as ''Administrator''
#Navigate to ''<cf_home>''\cfusion\runtime\bin: ''CF 10 Example:''<pre>cd C:\ColdFusion10\cfusion\runtime\bin</pre> ''CF 11 Example:''<pre>cd C:\ColdFusion11\cfusion\runtime\bin</pre>
#Open 'wsconfig.exe', issuing it the upgrade parameter: <pre>.\wsconfig.exe -ws iis -site 0 -upgrade -v</pre>

The tool will restart IIS, then you'll be able to continue using ColdFusion.

===ColdFusion 10 Mandatory Update===
If you happen to have a server on Coldfusion 10 version 282462 or earlier, you will first need to apply the ColdFusion 10 Mandatory Update first. Follow these steps to complete the installation:
#[http://download.macromedia.com/pub/coldfusion/10/cf10_mdt_updt.jar Download the JAR file] for the update from Adobe.
#On your server, open a command prompt as '''Administrator''' then navigate to the folder containing the update's JAR file.
#Launch the JAR with this command: <pre>java -jar cf10_mdt_updt.jar</pre>
#Follow the installer's instructions, and the update will complete in a couple minutes.

Once the mandatory update has been installed, you'll be able to proceed through the update instructions above.
[[Category:ColdFusion]]
[[Category:ColdFusion-VPS]]

Upgrading ColdFusion

2014-11-06T18:12:00Z

Jakeh:

__FORCETOC__
==Upgrading ColdFusion 10+==
===Upgrading ColdFusion 10+ to the latest version===
In our experience it is most reliable to download the latest cumulative update through ColdFusion Administrator, then manually execute the update from the command line. Follow these steps to apply ColdFusion updates from the command line on your server:
====Step 1 - Install Java if not already installed====
Your VPS may be using the built-in Java JRE bundled with ColdFusion, but it is a good idea to use a separate version of Java for installing ColdFusion updates. You may download the latest version of Java from Oracle: [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html Java SE Development Kit 8 Downloads]

At the download page accept the license agreement, then download the appropriate version for your operating system. Most likely, you'll want the 64-bit version for your OS. During installation, it is a good idea to only install the development tools; the source code and public JRE are not needed. [[File:Jdk-options.png]]
====Step 2 - Ensure Java Bin Folder is in System Path====
#To check your path first open your system properties by right-clicking your VPS's '''Computer''' icon in '''Windows Explorer''', then clicking '''Propteries'''. [[File:Cf10updates-01.png]]
#In the window that opens, click the '''Advanced System Settings''' link off to the left. [[File:Cf10updates-02.png]]
#In the popup that appears, click the '''Environment Variables''' button toward the bottom right. [[File:Cf10updates-03.png]]
#In the next popup, select the '''Path''' variable under '''System Variables''', then click '''Edit'''. [[File:Cf10updates-04.png]]
#In the next popup, check the '''Variable value''' textbox to see if the path to a Java bin folder exists. If not, add a semicolon to the end of the line, followed by the path to your Java bin folder. For example, if you just installed Java as described above, you'd add a path like this: <pre>C:\Program Files\Java\jdk1.8.0_25\bin\</pre>[[File:Winpath.png]] 

Once you've updated your system's PATH variable, you can click OK on all the popup windows to save your changes.

====Step 3 - Download the ColdFusion Update====
#Log into ColdFusion Administrator for your server
#Navigate to the '''Server Update'''-->'''Updates''' section
##If you do not see an available update, click the '''Check for Updates''' button
##If you see an available update, click the '''Download''' button [[File:Cf10-update14.png]]
#ColdFusion will download the file to '''''<cf_home>''/hf-updates/''' (eg. C:\ColdFusion10\cfusion\hf-updates)
====Step 4 - Run the Update Installer====
#Stop ColdFusion. This will help ensure the update will install properly.
#Open a command prompt window on your server as ''Administrator''. You can do this by right-clicking on the ''CMD'' icon in the Start Menu, then choosing ''Run As Administrator''
#Navigate to the location where ColdFusion downloaded your update. ''CF 10 Example:'' <pre>cd c:\ColdFusion10\cfusion\hf-updates</pre> ''CF 11 Example:'' <pre>cd c:\ColdFusion11\cfusion\hf-updates</pre>
#Launch your update via the following command: <pre>javaw -jar hotfix_0XX.jar</pre> (replace '''0XX''' with the actual update number)
#Your CF update will be launched in a GUI. Just follow the prompts to install the update, and it will take care of the rest. If you are running a multi-instance ColdFusion server, ensure the boxes for all your instances are checked, and the updater will patch each instance automatically for you.

Once the update has completed, just log into ColdFusion Administrator and go back to the Server Updates section. If it shows the update you applied in the '''Installed Updates''' tab, your ColdFusion installation has been updated successfully.

===Post-Upgrade: Upgrade the IIS connector===
The ColdFusion to IIS connector must be upgraded after applying a ColdFusion 10 Update. After applying the latest update for ColdFusion 10, perform the following steps:
#Open a command prompt as ''Administrator''
#Navigate to ''<cf_home>''\cfusion\runtime\bin: ''CF 10 Example:''<pre>cd C:\ColdFusion10\cfusion\runtime\bin</pre> ''CF 11 Example:''<pre>cd C:\ColdFusion11\cfusion\runtime\bin</pre>
#Open 'wsconfig.exe', issuing it the upgrade parameter: <pre>.\wsconfig.exe -ws iis -site 0 -upgrade -v</pre>

The tool will restart IIS, then you'll be able to continue using ColdFusion.

===ColdFusion 10 Mandatory Update===
If you happen to have a server on Coldfusion 10 version 282462 or earlier, you will first need to apply the ColdFusion 10 Mandatory Update first. Follow these steps to complete the installation:
#[http://download.macromedia.com/pub/coldfusion/10/cf10_mdt_updt.jar Download the JAR file] for the update from Adobe.
#On your server, open a command prompt as '''Administrator''' then navigate to the folder containing the update's JAR file.
#Launch the JAR with this command: <pre>java -jar cf10_mdt_updt.jar</pre>
#Follow the installer's instructions, and the update will complete in a couple minutes.

Once the mandatory update has been installed, you'll be able to proceed through the update instructions above.
[[Category:ColdFusion]]
[[Category:ColdFusion-VPS]]

Upgrading ColdFusion

2014-11-06T18:03:33Z

Jakeh: /* Upgrading ColdFusion 10+ to the latest version */

__FORCETOC__
==Upgrading ColdFusion 10==
===Upgrading ColdFusion 10+ to the latest version===
In our experience it is most reliable to download the latest cumulative update through ColdFusion Administrator, then manually execute the update from the command line. Follow these steps to apply ColdFusion updates from the command line on your server:
====Step 1 - Install Java if not already installed====
Your VPS may be using the built-in Java JRE bundled with ColdFusion, but it is a good idea to use a separate version of Java for installing ColdFusion updates. You may download the latest version of Java from Oracle: [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html Java SE Development Kit 8 Downloads]

At the download page accept the license agreement, then download the appropriate version for your operating system. Most likely, you'll want the 64-bit version for your OS. During installation, it is a good idea to only install the development tools; the source code and public JRE are not needed. [[File:Jdk-options.png]]
====Step 2 - Ensure Java Bin Folder is in System Path====
#To check your path first open your system properties by right-clicking your VPS's '''Computer''' icon in '''Windows Explorer''', then clicking '''Propteries'''. [[File:Cf10updates-01.png]]
#In the window that opens, click the '''Advanced System Settings''' link off to the left. [[File:Cf10updates-02.png]]
#In the popup that appears, click the '''Environment Variables''' button toward the bottom right. [[File:Cf10updates-03.png]]
#In the next popup, select the '''Path''' variable under '''System Variables''', then click '''Edit'''. [[File:Cf10updates-04.png]]
#In the next popup, check the '''Variable value''' textbox to see if the path to a Java bin folder exists. If not, add a semicolon to the end of the line, followed by the path to your Java bin folder. For example, if you just installed Java as described above, you'd add a path like this: <pre>C:\Program Files\Java\jdk1.8.0_25\bin\</pre>[[File:Winpath.png]] 

Once you've updated your system's PATH variable, you can click OK on all the popup windows to save your changes.

====Step 3 - Download the ColdFusion Update====
#Log into ColdFusion Administrator for your server
#Navigate to the '''Server Update'''-->'''Updates''' section
##If you do not see an available update, click the '''Check for Updates''' button
##If you see an available update, click the '''Download''' button [[File:Cf10-update14.png]]
#ColdFusion will download the file to '''''<cf_home>''/hf-updates/''' (eg. C:\ColdFusion10\cfusion\hf-updates)
====Step 4 - Run the Update Installer====
#Stop ColdFusion. This will help ensure the update will install properly.
#Open a command prompt window on your server as ''Administrator''. You can do this by right-clicking on the ''CMD'' icon in the Start Menu, then choosing ''Run As Administrator''
#Navigate to the location where ColdFusion downloaded your update. ''CF 10 Example:'' <pre>cd c:\ColdFusion10\cfusion\hf-updates</pre> ''CF 11 Example:'' <pre>cd c:\ColdFusion11\cfusion\hf-updates</pre>
#Launch your update via the following command: <pre>javaw -jar hotfix_0XX.jar</pre> (replace '''0XX''' with the actual update number)
#Your CF update will be launched in a GUI. Just follow the prompts to install the update, and it will take care of the rest. If you are running a multi-instance ColdFusion server, ensure the boxes for all your instances are checked, and the updater will patch each instance automatically for you.

Once the update has completed, just log into ColdFusion Administrator and go back to the Server Updates section. If it shows the update you applied in the '''Installed Updates''' tab, your ColdFusion installation has been updated successfully.

===Post-Upgrade: Upgrade the IIS connector===
The ColdFusion to IIS connector must be upgraded after applying a ColdFusion 10 Update. After applying the latest update for ColdFusion 10, perform the following steps:
#Open a command prompt as ''Administrator''
#Navigate to C:\ColdFusion10\cfusion\runtime\bin: <code>cd C:\ColdFusion10\cfusion\runtime\bin</code>
#Open 'wsconfig.exe', issuing it the upgrade parameter: <code>.\wsconfig.exe -ws iis -site 0 -upgrade -v</code>

The tool will restart IIS, then you'll be able to continue using ColdFusion.

===ColdFusion 10 Mandatory Update===
If you happen to have a server on Coldfusion 10 version 282462 or earlier, you will first need to apply the ColdFusion 10 Mandatory Update first. Follow these steps to complete the installation:
#[http://download.macromedia.com/pub/coldfusion/10/cf10_mdt_updt.jar Download the JAR file] for the update from Adobe.
#On your server, open a command prompt as '''Administrator''' then navigate to the folder containing the update's JAR file.
#Launch the JAR with this command: <pre>java -jar cf10_mdt_updt.jar</pre>
#Follow the installer's instructions, and the update will complete in a couple minutes.

Once the mandatory update has been installed, you'll be able to proceed through the update instructions above.
[[Category:ColdFusion]]
[[Category:ColdFusion-VPS]]