Routines for mcadmin.kb


CheckCommonTables

File Name

mcadmin.kb

Syntax

None

Parameters

None

Returns

None

Side Effects

None Globals Changed: None

Description

This function executes the functions and SQL necessary to check the common table for MC business rules.

Dialog Forms Called

None


CheckTreeTable

File Name

mcadmin.kb

Syntax

CheckTreeTable(VAL table: STRING, VAL hlabel: STRING ): BOOLEAN

Parameters

table - name of the table

Returns

None

Side Effects

None

Description

Writes an exception result row to a window for bad data.

Dialog Forms Called

None


GetSilentCheckOutput

File Name

mcadmin.kb

Syntax

GetSilentCheckOutput

Parameters

None

Returns

List of String

Side Effects

None

Description

The output written to the silent log is returned.

Dialog Forms Called

None


GoSecure

File Name

mcadmin.kb

Syntax

None

Parameters

pwhdl - window that should be the parent of Go Secure Window

Returns

None

Side Effects

The current process is forced to run in a secure mode.

Description

Initializes the Go Secure window.

Dialog Forms Called

mc_svcs.dfc[go_secure_main]


InitPurgeWin

File Name

mcadmin.kb

Syntax

None

Parameters

pwhdl - window that should be the parent of Purge WIndow

Returns

Window - The Purge Window Handle

Side Effects

The current process will be forced to be running in a secure mode. Globals Changed: GSLogWin is set to the Purge whdl

Description

Initializes Purge Window

Dialog Forms Called

None


InitSilentCheck

File Name

mcadmin.kb

Syntax

InitSilentCheck

Parameters

None

Returns

None

Side Effects

None

Description

Intiializes a global list of string to begin silent logging

Dialog Forms Called

None


LogResultRow

File Name

mcadmin.kb

Syntax

LogResultRow(NumResultCols: INTEGER, ResultRow: ResultType, Columns: LIST OF STRING, ErrorLevel: INTEGER)

Parameters

NumResultCols - number of columns to log to window

ResultRow - contains column values

Columns - column Names

ErrorLevel - type of log string to write - Error or Warning

Returns

None

Side Effects

None

Description

Writes an exception result row to a window.

Dialog Forms Called

None


MCCheckTable

File Name

mcadmin.kb

Syntax

None

Parameters

TBName - the table that is being checked

ColName - the Column in TBName that is being checked

RefTable - the table that TBName.ColName is foreign keyed to

LogSelect - a select string that is designed to get 'bad' data out

of the database. Any rows returned with this

select are logged to the Purge window. This string

will be sent to DBLangReplaceTerms to insert the following

SQL fragments if needed:

String 1: OrgCondition (use if TBNAme has an Org_ID)

String 2: MultiCustomer Where Clause

Columns - a list of Columns to log on an exception

CheckType - there are three different type of multi-customer checks

General - used most of the time. This will check to see

if ownerships of related objects match

(i.e. The system is valid for a solution)

User - checks to see of the owner of an object will be

able to see it in a secure environment

Group - checks to see of the group owner of an object

will be able to see it in a secure environment

ErrorLevel - defines whether if the exceptions are error or warning level messages

Returns

Integer - number of exceptions generated

Side Effects

Text is logged to the Go Secure window

Description

This function will check a column in a table to see if it adheres to the Multi-Customer business rules. If there are values in the column that are not allowed based on the ownership of the current column, an exception will be raised. This is a generic function to be used in the Go Secure feature. If this function does not meet the needs in all cases, a custom function can be written which makes calls to LogEvent to log exceptions and messages to the Go Secure Window.

Dialog Forms Called

mc_svcs.dfc[select_org]


MCLogEvent

File Name

mcadmin.kb

Syntax

MCLogEvent(ErrorLevel: INTEGER, LogStr: STRING)

Parameters

ErrorLevel - defines the level of importance of the error

LogStr - string to write to the window

Returns

None

Side Effects

None. Globals Changed: None.

Description

This function logs a line of text to the Go Secure / Purge window or stores it in a global list of string Inserts a log line into the Log Window id the window handle is known, or into a global list of string if there is no log window.

Dialog Forms Called

None