 The Aggregate API offers a series of functions to execute aggregations on a Table, rather than utilising the Table API.  Whilst the Table API will still be used to get information from records, this API focuses much more on aggregate functions to make sure it is much more efficient and easier to use for specific purposes.

Aggregation API

DateTime API

 A Job is a server side script that runs on a schedule (e. g.

Job API

 To use this functionality, you need to be on Version 1. 10 or later.

Journal API

Dialog API

 Logging Business API The Logger functionality provides the ability to log application messages, the logger can be configured to log only messages if the desired logging level are set.  There are 5 levels of logging in Servicely.

Logger API

 When scripting, calculating decimals can often be problematic on certain coding languages.  However, to remediate this, we have implemented a library within the platform, to allow you to easily and accurately calculate decimal values.

Money API (BigDecimal)

 Provisioning Scripts can be used to automate tasks on certain events within the lifecycle of the application instances.  For example, scripts can be run on node-startup, platform update, or application upgrade.

Provisioning Scripts

 A Script library allows you to create reusable scripts to run across different server side capabilities of the platform including A Script library also helps to abstract complexities that would otherwise be exposed onto the respective platform capabilities mentioned above.  If we are to call a function (called IncidentUtil.

Script Libraries

 To interact with specific fields on the form on the client side, we have a variety of functions and methods you can use to make fields read only, required and more.  The majority of these can be accessed in the following way.

Table API (Client)

 The Table and Table Record objects are used to deal with Servicely tables and the records stored in them.  They offer a series of functions to query, create, update and delete Table records.

Table API (Server)

 A Trigger automates business logics before/after a record creation/update/deletion.  For example, a Trigger can automatically set a record’s field to a particular value, after you make a certain change on that record.

Trigger

 A UI Event automates business logics on a Servicely Table’s form and/or fields as they are loaded or as you interact with them on your web browser, i. e.

UI Event

 To assist in getting quick access to various details of a user record, we have two different versions of the User Object.  One for server side, one for client side.

User Object (Client and Server)

 You can use this functionality to run any server side script (runs on Servicely servers) of your own choosing.

Running Server Scripts

Workflow API

 To support other areas and features in the platform, there are other features in the platform that you can make use of which have a very particular purpose.  As these are too small to have their own page, this page groups these items all together in one page.

Other API / Javascript Scripts

 The TableChecks configuration object is a powerful tool that governs the behavior of various system operations by allowing the selective activation or deactivation of multiple predefined settings.  These settings encompass aspects such as permissions, validations, event triggers, and system protections, each of which influences how the system processes and interacts with data.

TableChecks

Reference Qualifiers

Scripting

Out of the Box - Available without modifications from a fresh install of Servicely

OOTB

CMDB

Servicely Docs

Servicely product documentation including out-of-box configuration

Business Applications Overview

What is Enterprise Interactions?

Interaction fields and their behaviour

Additional security and restrictions

Interaction specific roles

Enterprise Interactions

HR Case Fields and their behaviour

HR Case Management - Workflow

Other fields hidden from form and un-used

HR Case automation and functionality

HR Permissions & Roles

Human Resources

What is IT Service Management?

ITSM Processes

ITSM Roles

IT Service Management

Business Applications

Catalog Categories

Catalog Items

Questions

Reference Filter

Catalog

SOFI - Service Agent Assistant

AI Prompt - Single shot LLM Classification/Prompting

Intelligent Routing

Intelligent Automation

Kanban

Announcements

Knowledge base fields and their behaviour

Knowledge fields and their behaviour

Approval within Knowledge

Knowledge Table Schema

Knowledge specific roles

Knowledge Management

Reports

Dashboards

Scheduled reports

Template Reports

Reports and Dashboards

Survey

Templates

Servicely Capability

Application Properties

What is an Application?

Miscellaneous Application Properties

Application Administration

Change Sets

Data Import & Transformation

Conversation Application (Beta)

Email processing and management

Messaging & Notifications

IP Filtering

Reverse Proxy

Networking

Authentication & Authorization

Permissions & Security

System fields and their behaviour

System Event Definition

Timezone Management

User Impersonation

Two Factor Authentication (2FA)

Single Sign-on - SAML 2.0

User and Group Provisioning

User access and provisioning

Servicely Administration

Aspects & Views

Branding

Checklist Templates

Choices & Choice Lists

Classifications

Custom Related Lists

Form Layouts

Full Text Search

List Layouts

Localisation

Platform Password reset

Query Functions

Record Generation

Reclassification Field Map

Reminder Generation

System Table Cleanup

Schedule

Service Level Management (SLM)

Workflow

Servicely Configuration

Microsoft Teams Group Chat Setup

Microsoft Teams Notification Setup

Microsoft Teams

Adding a new CMDB Class/Table

CMDB Permissions & Roles

Configuration Management Database - CMDB

Inbound Authentication for Integrations

GET Request - Retrieving records

DELETE request - Deleting records

PATCH Request - Updating existing records

POST Request - Creating new records

PUT Request - Replacing content of existing records

JSON REST API

Microsoft Intune CMDB Integration

Node-RED Authentication

Node-RED

Managed - OAuth2

Managed - HMAC Body (Servicely compatible)

Managed - Bearer token

Managed - Basic Authentication

Outbound Authentication for Integrations

Outbound HTTP Requests (Scripted)

System Controllers

Webhooks

Foundation Data & Integrations

Creating a new Catalog Item

Upgrade FAQs & Best Practice

Guides

Scripting

Need Help?