ColdFusion Administrator API Reference

Apart from modifying Administrator settings from the ColdFusion Administrator portal, you can also change the settings using the Admin APIs.

ColdFusion provides the APIs that are located in the location (<CF Directory>\cfusion\wwwroot\CFIDE\adminapi).

Using the CFCs shown below, you can modify the Administrator settings and properties.

Access Manager CFC

Provides functions to check whether the current user has the access rights required for invoking functions.

canAccessPage

Indicates whether or not the current user can access the specified page.

Output: suppressed

Parameters:
page: string, required, page to be accessed by the user.

checkAdminRoles

Checks whether the current user is in the list of required administrative roles, else throws an error.

Output: suppressed

Parameters:
requiredRoles: any, optional, requiredRoles - List of required roles. 
checkAllRoles: boolean, optional, checkAllRoles 

checkRootAdminUser

Checks whether the current user is the root admin user, else throws an error.

Output: suppressed

Administrator CFC

The Administrator CFC provides methods for basic Administrator functionalities, such as, login, logout, Migration Wizard, and Setup Wizard.

* - private method

checkValidUpdate

Parameters:

• item: struct, required, item 
• version: string, required, version 
• updates: any, required, updates 

createStruct

Parameters:

item: any, optional, item 

getAdminProperty

Returns Migration Wizard or Setup Wizard status.

Output: suppressed

Parameters:
propertyName: any, required, propertyName - Migration or setup flag to be returned. Valid Properties are:

• migrationFlag
• MXMigrationFlag
• SetupWizardFlag
• SecureProfileFlag
• migrateCF10
• migrateCF9
• setupSampleApps
• setupOdbc
• setupEnableRds

getBuildNumber

Returns the build number.

getMigrateCFPrev2Flag

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMigrateCFPrev3Flag

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMigrateCFPrevFlag

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMigrationFlag

Indicates whether the ColdFusion Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMXMigrationFlag

Indicates whether the ColdFusion MX to ColdFusion 8 Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSalt

Get salt from server for Administrator login.

getSecureProfileFlag

Indicates whether the Secure profile should be enabled or not when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSetupEnableRDS

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSetupOdbc

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSetupSampleApps

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSetupWizardFlag

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getUpdateCount

Returns number of updates available for the server.

getUpdates

Returns List of Available Updates For ColdFusion Server

Output: suppressed

Parameters:
   filter: boolean, optional, filter - Flag to specify whether to filter out any updates not relevant for current server 
   throwOnError: boolean, optional, throwOnError - Flag to specify whether to throw exception on error

login

Authenticates the user for the length of the request. Required before accessing other methods of the Administrator API. Returns true if login successful.

Output: suppressed

Parameters:
   adminPassword: any, required, adminPassword - ColdFusion Administrator password. 
   adminUserId: any, optional, adminUserId - ColdFusion Administrator User Id 
   rdsPasswordAllowed: any, optional, rdsPasswordAllowed - Allow the user to login and access the adminapi with the RDS password. 
   isHashed: any, optional, isHashed - Set it to true if the password sent is already hashed once.

logout

Logout from the Administrator API.

setAdminProperty

Sets Migration Wizard or Setup Wizard status.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName - Migration or setup flag to be set. Valid properties are:

• migrationFlag
• MXMigrationFlag
• SetupWizardFlag
• SecureProfileFlag
• migrateCF10
• migrateCF9
• setupSampleApps
• setupOdbc
• setupEnableRds

    propertyValue: any, required, propertyValue - Value for the migration or setup flag. Specify yes or no. 

setMigrateCFPrev2Flag

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No. 

setMigrateCFPrev3Flag

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No.

setMigrateCFPrevFlag

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No.

setMigrationFlag

Specifies whether the ColdFusion 5 to ColdFusion Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No. 

setMXMigrationFlag

Specifies whether the ColdFusion MX to ColdFusion 8 Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No.

setSecureProfileFlag

Specifies whether the Secure profile should be enabled or not when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No.

setSetupEnableRDS

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No.

setSetupOdbc

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No.

setSetupSampleApps

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No. 

setSetupWizardFlag

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
   flag: boolean, required, flag - Yes or No.

Base CFC

Base object for other Admin API CFCs.

dump

Used to debug variables inside of cfscript.

Output: enabled
Parameters:
   value: any, required, value - ColdFusion variable or scope to display. 
   expand: any, optional, expand - Expand views, yes or no (Internet Explorer and Mozilla only).

getEdition

Returns the edition:

• Developer
• Evaluation
• Enterprise
• Professional

Output: suppressed

getInstallType

Returns the install type.

Output: suppressed

isAdminUser

Check to see if user is authenticated.

Output: suppressed
Parameters:
   requiredRoles: any, optional, requiredRoles - List of required roles.

logaudit

Used for log auditing information for admin api.

Output: suppressed
Parameters:
   msg: any, required, msg - message to log. 
   isapplication: any, optional, isapplication - if message is application level.

tfformat

Indicates whether a passed value is of data type Boolean.

Output: suppressed
Parameters:
    val : any, required, val - Value to be checked.

throw

Used to throw errors in a cfscript block.

Output: suppressed
Parameters:
   message: any, optional, message - A message that describes the error. 
   type: any, optional, type 

Collections CFC

Manages collections migration from verity to solr.

disableTermHighlighting

Output: suppressed

Parameters:
   solrCollectionName: any, required, solrCollectionName - Name of Solr Collection to disable term highlighting for entire document. 

enableTermHighlighting

Enable term highlighting for the entire document for a Solr collection.

Output: suppressed
Parameters:
   solrCollectionName: any, required, solrCollectionName - Name of Solr Collection to enable term highlighting for entire document.

getSolrserver

Gets the solr  client for solr server.

Output: suppressed

isTermHighlightingEnabled

Return true if term highlighting for entire document is enabled for a Solr collection.

Output: suppressed
Parameters:
   solrCollectionName: any, required, solrCollectionName - Name of Solr Collection.

reloadCollection

Reload a Solr collection.

Output: suppressed
Parameters:
   solrCollectionName: any, required, solrCollectionName - Name of Solr Collection to be reloaded.

Datasource CFC

Add, modify, and delete ColdFusion data sources.

checkAllowedFileExtensions

Checks if an extension is allowed or not.

Output: suppressed
Parameters:
    ext : string, required, ext 

deleteDatasource

Deletes the specified data source.

Output: suppressed
Parameters:
   dsnname: any, required, dsnname - The name of the data source to be deleted.

formatJdbcURL

Formats the JDBC URL.

Output: suppressed
Parameters:
   driver: any, required, driver - JDBC driver. 
   host: any, optional, host - Machine to connect to. 
   port: any, optional, port - Port number on which the server is listening. 
   dsn: any, optional, dsn - Name that ColdFusion uses to connect to the data source. 
   database: any, optional, database - Name of database to access. 
   datasource: any, optional, datasource - Actual name of data source. 
   args: any, optional, args - Semicolon-separated list of arguments. 
   informixServer: any, optional, informixServer - Informix server name. 
   selectMethod: any, optional, selectMethod - Name of method for SELECT statement. 
   SID: any, optional, SID - Database system ID name. 
   MaxPooledStatements: any, optional, MaxPooledStatements - Maximum number of database statements to pool. 
   isnewdb: any, optional, isnewdb 
   qTimeout: any, optional, qTimeout - Query timeout value for all the statements created by the connection. 
   applicationintent: any, optional, applicationintent - Query timeout value for all the statements created by the connection. 

getAccessDefaultsFromRegistry

Retrieves Microsoft Access default values from Windows registry.

Output: suppressed
Parameters:
   scope: any, required, scope - Arguments scope to receive default values. 
   dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source.

getCFSettingDefaults

Gets the cfsetting defaults to the arguments scope that is passed.

Output: suppressed
Parameters:
   scope: any, required, scope - Scope - any structure (user-defined, form, URL, etc.)

getDatasourceDefaults

Gets the DSN defaults to the arguments scope that is passed in.

Output: suppressed
Parameters:
   scope: any, required, scope - Scope - any structure (user-defined, form, URL, etc.) 
   dsn: any, required, dsn - Data source name.

getDatasources

Returns a structure containing all data sources or a specified data source.

Output: suppressed
Parameters:
   dsnname: any, optional, dsnname - The name of the data source for which a structure is returned.

getDriverDefaults

Gets the driver defaults to the arguments scope that is passed in.

Output: suppressed
Parameters:
   scope: any, required, scope - Scope - any structure (user-defined, form, URL, etc.) 

getDriverDetails

Returns a structure containing all drivers

Output: suppressed
Parameters:
   driverName: String, optional, driverName - Name of the driver, if this is passed details of only that driver is returned

getNewDSNDefaults

Gets the data source defaults to the arguments scope that is passed in.

Output: suppressed
Parameters:
   scope: any, required, scope - Scope - Any structure (user-defined, form, URL, etc.)

getSlsAgentServiceName

Returns the name of the ODBC server agent.

Output: suppressed

getSlsServerPath

Returns the path/filename of the ODBC Sequelink INI file.

Output: suppressed

getSlsServerServiceName

Returns the ODBC Server service name.

Output: suppressed

getURLDefaults

Returns URL default values.

Output: suppressed
Parameters:
   scope: any, required, scope - Arguments scope to receive URL default values. 
   driver: any, optional, driver - Driver name, 
    delims : any, required, delims - Delimiters.

installOdbcService

Installs ODBC service.

Output: suppressed

removeOdbcService

Removes ODBC service.

Output: suppressed

setDB2

Creates or modifies a DB2 data source. Refer to the ColdFusion documentation or ColdFusion Administrator online Help for a list of supported DB2 versions.

Output: suppressed
Parameters:
    name:  string, required, name - ColdFusion data source name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Name of database on the server. 
   originaldsn: string, optional, originaldsn - Original ColdFusion data source name (use if you are renaming this data source). 
   port: string, optional, port - Port used to access the database server. The default is 50000. 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - Fully qualified JDBC driver class name. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - Data source description. 
   initargs: string, optional, initargs - Initialization connection string arguments, formatted (arg1=arg1value;arg2=arg2value). 
   args: string, optional, args - Connection string arguments, formatted (arg1=arg1value;arg2=arg2value). 
   MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Limit the number of data source connections to the value specified in the maxconnections argument. 
    maxconnections : numeric, optional, maxconnections - The maximum number of data source connections; used if you specify True for the enablemaxconnections argument. 
   pooling: boolean, optional, pooling - Enable server connection pooling for the data source. 
   disable: boolean, optional, disable - Disable connections to data sources. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements 
    alter : boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   vendor: string, optional, vendor - Always DB2. 
   type: string, optional, type - Always ddtek . 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource  
   spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource  
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection . 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection . 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection . 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. 

setDerbyClient

Creates or modifies an Apache Derby Client data source.

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion datasource name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Database name that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
   enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
   maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
   storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   port: string, optional, port 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
   clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. 

setDerbyEmbedded

Creates or modifies an Apache Derby Embedded data source.

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion datasource name. 
   database: string, required, database - Fully qualified path to the folder containing the Derby database. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
    isnewdb : boolean, optional, isnewdb - Indicates whether the database needs to be created 
    timeout : numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
    maxconnections : numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
    maxpooledstatements : numeric, optional, maxpooledstatements - Maximum number of pooled statements. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection . 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection . 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection . 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setInformix

Creates or modifies an Informix data source.

Output: suppressed
Parameters:
   vendor: string, optional, vendor - Always Informix. 
   type: string, optional, type - Always ddtek . 
    name:  string, required, name - ColdFusion data source name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Name of database on the server. 
   InformixServer: string, required, InformixServer - Name of the Informix server that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - Original ColdFusion data source name (use if you are renaming this data source). 
   port: string, optional, port - Port used to access the database server. The default is 1526. 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC driver class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - Data source description. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Limit the number of data source connections to the value specified in the maxconnections argument. 
    maxconnections : numeric, optional, maxconnections - The maximum number of data source connections; used if you specify True for the enablemaxconnections argument. 
   pooling: boolean, optional, pooling - Enable server connection pooling for the data source. 
   disable: boolean, optional, disable - Disable connections to data sources. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. 
   useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource  
   spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource  
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setJNDI

Creates a ColdFusion datasource that points to an already exsiting JNDI datasource

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion datasource name. 
    jndiname : string, required, jndiname - URL of the JNDI datasource  
    driver : string, optional, driver 
    type : string, optional, type - J2EE datasource  
    originalds n: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - Description of this data source connection. 
    jndienv : string, optional, jndienv - JNDI environment settings 
    buffer : numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements.

setMSAccess

Creates or modifies a Microsoft Access data source.

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion data source name. 
   databasefile: string, required, databasefile - Fully qualified path to the file containing the Access MDB file. 
   originaldsn: string, optional, originaldsn - Original ColdFusion data source name (use if you are renaming this data source). 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - Fully qualified JDBC driver class name. 
   port: string, optional, port - Port used to access the database server. The default is 20004. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
   encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - Data source description. 
   args: string, optional, args - Connection string arguments, formatted (arg1=arg1value;arg2=arg2value). 
   systemDatabaseFile: string, optional, systemDatabaseFile - For secure access to the database file, specify the fully qualified path name of the database that contains database security information. The system database is usually located in winnt\system32\system.mdw. 
   UseTrustedConnection: boolean, optional, UseTrustedConnection - If selected, causes ODBC driver to use the credentials specified in the ODBC connection or the network login id. 
   defaultusername: string, optional, defaultusername - The user name that the driver uses to connect to the data source if an application requests a connection without supplying a user name. 
   maxBufferSize: numeric, optional, maxBufferSize - The total number of bytes that ColdFusion uses to cache application pages. Enter a value to optimize ColdFusion performance. 
   pageTimeout: numeric, optional, pageTimeout - The number of milliseconds before a request for a ColdFusion page times out. The default is 600. If you observe excessive network activity when using this driver, increase the page timeout value. 
   TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
   enablemaxconnections: boolean, optional, enablemaxconnections - Limit the number of data source connections to the value specified in the maxconnections argument. 
   maxconnections: numeric, optional, maxconnections - The maximum number of data source connections; used if you specify True for the enablemaxconnections argument. 
   pooling: boolean, optional, pooling - Enable server connection pooling for the data source. 
   disable: boolean, optional, disable - Disable connections to data sources. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
   storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   defaultpassword: string, optional, defaultpassword - The password that the driver uses to connect to the data source if an application requests a connection without supplying a user name. 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
   clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setMSAccessUnicode

Creates or modifies a Microsoft Access Unicode data source.

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion datasource name. 
    databasefile : string, required, databasefile - database name that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - original ColdFusion datasource name, if you are renaming this dsn. 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - Data source description. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   pageTimeout: numeric, optional, pageTimeout - The number of milliseconds before a request for a ColdFusion page times out. The default is 600. If you observe excessive network activity when using this driver, increase the page timeout value. 
   maxBufferSize: numeric, optional, maxBufferSize - The total number of bytes that ColdFusion uses to cache application pages. Enter a value to optimize ColdFusion performance. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
    maxconnections : numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection . 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection . 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection . 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setMSSQL

Creates or modifies a Microsoft SQL Server data source.

Output: suppressed
Parameters:
   vendor: string, optional, vendor - Always Microsoft. 
   type: string, optional, type - Always ddtek . 
   name: string, required, name - ColdFusion datasource name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Database name that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - Port that is used to access the database server. (default 1433) 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description for this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   sendStringParametersAsUnicode: boolean, optional, sendStringParametersAsUnicode - Enable Unicode for data sources configured for non-Latin characters 
   selectmethod: string, required, selectmethod - Select Method (direct or cursor) 
   MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
   enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
   maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
   storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. 
   applicationintent: string, optional, applicationintent - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. 
   useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource 
   spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
   clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setMySQL5

Creates or modifies a MySQL 4 or MySQL 5 data source.

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion datasource name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Database name that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - Port that is used to access the database server. (default 3306) 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
    maxconnections : numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. 

setMySQL_DD

Creates or modifies a MySQL 5 datasource using drivers provided by DataDirect.

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion datasource name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Database name that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - Port that is used to access the database server. (default 3306) 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
    maxconnections : numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
    maxpooledstatements : numeric, optional, maxpooledstatements - Maximum number of pooled statements. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. 
   useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource  
   spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource  
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setODBCSocket

Creates or modifies an ODBC socket data source.

Output: enabled
Parameters:
   name: string, required, name - ColdFusion datasource name. 
    datasource : string, required, datasource - name of ODBC datasource , defined in the server control panel. 
   useTrustedConnection: string, optional, useTrustedConnection - If selected, causes ODBC driver to use the credentials specified in the ODBC connection or the network login id. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   host: string, optional, host - Database server host name or IP address. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - Port that is used to access the database server. (default 20004) 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   description: string, optional, description - A description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
    maxconnections : numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection . 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection . 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection . 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setOracle

Creates or modifies an Oracle data source.

Output: suppressed
Parameters:
   vendor: string, optional, vendor - Always Oracle. 
   type: string, optional, type - Always ddtek . 
   name: string, required, name - ColdFusion datasource name. 
   host: string, required, host - Database server host name or IP address. 
   sid: string, required, sid - The Oracle System Identifier that refers to the instance of the Oracle database software running on the server. ORCL is the default. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - Port that is used to access the database server. (default 1521) 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
    maxconnections : numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. 
   useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource  
   spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource  
   supportLinks: boolean, optional, supportLinks - Enables Oracle Linked Servers support 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setOther

Creates or modifies a user-defined data source

Output: enabled
Parameters:
   name: string, required, name - ColdFusion datasource name. 
   url: string, required, url - The JDBC Connection URL for this data source. 
   class: string, required, class - JDBC class file. 
   driver: string, optional, driver - JDBC driver. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - port that is used to access the database server. (default 1433) 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
   encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   selectmethod: string, required, selectmethod - Select Method (direct or cursor). 
   MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
   enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
   maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
   storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
   clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setPostGreSQL

Creates or modifies a PostGreSQL data source.

Output: suppressed
Parameters:
   name: string, required, name - ColdFusion datasource name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Database name that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - Port that is used to access the database server. (default 5432) 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo - datasource . xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - A description for this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
   enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
   maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
   storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
   clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

setSlsServerServiceName

Adds a new SequeLink service name

Output: suppressed
Parameters:
   serviceName: any, required, serviceName - SequeLink service name

setSybase

Creates or modifies a Sybase data source.

Output: suppressed
Parameters:
   vendor: string, optional, vendor - Always Sybase. 
   type: string, optional, type - Always ddtek . 
   name: string, required, name - ColdFusion datasource name. 
   host: string, required, host - Database server host name or IP address. 
   database: string, required, database - Database name that corresponds to the data source. 
   originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. 
   port: string, optional, port - Port that is used to access the database server. (default 5000) 
   driver: string, optional, driver - JDBC driver. 
   class: string, optional, class - JDBC class file. 
   username: string, optional, username - Database username. 
   password: string, optional, password - Database password. 
    encryptpassword : boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query. xml file:

• True - Encrypt the password before storing it.
• False - Store the password in clear text.

   description: string, optional, description - Description of this data source connection. 
   args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). 
   selectmethod: string, optional, selectmethod - Select Method (direct or cursor). 
   MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. 
   timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. 
   interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. 
   login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. 
   buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. 
   blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. 
    enablemaxconnections : boolean, optional, enablemaxconnections - Enables the maxconnections setting. 
    maxconnections : numeric, optional, maxconnections - Limit connections to this maximum amount. 
   pooling: boolean, optional, pooling - Enable server connection pooling for your data source. 
   disable: boolean, optional, disable - Suspends all client connections to the data source. 
   disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. 
   disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. 
   disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys 
   select: boolean, optional, select - Allow SQL SELECT statements. 
   create: boolean, optional, create - Allow SQL CREATE statements. 
   grant: boolean, optional, grant - Allow SQL GRANT statements. 
   insert: boolean, optional, insert - Allow SQL INSERT statements. 
   drop: boolean, optional, drop - Allow SQL DROP statements. 
   revoke: boolean, optional, revoke - Allow SQL REVOKE statements. 
   update: boolean, optional, update - Allow SQL UPDATE statements. 
   alter: boolean, optional, alter - Allow SQL ALTER statements. 
    storedproc : boolean, optional, storedproc - Allow SQL stored procedure calls. 
   delete: boolean, optional, delete - Allow SQL DELETE statements. 
   validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. 
   qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. 
   useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource  
   spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource  
   validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. 
   clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. 
    clientuser : boolean, optional, clientuser - If client user name client info should be set before using connection. 
   applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. 
   applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked.

sl54Add

Adds a datasource to the SequeLink configuration.

Available only for users in one of the roles: admi n

Output: suppressed
Parameters:
   dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. 
   odbcdsn: any, required, odbcdsn - Name of the ODBC data source that ColdFusion is to connect to. 
   connectString: any, optional, connectString - Passes database-specific parameters, such as login credentials, to the data source. 
   TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False.

sl54Del

Removes a data source from the SequeLink configuration.

Available only for users in one of the roles: admin

Output: suppressed
Parameters:
   dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source.

sl54displ

Available only for users in one of the roles: admin

Output: suppressed
Parameters:
   dsn: any, required, dsn

sl54mlog

Modifies the DBMS logon for the data source to SequeLink configuration.

Available only for users in one of the roles: admin
Output: suppressed
Parameters:
   odbcdsn: any, required, odbcdsn - Name of the ODBC data source that ColdFusion is to connect to. 
    logonmethod : any, optional, logonmethod - When anonymous: OSIntegrated; when not anonymous DBMSLOGON( userid , password)

sl54mod

Modifies an ODBC data source connection string in the SequeLink configuration.

Available only for users in one of the roles: admin
Output: suppressed
Parameters:
   dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. 
   odbcdsn: any, required, odbcdsn - Name of the ODBC data source that ColdFusion is to connect to. 
   connectString: any, optional, connectString - Passes database-specific parameters, such as login credentials, to the data source. 
   TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False.

ODBC Services

verifyDsn

Verifies a given data source name.

Output: suppressed
Parameters:
   dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. 
   returnMsgOnError: boolean, optional, returnMsgOnError - The function returns the error message on any error if this parameter is true

Debugging CFC

Manages debug settings.

addDebugEvent

Adds a debug event to the debugging output. For an example of debugging events, refer to WEB-INF/debug/classic.cfm.

Output: suppressed
Parameters:
   type: string, required, type - Debugging event to add:

• SqlQuery
• ObjectQuery
• StoredProcedure
• Trace
• CFTimer
• LockWarning
• Exception

   message: string, required, message - Text to display along with the debug event.
   priority: string, optional, priority - Info, Warning, or Error.
   startTime: numeric, optional, startTime - Start time, if appropriate for your debug event (Tip: now().getTime() returns the numeric calue of the date time).
   endTime: numeric, optional, endTime - End time, if appropriate for your debug event (Tip: now().getTime() returns the numeric calue of the date time).
   total: numeric, optional, total - Number of milliseconds, if appropriate for your debug event.

deleteIP

Removes an IP address from the debugging list.

Output: suppressed
Parameters:
   debugip: string, required, debugip - IP address to remove. 

disableLogging

Enable specific logging

Output: suppressed
Parameters:
   logFileName: string, required, logFileName

disableRemoteInspection

Disables Remote inspection flag

Output: suppressed

disableWeinreAdvanceSettings

Returns if remote inspection is running

Output: suppressed

enableLogging

Enable specific logging

Output: suppressed
Parameters:
   logFileName: string, required, logFileName

enableWeinreAdvanceSettings

Returns if remote inspection is running

Output: suppressed

getCurrentIP

Returns the IP address of the client.

Output: suppressed

getDebugProperty

Returns a specified debug property. To use this method, pass the desired property in the propertyName attribute.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName - Retrieves a debug property. Valid Properties are:

• MAX_DEBUG_SESSIONS
• REMOTE_INSPECTION_ENABLED
• enableDebug
• enableRobustExceptions
• enableAJAXDebugging
• enablePerfMon
• enableCFStat
• debugTemplate
• templateExecutionTime
• templateHighlightMinimum
• templateModel
• showExecutionTime
• showGeneralInfo
• showDatabaseInfo
• showExceptionInfo
• showTrace
• showTimer
• showVariables
• showApplicationVariables
• showCGIVariables
• showClientVariables
• showCookieVariables
• showFlashFormCompileErrors
• showFormVariables
• showRequestVariables
• showSessionVariables
• showServerVariables
• showURLVariables

getDebugRecordset

Returns debugger record set.

Output: suppressed

getIPList

Returns a list of IP addresses for which debugging is enabled.

Output: suppressed
Parameters:
   adminPassword: any, optional, adminPassword 
   adminPassword2: any, optional, adminPassword2 

getLineDebuggerPort

Returns JVM debug port

Output: suppressed

getLocalInspectionURL

Returns the inspection url of weinre server

Output: suppressed

getLocalIpAddressesList

Returns all the ip addresses of this machine

Output: suppressed

getLocalWeinreIPAddress

Returns the ipaddress on which the weinre server is running

Output: suppressed

getLocalWeinreServerDeathTimeOut

Returns the Local Weinre Server Death Timeout

Output: suppressed

getLocalWeinreServerPort

Returns the port on which the weinre server is running

Output: suppressed

getLocalWeinreServerReadTimeOut

Returns the Local Weinre Server Read Timeout

Output: suppressed

getLogProperty

Returns a specified logging property. To use this method, pass the desired property in the propertyName attribute.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName - Retrieves a logging property. Valid Properties are:

• pattern
• LogDirectory
• MaxFileSize
• MaxArchives
• LogScheduledTask
• LogCorbaCalls
• LogRequestTimeLimit
• logMailSeverity
• logMailSentMessages

setIP

Sets a list of one or more IP addresses for which debugging is enabled.

Output: suppressed
Parameters:
    debugip : string, required, debugip - List of IP addresses. 

setLineDebuggerEnabled

Enables or disables line debugger

Output: suppressed
Parameters:
   enabled: boolean, optional, enabled 

setLineDebuggerPort

Sets JVM debug port

Output: suppressed
Parameters:
   portNumber: numeric, required, portNumber 

setLocalWeinreIpAddress

sets the local weinre ip address

Output: suppressed
Parameters:
    ipAddress : string, required, ipAddress 

setLocalWeinreServerDeathTimeOut

sets the local weinre death timeout 

Output: suppressed
Parameters:
   deathTimeout: string, required, deathTimeout

setLocalWeinreServerPort

sets the local weinre port address

Output: suppressed
Parameters:
   port: string, required, port

setLocalWeinreServerReadTimeOut

sets the local weinre read timeout 

Output: suppressed
Parameters:
   readTimeOut: string, required, readTimeOut 

setLogProperty

Sets a specified logging property. To use this method, pass the property in the propertyName attribute and the associated value in the propertyValue attribute.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName - Property to set. Valid Properties are:

• pattern
• LogDirectory
• MaxFileSize
• MaxArchives
• LogScheduledTask
• LogCorbaCalls
• LogRequestTimeLimit
• logMailSeverity
• logMailSentMessages

   propertyValue: any, required, propertyValue - Value for propertyName.

setMaxDebuggingSessions

Sets maximum simultaneous debugging sessions

Output: suppressed
Parameters:
   maxSessions: numeric, required, maxSessions

setRemoteInspectionEnabled

Enables remote inspection flag 

Output: suppressed

setWeinreServerlocation

Sets the weinre server url used in case of remote inspection

Output: suppressed
Parameters:
    weinreUrl : string, required, weinreUrl  

setWeinreServerType

Sets the inspection type to local or remote

Output: suppressed
Parameters:
   inspectionType: string, required, inspectionType 

startLineDebugger

Starts CF line debugger

Output: suppressed

startLocalWeinreServer

starts the local weinre server if installed by coldfusion

Output: suppressed

startLocalWeinreServerOnFreePort

starts the local weinre server if installed by coldfusion

Output: suppressed

stopLineDebugger

Stops CF line debugger

Output: suppressed

stopLocalWeinreServer

stops the local weinre server if running

Output: suppressed

store

Output: suppressed

storeRemoteInspectionUI

Output: suppressed

validateIP*

Ensures that a string contains a valid IP address.

Output: suppressed
Parameters:
    debugip : any, required, debugip - String to test. 

Document CFC

Manages CFDocument settings.

Event Gateway CFC

Add, modify, delete, and manage event gateways.

addServiceManager

Add and register the Service Manager

Output: suppressed
Parameters:
   name: any, required, name - name of the Service Manager 
   hostname: any, required, hostname - hostname of the Service Manager 
   port: numeric, required, port - hostname of the Service Manager 
   weight: numeric, required, weight - hostname of the Service Manager 
    ishttps : boolean, required, ishttps - hostname of the Service Manager

disableServiceManager

Disables and unregisters the Service Manager for given name

Output: suppressed
Parameters:
   name: any, required, name - name of the Service Manager 

editServiceManager

Edit and re-register the Service Manager

Output: suppressed
Parameters:
   name: any, required, name - name of the Service Manager 
   hostname: any, required, hostname - hostname of the Service Manager 
   port: numeric, required, port - hostname of the Service Manager 
   weight: numeric, required, weight - hostname of the Service Manager 
    ishttps : boolean, required, ishttps - hostname of the Service Manager 

enableServiceManager

Enables and registers the Service Manager for given name

Output: suppressed
Parameters:
   name: any, required, name - name of the Service Manager 

getAllServiceManager

Return the Service Manager for given name

Output: suppressed

getServiceManager

Return the Service Manager for given name

Output: suppressed
Parameters:
   name: any, required, name - name of the Service Manager 

removeServiceManager

Removes and unconfigures the Service Manager for given name

Output: suppressed
Parameters:
   name: any, required, name - name of the Service Manager 

verifyServiceManager

Verifies the Service Manager for given name

Output: suppressed
Parameters:
   name: any, required, name - name of the Service Manager 

deleteGatewayInstance

Delete an instance of a gateway.

Output: suppressed
Parameters:
   gatewayid: any, required, gatewayid - ID of the gateway instance

deleteGatewayType

Removes an event gateway type.

Output: suppressed
Parameters:
   type: any, required, type - gateway type

getGatewayEvents

Return value of specified gateway event counters, these are reset on server start.

Output: suppressed
Parameters:
    gatewayID : any, required, gatewayID - Name of the the gateway . 
   propertyName: any, required, propertyName - Valid Properties are:

• EventsIn

EventsOut

getGatewayInstances

Returns instances of all gateways or of a specified gateway instance.

Output: suppressed
Parameters:
   gatewayid: any, optional, gatewayid - Specifies the ID of a gateway instance.

getGatewayInstanceStatus

Return status (started/stopped) for a gateway instance.

Output: suppressed
Parameters:
    gatewayid : any, required, gatewayid - Name of the gateway instance.

getGatewayProperty

Return value of specified gateway property.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName - Valid Properties are:

• ThreadPoolSize

MaxQueueSize

getGatewayServiceStatus

Returns gateway service status.

Output: suppressed

getGatewayTypes

Returns known types of event gateways.

Output: suppressed
Parameters:
   type: any, optional, type - Specifies a gateway type. 

getSMSTestServerStatus

Returns status (started/stopped) of SMS Test Server.

Output: suppressed

ResetGatewayEvents

Reset the internal event counters for a specific gateway.

Output: suppressed
Parameters:
   gatewayID: any, required, gatewayID - Name of the the gateway. 
   propertyName: any, required, propertyName - Valid Properties are:

• EventsIn

EventsOut

restartGatewayInstance

Restart an instance of an event gateway.

Output: suppressed
Parameters:
   gatewayid: any, required, gatewayid - Name of the gateway instance. 

setGatewayInstance

Adds a gateway instance.

Output: suppressed
Parameters:
   gatewayid: any, required, gatewayid - A name for the gateway instance. 
   type: any, required, type - Gateway type, such as SMS, SocketGateway, etc. 
   cfcPaths: array, required, cfcPaths - Absolute path to listener CFC for incoming messages. 
   configurationpath: any, required, configurationpath - Configuration file for the gateway instance. 
   mode: any, required, mode - Gateway startup status:

• auto
• manual
• disabled

setGatewayProperty

Set a value for a specified gateway property.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName - Valid Properties are:

• ThreadPoolSize
• MaxQueueSize

   propertyValue: any, required, propertyValue - Value for the specified property.

setGatewayServiceStatus

Enables/Disables ColdFusion Event Gateway Services

Output: suppressed
Parameters:
   enableGatewayService: any, required, enableGatewayService - Specifies whether ColdFusion Event Gateway Services are enabled.

setGatewayType

Adds an event gateway type.

Output: suppressed
Parameters:
   type: any, required, type - gateway type 
   description: any, required, description - description of gateway type 
   class: any, required, class - name of Java class for gateway type 
   timeout: any, optional, timeout - timeout value 
   killOnTimeout: any, optional, killOnTimeout - Yes or No

startGatewayInstance

Start an instance of an event gateway.

Output: suppressed
Parameters:
    gatewayid : any, required, gatewayid - Name of the gateway instance. 

startGatewayService

Enables event gateway service.

Output: suppressed

startSMSTestServer

Starts SMS Test Server.

Output: suppressed

stopGatewayInstance

Stop an instance of an event gateway.

Output: suppressed
Parameters:
    gatewayid : any, required, gatewayid - Name of the gateway instance.

stopGatewayService

Stops event gateway service.

Output: suppressed

stopSMSTestServer

Stops SMS Test Server.

Output: suppressed