Skip to main content
This website uses cookies
Accept all cookies
Reject additional cookies
Set cookie preferences
Your cookie preferences were saved
Change cookie preferences
Toggle menu
Toggle menu
Toggle menu
Toggle menu
Main menu
Main menu
Section Menu
Section Menu
Platform Introduction
List of child pages of Platform Introduction
List of child pages of Platform Introduction
What is the Digital Platform?
Getting Started with iCM
Building the Platform
Service Delivery
Website Users and User Management
Platform FAQs
Glossary of Terms
Products and Components
List of child pages of Products and Components
List of child pages of Products and Components
Bookings
Case Management
Templates
Tools and Expansions
Websites and Content
List of child pages of Websites and Content
List of child pages of Websites and Content
Creating and Managing Content
Site Features
Theme Documentation
Theme Demos
Forms and Workflow
List of child pages of Forms and Workflow
List of child pages of Forms and Workflow
Forms
Form Data Browser
Workflow Processes
Handlebars
API and Developer
List of child pages of API and Developer
List of child pages of API and Developer
The API Server
API Server Workers
End Points
JavaScript Libraries
Framework Components
Best Practice Guides
Platform Admin
List of child pages of Platform Admin
List of child pages of Platform Admin
iCM Management
Data Management
Email
Platform Search Engine
Text Editor Configuration
Website Metrics
Using External Datasources
iCM Single Sign-On
Community Area
Release Notes
Video Guides
Example Content
MyGOSS
Platform Introduction
Products and Components
Websites and Content
Forms and Workflow
API and Developer
The API Server
API Server Workers
Authentication
Blob Storage Worker
Email
End Point Library Workers
File Store
Forms Service
Form Utils
Database Functions
executeSQL(sql[, parameters, datasource, transactionId, generatedKeyColumns, queryTimeout])
beginTransaction( [datasource] )
commitTransaction( transactionId )
rollbackTransaction( transactionId )
doOptionDataRead(fieldname, dbdetails)
filterSwearWords(text[, filterString])
ftpRequest and sftpRequest
generateReadableId()
getLock(lockName[, id, timeout, comment])
hash(hashType, algorithm, data[, key, dataBase64Encoded, returnFormat])
getPasswordRulesDescription, validatePasswordAgainstRules
pdfRequest(name[, header, footer, html, template, data])
releaseLocks(lockNames)
spellcheck(text)
Gatekeeper
GovNotify
History Service
iCM API
Image Utilities
Machine Learning Worker
MyGovScot
Notification
OAuth
Postcode
SharePoint Worker
Site Session Store
SMS Worker
Workflow Worker
End Points
JavaScript Libraries
Framework Components
Best Practice Guides
Platform Admin
Hosting and Support
Release Notes
Community Resources
Training
Close navigation
Community Area
Release Notes
Video Guides
Example Content
MyGOSS
Link to '
The Digital Platform Documentation Site
' homepage
Close
Search...
Find
Platform Introduction
What is the Digital Platform?
Getting Started with iCM
Logging in to iCM
The iCM Home Page
Finding Your Way Around
Personal Settings and Shortcuts
Building the Platform
Creating Articles and Using Templates
Designing your own Forms
Analytics and Cookie Banners
Service Delivery
My Account and User Requests
Staff Actions
Website Users and User Management
Registration
Logging In
Profiles
Users and User Groups
View all Website Users and User Management
Platform FAQs
View all Platform Introduction
Products and Components
Bookings
Events
Diary Planner and Appointment Booking
Room Bookings
Registrars
Case Management
Introducing Case Management
Case Management How-to Guides
Case Handling
Case Properties
View all Case Management
Templates
Assisted Service
Authentication
Blog
Classified
View all Templates
Tools and Expansions
Comms Manager
Complaints Handling in Case Management
Configuration Manager
Contribute
View all Tools and Expansions
Websites and Content
Creating and Managing Content
Articles
Events
Features
Forums
View all Creating and Managing Content
Site Features
Accessibility Features
Article Feedback
Content Discoverability
Contributor Actions
View all Site Features
Theme Documentation
Impact
Chill
Command
Cruise
View all Theme Documentation
Theme Demos
Chill Theme Demo Site
Command Theme Demo Site
Cruise Theme Demo Site
Dynamic Theme Demo Site
Forms and Workflow
Forms
Managing Forms
Using the Forms Designer
Form Fields
Handlebars
View all Forms
Form Data Browser
Form Data Overview
Working with Form Data
Searching for Form Data
Workflow Processes
Introducing the Process Modeller
Modeller Navigation
Managing Process Models
Editing a Model
View all Workflow Processes
Handlebars
Custom Helpers
Swag Library Helpers
Handlebars Examples
API and Developer
The API Server
Getting Started
Making Requests
Creating and Configuring an API Server
API Server Security
View all The API Server
API Server Workers
Authentication
Blob Storage Worker
Email
End Point Library Workers
View all API Server Workers
End Points
Writing and Deploying End Points
End Point this Object
Copy, Create, Edit and Delete End Points
End Point Groups - Namespaces
View all End Points
JavaScript Libraries
adm-zip
apiclient
async
axios
View all JavaScript Libraries
Framework Components
Accordion
Alert
Autocomplete
Button
View all Framework Components
Best Practice Guides
Writing End Points
Form Design
Designing Workflow Processes
Platform Admin
iCM Management
Site Groups and Users
iCM Groups and Users
Approval Requirements
Version Control Policies
View all iCM Management
Data Management
Data Storage - What and Where?
Data Storage - Strengths and Weaknesses
Data Flows and Access
Core Product Data Storage
View all Data Management
Email
Emails Sent by iCM
Email Security - Using DKIM and SPF Records
Email Security - TLS Encryption
Emails from Non-Production Environments
View all Email
Platform Search Engine
Enabling the External Content Search
Search and Replace in iCM
Search Indexing
Search Ranking
View all Platform Search Engine
Text Editor Configuration
Website Metrics
View all Platform Admin
Platform Introduction
Products and Components
Websites and Content
Forms and Workflow
API and Developer
The API Server
API Server Workers
Authentication
Blob Storage Worker
Email
End Point Library Workers
File Store
Forms Service
Form Utils
Database Functions
executeSQL(sql[, parameters, datasource, transactionId, generatedKeyColumns, queryTimeout])
beginTransaction( [datasource] )
commitTransaction( transactionId )
rollbackTransaction( transactionId )
doOptionDataRead(fieldname, dbdetails)
filterSwearWords(text[, filterString])
ftpRequest and sftpRequest
generateReadableId()
getLock(lockName[, id, timeout, comment])
hash(hashType, algorithm, data[, key, dataBase64Encoded, returnFormat])
getPasswordRulesDescription, validatePasswordAgainstRules
pdfRequest(name[, header, footer, html, template, data])
releaseLocks(lockNames)
spellcheck(text)
Gatekeeper
GovNotify
History Service
iCM API
Image Utilities
Machine Learning Worker
MyGovScot
Notification
OAuth
Postcode
SharePoint Worker
Site Session Store
SMS Worker
Workflow Worker
End Points
JavaScript Libraries
Framework Components
Best Practice Guides
Platform Admin
Hosting and Support
Release Notes
Community Resources
Training
Home
API and Developer
API Server Workers
Form Utils
Database Functions
executeSQL(sql[, parameters, datasource, transactionId, generatedKeyColumns, queryTimeout])
This function allows parameterised SQL statements to be executed against a datasource.
beginTransaction( [datasource] )
commitTransaction( transactionId )
rollbackTransaction( transactionId )
Share this page
Print
Was this page useful?
No
Send page feedback
