Brugerhåndbog Annuller


  1. ColdFusion User Guide
  2. Introduction to ColdFusion
    1. About Adobe ColdFusion
    2. Download Adobe ColdFusion
    3. What's new in ColdFusion (2023 release)
    4. ColdFusion (2023 release) Release Notes
    5. Deprecated Features
    6. REST enhancements in ColdFusion
    7. Central Configuration Server
    8. Server Auto-Lockdown
    9. Asynchronous programming
    10. Docker images for ColdFusion
    11. SAML in ColdFusion
    12. JSON Web Tokens in ColdFusion
    13. Use SAML and LDAP in Admin
  3. Cloud Services in ColdFusion
    1. ColdFusion and GCP Storage
    2. ColdFusion and GCP Firestore
    3. ColdFusion and GCP PubSub
    4. ColdFusion and Amazon S3
    5. ColdFusion and DynamoDB
    6. ColdFusion and Amazon SQS
    7. ColdFusion and Amazon SNS
    8. ColdFusion and MongoDB
    9. ColdFusion and Azure Blob
    10. ColdFusion and Azure Service Bus
    11. Multi-cloud storage services
    12. Multi-cloud RDS databases
    13. ColdFusion and Azure Cosmos DB
  4. Install ColdFusion
    1. Install the server configuration
    2. Install ColdFusion- Zip Installer
    3. Install ColdFusion- GUI Installer
    4. CFSetup configuration tool
    5. ColdFusion Licensing and Activation
    6. ColdFusion server profiles
    7. Prepare to install ColdFusion
    8. Install the JEE configuration
    9. Install ColdFusion Express
    10. Install integrated technologies
    11. Configure your system
    12. Troubleshoot installation issues
    13. Install ColdFusion silently
    14. Install Adobe ColdFusion (2016 release) hotfix
    15. ColdFusion (2018 release) - Install JEE configuration
  5. Use ColdFusion
    1. GraphQL in ColdFusion
    2. Command Line Interface (CLI)
    3. External session storage
    4. Generate Swagger documents
    5. Language enhancements
    6. NTLM support
    7. Enhanced PDF in ColdFusion
    8. Security enhancements in ColdFusion (2016 release)
  6. Performance Monitoring Toolset
    1. Overview of ColdFusion Performance Monitoring Toolset
    2. Auto-discovery of ColdFusion nodes and clusters
    3. Code profiler in ColdFusion Performance Monitoring Toolset
    4. Configure ColdFusion Performance Monitoring Toolset settings
    5. Install ColdFusion Performance Monitoring Toolset
    6. View cloud metrics
    7. Monitor GraphQL in Performance Monitoring Toolset
    8. Configure TLS/SSL and Authentication for Elasticsearch 8.x  in Performance Monitoring Toolset
    9. View cluster and node metrics
    10. View data source metrics
    11. View external services
    12. View incoming services
    13. View list of sites and busy connections
    14. View topology of sites
    15. Datastore Health Monitoring
    16. Performance Monitoring Toolset Update 1
    17. Secure Performance Monitoring Toolset with HTTPS/SSL
    18. Performance Monitoring Toolset deployment guide
  7. Adobe ColdFusion Builder extension for Visual Studio Code
    1. Getting started with Adobe ColdFusion Builder extension for Visual Studio Code
    2. Add a ColdFusion server
    3. Project Manager
    4. Work with ColdFusion code
    5. Profile preferences
    6. Debug applications
    7. Debug code in Virtual Host
    8. Refactoring
    9. Services Browser
    10. RDS support
    11. PMT Code Profiler integration
    12. Security Analyzer report integration
    13. Known issues in this release
  8. Use ColdFusion Builder
    1. About ColdFusion Builder
    2. System requirements | ColdFusion Builder
    3. Install ColdFusion Builder
    4. Edit code in ColdFusion Builder
    5. Manage servers in ColdFusion Builder
    6. Manage projects in ColdFusion Builder
    7. What's new in Adobe ColdFusion Builder (2018 release)
    8. Frequently Asked Questions (FAQ) | Adobe ColdFusion Builder (2018 release)
    9. Debug applications in ColdFusion Builder
    10. ColdFusion Builder workbench
    11. ColdFusion Builder extensions
    12. Debugging Perspective in ColdFusion Builder
    13. Build mobile applications using ColdFusion Builder
    14. Bundled ColdFusion Server
    15. Debug mobile applications in ColdFusion Builder
    16. Use extensions in ColdFusion Builder
  9. Coldfusion API Manager
    1. Overview of Adobe ColdFusion API Manager
    2. Features in ColdFusion API Manager
    3. Get started with ColdFusion API Manager
    4. Install ColdFusion API Manager
    5. Authentication types
    6. Create and publish APIs
    7. Administrator
    8. Subscriber
    9. Throttling and rate limiting
    10. Notifications
    11. Connectors
    12. Set up cluster support
    13. Integrate ColdFusion and API Manager
    14. Metrics and Logging in API Manager
    15. Generate Swagger documents
    16. Configure SSL
    17. Known issues in this release
    18. Policies in ColdFusion API Manager
    19. Create a Redis cluster
    20. Multitenancy in API Manager
    21. Docker images for ColdFusion API Manager
  10. Configure and administer ColdFusion
    1. Administer ColdFusion
    2. Use the ColdFusion administrator
    3. Data Source Management for ColdFusion
    4. Connect to web servers
    5. Deploy ColdFusion applications
    6. Administer ColdFusion security
    7. Basic Troubleshooting and FAQs
    8. Work with Server Manager
    9. Use multiple server instances
    10. WebSocket Enhancements (ColdFusion 11)
    11. Security Enhancements (ColdFusion 11)
    12. Work with Server Monitor
    13. ColdFusion Administrator API Reference
  11. ColdFusion functions
    1. ColdFusion functions by category
    2. Functions a-b
      1. Abs
      2. ACos
      3. AddSOAPRequestHeader
      4. AddSOAPResponseHeader
      5. AjaxLink
      6. AjaxOnLoad
      7. ApplicationStop
      8. ArrayAppend
      9. ArrayAvg
      10. ArrayClear
      11. ArrayContains
      12. ArrayContainsNoCase
      13. ArrayDelete
      14. ArrayDeleteAt
      15. ArrayDeleteNoCase
      16. ArrayEach
      17. ArrayFilter
      18. ArrayFind
      19. ArrayFindAll
      20. ArrayFindAllNoCase
      21. ArrayFindNoCase
      22. ArrayInsertAt
      23. ArrayIsDefined
      24. ArrayIsEmpty
      25. ArrayLen
      26. ArrayMap
      27. ArrayMax
      28. ArrayMin
      29. ArrayNew
      30. ArrayPrepend
      31. ArrayReduce
      32. ArrayResize
      33. ArraySet
      34. ArraySetMetadata
      35. ArraySlice
      36. ArraySort
      37. ArraySum
      38. ArraySwap
      39. ArrayToList
      40. Asc
      41. ASin
      42. Atn
      43. AuthenticatedContext
      44. AuthenticatedUser
      45. BinaryDecode
      46. BinaryEncode
      47. BitAnd
      48. BitMaskClear
      49. BitMaskRead
      50. BitMaskSet
      51. BitNot
      52. BitOr
      53. BitSHLN
      54. BitSHRN
      55. BitXor
      56. BooleanFormat
    3. Functions-c-d
      1. CacheGet
      2. CacheGetAllIds
      3. CacheGetMetadata
      4. CacheGetProperties
      5. CacheGetSession
      6. CacheIdExists
      7. CachePut
      8. CacheRegionExists
      9. CacheRegionNew
      10. CacheRegionRemove
      11. CacheRemove
      12. CacheRemoveAll
      13. CacheSetProperties
      14. CallStackDump
      15. CallStackGet
      16. CanDeSerialize
      17. Canonicalize
      18. CanSerialize
      19. Ceiling
      20. CharsetDecode
      21. CharsetEncode
      22. Chr
      23. CJustify
      24. Compare
      25. CompareNoCase
      26. Cos
      27. CreateDate
      28. CreateDateTime
      29. CreateObject
      30. CreateObject: .NET object
      31. CreateObject: COM object
      32. CreateObject: component object
      33. CreateObject: CORBA object
      34. CreateObject: Java or EJB object
      35. CreateObject: web service object
      36. CreateODBCDate
      37. CreateODBCDateTime
      38. CreateODBCTime
      39. CreateTime
      40. CreateTimeSpan
      41. CreateUUID
      42. CSRFGenerateToken
      43. CSRFVerifyToken
      44. DateAdd
      45. DateCompare
      46. DateConvert
      47. DateDiff
      48. DateFormat
      49. DatePart
      50. DateTimeFormat
      51. Day
      52. DayOfWeek
      53. DayOfWeekAsString
      54. DayOfYear
      55. DaysInMonth
      56. DaysInYear
      57. DE
      58. DecimalFormat
      59. DecodeForHTML
      60. DecodeFromURL
      61. DecrementValue
      62. Decrypt
      63. DecryptBinary
      64. DeleteClientVariable
      65. Deserialize
      66. DeserializeJSON
      67. DeserializeXML
      68. DirectoryCopy
      69. DirectoryCreate
      70. DirectoryDelete
      71. DirectoryExists
      72. DirectoryList
      73. DirectoryRename
      74. DollarFormat
      75. DotNetToCFType
      76. Duplicate
    4. Functions-e-g
      1. EncodeForCSS
      2. EncodeForDN
      3. EncodeForHTML
      4. EncodeForHTMLAttribute
      5. EncodeForJavaScript
      6. EncodeForLDAP
      7. EncodeForURL
      8. EncodeForXML
      9. EncodeForXMLAttribute
      10. EncodeForXpath
      11. Encrypt
      12. EncryptBinary
      13. EntityDelete
      14. EntityLoad
      15. EntityLoadByExample
      16. EntityLoadByPK
      17. EntityMerge
      18. EntityNew
      19. EntityReload
      20. EntitySave
      21. EntityToQuery
      22. Evaluate
      23. Exp
      24. ExpandPath
      25. FileClose
      26. FileCopy
      27. FileDelete
      28. FileExists
      29. FileGetMimeType
      30. FileIsEOF
      31. FileMove
      32. FileOpen
      33. FileRead
      34. FileReadBinary
      35. FileReadLine
      36. FileSeek
      37. FileSetAccessMode
      38. FileSetAttribute
      39. FileSetLastModified
      40. FileSkipBytes
      41. FileUpload
      42. FileUploadAll
      43. FileWrite
      44. FileWriteLine
      45. Find
      46. FindNoCase
      47. FindOneOf
      48. FirstDayOfMonth
      49. Fix
      50. Floor
      51. FormatBaseN
      52. Generate3DesKey
      53. GeneratePBKDFKey
      54. GenerateSecretKey
      55.  GetApplicationMetadata
      56. GetAuthUser
      57. GetBaseTagData
      58. GetBaseTagList
      59. GetBaseTemplatePath
      60. GetClientVariablesList
      61. GetComponentMetaData
      62. GetContextRoot
      63. GetCPUUsage
      64. GetCurrentTemplatePath
      65. GetDirectoryFromPath
      66. GetEncoding
      67. GetException
      68. GetFileFromPath
      69. GetFileInfo
      70. GetFreeSpace
      71. GetFunctionCalledName
      72. GetFunctionList
      73. GetGatewayHelper
      74. GetHttpRequestData
      75. GetHttpTimeString
      76. GetK2ServerDocCount
      77. GetK2ServerDocCountLimit
      78. GetLocale
      79. GetLocaleDisplayName
      80. GetLocalHostIP
      81. GetMetaData
      82. GetMetricData
      83. GetPageContext
      84. GetPrinterInfo
      85. GetPrinterList
      86. GetProfileSections
      87. GetProfileString
      88. GetReadableImageFormats
      89. GetSafeHTML
      90. GetSAMLAuthRequest
      91. GetSAMLLogoutRequest
      92. GenerateSAMLSPMetadata
      93. GetSOAPRequest
      94. GetSOAPRequestHeader
      95. GetSOAPResponse
      96. GetSOAPResponseHeader
      97. GetSystemFreeMemory
      98. GetSystemTotalMemory
      99. GetTempDirectory
      100. GetTempFile
      101. GetTemplatePath
      102. GetTickCount
      103. GetTimeZoneInfo
      104. GetToken
      105. GetTotalSpace
      106. GetUserRoles
      107. GetVFSMetaData
      108. GetWriteableImageFormats
    5. Functions-h-im
      1. Hash
      2. HMac
      3. Hour
      4. HQLMethods
      5. HTMLCodeFormat
      6. HTMLEditFormat
      7. IIf
      8. ImageAddBorder
      9. ImageBlur
      10. ImageClearRect
      11. ImageCopy
      12. ImageCreateCaptcha
      13. ImageCrop
      14. ImageDrawArc
      15. ImageDrawBeveledRect
      16. ImageDrawCubicCurve
      17. ImageDrawLine
      18. ImageDrawLines
      19. ImageDrawOval
      20. ImageDrawPoint
      21. ImageDrawQuadraticCurve
      22. ImageDrawRect
      23. ImageDrawRoundRect
      24. ImageDrawText
      25. ImageFlip
      26. ImageGetBlob
      27. ImageGetBufferedImage
      28. ImageGetEXIFMetadata
      29. ImageGetEXIFTag
      30. ImageGetHeight
      31. ImageGetIPTCMetadata
      32. ImageGetIPTCTag
      33. ImageGetMetadata
      34. ImageGetWidth
      35. ImageGrayscale
      36. ImageInfo
      37. ImageMakeColorTransparent
      38. ImageMakeTranslucent
      39. ImageNegative
      40. ImageNew
      41. ImageOverlay
      42. ImagePaste
      43. ImageRead
      44. ImageReadBase64
      45. ImageResize
      46. ImageRotate
      47. ImageRotateDrawingAxis
      48. ImageScaleToFit
      49. ImageSetAntialiasing
      50. ImageSetBackgroundColor
      51. ImageSetDrawingColor
      52. ImageSetDrawingStroke
      53. ImageSetDrawingTransparency
      54. ImageSharpen
      55. ImageShear
      56. ImageShearDrawingAxis
      57. ImageTranslate
      58. ImageTranslateDrawingAxis
      59. ImageWrite
      60. ImageWriteBase64
      61. ImageXORDrawingMode
    6. Functions-in-k
      1. IncrementValue
      2. InputBaseN
      3. Insert
      4. Int
      5. InvalidateOauthAccesstoken
      6. Invoke
      7. InitSAMLAuthRequest
      8. InitSAMLLogoutRequest
      9. InvokeCFClientFunction
      10. IsArray
      11. IsAuthenticated
      12. IsAuthorized
      13. IsBinary
      14. IsBoolean
      15. IsClosure
      16. IsCustomFunction
      17. IsDate
      18. IsDateObject
      19. IsDDX
      20. IsDebugMode
      21. IsDefined
      22. IsImage
      23. IsImageFile
      24. IsInstanceOf
      25. IsIPv6
      26. IsJSON
      27. IsK2ServerABroker
      28. IsK2ServerDocCountExceeded
      29. IsK2ServerOnline
      30. IsLeapYear
      31. IsLocalHost
      32. IsNull
      33. IsNumeric
      34. IsNumericDate
      35. IsObject
      36. isOnline
      37. IsPDFArchive
      38. IsPDFFile
      39. IsPDFObject
      40. IsProtected
      41. IsQuery
      42. isSamlLogoutResponse
      43. isSafeHTML
      44. IsSimpleValue
      45. IsSOAPRequest
      46. IsSpreadsheetFile
      47. IsSpreadsheetObject
      48. IsStruct
      49. IsUserInAnyRole
      50. IsUserInRole
      51. IsUserLoggedIn
      52. IsValid
      53. IsValidOauthAccesstoken
      54. IsWDDX
      55. IsXML
      56. IsXmlAttribute
      57. IsXmlDoc
      58. IsXmlElem
      59. IsXmlNode
      60. IsXmlRoot
      61. JavaCast
      62. JSStringFormat
    7. Functions-l
      1. LCase
      2. Left
      3. Len
      4. ListAppend
      5. ListChangeDelims
      6. ListContains
      7. ListContainsNoCase
      8. ListDeleteAt
      9. ListEach
      10. ListFilter
      11. ListFind
      12. ListFindNoCase
      13. ListFirst
      14. ListGetAt
      15. ListInsertAt
      16. ListLast
      17. ListLen
      18. ListMap
      19. ListPrepend
      20. ListQualify
      21. ListReduce
      22. ListRemoveDuplicates
      23. ListRest
      24. ListSetAt
      25. ListSort
      26. ListToArray
      27. ListValueCount
      28. ListValueCountNoCase
      29. LJustify
      30. Location
      31. Log
      32. Log10
      33. LSCurrencyFormat
      34. LSDateFormat
      35. LSDateTimeFormat
      36. LSEuroCurrencyFormat
      37. LSIsCurrency
      38. LSIsDate
      39. LSIsNumeric
      40. LSNumberFormat
      41. LSParseCurrency
      42. LSParseDateTime
      43. LSParseEuroCurrency
      44. LSParseNumber
      45. LSTimeFormat
      46. LTrim
    8. Functions-m-r
      1. Max
      2. Mid
      3. Min
      4. Minute
      5. Month
      6. MonthAsString
      7. Now
      8. NumberFormat
      9. ObjectEquals
      10. ObjectLoad
      11. ObjectSave
      12. OnWSAuthenticate
      13. ORMClearSession
      14. ORMCloseAllSessions
      15. ORMCloseSession
      16. ORMEvictCollection
      17. ORMEvictEntity
      18. ORMEvictQueries
      19. ORMExecuteQuery
      20. ORMFlush
      21. ORMFlushall
      22. ORMGetSession
      23. ORMGetSessionFactory
      24. ORMIndex
      25. ORMIndexPurge
      26. ORMReload
      27. ORMSearch
      28. ORMSearchOffline
      29. ParagraphFormat
      30. ParameterExists
      31. ParseDateTime
      32. Pi
      33. PrecisionEvaluate
      34. ProcessSAMLResponse
      35. ProcessSAMLLogoutRequest
      36. Quarter
      37. PreserveSingleQuotes
      38. QueryAddColumn
      39. QueryAddRow
      40. QueryConvertForGrid
      41. QueryExecute
      42. QueryFilter
      43. QueryGetResult
      44. QueryGetRow
      45. QueryKeyExists
      46. QueryMap
      47. QueryNew
      48. QueryReduce
      49. QuerySetCell
      50. QuotedValueList
      51. QueryEach
      52. Rand
      53. Randomize
      54. RandRange
      55. ReEscape
      56. REFind
      57. REFindNoCase
      58. ReleaseComObject
      59. REMatch
      60. REMatchNoCase
      61. RemoveCachedQuery
      62. RemoveChars
      63. RepeatString
      64. Replace
      65. ReplaceList
      66. ReplaceNoCase
      67. REReplace
      68. REReplaceNoCase
      69. RestDeleteApplication
      70. RestSetResponse
      71. RestInitApplication
      72. Reverse
      73. Right
      74. RJustify
      75. Round
      76. RTrim
    9. Functions-s
      1. Second
      2. SendGatewayMessage
      3. SendSAMLLogoutResponse
      4. Serialize
      5. SerializeJSON
      6. SerializeXML
      7. SessionInvalidate
      8. SessionRotate
      9. SessionGetMetaData
      10. SessionInvalidate
      11. SessionRotate
      12. SetDay
      13. SetEncoding
      14. SetHour
      15. SetLocale
      16. SetMonth
      17. SetProfileString
      18. SetVariable
      19. SetYear
      20. Sgn
      21. Sin
      22. Sleep
      23. SpanExcluding
      24. SpanIncluding
      25. SpreadsheetAddAutoFilter
      26. SpreadsheetAddColumn
      27. SpreadsheetAddFreezePane
      28. SpreadsheetAddImage
      29. SpreadsheetAddInfo
      30. SpreadsheetAddPageBreaks
      31. SpreadsheetAddRow
      32. SpreadsheetAddRows
      33. SpreadsheetAddSplitPane
      34. SpreadsheetCreateSheet
      35. SpreadsheetDeleteColumn
      36. SpreadsheetDeleteColumns
      37. SpreadsheetDeleteRow
      38. SpreadsheetDeleteRows
      39. SpreadsheetFormatCell
      40. SpreadsheetFormatColumn
      41. SpreadsheetFormatCellRange
      42. SpreadsheetFormatColumn
      43. SpreadsheetFormatColumns
      44. SpreadsheetFormatRow
      45. SpreadsheetFormatRows
      46. SpreadsheetGetCellComment
      47. SpreadsheetGetCellFormula
      48. SpreadsheetGetCellValue
      49. SpreadsheetGetColumnCount
      50. SpreadsheetInfo
      51. SpreadsheetMergeCells
      52. SpreadsheetNew
      53. SpreadsheetRead
      54. SpreadsheetReadBinary
      55. SpreadsheetRemoveSheet
      56. SpreadsheetSetActiveSheet
      57. SpreadsheetSetActiveSheetNumber
      58. SpreadsheetSetCellComment
      59. SpreadsheetSetCellFormula
      60. SpreadsheetSetCellValue
      61. SpreadsheetSetColumnWidth
      62. SpreadsheetSetFooter
      63. SpreadsheetSetHeader
      64. SpreadsheetSetRowHeight
      65. SpreadsheetShiftColumns
      66. SpreadsheetShiftRows
      67. SpreadsheetWrite
      68. Sqr
      69. StripCR
      70. StructAppend
      71. StructClear
      72. StructCopy
      73. StructCount
      74. StructDelete
      75. StructEach
      76. StructFilter
      77. StructFind
      78. StructFindKey
      79. StructFindValue
      80. StructGet
      81. StructGetMetadata
      82. StructInsert
      83. StructIsEmpty
      84. StructKeyArray
      85. StructKeyExists
      86. StructKeyList
      87. StructMap
      88. StructNew
      89. StructReduce
      90. StructSetMetadata
      91. StructSort
      92. StructToSorted
      93. StructUpdate
      94. StoreSetMetadata
      95. StoreGetACL
      96. StoreGetMetadata
      97. StoreAddACL
      98. StoreSetACL
    10. Functions-t-z
      1. Tan
      2. ThreadJoin
      3. ThreadTerminate
      4. Throw
      5. TimeFormat
      6. ToBase64
      7. ToBinary
      8. ToScript
      9. ToString
      10. Trace
      11. Transactionandconcurrency
      12. TransactionCommit
      13. TransactionRollback
      14. TransactionSetSavePoint
      15. Trim
      16. UCase
      17. URLDecode
      18. URLEncodedFormat
      19. URLSessionFormat
      20. Val
      21. ValueList
      22. VerifyClient
      23. Week
      24. Wrap
      25. WriteDump
      26. WriteLog
      27. WriteOutput
      28. WSGetAllChannels
      29. WSGetSubscribers
      30. WSPublish
      31. WSSendMessage
      32. XmlChildPos
      33. XmlElemNew
      34. XmlFormat
      35. XmlGetNodeType
      36. XmlNew
      37. XmlParse
      38. XmlSearch
      39. XmlTransform
      40. XmlValidate
      41. Year
      42. YesNoFormat
  12. ColdFusion Tags
    1. ColdFusion tags by category
    2. Tags a-b
      1. cfabort
      2. cfajaximport
      3. cfajaxproxy
      4. cfapplet
      5. cfapplication
      6. cfargument
      7. cfassociate
      8. cfauthenticate
      9. cfbreak
    3. Tags c
      1. cfcache
      2. cfcalendar
      3. cfcase
      4. cfcatch
      5. cfchart
      6. cfchartdata
      7. cfchartseries
      8. cfclient
      9. cfclientsettings
      10. cfcol
      11. cfcollection
      12. cfcomponent
      13. cfcontent
      14. cfcontinue
      15. cfcookie
      16. Tags d-e
    4. Tags f
      1. cffeed
      2. cffile
      3. cffile action = "append"
      4. cffile action = "copy"
      5. cffile action = "delete"
      6. cffile action = "move"
      7. cffile action = "read"
      8. cffile action = "readBinary"
      9. cffile action = "rename"
      10. cffile action = "upload"
      11. cffile action = "uploadAll"
      12. cffile action = "write"
      13. cffileupload
      14. cffinally
      15. cfflush
      16. cfform
      17. cfformgroup
      18. cfformitem
      19. cfftp
      20. cfftp: Connection: file and directory operations
      21. cfftp: Opening and closing FTP server connections
      22. cfftp : Opening and closing secure FTP server connections
      23. cfftp action = "listDir"
      24. cffunction
    5. Tags g-h
      1. cfgraph
      2. cfgraphdata
      3. cfgrid
      4. cfgridcolumn
      5. cfgridrow
      6. cfgridupdate
      7. cfheader
      8. cfhtmlhead
      9. cfhtmltopdf
      10. cfhtmltopdfitem
      11. cfhttp
      12. cfhttpparam
    6. Tags i
      1. cfif
      2. cfimage
      3. cfimap
      4. cfimapfilter
      5. cfimpersonate
      6. cfimport
      7. cfinclude
      8. cfindex
      9. cfinput
      10. cfinsert
      11. cfinterface
      12. cfinvoke
      13. cfinvokeargument
    7. Tags j-l
      1. cfjava
      2. cflayout
      3. cflayoutarea
      4. cfldap
      5. cflocation
      6. cflock
      7. cflog
      8. cflogin
      9. cfloginuser
      10. cflogout
      11. cfloop
      12. cfloop : conditional loop
      13. cfloop : index loop
      14. cfloop : looping over a COM collection or structure
      15. cfloop : looping over a date or time range
      16. cfloop : looping over a list, a file, or an array
      17. cfloop : looping over a query
    8. Tags m-o
      1. cfmail
      2. cfmailparam
      3. cfmailpart
      4. cfmap
      5. cfmapitem
      6. cfmediaplayer
      7. cfmenu
      8. cfmenuitem
      9. cfmessagebox
      10. cfmodule
      11. cfNTauthenticate
      12. cfoauth
      13. cfobject
      14. cfobject: .NET object
      15. cfobject: COM object
      16. cfobject: component object
      17. cfobject: CORBA object
      18. cfobject: Java or EJB object
      19. cfobject: web service object
      20. cfobjectcache
      21. cfoutput
    9. Tags p-q
      1. cfparam
      2. cfpdf
      3. cfpdfform
      4. cfpdfformparam
      5. cfpdfparam
      6. cfpdfsubform
      7. cfpod
      8. cfpop
      9. cfpresentation
      10. cfpresentationslide
      11. cfpresenter
      12. cfprint
      13. cfprocessingdirective
      14. cfprocparam
      15. cfprocresult
      16. cfprogressbar
      17. cfproperty
      18. cfquery
      19. cfqueryparam
    10. Tags r-s
      1. cfregistry
      2. cfreport
      3. cfreportparam
      4. cfrethrow
      5. cfreturn
      6. cfsavecontent
      7. cfschedule
      8. cfscript
      9. cfsearch
      10. cfselect
      11. cfservlet
      12. cfservletparam
      13. cfset
      14. cfsetting
      15. cfsharepoint
      16. cfsilent
      17. cfslider
      18. cfspreadsheet
      19. cfsprydataset
      20. cfstoredproc
      21. cfswitch
    11. Tags t
      1. cftable
      2. cftextarea
      3. cftextinput
      4. cfthread
      5. cfthrow
      6. cftimer
      7. cftooltip
      8. cftrace
      9. cftransaction
      10. cftree
      11. cftreeitem
      12. cftry
    12. Tags u-z
      1. cfupdate
      2. cfwddx
      3. cfwebsocket
      4. cfwindow
      5. cfxml
      6. cfzip
      7. cfzipparam
  13. CFML Reference
    1. Reserved words and variables
      1. Reserved words and variables
      2. Reserved words
      3. Scope-specific built-in variables
      4. Custom tag variables
      5. ColdFusion tag-specific variables
      6. CGI environment (CGI Scope) variables
    2. Ajax JavaScript functions
      1. Ajax JavaScript functions
      2. Function summary Ajax
      3. ColdFusion.Ajax.submitForm
      4. ColdFusion.Autosuggest.getAutosuggestObject
      5. ColdFusion.Layout.enableSourceBind
      6. ColdFusion.MessageBox.getMessageBoxObject
      7. ColdFusion.ProgressBar.getProgressBarObject
      8. ColdFusion.MessageBox.isMessageBoxDefined
      9. JavaScriptFunctionsinColdFusion9Update1
    3. ColdFusion ActionScript functions
      1. ColdFusion ActionScript functions
      2. CF.http
      3. CF.query
    4. ColdFusion mobile functions
      1. ColdFusion Mobile Functions
      2. Accelerometer Functions
      3. Camera Functions
      4. Connection Functions
      5. Contact Functions
      6. Event Functions
      7. File System Functions
      8. Geolocation Functions
      9. Media and Capture Functions
      10. Notification Functions
      11. Splash Screen Functions
      12. Storage Functions
    5. Application.cfc reference
      1. Application.CFC reference
      2. Application variables
      3. Method summary
      4. onAbort
      5. onApplicationEnd
      6. onApplicationStart
      7. onMissingTemplate
      8. onCFCRequest
      9. onError
      10. onRequestEnd
      11. onRequest
      12. onRequestStart
      13. onServerStart
      14. onSessionEnd
      15. onSessionStart
    6. Script functions implemented as CFCs
      1. Script Functions Implemented as CFCs
      2. Accessing the functions
      3. Function summary
      4. ftp
      5. http
      6. mail
      7. pdf
      8. query
      9. Script functions implemented as CFCs in ColdFusion 9 Update 1
      10. storedproc
    7. ColdFusion Flash Form style reference
      1. Styles valid for all controls
      2. Styles for cfform
      3. Styles for cfformgroup with horizontal or vertical type attributes
      4. Styles for box-style cfformgroup elements
      5. Styles for cfformgroup with accordion type attribute
      6. Styles for cfformgroup with tabnavigator type attribute
      7. Styles for cfformitem with hrule or vrule type attributes
      8. Styles for cfinput with radio, checkbox, button, image, or submit type attributes
      9. Styles for cftextarea tag and cfinput with text, password, or hidden type attributes
      10. Styles for cfselect with size attribute value of 1
      11. Styles for cfselect with size attribute value greater than 1
      12. Styles for cfcalendar tag and cfinput with dateField type attribute
      13. Styles for the cfgrid tag
      14. Styles for the cftree tag
      15. ColdFusion Flash Form Style Reference
    8. ColdFusion event gateway reference
      1. ColdFusion Event Gateway reference
      2. addEvent
      3. CFEvent
      4. CFEventclass
      5. Constructor
      6. Gateway development interfaces and classes
      7. getStatus
      8. setCFCPath
      9. setCFCMethod
      10. getOriginatorID
      11. getLogger
      12. getBuddyList
      13. getBuddyInfo
      14. IM gateway message sending commands
      15. IM Gateway GatewayHelper class methods
      16. onIncomingMessage
      17. onIMServerMessage
      18. onBuddyStatus
      19. onAddBuddyResponse
      20. onAddBuddyRequest
      21. IM Gateway CFC incoming message methods
      22. IM gateway methods and commands
      23. CFML CFEvent structure
      24. warn
      25. info
      26. setOriginatorID
      27. data command
      28. submit Multi command
      29. submit command
      30. setGatewayType
      31. setGatewayID
      32. setData
      33. setCFCListeners
      34. outgoingMessage
      35. getStatusTimeStamp
      36. numberOfMessagesReceived
      37. numberOfMessagesSent
      38. removeBuddy
      39. removeDeny
      40. removePermit
      41. setNickName
      42. setPermitMode
      43. setStatus
      44. SMS Gateway CFEvent structure and commands
      45. SMS Gateway incoming message CFEvent structure
      46. getStatusAsString
      47. getProtocolName
      48. getPermitMode
      49. getPermitList
      50. getNickName
      51. getName
      52. getDenyList
      53. getCustomAwayMessage
      54. getQueueSize
      55. getMaxQueueSize
      56. getHelper
      57. getGatewayType
      58. getGatewayServices
      59. getGatewayID_1
      60. getGatewayID
      61. getData
      62. getCFCTimeout
      63. setCFCTimeout
      64. getCFCPath
      65. getCFCMethod
      66. GatewayServices class
      67. Gateway interface
      68. GatewayHelper interface
      69. addPermit
      70. addDeny
      71. addBuddy
      72. error
      73. debug
      74. Logger class
      75. stop
      76. start
      77. CFML event gateway SendGatewayMessage data parameter
      78. restart
      79. fatal
      80. SMS gateway message sending commands
    9. ColdFusion C++ CFX Reference
      1. C++ class overview
      2. Deprecated class methods
      3. CCFXException class
      4. CCFXQuery class
      5. CCFXRequest class
      6. CCFXStringSet class
      7. ColdFusion C++ CFX Reference
    10. ColdFusion Java CFX reference
      1. ColdFusion Java CFX reference
      2. Class libraries overview
      3. Custom tag interface
      4. Query interface
      5. Request interface
      6. Response interface
      7. Debugging classes reference
    11. WDDX JavaScript Objects
      1. WDDX JavaScript objects
      2. JavaScript object overview
      3. WddxRecordset object
      4. WddxSerializer object
  14. Develop ColdFusion applications
    1. Introducing ColdFusion
      1. Introducing ColdFusion
      2. About ColdFusion
      3. About Internet applications and web application servers
      4. About JEE and the ColdFusion architecture
    2. Changes in ColdFusion
      1. Changes in ColdFusion
      2. Replacement of JRun with Tomcat
      3. Security enhancements
      4. ColdFusion WebSocket
      5. Enhanced Java integration
      6. ColdFusion ORM search for indexing and search
      7. Solr enhancements
      8. Scheduler enhancements
      9. Integration with Microsoft Exchange Server 2010
      10. RESTful Web Services in ColdFusion
      11. Lazy loading across client and server in ColdFusion
      12. Web service enhancements
      13. Displaying geolocation
      14. Client-side charting
      15. Caching enhancements
      16. Server update using ColdFusion Administrator
      17. Secure Profile for ColdFusion Administrator
    3. Introduction to application development
      1. Introduction to application development using ColdFusion
      2. Using the Developing ColdFusion Applications guide
      3. About Adobe ColdFusion documentation for Developers
    4. The CFML programming language
      1. The CFML programming language
      2. Elements of CFML
      3. ColdFusion variables
      4. Expressions and number signs
      5. Arrays and structures
      6. Extend ColdFusion pages with CFML scripting
      7. Regular expressions in functions
      8. ColdFusion language enhancements
      9. Built-in functions as first class citizen
      10. Data types- Developing guide
    5. Building blocks of ColdFusion applications
      1. Building blocks of ColdFusion applications
      2. Create ColdFusion elements
      3. Write and call user-defined functions
      4. Build and use ColdFusion Components
      5. Create and use custom CFML tags
      6. Build custom CFXAPI tags
      7. Use the member functions
      8. Object Oriented Programming in ColdFusion
    6. Develop CFML applications
      1. Develop CFML applications
      2. Design and optimize a ColdFusion application
      3. Handle errors
      4. Use persistent data and locking
      5. Use ColdFusion threads
      6. Secure applications
      7. Client-side CFML (for mobile development)
      8. Use the ColdFusion debugger
      9. Debugging and Troubleshooting Applications
      10. Develop globalized applications
      11. REST enhancements in ColdFusion
      12. Authentication through OAuth
      13. Social enhancements
    7. Develop mobile applications
      1. Mobile application development
      2. Build mobile applications
      3. Debug mobile applications
      4. Inspect mobile applications
      5. Package mobile applications
      6. Troubleshoot mobile applications
      7. Device detection
      8. Client-side CFML
      9. Mobile Templates
      10. Code samples to build a mobile application
    8. Access and use data
      1. Access and use data
      2. Introduction to Databases and SQL
      3. Access and retrieve data
      4. Update database
      5. Use Query of Queries
      6. Manage LDAP directories
      7. Solr search support
    9. ColdFusion ORM
      1. ColdFusion ORM
      2. Introducing ColdFusion ORM
      3. ORM architecture
      4. Configure ORM
      5. Define ORM mapping
      6. Work with objects
      7. ORM session management
      8. Transaction and concurrency
      9. Use HQL queries
      10. Autogenerate database schema
      11. Support for multiple data sources for ORM
      12. ColdFusion ORM search
    10. ColdFusion and HTML5
      1. ColdFusion and HTML 5
      2. Use ColdFusion Web Sockets
      3. Media Player enhancements
      4. Client-side charting
      5. Display geolocation data
    11. Flex and AIR integration in ColdFusion
      1. Flex and AIR integration in ColdFusion
      2. Use the Flash Remoting Service
      3. Use Flash Remoting Update
      4. Offline AIR application support
      5. Proxy ActionScript classes for ColdFusion services
      6. Use LiveCycle Data Services ES assembler
      7. Use server-side ActionScript
    12. Request and present information
      1. Request and present information
      2. Retrieve and format data
      3. Build dynamic forms with cfform tags
      4. Validate data
      5. Create forms in Flash
      6. Create skinnable XML forms
      7. Use Ajax data and development features
      8. Use Ajax User Interface components and features
    13. Office file interoperability
      1. Office file interoperability
      2. Using cfdocument
      3. Using cfpresentation
      4. Using cfspreadsheet
      5. Supported Office conversion formats
      6. SharePoint integration
    14. ColdFusion portlets
      1. ColdFusion portlets
      2. Run a ColdFusion portlet on a JBoss portal server
      3. Run a ColdFusion portlet on a WebSphere portal server
      4. Common methods used in portlet.cfc
      5. ColdFusion portlet components
      6. Support for JSR-286
    15. Work with documents, charts, and reports
      1. Work with documents, charts, and reports
      2. Manipulate PDF forms in ColdFusion
      3. Assemble PDF documents
      4. Create and manipulate ColdFusion images
      5. Create charts and graphs
      6. Create reports and documents for printing
      7. Create reports with Report Builder
      8. Create slide presentations
    16. Use web elements and external objects
      1. Use web elements and external objects
      2. Use XML and WDDX
      3. Use web services
      4. Use ColdFusion web services
      5. Integrate JEE and Java elements in CFML applications
      6. Use Microsoft .NET assemblies
      7. Integrate COM and CORBA objects in CFML applications
    17. Use external resources
      1. Send and receive e-mail
      2. Interact with Microsoft Exchange servers
      3. Interact with remote servers
      4. Manage files on the server
      5. Use event gateways
      6. Create custom event gateways
      7. Use the ColdFusion extensions for Eclipse
      8. Use the data services messaging event gateway
      9. Use the data management event gateway
      10. Use the FMS event gateway
      11. Use the instant messaging event gateways
      12. Use the SMS event gateway

The administrator portal is a platform to manage and administer properties and functionality of the ColdFusion API Manager. Through the administrator portal, you can manage all published APIs, and their functional and non-functional information.

As an administrator, you can perform the following tasks:

  • Add and manage all users and their roles with respect to single or multiple published APIs.
  • View and manage all SLA plans.
  • View and manage tier plans of all published APIs.


Logging in to the administrator portal

To log in to the administrator portal:

  1. Enter the user name and password in the fields provided.
  2. Click Login.
API Manager-Administrator login

If you want to change the password, navigate to <API Manager Installation Directory>/conf and open the file Change the password in the file. You can only change the default administrator password using the file.

Steps to reset admin password:

1. Edit the file at <apimanager_home/conf>with entries as:
            adminname=<User name while installing API Manager>
            adminpassword=<Your new preferred password>
2. Make readDefault to true in default_conf.xml.
3. Restart "ColdFusion 2016 API Manager" service.

You cannot delete or edit this account to remove administrator privileges.

You cannot change the password of other users except the default user.

You can change the logo and title on the header area of the administrator portal.

Navigate to the <API Manager Installation Directory>/wwwroot/portal/conf folder and open the file config.json. Modify the following properties:


"headerTitle": "API Manager Portal",

"adminHeaderTitle": "API Manager Administrator",

"headerLogoPath": "images/CF-Logo.png"



Specifying server settings

You can configure the settings for the API Manager server from the following screens:

  • General
  • API Datastore
  • API Analytics Server


On this page, you can set up an API Proxy or an API Portal to host your APIs.

API Proxy

In an enterprise, you communicate with existing and new customers. Consumers use a range of devices from phones to desktops. One of the ways to interact with the devices is through an API. But, there are some concerns, for example, security, availability, and monitoring of the APIs. In such situations, you define an API proxy. An API proxy performs the following:

  • Transports security
  • Monitors SLAs, performance, and so on, of the API
  • Defines access levels of an API

An API proxy makes your API independent from your back end services. Whenever you change your back end services, for example, changes in code, the application runs without interruptions.

Setting up an API Proxy

Define API proxy configuration

  1. In the Host field, enter the IP address. The API Proxy can be a host within the network or external to the network.

  2. In the Port field, enter the port of the API Proxy. For example, http://localhost:5100, where 5100 is the port number.

  3. To enable the port on the API Proxy when the proxy restarts (manually or scheduled), select the Enable check-box.

  4. In the Context Root field, enter the name of the context root. A context root identifies an application on the server. For example, if your application's context root is mycontextroot , and the application is hosted on http://localhost:5100, you can access the application at  http://localhost:5100/mycontextroot.


    If you change your connector settings in ColdFusion, reconfigure the connector settings in both Proxy and Portal

    If the proxy context is "/" and selecting to configure connector to CF, you can see a message regarding restrictions in default document.

    If the proxy content is "/ something-else " and selecting to configure connector to CF, there is no message.

  5. In the AJP Port field, enter the port number of the Apache JServ Protocol (AJP) connector. AJP allows Tomcat to communicate with an Apache web server.

  6. To enable the AJP Port on the server, select the Enable check-box adjacent to the AJP Port field. To save the changes, click Save.

  7. In the Domain URL field, enter the URL of the domain that hosts the API endpoints.

Advanced Request Settings section

  • Max Header Size (in bytes): Maximum allowable size for an API request header.
  • Max Body Size (in bytes): Maximum allowable size for the body of an API request.
  • Max Total Files Upload Size (in bytes): Maximum size allocated to a file for upload.
  • Max No. of Headers: Maximum allowed count of headers in a request.
  • Max No. of Parameters: Maximum allowed count of query parameters in a request.

Setting up a Portal

Publishers use portals to create APIs for subscribers to consume. On a portal, a publisher can create the APIs and can restrict the APIs to certain nodes. Portals can run on multiple nodes. On the other hand, you can configure an API proxy on any node.

Define API portal configuration

  1. In the Port field, enter the port of the API Portal.

  2. To enable the port on the API Portal when the proxy restarts (manually or scheduled), select the Enable check-box.

  3. In the AJP Port field, enter the port number of the Apache JServ Protocol (AJP) connector. AJP allows Tomcat to communicate with an Apache web server.

  4. To enable the AJP Port on the server, select the Enable check-box adjacent to the AJP Port field. To save the changes, click Save.

API Datastore

The Datastore is a distributed configuration system and an in-memory cache used in the API Manager. The API Datastore has the following advantages:

  • Distributed
  • Fast
  • Scalable
  • Failsafe

Configuring datastore settings

  1. In the Host field, enter the host name or IP address of the Data store. The Data store can be local or external to a network.

  2. In the Port field, enter the port number of the Data Store.

  3. In the Password field, enter the password of the Data Store.

  4. In the Timeout field, enter the timeout duration in seconds.

API Analytics Server

Configure the settings for the number of API requests for which to generate metrics. For more information, refer to Metrics and Logging.

Configuring metric settings

  1. In the Cluster Name field, enter the name of the Elastic Search cluster. The analytics of these requests are then published into a portal. For more details, refer to Setting up Cluster Support.

  2. Specify the ElasticSearch node address along with the HTTP Port and Cluster Port.

    • API Manager uses Cluster port to send the metrics related data to the ElasticSearch.
    • API Manager uses HTTP port to fetch the data from ElasticSearch to render it on Analytics Dashboard.
  3. To manually add the other nodes of ElasticSearch cluster, click Add Address.

  4. Enter the ElasticSearch node address and enter the port number in the HTTP Port and Cluster Port fields. 

  5. In the Socket Timeout field, enter the timeout for receiving individual packets from ElasticSearch Server.

    If a large amount of data is retrieved in a single request from ElasticSearch server and network latency is high, increase the timeout.

  6. In Analytics Server configuration, the client allows to sniff the rest of the cluster, which lists all nodes that the cluster can use. To enable this feature, select Sniff.

    When you select Sniff and specify an Analytics Server address in the configuration, the API Manager automatically finds the other cluster nodes and balances load among them in a round-robin fashion.

  7. In the Flush Interval field, enter the time interval (in seconds). This is the time after which the Analytics Server receives a specified number of API requests to flush the data to the disk.

  8. In the Refresh Interval field, enter the time interval (in seconds). This is the time after which the Analytics Server refreshes all indices and in-memory buffer is written to a new segment, without committing those changes to the disk.

  9. In the Maximum Actions Per Bulk Request field, enter the number of actions that are collectively sent to the Analytics Server for metrics calculation and visualization. If you enter 1000 in the field, no more than 1000 actions can be sent to the Analytics Server. The default value is 1000 actions per bulk request. 

  10. In the Maximum Concurrent Bulk Request field, enter the number of concurrent bulk requests that are sent to the Analytics Server. For example, if you enter 2 in the field, no more than two concurrent bulk requests can be sent to the Analytics Server.

  11. In the Maximum Volume Per Bulk Request field, enter the size of the each bulk request in this field. The size is calculated in Megabytes. For example, if you enter 5 in the field, the size of bulk request cannot exceed 5 MB.

Specifying security settings


You can configure the OAuth2 settings on this screen. This protocol allows third-party applications to grant limited access to an HTTP REST service, either on behalf of a resource owner, or by allowing the third-party application to obtain access on its own behalf.

Configuring OAuth2 settings

  1. Click Security > Configuration.

  2. In the Encryption Seed field, enter a random string as new seed value to encrypt application keys, user store connection passwords, and mail server passwords. This string is always a random value.


    If you change the encryption seed, restart the API Manager application server.

  3. In the Portal Session Timeout field, enter the number of seconds after which the session of an API publisher or administrator portal application expires.

  4. In the Password Reset Timeout field, enter the number of seconds within which a user can submit a request to change the password.

  5. In the Max Invalid Login Attempts Before Lockout field, enter the maximum attempts to log in before you are locked out. For example, if you enter five in the field, you can enter an incorrect password only five times.

    If you enter zero in the field, a user can make unlimited login attempts. Entering zero is not recommended.

  6. To permanently lock an account, select the Lockout Forever check-box. By default, it is unchecked. If you choose this option, a user is locked out permanently as soon as he exhausts the maximum attempts to log in to the portal.

  7. In the Account Lockout Duration field, enter the time in seconds after which a user can request for a new password after exhausting the maximum invalid login attempts.

  8. In the OAuth2 Session Timeout field, enter the number of seconds after which your OAuth2 session gets expires. After the session, you will enter your user name and password for obtaining access tokens and authorization codes.

  9. In the OAuth2 Access Token Default Timeout field, enter the duration of the default OAuth2 access token after which the original access token expires. A subscriber can override this value in the application configuration.

  10. In the OAuth2 Refresh Token Default Timeout field, enter the default OAuth2 refresh token duration after which the ioriginal refresh token expires. A subscriber can override this value in the application configuration.

  11. In the Authorization Code Timeout field, enter the number of seconds after which the OAuth2 authorization code expires.

  12. To allow only HTTPS on OAuth2 and token endpoints, select the Mandate HTTPS check-box. If you select this check-box, you reject plain HTTP connections.

User Store

A user store is a database to store information about users and user roles. The database stores login id, password, first name, last name, email address, and so on.

You can create a user store through LDAP or a database connection, such as, JDBC and ODBC. The API Manager comes with an internal user store. 

To add a user store:

Creating a user store

  1. Click Security > User Store.

  2. Click Add User Store.

  3. From the Connector Type drop-down list, select the type of connector - LDAP Connector or Database Table Connector.

Database Table Connector

You can create a user store using JDBC. You can create a connection string in the database to store the information that an application uses to connect to the database.

Details tab

The Details tab contains the following fields:




The name identifies the user store.

Logon Identifier

The unique identifier for a user store. Prefix this identifier when you log in to a portal.


The information about the user store.

Disabled check-box

Select to enable users in the store access consumer applications.

Connection tab

The Connection tab contains the following fields:



Database Server Name

The name of the host from where the database runs.

Database Port

The port number of the database server.

Database User Name

The name of the user that has permission to a table.

Database User Password

The password of the user.

Database Name

The name of the database server that contains the table.

JDBC Driver

The name of the class of the JDBC driver.

JDBC Connection URL

The URL of the JDBC driver. For more information, refer to the JDBC Driver documentation.

Datasource Path

The path to the source of JDBC data. For example, jdbc/SampleDataSource.

Initial JNDI Properties

The list of JNDI standard environment properties.

Configuration tab

The Configuration tab contains the following fields:

Field Description
User Table The name of the table that contains the user accounts.
Key Column The value of the column that uniquely identifies the rows in the table.
User First Name Column The first name of the user.
User Last Name Column The last name of the user.
User Email Column The email of the user.
Password Column The name of the column in the table that holds the values of the passwords of a user.
Roles Table The name of the table in the database that contain user roles.
Roles Table Key Column The name of the table that contains the mapping between users and their roles.
User Roles Mapping Table User Key Column The value of the column that associates user account in the table.
User Roles Mapping Table Role Key Column The value of the column that associates roles of users in the table.

Pooling tab

The Pooling tab contains the following fields:



Maximum Idle Connections

The maximum number of connections to the database that can be idle.

Minimum Idle Connections

The minimum number of connections to the database that can be idle.

Connection Wait Timeout

The time (in milliseconds) that the pool can wait for a connection before it times out.

Maximum Active Connections

The maximum number of connections that are allocated from the pool concurrently.

Idle Connection Evict Timeout

The time (in milliseconds) to wait before removing an idle connection.

Advanced tab

The Advanced tab contains the following fields:



Enable writing empty string

Select this check-box to write an empty string instead of a null value in columns defined as not-null in the table schema.

Name Quoting

Select this check-box if you want the column names for the database to be within quotes.

Validate Connection Query

The SQL query to validate the database connection.

JavaScript connector

You can write JavaScript code to connect to any database and authenticate users, fetch users, and perform other tasks.

Details tab

The Details tab contains the following details:




The name of the user store.

Logon Identifier

The identifier to the user store.


More information about the user store.


If disabled, users are unable to access applications.

Scripts tab

The Scripts tab contains the following details:

Script Mode: Write all your events in the script mode.

Events mode: Add a JS event, for example, searchUsers, getUser, from a list of events. For example, add the event getUser. The following screenshot displays a sample code to retrieve a list of users from the user store:

Upload JS file: When uploading a file, the content of the file gets displayed in the Scripts tab. You can edit the file and save it. The changes you make do not reflect in your original file.

JavaScript Variables: Declare your variables in the section.

List of JavaScript events


Initialize variables, set properties, or declare helper functions. For example,

var http = require("http"); // USe HTTP as client
                var pool = http.configure().pool({
                                "total" : 30,
                                "perRoute": 20
                                "readtimeout": 20,
                                "requesttimeout": 100
                                "truststorename": "namegiveninadmin",
                                "keystore": "admin"
                var url = "Your URL";
                var apiKey = "Your API key";


Authorize users of a user store, when the user store is configured for OAuth2. Also onboard publishers, subscribers, or administrators to a user store.

function auth(username, password) { 
                         r authMap = {
                                                "username": username, 
                                                "password": password,
                                                "options": {
                                                "multiOptionalFactorEnroll": false,
                                                "warnBeforePasswordExpired": false
                                print("response: " + JSON.stringify(authMap));
                                var response = + "authn")
                                if(response.status == 401)
                                                throw new Error("Invalid Username/Password");
                                if(response.status == 200) { //parse Response
                                                print("received response " + response.body);
                                                var json = JSON.parse(response.body);
                                                if(json.status == "SUCCESS") {//save profile
                                                                return true;
                                                throw new Error("Unknown Error");
                                } else
                                                throw new Error("Internal Server Error");


Search for users in a user store, specify a search filter, and specify the number of search results to be returned in a page.

function searchUsers(settings) {
                                print("inside search users");
                                var response = pool.get(url + "users")
                                                .header("Authorization","SSWS " + apiKey)
                                                .queryString("limit", settings.pageSize)
                                print("received response " + response);
                                if(response.status == 200){
                                                var json = JSON.parse(response.body);
                                                if(json.length) {
                                                                var users = [];
                                                                for each (var user in json) {
                                                                return users;
                                                return [];
                                } else if(response.status == 401) {
                                      "Okta API Key " + apiKey + " is invalid/expired. Unable to search for the users");
                                throw new Error("Internal server error.");

Returns array of users with the following properties:

  • uniqueid
  • username
  • firstname
  • lastname
  • email
  • accountenabled


Search for scopes for both OAuth2 or basic authentication where you want to tag your scopes with roles.

function searchRoles(settings) { 
                                print("inside search groups");
                                var response = pool.get(url + "groups")
                                                .header("Authorization","SSWS " + apiKey)
                                                .queryString("limit", settings.pageSize)
                                print("received response " + response);
                                if(response.status == 200){
                                                var json = JSON.parse(response.body);
                                                if(json.length) {
                                                                var groups = [];
                                                                for each (var group in json) {
                                                                return groups;
                                                return [];
                                } else if(response.status == 401) {
                                      "Okta API Key " + apiKey + " is invalid/expired. Unable to search for the groups");
                                throw new Error("Internal server error.");

The search results are returned with the following:

  • uniqueidrolename
  • rolename
  • description


Retrieves a user belonging to any role or roles.

function getUser(username, needgroups) { // needgroups=True or false
                                print("inside get user");
                                var response = pool.get(url + "users/" + username)
                                                .header("Authorization","SSWS " + apiKey)
                                print("received response " + response);
                                if(response.status == 200) {
                                                var acc = toAccount(JSON.parse(response.body));
                                                if(needgroups) {
                                                                var groups = getUserRoles(username);
                                                                acc.userRoles = groups; // userRoles- list of unique ids of roles.
                                                return acc;
                                } else if(response.status == 401) {
                                      "Okta API Key " + apiKey + " is invalid/expired. Unable to search for the users");
                                } else if(response.status == 404) {
                                                return null;
                                throw new Error("Internal server error.");


Retrieves a list of roles for a user.

function getUserRoles(username) {
                                print("inside get user roles");
                                var response = pool.get(url + "users/" + username + "/groups")
                                                .header("Authorization","SSWS " + apiKey)
                                if(response.status == 200){
                                                var json = JSON.parse(response.body);
                                                if(json.length) {
                                                                var groups = [];
                                                                for each (var group in json) {
                                                                return groups;
                                                return [];
                                } else if(response.status == 401) {
                                      "Okta API Key " + apiKey + " is invalid/expired. Unable to search for the groups");
                                throw new Error("Internal server error.");

The search results are returned with the following:

  • uniqueid
  • rolename
  • description


Retrieves users belonging to a role in the user store.

function getRoleMembers(rolename) {
                                print("inside get role members");
                                var response = pool.get(url + "groups/" + rolename + "/users")
                                                .header("Authorization","SSWS " + apiKey)
                                if(response.status == 200){
                                                var json = JSON.parse(response.body);
                                                if(json.length) {
                                                                var users = [];
                                                                for each (var user in json) {
                                                                return users;
                                                return [];
                                } else if(response.status == 401) {
                                      "Okta API Key " + apiKey + " is invalid/expired. Unable to search for the users of group");
                                throw new Error("Internal server error.");

Returns array of users with the following properties:

  • uniqueid
  • username
  • firstname
  • lastname
  • email
  • accountenabled


Any helper function you want to execute before exiting the JavaScript connector. For example, creating a log file, storing values in memory, or terminating a session.

function onstoreend(){

For more information, see the Nashorn documentation.

LDAP Connector

You can configure the API Manager to leverage an LDAP server for user authentication. In this case, the LDAP server creates and manages users.

Details tab

The Details tab contains the following fields:




The name of the user store. The name identifies this user store.

Logon Identifier

The identifier of the user store in LDAP.


The information about this user store.


Select this check-box to enable users in the store access the consumer applications.

Connection tab

The Connection tab contains the following fields:




The name or IP address of the LDAP server.

TCP Port

The port number of the LDAP server. This port is the same as the port on which the LDAP listens for SSL connections.

User Bind DN

The bind Distinguished Name (DN) to connect to the LDAP server. The bind DN is the user on the external LDAP server permitted to search the LDAP directory within the defined search base. The role of the bind DN is to query the directory using the LDAP query filter and search for a user. For example, some possible bind DNs are cn=administrator, cn=Users, dc=domain, or c=com.

User Bind DN Password

The password to connect to the LDAP server.

SSL/TLS Enabled

Select this check-box to use a secure connection.

StartTLS Enabled

Select this check-box to allow an application to send secure requests to an LDAP server.

Base Contexts

The points in the LDAP tree for searching the tree.

Failover Servers

The name of all the servers that act as failover servers. For example, "ldap://" represents a list of failover servers. If the primary server fails, Java Naming and Directory Interface (JNDI) connects to the next available server in the list.

Configuration tab

The Configuration tab contains the following fields:

Field Description
User Configuration The object classes for creating user objects in LDAP. An object class represents the type of data  in an LDAP. An objects class contains attributes of an entry in an LDAP. An objectclass is defined in a schema.
LDAP Filter for Retrieving Accounts The filter attribute to retrieve user accounts from LDAP.
Account User Name Attributes The attribute or attributes that represent a user name of an account. An attribute authenticates a user name in an LDAP entry.
User First Name Attribute The attribute that represents the first name of the user in an LDAP account.
User Last Name Attribute The attribute that represents the last name of the user in an LDAP account.
User Email Attribute The attribute that represents the email of the user in an LDAP account.
Group Configuration The object classes for creating groups in LDAP.
LDAP Filter for Retrieving Groups The filter attribute to retrieve user groups from LDAP.
Group Name Attribute The attribute that represents the name of the group in an LDAP account.
Group Membership Attribute The attribute that contains users in an LDAP group.

Advanced tab

The Advanced tab contains the following fields:



Use Paged Result Control

Select this check-box to ensure that the LDAP uses paged results instead of Virtual List View (VLV) when retrieving user accounts. VLV lets you query a large directory in chunks. For example, let there be a directory with a large number of users, "ou":


     + ou=DemoGroups (100,000 groups)         

     + ou=DemoUsers (100,000 users)

If you want to present the information in the user group "ou" in a scrollable or paged window in an application, retrieving 1000 pages of 100 results each is an inefficient way. This method is resource-intensive and wastes bandwidth. On the other hand, VLV queries a large data-set with a sorting rule. For example, using VLV, you can sort the first 50 users ordered by organizationName in an LDAP.

LDAP Referral Handling

Either follow or ignore LDAP referrals. LDAP referrals enable an LDAP tree to be distributed across multiple LDAP servers. Therefore, an LDAP server can reference other LDAP servers even though it does not store the full Directory Information Tree (DIT). When you browse a particular directory, an LDAP server returns referrals after referring you to another server in the tree.

Adding users

User management in the API Manager involves defining and managing users, roles, and their access levels. You can add or delete users, assign roles, search for users, manage user stores, and import external users from LDAP or database connection.

To add a user:

  1. Click Security > Users

  2. Click Import External Users to retrieve users from a database or an LDAP connection.

  3. To add a user, select a user store and click Add User. The following page displays.

    1. In the User Name field, enter the unique identifier of the new user.
    2. Enter the attributes of the user in the rest of the fields.
    3. Select the appropriate role for the new user- Publisher, Subscriber, or Administrator. For more details, see Roles.
    4. Click Add User to add the user in the user store.

SAML Identity Provider

In this scenario, the user tries to access a service provider configured in API Manager. API Manager the sends a SAML token to the service provider. The service provider then identifies the user and authenticates the token. If the user is identified successfully, the user logs in to the service provider.

To set up API Manager as identity provider:

  1. Log in to the API Manager as Administrator. Click Security > Identity Providers > SAML.

  2. In the General tab, enter the following details:


    Name of the SAML identity provider.

    Display Name

    The name of the IdP to be displayed.


    Enable or disable the IDP.


    The description of the IDP.

    Service Provider

    Select the SP already created.

  3. In the Metadata tab, you have three options to import SAML metadata. enter the following details:


    The URL through which you get the metadata.


    The URL through which you log in.

    Sign Authentication Assertions

    Enable if you want to sign before sending the assertions.

    Sign Certificate

    The certificate used for signing.

  4. In the Attribute Mappings tab, enter the following details:

    Default Roles

    Choose from the following – Publisher, Subscriber, or Administrator

    Role Attribute Name

    Role identifier between API Manager and the IDP.

    Role Attribute Delimiter

    Delimiter for role attributes.

    Attribute Mappings

    Enter the same values that you had entered when configuring the application in Okta.

  5. In the Advanced Settings tab, enter the following details.

    User ID Location

    Identifier for the user name defined in the metadata.

    Clock Skew (seconds)

    Offset between the API Manager and the IDP local times.

SAML Service Provider

In this scenario, the service provider sends a SAML token to the API Manager as identity provider. API Manager then sends the appropriate response to the service provider, which then authenticates the SAML metadata and allows the user to log in to the application.

Enabling API Manager as an identity provider, you need a key pair that is signed by an external certificate authority. You can generate a key pair either by:

To set up the service provider:

Click Security > Service Providers > SAML. Enter the following details:


The name of the service provider.

Display Name

The name to be displayed.


Enable or disable the service provider.



The description of the service provider.

Entity Id

Globally unique name for the SAML entity, which in this case is the Service Provider.


The location where your Identity Provider receives SSO messages.


The location where the SAML assertion is sent.

Sign Requests


Assertions Signed


Enable IDP SSO

Enable the check-box to allow the Identity Provider's single-sign on service to receive a signed auth request.

Signing Keystore name




Encryption Keystore name




Key Stores

A Key Store is a repository of security certificates – either authorization certificates or public key certificates – plus corresponding private keys, used for instance in SSL encryption.

You can use a key store in one of the following ways:

  • The keystore contains private keys and certificates used by SSL servers to authenticate themselves to SSL clients. By convention, such files are referred to as keystores .
  • When used as a  truststore , the file contains certificates of trusted SSL servers, or of Certificate Authorities trusted to identify servers. There are no private keys in the truststore .

To create a key store:

To import a key store:

1.       Click Create Key Store.

2.       Set a name and password for the key store.

3.       Click Create.

4.       Click Import Certificate.

5.       Enter the alias for the certificate and choose the certificate file that you had created using keytool command line or GUI.

6.       Click Import Certificate.

1.       Click Import Key Store.

2.       Enter the following details:

a.       Name of the key store

b.      Password of the key store

c.       Choose the certificate you had created previously

d.      Choose the type of key store – JKS or PKCS

e.      (Optional) Enter an alias for the certificate

3.       Click Create.

Setting up SAML Identity Provider (IDP)

For this example, you can set up Okta as Identity Provider with the details of your SAML Service Provider (SP). The first step is to set up an application in Okta.

  1. Log in to your Okta organization with administrative privileges.

  2. Create an application using SAML 2.0 as the integration type.

  3. In the Configure SAML tab, enter the following details:

    a.       Enter http://localhost:9000/amp/saml/SSO/default/localhost in the Single sign on URL field. This is the same URL as ACS URL as specified in the SAML SP settings in API Manager.

    b.      Enter http://localhost/amp/apimanager as the Entity ID. This is the same URL as specified in the SAML SP settings in API Manager.

    c.       In the Attribute Statements section, add the following attributes:

                                                                   i.      firstname set to "user.firstName"

                                                                 ii.      lastname set to "user.lastName"

                                                                iii.      email set to ""

  4. Click Next and click Finish. To create a group and assign users, click Directory > Groups.

  5. To add a group and assign members, click Add Group.

Configuring SLAs

In the API Manager, an application or a resource can be available to a consumer at different levels of service. SLA configuration enforces access control through rate limiting and throttling.  Throttling tiers limit the number of hits to an API over a certain time, due to monetization of the API, security restrictions, infrastructure issues, and so on.

For example, you can set throttling tiers to the APIs to limit access to it accordingly. Each tier defines a maximum number of requests per day or week or month.

You can also set the rate limit for an SLA per second or minute or hour.

You can then add your own tiers to the API Manager using the instructions below:

Adding an SLA

  1. Click SLA Configuration. The following page displays.

  2. Select the rate limiting algorithm. In API manager, two types of algorithms can be used to limit the rate: Rolling and Fixed.

    In fixed window algorithm, the period is considered from the starting of the time unit to the end of the time unit. For example, a period is considered as 0-60 seconds for a minute irrespective of the time frame at which the API request has been made.

    In rolling window algorithm, the period is considered from the fraction of the time at which the request has been made to the end of the time unit. For example, if two requests for API calls are made at 30th second and 40th second of a minute it is considered as two requests from 30th second of that minute up to the 30th second of next minute.

    For more details, refer to Rate-limiting.

  3. In the SLA Name field, enter the name of the new SLA.

    In the Rate Limit field, enter the API request rate limit in the SLA. You can only limit an API request rate to number of requests per second, minute, or hour.

    In the Throttle Limit field, enter the API throttle limit in the SLA. You can only limit an API request rate to number of requests per second, minute, or hour.

    Select the type of throttle limit- Hard or Soft.

    • Hard: If you select this option, the number of API requests cannot exceed the throttle limit.
    • Soft: If you select this option, you can set the API request limit exceed a percentage. For example, if you set the Exceed Limit to 90%, the number of API requests can exceed 90% of the prescribed limit.
  4. In the Notify Limit field, enter the limits (in percentage) at which you receive notifications when the number of API requests approach the limit.

  5. In the Exceed Limit field, enter the limits (in percentage) by which the number of API requests can exceed.

  6. If the SLA requires an approval from the API publisher, select the Approval Required check-box.

Editing an SLA

You can edit an SLA and modify its properties. Choose an SLA from the Existing SLAs list.

  1. Click Edit. The following page displays.

  2. Update all the properties of the SLA and click Update SLA.

Creating a multi-tenant organization

To create a multi-tenant organization, click Organizations on the left pane and then click Create Organization.

Enter the following details.

Click Create.

For more information, see Multi-tenancy in API Manager.

Viewing cluster information

You can see a list of all clusters configured in API Manager. You can also see a cluster's proxy port, portal port, and so on.


Set the maximum response size to define the maximum size, in bytes, of the response that can be stored in the output cache. Also specify the timeout, in seconds.

ColdFusion discovery server

If you want to discover REST services published in a ColdFusion non-InVM environment, configure the ColdFusion server on the CF Discovery Server Configuration page.

  1. In the Protocol drop-down list, select HTTP or HTTPS.

  2. In the Name field, enter the name of the ColdFusion server.

  3. In the Address field, enter the host and port number of the CF server.

  4. In the Context field, enter the REST servlet context of the CF server.

  5. In the Username and Password fields, enter the credentials to log in to the ColdFusion server.

Configuring notifications

The API Manager sends notifications for any alerts or user events that require attention. You can configure the settings for email notifications for publishers and consumers.

Configuring mail settings

  1. Click Notifications > Mail. The following page displays.

  2. In the Mail Server field, enter the name of the server that sends Simple Mail Transfer Protocol (SMTP) messages. Alternatively, you can enter the mail server (for example, or the IP address of the mail server (for example,

  3. In the Port field, enter the port number of the mail server.

  4. In the From E-Mail Address field, enter the email address from which all password reset notification mails are sent to users.

  5. In the Username and Password fields, enter the credentials to authenticate a user in the mail server.

  6. In the Timeout field, enter the time (in seconds) that the API Manager waits for a response from th email server.

  7. In the Protocol field, enter the messaging protocol for the mail server, for example, SMTP.

  8. To enable Transport Level Security (TSL) on the connection to the mail server, select the Enable TLS connection to mail server check-box. Transport Layer Security (TLS) is a protocol that ensures privacy between applications and their users within a network. When a server and client communicate, TLS ensures security of the communication.

Modifying the e-mail template for password reset

To modify the e-mail template for password reset, navigate to {API Manager HOME}/conf/templates and open the file resetpassword .vm.

You can modify the subject and the body.

Configure log

In this page, choose the modules for which you want to generate debug logs. For example,

  • Messages logged during startup, shutdown, and cluster updates.
  • Messages logged when a request is dispatched.
  • Messages logged when an API resolves a request.

You can enable debugging for specific sections that you want to debug. For example, if you want to check for any issues while creating an API, enable the Publisher check-box in the Portal section.

This way you can manage your debug logs properly.

Viewing the analytics dashboard

Analytics dashboard helps you view the number of APIs that are run from a node, the number of API requests, and system statistics. The API Manager collects information as APIs process information. If you see a sudden spike on a graph or chart, you can take immediate measures.

By clicking a particular data (for example, API name or Publisher name or field in graph), you can filter the entire dashboard on that field.

Click Analytics to display the dashboard.

There are three types of dashboards in the Administrator portal: 

  • Home
  • Publisher APIs
  • Publishers

Home: On the Home dashboard panel, you can see the following dashboards:

Request Count for Nodes

You can view the node IP and port on which an API runs. You can also view the number of requests by the API. Hover the pointer on the visualization to see the details.

Total Request Count

You can view the count of requests by an API.

Consumed Metrics

You can view the avarage response time (in milliseconds) of an API, and the average incoming and outgoing data (in KB) of the API.

Average Request Count

You can view a line graph of the count of API requests. You can further filter the data according to the time range, for example, today, this week, this month, last minutes, last 30 minutes, last 5 years, and so on. Hover the pointer on an point on the axis to view the number of API requests within the time range.

Average Response Time

You can view the average response time of an API using this visualization. This time is in milliseconds. You can filter the data according to a time range.

Publisher APIs: On the Publisher APIs dashboard, you can see the details of each API from a publisher, the number of APIs, the number of publishers, the response times for APIs, and so on.

You can filter the requests and whole dashboard on the publishers.

Hover the pointer on a pie chart or a line chart to view more details.


Pie-chart for the number of API requests by publishers.


The number of API requests by a publisher.


The number of API requests.


The number of APIs.


The number of nodes in a cluster that contains the APIs.


The number of publishers.

Publishers: On the Publishers dashboard, you can see the visualization of the number of API requests, the number of publishers, average data consumption per publisher, and so on.

You can filter the requests and whole dashboard on the publishers.

Hover the pointer on a pie chart or a line chart to view more details.


Pie-chart for the number of API requests by publishers.


The number of nodes in a cluster that contains the APIs.


The number of API requests.


The unique count of publishers that have made at least one request within the time range.


The number of API requests from all publishers.


The number of API requests by publishers according to time-range.

Creating a visualization

You can create your custom visualizations and save it for further analysis. Follow the steps below to create a visualization:

  1. To create a visualization, click the Visualize tab.

  2. You can create visualizations in the form of area charts, data table, pie charts, and so on, from API information. As an example, create an area chart from the API analytics. Click Area chart from the list.

  3. Select from the following:

  4. Create a visualization from a new search. Select From a new search. You can see the following index patterns in the drop-down list:

  5. Select the data point on the X-Axis and click Apply.

An area chart displays with number of API requests on the Y-axis and API time-stamp on the X-axis.

Filtering data according to time range

In the Analytics page, you can filter the results according to a time range.

There are three ways options:

  1. Quick
  2. Relative
  3. Absolute
  1. Click the time filter as shown below:

  2. Select any time range from the list, as shown below:

    If you select Today, you can see the analytics of all APIs for the last 24 hours.

  3. Click Relative. You can filter the data from a specified date and time to the current date and time.

  4. Click Absolute. You can filter the results according to dates.

Filtering data according to fields

You can filter the dashboard according to fields and get complete analytic report of an API's activity. When you apply a filter, the dashboard changes accordingly and you can view the graphical results.

To filter dashboard information according to fields:

  1. Click any dashboard type:

    • Home
    • Publisher APIs
    • Publishers
  2. Choose any dashboard and hover your mouse on the graph to view the field and its values. The snapshot below displays the field values for the request count for all publisher APIs within a particular time:

    You can see a table that lists all field values for the API usweather and the number of times the API is called.

  3. Click the graph. You can see a new dashboard listing all the attributes of the chosen API.


As an Administrator, you can create organizations or tenants in the API Manager. The goal of multitenancy is to maximize resource sharing by allowing multiple users (tenants) to log in and use a single server/cluster at the same time, in a tenant-isolated manner. 

To create organizations and manage tenants, refer Multitenancy in API Manager.

API Manager Updates

In the Update section, you can verify and make product updates from the browser-interface itself.

Verify if there are any product updates by clicking update in the left navigation panel of the Administrator console. The updates can include hot fixes and security hot fixes for ColdFusion 2016 API Manager.

Available Updates

Click Check Updates to see if any hotfix updates are available for installation.

You can either:

Download: Downloads and places the file in <api_manager_home>/hf-updates/ for installation at a later time.

Download and Install: Downloads the hot fix and performs a silent installation.

Installed Updates

Lists all hotfix updates to ColdFusion 2016 API Manager that you have installed.


Provides options to specify update preferences such as update notifications or if to automatically check for updates.

If you have set up a local update site, you can also specify URL of that site to get updates.

Notifications for API Manager Updates

In this release of ColdFusion 2016 API Manager, if there are any updates available, you can see the notifications on the top of the screen when you log in to the Administrator portal.

Click the notifications icon to go to the Updates screen to view all available updates.


Log ind på din konto