MACROMEDIA COLDFUSION 4.5-ADMINISTRING COLDFUSION SERVER Technical Information download pdf (Page 35)

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Last updated 2/21/2012

Alternatively, you can extend the ColdFusion Administrator by editing the

wwwroot/CFIDE/administrator/custommenu.xml file.

Administrator API

You can use the Administrator API to perform most ColdFusion Administrator tasks programmatically. The

Administrator API consists of a set of ColdFusion components (CFCs) that contain methods you call to perform

Administrator tasks. For example, you use the

setMSQL method of datasource.cfc to add a SQL Server data source.

The CFCs for the Administrator API are located in the cf_web_root/CFIDE/adminapi directory. Each CFC

corresponds to an area of the ColdFusion Administrator, as the following table shows:

The adminapi directory also contains an Application.cfm file and two subdirectories.

Note: If you are using sandbox security, enable access to the cf_web_root/CFIDE/adminapi directory to use the

Administrator API.

Following are the styles of methods in the Administrator API:

Method arguments When setting complex or varied values, the Administrator API uses method arguments.

Getting and setting simple values When setting simple values, such as true or false debug settings, the Administrator

API uses get and set property methods.

To view the methods, method arguments, and documentation for the Administrator API CFCs, use the CFC Explorer.

For example, to view datasource.cfc when running in the server configuration, open a browser to

http://localhost:8500/CFIDE/adminapi/datasource.cfc.

CFC Description

accessmanager.cfc Specify the user name, password, description, access rights, sandboxes, and allowed roles for individual

users.

administrator.cfc Contains basic Administrator functionality, including login, logout, the Migration wizard, and the Setup

wizard. You must call the

base.cfc Base object for all other Administrator API CFCs.

datasource.cfc Add, modify, and delete ColdFusion data sources.

debugging.cfc Manage debug settings

eventgateway.cfc Manage event gateways

extensions.cfc Manage custom tags, mappings, CFXs, applets, CORBA, and web services.

office.cfc Manage OpenOffice settings.

mail.cfc Manage ColdFusion mail settings.

runtime.cfc Manage runtime settings for fonts, cache, charts, configuration, and other settings.

security.cfc Manage passwords, RDS, and sandbox security.

serverinstance.cfc Start, stop, and restart JRun servers. This CFC only works when running the multiserver configuration.

servermonitoring.cfc Perform many of the Server Monitor tasks programmatically.

1 2 ... 30 31 32 33 34 35 36 37 38 39 40 ... 173 174

No comments

MACROMEDIA COLDFUSION 4.5-ADMINISTRING COLDFUSION SERVER Technical Information Page 35