Search Results for procedures

 

Style Guide, Procedures and Code Documentation

In order for source code to be more readily readable across teams, it is recommended that your source code always be styled according to this style guide.

 

 

 

 

 

Include

An Include Procedure cannot be executed directly, the contents of its source code can only be Included into other Procedures using the Include command.

 

Public Method

A Public Method may be called from any other Procedure, by the Default plug-in, or a Custom COM DLL. Each Public Method may either use specific Input Parameters, or it may accept an Input Query.

 

Remote Method

A Remote Method may be called by any other Moxie system. It can be used to divide up a large system among a number of backend servers, or as a public API for 3rd parties. In order to call a Remote Method from MOX, the Remote statement is used.

 

PaaS Method

A PaaS Method may be called by any other Moxie system. In order to call a PaaS Method from MOX, the PaaS statement is used.

 

MOX Coding and Programing Language Syntax Documentation

The MOX coding and programming language pays heritage to BASIC, but has been crafted for the specific type of work and environment that is demanded of Moxie.Build.

 

Message Handler

A Message Handler is only ever called by the Database on a Database Event. These Event Messages allow a Developer to intercept operations taking place on a per-record level and implement Event based business logic.

 

Record Action

Record Actions are presented to the users of the Default Admin interface and are also intended to be made available in a dynamic way to users of a customized front end. As an Action, the Procedure is expected to perform some sort of task, such as an automated set of updates to the Database Record.

 

Record Report

Record Reports are presented to the users of the Default Admin interface and are also intended to be made available in a dynamic way to users of a customized front end. As a Report, the Procedure is expected to produce output to be displayed to the user.

 

Table Report

Table Reports are presented to the users of the Default Admin interface and are also intended to be made available in a dynamic way to users of a customized front end. As a Report, the Procedure is expected to produce output to be displayed to the user.

 

Export and Import of Database Schema

ExportSchema and ImportSchema are BuiltIn procedures that are available for use with source control systems.

 

Get Started with Setting up the Development Environment

Developing in Moxie.Build on localhost give you the advantage of working with the template files natively. When working on procedures (MOX code) you need to access that through the Procedures page in the Admin area of a Moxie.Build system, if running the server on localhost or on a remote server. When running on a remote server, you can edit the template files via the Files page in the Admin area.

 

Query Based Routing Example

For small and simple procedures that are not expected to grow in complexity over time, simple routing based on URL parameter values from a [Pull] directly from the Request query is sufficient and requires less code. For complex procedures that are expected to grow and evolve over time, a larger more robust foundation for the routing should be used.

 

SetKillCount

Takes one parameter, Value

 

[If] Assignment (Top Query)

Parameter is divided into two parts, the Test and the Result if True. The test comes prior to the keyword of Then and the Result if True comes after.

 

Command Line with .mox file

A .mox file, with MOX code in it, can be run from the command line while a Moxie.Build system is not otherwise already running.

 

Moxie.cfg Config

The Moxie.cfg file is read on server start and controls aspects that cannot be changed while the server is running

 

[CountIf]

Takes one parameter, TestCondition

 

Method

Private Method contained within a given procedure.

 

IncrKillCount

Has one parameter.

 

PaaS

Takes three parameters, Url, SaaSTenant, InputQuery, OutputQuery

 

Select / Case / End Select

Takes a variable number of conditional statements to compare against a single source

 

Remote

Takes three parameters, Url, InputQuery, OutputQuery

 

HttpNoCache

Has no parameters.

 

RecoverMOX$

Takes one parameter, HtmlEscapedString, and returns the Unescaped Version of this string

 

ListProcs

Takes one parameter, TableName

 

LoadNulFile

Takes two parameters, FileName, bHasHeader

 

SkipCalls

Takes no parameters

 

Lang$

Takes one parameter, Source

 

Lang

Takes four parameters, FieldBase, Destination, Source, IfLenFld

 

InStr%

Takes two parameters, Source, Match

 

InStr$

Takes two parameters, Source, Match

 

InStrAny$

Takes two parameters, Source, Match

 

InStrAny%

Takes two parameters, Source, Match

 

Folder and File Structure

Brief overview on the file structure and contents under Moxie. The files and folders discussed in this post are those that are essential when upgrading to the most recent version of Moxie , or when troubleshooting server errors.

 

 

[Sort] (DB Relationship Attribute)

Accepts a space separated list of field names.

 

 

[If] Assignment (DB Field Attribute)

Parameter is divided into two parts, the Test and the Result if True. The test comes prior to the keyword of Then and the Result if True comes after.

 

Critical

Takes one parameter, the Name of the critical section

 

If (Not) / And / Or / ElseIf / End If

Takes a variable number of conditional statements

 

Include

Takes one parameter, ProcedureName