Search Results for procedure

 

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.

 

 

 

 

 

 

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.

 

Table Action

Table 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 Table.

 

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.

 

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.

 

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.

 

Method

Private Method contained within a given procedure.

 

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.

 

Export and Import of Database Schema

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

 

Include

Takes one parameter, ProcedureName

 

Learn More about Frontend Development

Prerequisites: This tutorial assumes that you have already set up a Category and Procedure if necessary. This page covers some of the basics that are involved in Front End development using the MOX language.

 

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.

 

Lang

Takes four parameters, FieldBase, Destination, Source, IfLenFld

 

HtmlBlocks / End HtmlBlocks

Takes two parameters, Location, Mode

 

MsgBox

Takes two parameters, Text, Title

 

UpdateTableProc

Takes ten parameters, TableName, OldProcName, NewProcName, Type, Params, GroupTypes, Label, Note, DevNote, Source

 

LoadNulFile

Takes two parameters, FileName, bHasHeader

 

Nightly Management Utility

This utility program manages a server install with one or many Moxie.Build services running by taking care of nightly tasks via a scheduled task

 

Select / Case / End Select

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

 

SetKillCount

Takes one parameter, Value

 

PaaS

Takes three parameters, Url, SaaSTenant, InputQuery, OutputQuery

 

Remote

Takes three parameters, Url, InputQuery, OutputQuery

 

Sleep

Takes one parameter.

 

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

 

Thread

Takes a variable number of parameters

 

OnError (Continue)

Used as a scoping keyword, similar to WorkWith/End WorkWith .

 

HttpNoCache

Has no parameters.

 

InStrAny$

Takes two parameters, Source, Match

 

DeleteTableProc

Takes two parameters, a TableName and ProcName

 

HttpsEnsure

Takes no parameters.

 

Lang$

Takes one parameter, Source

 

HtmlBlock / End HtmlBlock

Takes two parameters, Location, Mode

 

HtmlHistory

Takes two parameters, Title, Path

 

RecoverMOX$

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

 

Html

Takes 3 parameters, Location, Mode, Text

 

Flush

Takes one parameter, TableName

 

[CountIf]

Takes one parameter, TestCondition

 

[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.

 

SkipCalls

Takes no parameters

 

NewTableProc

Takes nine parameters, TableName, ProcName, Type, Params, GroupTypes, Label, Note, DevNote, Source

 

InStr%

Takes two parameters, Source, Match

 

FlushAll

Has no parameters

 

InStrAny%

Takes two parameters, Source, Match

 

InStr$

Takes two parameters, Source, Match

 

ListProcs

Takes one parameter, TableName

 

[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.

 

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.

 

AjaxReply

Has no parameters

 

Public Method WorkQuery Example

In this example, you will see how to use a public method that works on or with the current WorkQuery that you pass into the method.

 

 

 

Learn More About the Content Management System

Prerequisites: This page assumes that you have already set up your Moxie.Build server and logged in as an admin user. This page covers some of the basics that are involved in using the Content Management aspects of the Moxie.Build system.

 

Templates Documentation

Prerequisites: This tutorial assumes that you have already learned about Managing Files .

 

 

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

Takes a variable number of conditional statements

 

GoTo

Takes one parameter, a Label

 

IncrKillCount

Has one parameter.

 

LangWith

Has one parameter, a Content.Lang prefix

 

JsonReply

Has no parameters

 

Exception

Takes one parameter, the text of the exception to throw.

 

Error

Takes one parameter, the text of the error to throw.

 

Critical

Takes one parameter, the Name of the critical section

 

Function

A special type of Private Method, called a Private Function, that is intended to return a single value or multiple values simultaneously.

 

Exit (Proc)

Takes no parameters