SimpleOne API

The SimpleOne API extension makes it easy to create business logic code for the SimpleOne business process automation solution. It adds support for the SimpleOne Client and Server API classes and methods and offers source code highlighting, tooltips, and autocomplete functionality when editing JavaScript files.

To learn more about SimpleOne, visit our Website, read the Documentation, or subscribe to our YouTube channel.

Make your coding Simple!

Features

Associations

To use the extension features you need to associate your scripts with the API type used (client-side or server-side). You can create associations for specific folders and files.

To associate a folder with an API type, open any JavaScript file in it. A pop-up appears where you can associate the folder with server or client API, or you can choose to never be asked about this folder again. This association applies to all files in the folder, so we recommend storing scripts by type. The folder association can be changed via the Associate Folder item in the folder context menu.

To associate a specific file with an API type, put a directive on the first line of the script. Two forms are supported:

• An explicit type: server / type: client directive. It is matched anywhere on the line, so it works inside a metadata comment such as /* type: server, name=Get client Id, application=Simple */ — unrelated words like client in the metadata no longer break the detection.
• A short comment: // server or // client.

This setting overrides the association for the folder in which the file is stored.

Code Highlighting and Tooltips

SimpleOne API classes and methods are highlighted in JavaScript files. Highlighting is applied on top of the editor's own coloring, so it does not affect the built-in coloring of constants, variables, or parameters. A method is highlighted only for the class of the instance it is actually called on, so identically named methods of different classes are not confused.

When you hover over a supported class or method, a tooltip appears with its summary and a link to the documentation. The tooltip resolves the exact class by the position of the token, so hovers stay correct even when methods of different classes share a name.

Autocomplete

SimpleOne API classes and methods are suggested while you edit the code, and via Ctrl+Space. A short description of the suggested class or method is also shown. Whether suggestions pop up automatically as you type is controlled by the standard editor.quickSuggestions setting of Visual Studio Code — the extension does not force it.

Settings

Changes to these settings apply immediately, without reloading the window.

Supported API Classes

The following classes are supported. Follow the links to learn more about them.

Client-Side

• s_i18n
• SimpleAjax
• SimpleEventBus
• SimpleForm
• SimpleGo
• SimpleList
• SimpleMenu
• SimpleModal
• SimplePreference
• SimpleRecord (client-side)
• SimpleStorage
• SimpleSystem (client-side)
• SimpleUser
• SimpleWidget(s)

Server-Side

• ExportVariables
• SimpleAttachment
• SimpleAttachmentService
• SimpleCache
• SimpleDateTime
• SimpleDelegation
• SimpleDuration
• SimpleEmailOutbound
• SimpleEmailTemplate
• SimpleEngine
• SimpleExternalRabbitMQ
• SimpleImage
• SimpleImport
• SimpleLogArchive
• SimpleMail
• SimpleMessage
• SimpleRecord (server-side)
• SimpleRecordDeletionLog
• SimpleRecordSecure
• SimpleRestRequest
• SimpleRestResponse
• SimpleSchedule
• SimpleSearch
• SimpleSession
• SimpleSystem
• SimpleTable
• SimpleTemplate
• SimpleTemplatePrinter
• SimpleTime
• SimpleUser
• SimpleUserCriteria
• SimpleVcs
• SimpleWebService
• SimpleWorkflow
• SimpleWysiwyg