Table of Contents

Polar Studio API documentation

Introduction

Within Polar Studio the scripting language enables you to interact with all parts of the application. The exposed API is documented in this site.

The data layer

The Polar Studio data layer is used to interact with the database. The objects exposed by the data layer follow all the business rules that are defined in Polar Studio. These object follow this hierarchy (The names of these objects start with 'buda': business data) :

  • BudaEngine: The whole engine for a project. One object servers the whole server and all concurrent sessions.
  • BudaSession: A session for a user.
  • BudaUser: The user logged in in the BudaSession.
  • BudaGroup: The user-group a user is part of within an application.
  • BudaApplication: An application opened by a user within a BudaSession.
  • BudaDataset: A dataset (like a RecordSet, but now with all PolarStudio enhancements) on a table.
  • BudaField: A field in a dataset.

The presentation layer

The presentation layer is the part that creates the web-application. It relies on the data layer to get and manipulate the data. The objects in the presentation layer are closely related to their counter-objects in the data layer:

  • BpServer: The Blue Polar Server. This single instanced main object serves all sessions on the server for this project. Relates to BudaEngine.
  • Session: A session for a user. The user does not necessarily have to be logged in. For webservice requests temporary sessions are created. Relates to BudaSession.
  • Application: A web application within a logged-in Session as opened for a user. Relates to BudaApplication.
  • Form: A form opened within an application. Can be unbound or bound to a BudaDataset.
  • Control: A control on a form. Can be unbound or bound to a BudaField or to a Relationship.

Other libraries

Polar Studio makes use of the following additional libraries:

  • CustomFormProcessor: Used to create custom forms that store their data in xml in a table.
  • PolarChart: Various graphical server tools for creating QR codes, barcodes, charts and image manipulation.
  • PolarDataInterop: A wrapper for the native DotNet database drivers to provide an OLEDB compatible interface with recordsets.
  • PolarStudioGlobals: A bunch of helper objects used in Polar Studio.