Function.Global.General

From GAB Help
Jump to: navigation, search

Available commands

Contents

Function.Global.1Click.UnPack

This function installs a 1-Click application package to the specified company codes on the current Global Shop installation. Note: This command requires Global Shop-generated signature

Syntax

Function.Global.1Click.UnPack(FQ GAP file, MD5 hash, return)

Arguments

FQ GAP file
MD5 hash
return

Examples

Remarks


Function.Global.Accounting.GetARItemStatus

Syntax

Function.Global.Accounting.GetARItemStatus(customer ID, Invoice number, string return)

Arguments

customer ID
Invoice number
string return

Examples

Remarks


Function.Global.APS.JobStarted

This command will return a boolean value indicating if any job detail records exist for the specified job/suffix.

Syntax

Function.Global.APS.JobStarted(job, suffix, boolean return)

Arguments

job
suffix
boolean return

Examples

Remarks


Function.Global.APS.JobStatus

This command will return a long value indicating the specified work order's status.  The returned value is made up of one or more of the following components: -1 = Work order was not found in the APS data 0  = Work order exists in APS data 1  = Work order is a multi-level work order parent 2  = Work order is a multi-level work order child 4  = Work order is on hold 8  = Work order is locked The return value of a top-level parent work order that is locked would be 9, while the return value of a work order component that has children would be 3.  Since the values can be composites of multiple components, it is a good idea to use Function.Intrinsic.Math.BitwiseL to test for the presence of the desired property/properties.

Syntax

Function.Global.APS.JobStatus(job, suffix, long return)

Arguments

job
suffix
long return

Examples

Remarks


Function.Global.APS.Printaps3Report

Prints an APS Version 3 Report – Report numbers are listed next to the reports on the APS Reports Menu.

Syntax

Function.Global.APS.Printaps3Report(Report Number)

Arguments

Report Number

Long for the Report Number

Example

Function.Global.APS.Printaps3Report(30)

Remarks

  • The above example returns the Work Center Dispatch List By Daily Work Schedule


Function.Global.APS.PSC

Function.Global.APS.PSC

Syntax

Arguments

Examples

Remarks


Function.Global.APS.ScheduleJob

Syntax

Function.Global.APS.ScheduleJob(job, suffix, direction, date) or

Function.Global.APS.ScheduleJob(job, suffix, direction, date, sequence)

Arguments

Job

String Variable for the Job number

Suffix

String Variable for the Suffix of the Job

Direction

String “F” - Forward Scheduling or “B” for backward scheduling

Date

Date variable for scheduling date (start date)

Sequence

String variable that is optional

Example

Function.Global.APS.ScheduleJob(“111111”,”001”,”B”,11/24/2010)

Remarks

  • A post-2008.03 version of JB0011CL is required for this command to work properly. Please contact gab@gssmail.com to
  • obtain a copy of this program, if you need it before 2009.01 is released.
  • APS version 3, or higher, must be enabled for this function to work.


Function.Global.Bi.ActivateReportSequence

This function activates the specified sequence of the passed report ID.

Syntax

Function.Global.BI.ActivateReportSequence(report ID, sequence, company code, activate boolean)

Arguments

Example

Remarks

  • This function requires 2012.2


Function.Global.BI.ActivateReportSequence

This function activates the specified sequence of the passed report ID.

Syntax

Function.Global.BI.ActivateReportSequence(report ID, sequence, company code, activate boolean)

Arguments

report ID
sequence
company code
activate boolean

Examples

Remarks


Function.Global.Bi.AddCustomReportID

This function adds a new custom BI report, and returns its ID.

Syntax

Function.Global.BI.AddCustomReportID(company code, description, module, return long report ID))

Arguments

Example

Remarks

  • This function requires 2012.2
  • NOTE User report IDs are 100000 or higher.


Function.Global.BI.AddCustomReportID

This function adds a new user created report ID. *NOTE* User report IDs are 100000 or higher.

Syntax

Function.Global.BI.AddCustomReportID(Company [String], Description [String], Module [Long], Return Report ID [Long])

Function.Global.BI.AddCustomReportID(company code, description, module, return long report ID)

Arguments

company code
description
module
return long report ID

Examples

Remarks


Function.Global.Bi.AddGSSReportID

This function adds a new report ID in any area, global or user created ranges.

Syntax

Function.Global.BI.AddGSSReportID(report ID, description, module) or

Function.Global.BI.AddGSSReportID((Report ID As Long, Company As String, Description As String, Module As Long,Core PreProcessor As Boolean)

Arguments

Example

Remarks

  • This function requires 2012.2
  • This function can only be called from Global Shop signed programs.


Function.Global.BI.AddGSSReportID

This function adds a new report ID in any area, global or user created ranges.*NOTE* This functions is reserved for GSS use only.

Syntax

Function.Global.BI.AddGSSReportID((Report ID [Long], Company [String], Description [String], Module [Long], Core PreProcessor [Boolean])

Function.Global.BI.AddGSSReportID(report ID, description, module)

Arguments

report ID
description
module

Examples

Remarks


Function.Global.Bi.AddGSSReportSequence

This function adds a new BI report sequence to a GSS created report.

Syntax

Function.Global.BI.AddGSSReportSequence(Report ID As Long, Sequence As Long, Company As String, Description As String, Priority As Long, Report FQP As String, Output Mode As Long, Output Format As Long, Output Path As String, Copies As Long, Trace As Boolean, Unattended As Boolean, Workload As Boolean)

Arguments

Output Modes(Add together for multiple modes):

2 - Email

4 - Export

8 - Print

16 - View

Example

Remarks

  • This function requires 2012.2
  • This function can only be called from Global Shop signed programs.[[Category:NeedsEdit]


Function.Global.BI.AddGSSReportSequence

This function adds a new GSS report sequence. Note: This function can only be called from Global Shop signed programs.

Syntax

Function.Global.BI.AddGSSReportSequence(iReportID, iReportSeq, sCoCode, iPriority, sReportFQN, iOutputType, iOutputMode, iOutputFormat, sOutputFQN, bTrace, bUnattended, bWorkload)

Function.Global.BI.AddGSSReportSequence(Report ID [Long], Sequence [Long], Company [String], Description [String], Priority [Long], Report FQP [String], Output Mode [Long], Output Format [Long], Output Path [String], Copies [Long], Trace [Boolean], Unattended [Boolean], Workload [Boolean])

Arguments

Report ID

Long

Sequence

Long

Company

String

Description

String

Priority

Long

Report FQP

String

Output Mode

Long

Output Format

Long

Output Path

String

Copies

Long

Trace

Boolean

Unattended

Boolean

Workload

Boolean

Examples

Remarks


Function.Global.Bi.AddReportSequenceEmail

This function adds a new email address for a report sequence.

Syntax

Function.Global.BI.AddReportSequenceEmail(Report ID As Long, Sequence As Long, Company As String, Email Address As String)

Arguments

Example

Remarks

[[Category:NeedsEdit]


Function.Global.BI.AddReportSequenceEmail

This function adds a new email address for a report sequence.

Syntax

Function.Global.BI.AddReportSequenceEmail(Report ID [Long], Sequence [Long], Company [String], Email Address [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Email Address

String

Examples

Remarks


Function.Global.Bi.AddReportSequenceGroup

This function adds a new security group for a report sequence.

Syntax

Function.Global.BI.AddReportSequenceGroup(Report ID As Long, Sequence As Long, Company As String, Group As String)

Arguments

Example

Remarks


Function.Global.Bi.AddReportSequenceUser

This function adds a new security user for a report sequence.

Syntax

Function.Global.BI.AddReportSequenceUser(Report ID As Long, Sequence As Long, Company As String, User As String)

Arguments

Example

Remarks


Function.Global.Bi.AddUserReportSequence

This function adds a new BI report sequence to a user created report.

Syntax

Function.Global.BI.AddUserReportSequence(Report ID As Long, Company As String, Description As String, Priority As Long, Report FQP As String, Output Mode As Long, Output Format As Long, Output Path As String, Copies As Long, Trace As Boolean, Unattended As Boolean, Workload As Boolean, Return Sequence As Long)

Arguments

Output Modes(Add together for multiple modes):

2 - Email

4 - Export

8 - Print

16 - View

Example

Remarks

  • This function requires 2012.2


Function.Global.BI.AddUserReportSequence

This function adds a new new BI report sequence.

Syntax

Function.Global.BI.AddUserReportSequence(iReportID, sCoCode, iPriority, sReportFQN, iOutputType, iOutputMode, iOutputFormat, sOutputFQN, bTrace, bUnattended, bWorkload, ret report seq)

Function.Global.BI.AddUserReportSequence(Report ID [Long], Company [String], Description [String], Priority [Long], Report FQP [String], Output Mode [Long], Output Format [Long], Output Path [String], Copies [Long], Trace [Boolean], Unattended [Boolean], Workload [Boolean], Return Sequence [Long])

Arguments

Report ID

Long

Company

String

Description

String

Priority

Long

Report FQP

String

Output Mode

Long

Output Format

Long

Output Path

String

Copies

Long

Trace

Boolean

Unattended

Boolean

Workload

Boolean

Return Sequence

Long

Examples

Remarks


Function.Global.BI.CreateCSFile

This command creates a Codesoft label file to be used by Sentinel to generate and print labels.  The Parameter Names and Parameter Values are passed in a string with a delimiter of *!*. Note: This is intended for use with the Codesoft and Sentinel label products.  If you are interested in purchasing and using these products please contact Global Shop for pricing information.

Syntax

Function.Global.BI.CreateCSFile(Parameter Names, Parameter Values, CS File FQP)

Arguments

Parameter Names
Parameter Values
CS File FQP

Examples

Remarks


Function.Global.Bi.DeleteReportID

This function deletes a user report ID and all corresponding ID sequences and sequence information.

Syntax

Function.Global.BI.DeleteReportID(Report ID As Long, Company As String)

Arguments

Example

Remarks


Function.Global.BI.DeleteReportID

This function deletes a user report ID and all corresponding ID sequences and sequence information.

Syntax

Function.Global.BI.DeleteReportID(Report ID [Long], Company [String])

Arguments

Report ID

Long

Company

String

Examples

Remarks


Function.Global.Bi.DeleteReportSequence

This function deletes a user report sequence and all corresponding sequence information.

Syntax

Function.Global.BI.DeleteReportSequence(Report ID As Long, Sequence As Long, Company As String)

Arguments

Example

Remarks


Function.Global.BI.DeleteReportSequence

This function deletes a user report sequence and all corresponding sequence information.

Syntax

Function.Global.BI.DeleteReportSequence(Report ID [Long], Sequence [Long], Company [String])

Function.Global.BI.DeleteReportSequence(Report ID, report sequence, sCoCode)

Arguments

Report ID
report sequence
sCoCode

Examples

Remarks


Function.Global.Bi.DeleteReportSequenceEmail

This function deletes a email defined on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceEmail(Report ID As Long, Sequence As Long, Company As String, Email As String)

Arguments

Example

Remarks


Function.Global.BI.DeleteReportSequenceEmail

This function deletes a email defined on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceEmail(Report ID [Long], Sequence [Long], Company [String], Email [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Email

String]

Examples

Remarks


Function.Global.Bi.DeleteReportSequenceGroup

This function deletes a security group defined on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceGroup(Report ID As Long, Sequence As Long, Company As String, Group As String, All Flag As Boolean)

Arguments

Example

Remarks

  • NOTE: If the All Flag is set to True, it will delete all security groups.


Function.Global.BI.DeleteReportSequenceGroup

This function deletes a security group defined on a report sequence. *NOTE* If the All Flag is set to True, it will delete all security groups.

Syntax

Function.Global.BI.DeleteReportSequenceGroup(Report ID [Long], Sequence [Long], Company [String], Group [String], All Flag [Boolean])

Arguments

Report ID

Long

Sequence

Long

Company

String

Group

String

All Flag

Boolean

Examples

Remarks


Function.Global.Bi.DeleteReportSequenceLogo

This function deletes a the logo file defined to use on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceLogo(Report ID As Long, Sequence As Long, Company As String)

Arguments

Example

Remarks


Function.Global.BI.DeleteReportSequenceLogo

This function deletes a the logo file defined to use on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceLogo(Report ID [Long], Sequence [Long], Company [String])

Arguments

Report ID

Long

Sequence

Long

Company

String]

Examples

Remarks


Function.Global.BI.DeleteReportSequenceNotes

Function.Global.BI.DeleteReportSequenceNotes

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.DeleteReportSequenceOverride

This function deletes a the override report defined on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceOverride(Report ID As Long, Sequence As Long, Company As String)

Arguments

Example

Remarks


Function.Global.BI.DeleteReportSequenceOverride

This function deletes a the override report defined on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceOverride(Report ID [Long], Sequence [Long], Company [String])

Arguments

Report ID

Long

Sequence

Long

Company

String]

Examples

Remarks


Function.Global.Bi.DeleteReportSequencePreProcessor

This function deletes a the preprocessor defined to use on a user report sequence.

Syntax

Function.Global.BI.DeleteReportSequencePreProcessor(Report ID As Long, Sequence As Long, Company As String)

Arguments

Example

Remarks


Function.Global.BI.DeleteReportSequencePreProcessor

This function deletes a the preprocessor defined to use on a user report sequence.

Syntax

Function.Global.BI.DeleteReportSequencePreProcessor(Report ID [Long], Sequence [Long], Company [String])

Arguments

Report ID

Long

Sequence

Long

Company

String]

Examples

Remarks


Function.Global.Bi.DeleteReportSequenceUser

This function deletes a security user defined on a report sequence.

Syntax

Function.Global.BI.DeleteReportSequenceUser(Report ID As Long, Sequence As Long, Company As String, User As String, All Flag As Boolean)

Arguments

Example

Remarks

  • NOTE: If the All Flag is set to True, it will delete all security users.


Function.Global.BI.DeleteReportSequenceUser

This function deletes a security user defined on a report sequence. *NOTE* If the All Flag is set to True, it will delete all security users.

Syntax

Function.Global.BI.DeleteReportSequenceUser(Report ID [Long], Sequence [Long], Company [String], User [String], All Flag [Boolean])

Arguments

Report ID

Long

Sequence

Long

Company

String

User

String

All Flag

Boolean

Examples

Remarks


Function.Global.BI.DisableOverride

Function.Global.BI.DisableOverride

Syntax

Arguments

Examples

Remarks


Function.Global.BI.EnableOverride

Function.Global.BI.EnableOverride

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.GetIDFromName

Syntax

Function.Global.BI.GetIDFromName(name, long return)

Arguments

Example

Remarks

  • Sets up a BI report in Global Shop with a description and filename/path. Returns report ID. (If report exists returns existing report ID.)
  • Returns report ID from existing BI report from filename\path.


Function.Global.BI.GetIDFromName

The new syntax for this command allows you to specify a boolean value, indicating if the command should ignore case in the description fragment.  The default behavior of the command is to perform case-sensitive string comparisons.

Syntax

Function.Global.BI.GetIDFromName(description fragment, case boolean, long return)

Arguments

description fragment
case boolean
long return

Examples

Remarks


Function.Global.Bi.GetIDInfo

This function returns report ID information in a string delimited with "*!*".

Syntax

Function.Global.BI.GetIDInfo(Report ID As Long, Company As String, Return As String)

Arguments

Return:

Description

Module

Example

Remarks

  • NOTE: "" is the default return if no values found.


Function.Global.BI.GetIDInfo

This function returns report ID information in a string delimited with "*!*". Return: Description Module *NOTE* "" is the default return if no values found.

Syntax

Function.Global.BI.GetIDInfo(Report ID [Long], Company [String], Return [String])

Arguments

Report ID

Long

Company

String

Return

String

Examples

Remarks


Function.Global.Bi.GetParameters

Syntax

Function.Global.BI.GetParameters(call key, string return)

Arguments

Example

Remarks

  • This function, given a BI call key, returns a double delimited string containing the report parameter names and values. *!* is the column delimiter, while !*! is the row delimiter.
  • If no parameters are present on the passed call key, the string return will be blank.


Function.Global.BI.GetReportSequenceEmail

Function.Global.BI.GetReportSequenceEmail

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.GetReportSequenceEmails

This function returns report sequence emails in a string delimited with "*!*".

Syntax

Function.Global.BI.GetReportSequenceEmails(Report ID As Long, Sequence As Long, Company As String, Return As String)

Arguments

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.


Function.Global.BI.GetReportSequenceEmails

This function returns report sequence emails in a string delimited with "*!*". *NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequenceEmails(Report ID [Long], Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

String

Examples

Remarks


Function.Global.Bi.GetReportSequenceGroups

This function returns report sequence groups in a string delimited with "*!*".

Syntax

Function.Global.BI.GetReportSequenceGroups(Report ID As Long, Sequence As Long, Company As String, Return As String)

Arguments

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.[[Category:NeedsEdit]


Function.Global.BI.GetReportSequenceGroups

This function returns report sequence groups in a string delimited with "*!*".*NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequenceGroups(Report ID [Long], Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

String]

Examples

Remarks


Function.Global.Bi.GetReportSequenceInfo

This function returns report sequence information in a string delimited with "*!*".

Syntax

Function.Global.BI.GetReportSequenceInfo(Report ID As Long, Report Sequence As Long, Company As String, Return As String)

Arguments

Return:

Description

Priority

Report FQP

Output Mode

Output Format

Output Path

Copies

Trace

Unattended

Workload

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.[[Category:NeedsEdit]


Function.Global.BI.GetReportSequenceInfo

This function returns report sequence information in a string delimited with "*!*". Return: Description Priority Report FQP Output Mode Output Format Output Path Copies Trace Unattended Workload *NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequenceInfo(Report ID [Long], Report Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Report Sequence

Long

Company

String

Return

String

Examples

Remarks


Function.Global.BI.GetReportSequenceList

Function.Global.BI.GetReportSequenceList

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.GetReportSequenceLogo

This function returns report sequence logo information in a string.

Syntax

Function.Global.BI.GetReportSequenceLogo(Report ID As Long, Sequence As Long, Company As String, Return As String)

Arguments

Return:

Report Logo FQP

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.


Function.Global.BI.GetReportSequenceLogo

This function returns report sequence logo information in a string. Return: Report Logo FQP *NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequenceLogo(Report ID [Long], Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

String]

Examples

Remarks


Function.Global.BI.GetReportSequenceNotes

Function.Global.BI.GetReportSequenceNotes

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.GetReportSequenceOverride

This function returns report sequence override information in a string.

Syntax

Function.Global.BI.GetReportSequenceOverride(Report ID As Long, Sequence As Long, Company As String, Return As String)

Arguments

Return:

Override report FQP

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.


Function.Global.BI.GetReportSequenceOverride

This function returns report sequence override information in a string. Return: Override report FQP *NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequenceOverride(Report ID [Long], Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

String]

Examples

Remarks


Function.Global.Bi.GetReportSequencePreProcessor

This function returns report sequence preprocessor information in a string delimited with "*!*".

Syntax

Function.Global.BI.GetReportSequencePreProcessor(Report ID As Long, Sequence As Long, Company As String, Return As String)

Arguments

Return:

PreProcessor FQP

Description

Menu Path

Purge Days

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.


Function.Global.BI.GetReportSequencePreProcessor

This function returns report sequence preprocessor information in a string delimited with "*!*". Return: PreProcessor FQP Description Menu Path Purge Days *NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequencePreProcessor(Report ID [Long], Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

String

Examples

Remarks


Function.Global.Bi.GetReportSequencePreProcessorList

This function returns report sequence preprocessors in a string delimited with "*!*".

Syntax

Function.Global.BI.GetReportSequencePreProcessorList(Report ID As Long, Sequence As Long, Company As String, Return As String)

Arguments

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.


Function.Global.BI.GetReportSequencePreProcessorList

This function returns report sequence preprocessors in a string delimited with "*!*". *NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequencePreProcessorList(Report ID [Long], Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

String]

Examples

Remarks


Function.Global.Bi.GetReportSequenceUsers

This function returns report sequence users in a string delimited with "*!*".

Syntax

Function.Global.BI.GetReportSequenceUsers(Report ID As Long, Sequence As Long, Company As String, Return As String)

Arguments

Example

Remarks

  • NOTE: "***NORETURN***" is returned if no values found for report sequence.


Function.Global.BI.GetReportSequenceUsers

This function returns report sequence users in a string delimited with "*!*".*NOTE* "***NORETURN***" is returned if no values found for report sequence.

Syntax

Function.Global.BI.GetReportSequenceUsers(Report ID [Long], Sequence [Long], Company [String], Return [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

String]

Examples

Remarks


Function.Global.BI.GetRunID

Function.Global.BI.GetRunID

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.InitializeReport

Syntax

Function.Global.BI.InitializeReport(description, filename, long return)

Arguments

Example

Remarks

  • Sets up a BI report in Global Shop with a description and filename/path. Returns report ID. (If report exists returns existing report ID.)
  • Returns report ID from existing BI report from filename\path.


Function.Global.Bi.IsCorePreProcessor

This function returns a boolean flag indicating whether or not the report processor is core or GAB.

Syntax

Function.Global.BI.IsCorePreProcessor(Report ID As Long, Return As Boolean)

Arguments

Example

Remarks


Function.Global.BI.IsCorePreProcessor

This function returns a boolean flag indicating whether or not the report processor is core or GAB.

Syntax

Function.Global.BI.IsCorePreProcessor(Report ID [Long], Return [Boolean])

Arguments

Report ID

Long

Return

Boolean

Examples

Remarks


Function.Global.Bi.IsReportSequenceactive

This function returns a boolean flag indicating whether or not a report sequence is active.

Syntax

Function.Global.BI.IsReportSequenceActive(Report ID As Long, Sequence As Long, Company As String, Return As Boolean)

Arguments

Example

Remarks


Function.Global.BI.IsReportSequenceActive

This function returns a boolean flag indicating whether or not a report sequence is active.

Syntax

Function.Global.BI.IsReportSequenceActive(Report ID [Long], Sequence [Long], Company [String], Return [Boolean])

Arguments

Report ID

Long

Sequence

Long

Company

String

Return

Boolean

Examples

Remarks


Function.Global.Bi.LaunchDashboard

Syntax

Function.Global.BI.LaunchDashboard(Module,Type,Arg,Sync)

Arguments

Module - Code - Name - Types Supported

A - Ontime Delivery - P,C,I

B - Direct Labor Perf to Standard - P,E,D

C - Business Concentration - P

D - Indirect to Total Labor - P,E,D

E - Setup to Total Direct Labor - P,E,D

G - AR Summary Report - P,C

H - AP Summary Reports - P,V

P - Cash Projector - P

Q - Sales History/Profitability - P,C

J - Executive Summary -

Type

P – Plant

C – Customer

I – Part

D – Payroll Department

E – Employee

V – Vendor

Argument

Part Number, Customer number, etc.

Sync

True for Synchronous, False for ASynchronous

Example

Function.Global.BI.LaunchDashboard(A,P,””, False)

Remarks

None


Function.Global.Bi.PrintBartenderLabel

Prints a BarTender Label from scripting.

Syntax

Function.Global.BI.PrintBarTenderLabel(rpt id, mode, param name array, param value array,Boolean Sync or Async,[printer name], [printer quantitiy])

Arguments

Rpt ID

Report ID from BI_RPT

Mode
Param Name Array

Variable of the Parameter Array

Param Value Array

Values in the Parameter Array

Boolean

True =Sync, False = Async

=Printer Name

String of the Printer Name

Printer Quantity

Long for the number of copies needing to print

Example

Program.Sub.Main.Start
 variable.local.sName.declare(String)
 variable.local.sValue.declare(String)
 variable.local.sTemp.declare(String)
 function.intrinsic.string.split("StartDate*!*EndDate*!*AllDates",
"*!*",variable.local.sName)
 function.intrinsic.string.split("19800101*!*20200101*!*1","*!*",
variable.local.sValue)
Function.global.bi.printbartenderLabel("000002",3, variable.local.sName, Variable.local.sValue, False)
or
Function.global.bi.printbartenderLabel("000002",3, variable.local.sName, Variable.local.sValue, False,”HP Laser 4000”,3)
Program.Sub.Main.End

Remarks

  • This report will run Ascynchronously.


Function.Global.BI.PrintCodeSoftLabel

Function.Global.BI.PrintCodeSoftLabel

Syntax

Arguments

Examples

Remarks


Function.Global.BI.PrintCodeSoftLabelFromDataTable

Syntax

Function.Global.BI.PrintCodeSoftLabelFromDataTable(BI Run ID [long], Log ID [long], DataTable Name [string], Printer Name [string], Synchronous [boolean])

Arguments

BI Run ID

long

Log ID

long

Datatable

string

Printer

string

Sync

boolean

Examples

'Get run ID
Function.Global.BI.GetRunID(Variable.Global.BIRunID)

'Get Report ID From Name
Function.Global.BI.GetIDFromName("SampleName.lab",Variable.Local.iBIRptID)

'Starting BI Logging
Function.Global.BI.StartLogging(Variable.Global.BIRunID,Variable.Local.iBIRptID,-1,"",Variable.Global.BILogID)

'Set Starting and Ending Part
Variable.Global.sStartPart.Set(Variable.Screen.Form1!txtStartPart.Text)
Variable.Global.sEndPart.Set(Variable.Screen.Form1!txtEndPart.Text)

'Build Connection String
Function.Intrinsic.String.Build("Select X From SampleTable",Variable.Global.sStartPart,Variable.Global.sEndPart,Variable.Global.sLoc,Variable.Local.sSql)

'Open Connection
Function.ODBC.Connection!conx.OpenConnection(Variable.Ambient.PDSN,Variable.Ambient.PUser,Variable.Ambient.PPass)

'Create DataTable from SQL
Function.Data.DataTable.CreateFromSQL("dtName","conx",Variable.Local.sSql)

'Close Connection
Function.ODBC.Connection!conx.Close

'Print Codesoft Label from DataTable
Function.Global.BI.PrintCodesoftLabelFromDatatable(Variable.Global.BIRunID,Variable.Global.BILogID,"dtName","",True) 

Remarks


Function.Global.BI.PrintCodeSoftLabelFromUDT

Syntax

Function.Global.BI.PrintCodeSoftLabelFromUDT(BI run ID [long], Log ID [long], UDT name [string], Elements [string], printer [string])

Function.Global.BI.PrintCodeSoftLabelFromUDT(BI run ID [long], Log ID [long], UDT name [string], Elements [string], printer [string], sync)

Function.Global.BI.PrintCodeSoftLabelFromUDT(iBIRunID [Long], iLogID [Long], sUDT [String], sLoadElements [String], sPrinter [String], bSync [Boolean], sReport [String])

Function.Global.BI.PrintCodeSoftLabelFromUDT(rpt id [long], param name array [string aarray],param value array [string array], sync [bool], printer name [string], print quantity [string])

Function.Global.BI.PrintCodeSoftLabelFromUDT(rpt id [long], param name array [string array],param value array [string array], sync [bool])

Arguments

rpt id

long

param name array

string array

param value array

string array

sync

bool

Examples

Remarks


Function.Global.Bi.PrintReport

Prints a BI Report from scripting

Syntax

Function.Global.BI.PrintReport(rpt id, mode, param name array, param value array,Boolean Sync or Async) or

Function.Global.BI.PrintReport(Report ID, Mode, Param Name Array, Param Value Array, Printer Name, Boolean Sync or Async)

Arguments

Rpt ID

Report ID from BI_RPT

Mode

See Remarks

Param Name Array

Variable of the Parameter Array

Param Value Array

Values in the Parameter Array

Boolean

True =Sync, False = Async

Example

Program.Sub.Main.Start
 variable.local.sName.declare(String)
 variable.local.sValue.declare(String)
 variable.local.sTemp.declare(String)
 Function.Intrinsic.Debug.stop
 function.intrinsic.string.split("StartDate*!*EndDate*!*AllDates",
"*!*",variable.local.sName)
 function.intrinsic.string.split("19800101*!*20200101*!*1","*!*",
variable.local.sValue)
 Function.global.bi.printreport("000002",3,variable.local.sName,
Variable.local.sValue, False)
Program.Sub.Main.End

Remarks

  • This report will run Ascynchronously
  • The Mode parameter corresponds to the numeric value in the Output Options section of the Maintain Customizable Reports screen in Business Intelligence administration. For example, 0 is Preview Only.
  • The newest Global Shop Crystal Reports viewer components are required for the alternate syntax to function properly.


Function.Global.BI.ReplaceMenu

Function.Global.BI.ReplaceMenu

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.ReportExists

This function checks for the existence of a report within the specified company code.

Syntax

Function.Global.BI.ReportExists(report ID, company code, boolean return)

Arguments

Example

Remarks

  • This function requires 2012.2


Function.Global.BI.ReportExists

This function checks for the existence of a report within the specified company code.

Syntax

Function.Global.BI.ReportExists(report ID, company code, boolean return)

Arguments

report ID
company code
boolean return

Examples

Remarks


Function.Global.BI.RunReportPREPROCESSOR

Function.Global.BI.RunReportPREPROCESSOR

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.SaveReport

Syntax

Function.Global.BI.SaveReport(report id, mode, param name array, param value array, FQ filename) or

Function.Global.BI.SaveReport(report id, mode, param name as string array, param value as string array, filename as string)

Arguments

Example

Remarks


Function.Global.BI.SaveReport

Syntax

Function.Global.BI.SaveReport(report id, mode, param name array, param value array, FQ filename)

Function.Global.BI.SaveReport(rpt id, mode,param name array,param value array,FQ filename)

Arguments

rpt id
mode
param name array
param value array
FQ filename)

Examples

Remarks


Function.Global.BI.SetGSSPreProcessor

Function.Global.BI.SetGSSPreProcessor

Syntax

Arguments

Examples

Remarks


Function.Global.BI.SetOverride

Function.Global.BI.SetOverride

Syntax

Arguments

Examples

Remarks


Function.Global.BI.SetPrintOptionSelections

Function.Global.BI.SetPrintOptionSelections

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.SetReportSequenceLogo

This function sets the logo image file to use on a report sequence.

Syntax

Function.Global.BI.SetReportSequenceLogo(Report ID As Long, Sequence As Long, Company As String, Logo FQP As String)

Arguments

Example

Remarks


Function.Global.BI.SetReportSequenceLogo

This function sets the logo image file to use on a report sequence.

Syntax

Function.Global.BI.SetReportSequenceLogo(Report ID [Long], Sequence [Long], Company [String], Logo FQP [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Logo FQP

String]

Examples

Remarks


Function.Global.BI.SetReportSequenceNotes

Function.Global.BI.SetReportSequenceNotes

Syntax

Arguments

Examples

Remarks


Function.Global.BI.SetReportSequenceOutput

Function.Global.BI.SetReportSequenceOutput

Syntax

Arguments

Examples

Remarks


Function.Global.Bi.SetReportSequenceOverride

This function sets a report override to use on a sequence.

Syntax

Function.Global.BI.SetReportSequenceOverride(Report ID As Long, Sequence As Long, Company As String, Override FQP As String)

Arguments

Example

Remarks

  • NOTE: This functionality is obsoleted/ignored once the report has been converted to using a GAB preprocessor.


Function.Global.BI.SetReportSequenceOverride

This function sets a report override to use on a sequence *NOTE* This functionality is obsoleted/ignored once the report has been converted to using a GAB preprocessor.

Syntax

Function.Global.BI.SetReportSequenceOverride(Report ID [Long], Sequence [Long], Company [String], Override FQP [String])

Arguments

Report ID

Long

Sequence

Long

Company

String

Override FQP

String]

Examples

Remarks


Function.Global.Bi.SetReportSequencePreProcessor

This function sets the preprocessor file to be used on a report sequence.

Syntax

Function.Global.BI.SetReportSequencePreProcessor(Report ID As Long, Sequence As Long, Company As String, PreProcessor FQP As String, PreProcessor Description As String, Menu Path As String, Purge Days As Long)

Arguments

Example

Remarks


Function.Global.BI.SetReportSequencePreProcessor

This function sets the preprocessor file to be used on a report sequence.

Syntax

Function.Global.BI.SetReportSequencePreProcessor(Report ID [Long], Sequence [Long], Company [String], PreProcessor FQP [String], PreProcessor Description [String], Menu Path [String], Purge Days [Long])

Arguments

Report ID

Long

Sequence

Long

Company

String

PreProcessor FQP

String

PreProcessor Description

String

Menu Path

String

Purge Days

Long]

Examples

Remarks


Function.Global.BI.SetUserPreProcessor

Function.Global.BI.SetUserPreProcessor

Syntax

Arguments

Examples

Remarks


Function.Global.BI.StartLogging

Function.Global.BI.StartLogging

Syntax

Arguments

Examples

Remarks


Function.Global.BI.StopLogging

Function.Global.BI.StopLogging

Syntax

Arguments

Examples

Remarks


Function.Global.BI.ToggleA4

Function.Global.BI.ToggleA4

Syntax

Arguments

Examples

Remarks


Function.Global.Biometric.DeleteFingerprint

Syntax

Function.Global.Biometric.DeleteFingerprint(employee ID, digit ID)

Arguments

Examples

Remarks

  • Digit ID is a value from 0 to 9, from the left pinkie finger, to the right pinkie finger.
  • If you attempt to save a duplicate EID/DID record, GAB will overwrite the previous entry.
  • Calling DeleteFingerprint with a -1 for EID will delete ALL fingerprint records. Calling DeleteFingerprint with a valid EID, and a -1 for DID will delete all fingerprint records for the specified EID.
  • The Global Shop seat invoking GAB (core, or GUI), needs to have a biometric license and a supported device, for these commands to work.


Function.Global.Biometric.FingerprintCount

This command returns count information on fingerprint information stored in Global Shop.  If no employee ID is specified, the returned count information will be for all enrolled employees.  The return is a string delimited with *!*, containing 11 numbers.  The first position contains the total number of fingerprints, while the next 10 positions contain the number of fingerprints per digit. Note: The Global Shop seat invoking GAB (core, or GUI), needs to have a biometric license and a supported device, for these commands to work.

Syntax

Function.Global.Biometric.FingerprintCount(EID, string return)

Function.Global.Biometric.FingerprintCount(string return)

Arguments

string return

Examples

Remarks


Function.Global.Biometric.IdentifyRemoteFingerprint

This function retrieves a fingerprint posted from a Remote Desktop client session, and triggers the BIOMETRIC SCAN AuxEvent. A successful call to IdentifyRemoteFingerprint fills the minutiae byte array, so SaveFingerprint can be called afterward, if desired.

Syntax

Function.Global.Biometric.IdentifyRemoteFingerprint(terminal number)

Arguments

Example

Remarks

  • The ATG_FingerprintQueue table is required for this command.
  • The Global Shop seat invoking GAB (core, or GUI), needs to have the biometric support files loadedfor this command to work.


Function.Global.Biometric.ReconcileFingerprints

This command determines what fingerprints in the database, by fingerprint minutiae, are substantially similar to others in the fingerprint database.  The employee ID can be provided to limit the source scope of the reconciliation (the target scope is still the entire database).  In short, this command will determine if multiple fingerprints for the same employee and digit are similar, and it will report if fingerprints for one employee are too similar to fingerprints of another employee (as can sometimes happen with low-quality prints entered at enrollment). The return is a double delimited string (*!* is the inner delimiter, and $%$ is the outer delimiter), containing the following elements, in this order: Source employee ID Source digit ID Source sequence Source BIID Target employee ID Target digit ID Target sequence Target BIID Matching score Note: The Global Shop seat invoking GAB (core, or GUI), needs to have a biometric license and a supported device, for these commands to work. Note: This command will also delete BIID references from EMP_BIOMETRIC that have null minutiae data.

Syntax

Function.Global.Biometric.ReconcileFingerprints(EID, string return)

Function.Global.Biometric.ReconcileFingerprints(string return)

Arguments

string return

Examples

Remarks


Function.Global.Biometric.ReloadFingerprints

This function causes a forced reload of the fingerprint database.

Syntax

Function.Global.Biometric.ReloadFingerprints

Arguments

Example

Remarks

  • This function is not required after a SaveFingerprint or DeleteFingerprint command (as it happens automatically).
  • The Global Shop seat invoking GAB (core, or GUI), needs to have the biometric support files loaded and a supported device attached, for these commands to work.


Function.Global.Biometric.ResumeIdentification

Syntax

Function.Global.Biometric.ResumeIdentification

Arguments

Example

Remarks

  • Due to the async event model used by GAB, it can be a good idea to suspend identification while the post-processing of the previous scan is in flight.
  • Function.Global.Biometric.StartIO/StopIO are not replaced by with the use of these commands - they are complimentary commands.
  • The Global Shop seat invoking GAB (core, or GUI), needs to have the biometric support files loaded and a supported device attached, for these commands to work.


Function.Global.Biometric.SaveFingerprint

This command saves the most recently scanned fingerprint to the fingerprint database, with the provided employee and digit IDs.  If the Append parameter is passed a value of True, the command will allow multiple fingerprints to be saved per digit.  Multiple saved prints per digit allows the identification engine to work off of a superprint, allowing for higher recognition accuracy. Note: Digit ID is a value from 0 to 9, from the left pinkie finger, to the right pinkie finger. Note: If you attempt to save a duplicate EID/DID record, GAB will overwrite the previous entry, unless a True value is passed in the Append parameter. Note: The Global Shop seat invoking GAB (core, or GUI), needs to have a biometric license and a supported device, for these commands to work.

Syntax

Function.Global.Biometric.SaveFingerprint(employee ID, digit ID, append boolean, BIID return)

Arguments

employee ID
digit ID
append boolean
BIID return

Examples

Remarks


Function.Global.Biometric.SetcaptureThreshold

Syntax

Function.Global.Biometric.SetCaptureThreshold(0 to 100)

Arguments

Example

Remarks

  • Try setting threshold at 80 to start.


Function.Global.Biometric.SetCaptureTimeOut

Function.Global.Biometric.SetCaptureTimeOut

Syntax

Arguments

Examples

Remarks


Function.Global.Biometric.SetMatchThreshold

Syntax

Function.Global.Biometric.SetMatchThreshold(1 to 9)

Arguments

Example

Remarks

  • Try setting the threshold at 3 to start.


Function.Global.Biometric.SetMultiIdentify

Function.Global.Biometric.SetMultiIdentify

Syntax

Arguments

Examples

Remarks


Function.Global.Biometric.StartIO

Syntax

Function.Global.Biometric.StartIO

Arguments

Example

Remarks

  • Function.Intrinsic.Control.AddEventHandler("BIOMETRICSCAN","subname") specifies the subroutine to be called by the scan event. A "NONE" will be returned if a fingerprint match cannot be found.
  • The QUALITY argument on the raised event carries a value of 0 (low), 1 (medium), or 2 (high). For the purposes of fingerprint enrollment with Function.Global.Biometric.SaveFingerprint, you should probably only accept scans with a quality value of 2.
  • The SCORE argument on the raised event indicates the quality of match (if one is found). The return range is 0 (no match) or from 1 (poorest match) to 255 (best match).
  • Digit ID is a value from 0 to 9, from the left pinkie finger, to the right pinkie finger.
  • The Global Shop seat invoking GAB (core, or GUI), needs to have a biometric license and a supported device, for these commands to work.


Function.Global.Biometric.StopIO

Syntax

Function.Global.Biometric.StopIO

Arguments

Example

Remarks

  • Function.Intrinsic.Control.AddEventHandler("BIOMETRICSCAN","subname") specifies the subroutine to be called by the scan event. A "NONE" will be returned if a fingerprint match cannot be found.
  • The QUALITY argument on the raised event carries a value of 0 (low), 1 (medium), or 2 (high). For the purposes of fingerprint enrollment with Function.Global.Biometric.SaveFingerprint, you should probably only accept scans with a quality value of 2.
  • The SCORE argument on the raised event indicates the quality of match (if one is found). The return range is 0 (no match) or from 1 (poorest match) to 255 (best match).
  • Digit ID is a value from 0 to 9, from the left pinkie finger, to the right pinkie finger.
  • The Global Shop seat invoking GAB (core, or GUI), needs to have a biometric license and a supported device, for these commands to work.


Function.Global.Biometric.SuspendIdentification

Syntax

Function.Global.Biometric.SuspendIdentification

Arguments

Example

Remarks

  • Due to the async event model used by GAB, it can be a good idea to suspend identification while the post-processing of the previous scan is in flight.
  • Function.Global.Biometric.StartIO/StopIO are not replaced by with the use of these commands - they are complimentary commands.
  • The Global Shop seat invoking GAB (core, or GUI), needs to have the biometric support files loaded and a supported device attached, for these commands to work.


Function.Global.Callwrapper.GetProperty

Returns the value of a property of a callwrapper instance.

Syntax

Function.Global.Callwrapper.GetProperty(Callwrapper Name [String], Property Name [String], Return Property Value)

Arguments

Callwrapper Name

A name to identify this unique instance of a callwrapper.

Property Name

Name of the property being retrieved.

Property Value

Variable that will be updated with returned property value.

Example

F.Global.Callwrapper.New("ModifyComments","Manufacturing.ModifyJobDetailComments")
F.Global.Callwrapper.SetProperty("ModifyComments","Job","000155")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSuffix","001")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSequence",2000)
F.Global.Callwrapper.SetProperty("ModifyComments","Date","20170120")
F.Global.Callwrapper.SetProperty("ModifyComments","KeySequence",0)
F.Global.Callwrapper.SetProperty("ModifyComments","Comments","Here are the comments for this job detail.")
F.Global.CallWrapper.Run("ModifyComments")
V.Local.sStatus.Declare(String)
F.Global.CallWrapper.GetProperty("ModifyComments","Status",V.Local.sStatus)
F.Intrinsic.UI.Msgbox(V.Local.sReturn, "Complete!")

Remarks

  • This command is available in GAB 2.0 only.


Function.Global.Callwrapper.New

Creates a new instance of a callwrapper.

Syntax

Function.Global.Callwrapper.New(Callwrapper Name [String], Callwrapper Type [String])

Arguments

Callwrapper Name

A name to identify this unique instance of a callwrapper.

Callwrapper Type

Identifies the type of callwrapper used. see a list of callwrappers

Example

F.Global.Callwrapper.New("ModifyComments","Manufacturing.ModifyJobDetailComments")
F.Global.Callwrapper.SetProperty("ModifyComments","Job","000155")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSuffix","001")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSequence",2000)
F.Global.Callwrapper.SetProperty("ModifyComments","Date","20170120")
F.Global.Callwrapper.SetProperty("ModifyComments","KeySequence",0)
F.Global.Callwrapper.SetProperty("ModifyComments","Comments","Here are the comments for this job detail.")
F.Global.CallWrapper.Run("ModifyComments")
V.Local.sStatus.Declare(String)
F.Global.CallWrapper.GetProperty("ModifyComments","Status",V.Local.sStatus)
F.Intrinsic.UI.Msgbox(V.Local.sReturn, "Complete!")

Remarks

  • This command is available in GAB 2.0 only.


Function.Global.Callwrapper.Run

Runs an instance of a callwrapper.

Syntax

Function.Global.Callwrapper.Run(Callwrapper Name [String])

Arguments

Callwrapper Name

A name to identify this unique instance of a callwrapper.

Example

F.Global.Callwrapper.New("ModifyComments","Manufacturing.ModifyJobDetailComments")
F.Global.Callwrapper.SetProperty("ModifyComments","Job","000155")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSuffix","001")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSequence",2000)
F.Global.Callwrapper.SetProperty("ModifyComments","Date","20170120")
F.Global.Callwrapper.SetProperty("ModifyComments","KeySequence",0)
F.Global.Callwrapper.SetProperty("ModifyComments","Comments","Here are the comments for this job detail.")
F.Global.CallWrapper.Run("ModifyComments")
V.Local.sStatus.Declare(String)
F.Global.CallWrapper.GetProperty("ModifyComments","Status",V.Local.sStatus)
F.Intrinsic.UI.Msgbox(V.Local.sReturn, "Complete!")

Remarks

  • This command is available in GAB 2.0 only.


Function.Global.CallWrapper.RunAsync

Function.Global.CallWrapper.RunAsync

Syntax

Arguments

Examples

Remarks


Function.Global.Callwrapper.SetProperty

Sets the value of a property of a callwrapper instance.

Syntax

Function.Global.Callwrapper.SetProperty(Callwrapper Name [String], Property Name [String], Property Value)

Arguments

Callwrapper Name

A name to identify this unique instance of a callwrapper.

Property Name

Name of the property being set.

Property Value

Value of the property being set.

Example

F.Global.Callwrapper.New("ModifyComments","Manufacturing.ModifyJobDetailComments")
F.Global.Callwrapper.SetProperty("ModifyComments","Job","000155")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSuffix","001")
F.Global.Callwrapper.SetProperty("ModifyComments","JobSequence",2000)
F.Global.Callwrapper.SetProperty("ModifyComments","Date","20170120")
F.Global.Callwrapper.SetProperty("ModifyComments","KeySequence",0)
F.Global.Callwrapper.SetProperty("ModifyComments","Comments","Here are the comments for this job detail.")
F.Global.CallWrapper.Run("ModifyComments")
V.Local.sStatus.Declare(String)
F.Global.CallWrapper.GetProperty("ModifyComments","Status",V.Local.sStatus)
F.Intrinsic.UI.Msgbox(V.Local.sReturn, "Complete!")

Remarks

  • This command is available in GAB 2.0 only.


Function.Global.CRM.GetCitiesFromZip

Syntax

Function.Global.CRM.GetCitiesFromZip(Zip, Return)

Arguments

Zip

String

Return

Delimited String (*!* is the delimiter)

Example

Function.Global.CRM.GetCitiesFromZip(“77381”, v.local.sZips)

Remarks

  • You will need the ATG_Zip table for this function to work


Function.Global.CRM.GetStateFromABBR

Function.Global.CRM.GetStateFromABBR

Syntax

Arguments

Examples

Remarks


Function.Global.CRM.GetZipDistance

Syntax

Function.Global.CRM.GetZipDistance(Zip0, Zip1, Return Dist)

Arguments

Zip0

String

Zip1

String

Return Dist

Float Variable for Distance

Example

Function.Global.CRM.GetZipDistance(“77381”,”77388”, v.local.fDist)

Remarks

  • You will need the ATG_Zip table for this function to work


Function.Global.CRM.GetZipPosition

Syntax

Function.Global.CRM.GetZipPosition(Zip, Return Lat, Return Long)

Arguments

Zip

String

Return Lat

Float Variable Latitude of the zip

Return Long

Float Variable of Longitude

Example

Function.Global.CRM.GetZipPosition(“77381”,v.local.fLat, v.local.fLong)

Remarks

  • You will need the ATG_Zip table for this function to work


Function.Global.CRM.GetZipsNearZip

Syntax

Function.Global.CRM.GetZipsNearZip(Zip, Dist, Return)

Arguments

Zip

String

Dist

Float Value for the Distance in Miles

Return

Delimited String (*!* is the delimiter)

Example

Function.Global.CRM.GetZipsNearZip(“77381”,10, V.Local.sZips)

Remarks

  • You will need the ATG_Zip table for this function to work


Function.Global.CRM.Invoke

Syntax

Function.Global.CRM.Invoke(additional element list, PID return)

Arguments

additional element list
PID return

Examples

Remarks


Function.Global.CRM.IsSupervisor

Syntax

Function.Global.CRM.IsSupervisor(Boolean return [bool])

Function.Global.CRM.IsSupervisor(user ID [string], Boolean return [bool])

Arguments

user ID

string

Boolean return

bool

Examples

Remarks


Function.Global.CRM.SaveEvent

Syntax

Function.Global.CRM.SaveEvent(event id, seq, company number, company type, event type id, title, description, start datetime, end datetime, recipient, usergroup id, all day, reminder, reminder interval, event location id, request acknowledgement, link info, status id, priority id, event group id, event subgroup id, purge date, opportunity id, contact id, close date, creator, meta0, meta1, meta2, meta3, meta4, meta5, meta6, meta7, meta8, meta9, event id return)

Arguments

Company Type values:

10: Vendor

15: Customer

18: Prospect

19: Suspect

Recipient:

8-character GS username

Usergroup ID:

-1: Single recipient (no usergroup)

All Day:

"True" or "False"

Reminder:

"True" or "False"

Request Acknowledegment:

"True" or "False"

Contact ID:

Corresponds with Alt_ID in Contact file

Creator:

8-character GS username

Example

Remarks

  • All arguments are strings except for Event ID, which is a long. Pass -1 if creating a new event. If updating an existing event and a value does not change, send "*NC*". This function can only be called for a single recipient or usergroup. If multiple recipients or usergroups are needed, multiple function calls are required. All date arguments should be the string equivalent of the date or datetime value. All ID arguments should be the string equivalent of the long ID in the corresponding CRM table unless otherwise noted.


Function.Global.CRM.SaveOpportunity

Description

Syntax

Function.Global.CRM.SaveOpportunity(opp id, opp group id, company number, company type, contact ID, opp type id, opp description, workflow id, close date, expiration date, proj close date, lead source id, revenue, funnel id, probability id, status id, internal assignment, salesperson, close reason id, quote number, quote line, sales order number, sales order line, opp id return)

Arguments

Company Type values:

10: Vendor

15: Customer

18: Prospect

19: Suspect

Contact ID:

Corresponds with Alt_ID in Contact file

Internal Assignment:

8-character GS username

Salesperson:

3-character sales person code from AR tables in the standard company options

Example

Remarks

  • All arguments are strings except for Opp ID, which is a long. Pass -1 if creating a new opportunity. If updating an existing opportunity and a value does not change, send "*NC*". All date arguments should be the string equivalent of the date or datetime value. All ID arguments should be the string equivalent of the long ID in the corresponding CRM table unless otherwise noted. Revenue should be the string equivalent of the decimal value.


Function.Global.DocumentControl.AddDocument

This adds a document to an existing document contol reference entity.

Syntax

Function.Global.DocumentControl.AddDocument(link ID, file, description, group, file type) or

Function.Global.DocumentControl.AddDocument(link ID, file, description, group, user file type)

Arguments

None

Example

Remarks


Function.Global.DocumentControl.AddDocumentNFC

This function works exactly the same as F.Global.DocumentControl.AddDocument (adds a document to an existing document contol reference entity), except that it does not perform a file check to see if the file already exists in the target directory specified for that document type.

Syntax

Function.Global.DocumentControl.AddDocumentNFC(link ID, file, description, group, file type)

Function.Global.DocumentControl.AddDocumentNFC(link ID, file, description, group, user file type)

Arguments

link ID
file
description
group
user file type

Examples

Remarks


Function.Global.DocumentControl.AddStandaloneDocument

This command creates a stand-alone document control reference.

Syntax

Function.Global.DocumentControl.AddStandAloneDocument(link type, file, description, group, user, file type, non rev, no UNC, long return)

Arguments

Example

Remarks


Function.Global.DocumentControl.AddStandAloneDocument

This command creates a stand-alone document contr0l reference.

Syntax

Function.Global.DocumentControl.AddStandAloneDocument(link type, file, desc, group, user, nounc, smeta, public, long return)

Arguments

link type
file
desc
group
user
nounc
smeta
public
long return)

Examples

Remarks


Function.Global.DocumentControl.AddStandaloneLinkType

This command creates a new stand-alone link type.

Syntax

Function.Global.DocumentControl.AddStandAloneLinkType(description, ret ID)

Arguments

Example

Remarks


Function.Global.DocumentControl.AddStandAloneLinkType

This command creates a new stand-alone link type.

Syntax

Function.Global.DocumentControl.AddStandAloneLinkType(description, ret ID)

Arguments

description
ret ID

Examples

Remarks


Function.Global.DocumentControl.AddStandaloneMeta

This command adds metadata to a document ID and sequence combination.

Syntax

Function.Global.DocumentControl.AddStandAloneMeta(document ID, sequence, meta)

Arguments

Example

Remarks


Function.Global.DocumentControl.AddStandAloneMetaData

This command adds metadata to a document ID and sequence combination.

Syntax

Function.Global.DocumentControl.AddStandAloneMetaData(document ID, sequence, meta)

Arguments

document ID
sequence
meta

Examples

Remarks


Function.Global.DocumentControl.CheckUserDocumentSecurity

Syntax

Function.Global.DocumentControl.CheckUserDocumentSecurity(Doc ID, User, bRet)

Arguments

Example

Remarks


Function.Global.DocumentControl.CheckUserLinkSecurity

Description

Syntax

Function.Global.DocumentControl.CheckUserLinkSecurity(Link Type, User, iRet)

Arguments

Example

Remarks

  • iRet will be a numeric number if iRet is higher than zero the user has at least permission to view the link type.


Function.Global.DocumentControl.Copy

Copies documents from one link id to another link id. Returns true if documents are copied and returns false if no links were copied.

Syntax

Function.Global.DocumentControl.Copy(FromLinkID as long, ToLinkID as long, Return Boolean)

Arguments

Example

Remarks


Function.Global.DocumentControl.CopyExt

This function copies all documents from one ID to a new LinkID. The new LinkID must be created using F.Global.DocumentControl.CreateReference before using this command. The Delete Original parameter will delete existing references for the original ID after copying if True. The Copy Comments parameter will copy any existing comments from the original ID to the new ID.

Syntax

Function.Global.DocumentControl.CopyExt(Original LinkID [Long], New LinkID [Long], Delete Original [Boolean], Copy Comments [Boolean], User [String])

Arguments

Original LinkID

Long

New LinkID

Long

Delete Original

Boolean

Copy Comments

Boolean

User

String

Examples

Remarks


Function.Global.DocumentControl.CreateBulkReferences

Function.Global.DocumentControl.CreateBulkReferences

Syntax

Arguments

Examples

Remarks


Function.Global.DocumentControl.CreateReference

This creates a new document control base entity.

Syntax

Function.Global.DocumentControl.CreateReference(key, type, ID)

Arguments

Example

Remarks


Function.Global.DocumentControl.DeleteDocument

Syntax

Function.Global.DocumentControl.DeleteDocument(Doc ID)

Arguments

Example

Remarks


Function.Global.DocumentControl.DeleteLinkID

Function.Global.DocumentControl.DeleteLinkID

Syntax

Arguments

Examples

Remarks


Function.Global.DocumentControl.GetAllDocumentIDs

The Link ID Return returns a ":" delimited string of all document IDs. If no documents are found "" is returned.

Syntax

Function.Global.DocumentControl.GetAllDocumentIDs(DCC Key [String], Link ID Return [String])

Arguments

DCC Key

String

Link ID Return

String

Examples

Remarks


Function.Global.DocumentControl.GetDocument

Description

Syntax

Function.Global.DocumentControl.GetDocument(Doc ID, RetFile)

Arguments

Example

Remarks


Function.Global.DocumentControl.GetDocumentID

Syntax

Function.Global.DocumentControl.GetDocumentID(link ID, file, RetDocID)

Arguments

Example

Remarks


Function.Global.DocumentControl.GetLinkID

Syntax

Function.Global.DocumentControl.GetLinkID(Key, Link Type, RetLinkID)

Arguments

Example

Remarks


Function.Global.DocumentControl.GetLinkTypeIDs

Syntax

Function.Global.DocumentControl.GetLinkTypeIDs(string return)

Function.Global.DocumentControl.GetLinkTypeIDs(string return)

Arguments

string return

Examples

Remarks


Function.Global.DocumentControl.GetLinkTypeTitle

This function returns the text title that corresponds to the passed, numeric link type.  For example, passing a value of 25, will yield a string return of Work Order Operation Link Information.

Syntax

Function.Global.DocumentControl.GetLinkTypeTitle(Link type, string return)

Arguments

Link type
string return

Examples

Remarks


Function.Global.DocumentControl.GetReferenceStatus

The DCC Key Types for custom DCC Keys are 2010 - 2200. The status return codes are: 0 - No DCC header or documents exist 1 - DCC header exists, but no documents 2 - DCC header and documents exist

Syntax

Function.Global.DocumentControl.GetReferenceStatus(DCC Key [String], DCC Key Type [String], Status Return [Long])

Arguments

DCC Key

String

DCC Key Type

String

Status Return

Long

Examples

Remarks


Function.Global.DocumentControl.GetVersion

This function returns a value, indicating the version of Link/Document Control in use.  Valid return value are as follows: 3 - Link 3, or no Link/DCS module in use 4 - Link 4 DCS - Document Control

Syntax

Function.Global.DocumentControl.GetVersion(long return)

Arguments

long return

Examples

Remarks


Function.Global.DocumentControl.Invoke

Function.Global.DocumentControl.Invoke

Syntax

Arguments

Examples

Remarks


Function.Global.DocumentControl.ReconcileBaseEntries

Function.Global.DocumentControl.ReconcileBaseEntries

Syntax

Arguments

Examples

Remarks


Function.Global.DocumentControl.RevisionDisable

These commands enable and disable the creation of non-revision-specific document references within the document control module.

Syntax

Function.Global.DocumentControl.RevisionDisable()

Arguments

Examples

Remarks


Function.Global.DocumentControl.RevisionEnable

These commands enable and disable the creation of non-revision-specific document references within the document control module.

Syntax

Function.Global.DocumentControl.RevisionEnable()

Arguments

Examples

Remarks


Function.Global.DocumentControl.SearchStandaloneMeta

This command searches stand-alone document metadata for matches to the specified string, and returns the results in a string delimited with a colon (:).

Syntax

Function.Global.DocumentControl.SearchStandAloneMeta(meta, string return)

Arguments

Example

Remarks


Function.Global.DocumentControl.SearchStandAloneMetaData

This command searches stand-alone document metadata for matches to the specified string, and returns the results in a string delimited with a colon (:).

Syntax

Function.Global.DocumentControl.SearchStandAloneMetaData(meta, string return)

Arguments

meta
string return

Examples

Remarks


Function.Global.DocumentControl.UpdateStandAloneDocument

This command updates a stand-alone document control reference.

Syntax

Function.Global.DocumentControl.UpdateStandAloneDocument(fileID, filename, link type, description, group, user, nounc, meta data, public, long return)

Arguments

fileID
filename
link type
description
group
user
nounc
meta data
public
long return)

Examples

Remarks


Function.Global.DocumentControl.UpdateStandaloneLinkType

This command updates a stand-alone document link type description.

Syntax

Function.Global.DocumentControl.UpdateStandAloneLinkType(Link type, description)

Arguments

Example

Remarks


Function.Global.DocumentControl.UpdateStandAloneLinkType

This command updates a stand-alone document link type description.

Syntax

Function.Global.DocumentControl.UpdateStandAloneLinkType(Link type, description)

Arguments

Link type
description

Examples

Remarks


Function.Global.General.CallAsyncGas

Syntax

Function.Global.General.CallAsyncGas(GAB Program, PID Return) or

Function.Global.General.CallAsyncGAS(GAB program, switches, PID long return)

Arguments

GAB Program

String

PID Return

Long Process ID returned from Call

Example

Function.Global.General.CallAsyncGAS(“GAB Program”, iPID)

Remarks


Function.Global.General.CallSyncGas

Syntax

Function.Global.General.CallSyncGas(GAB Program) or

Function.Global.General.CallSyncGAS(GAB program, switches)

Arguments

GAB Program

String

switches

Example

Function.Global.General.CallSyncGAS(“GAB Program”)

Remarks


Function.Global.General.CallwrapperAsync

These commands launch wrapped Global Shop processes (indicated by a long integer mode).

Syntax

Function.Global.General.CallWrapperAsync(mode, parameters) or

Function.Global.General.CallWrapperSync(mode, parameters)

This command will pass the Business Intelligence Override flag to any call wrapper mode related to a Business Intelligence reports. This command will also support all existing call wrapper modes.

Function.Global.General.CallWrapperAsyncBIO(Mode, Parameters)

Function.Global.General.CallWrapperSyncBIO(Mode, Parameters)

Arguments

Mode

Numeric Value that represents the program

Parameters

String Value delimited by !*!

Program Mode Parameters
1SHOTGI 50 - Run 1SHOTGI Program name
FIXBMATL 1000 - Fix BOM calls REBLDALL Company code
BM0050 1010 - Update Inventory Description to BOM

Bill of Material>Administration>Update Inventory Description to BOM - Process

01: Unit Cost Updates

02: Rebuild Browser Index

Beginning BOM Parent

Beginning BOM Rev

End BOM Parent

End BOM Rev

All BOMs Flag

Update Cost

01: Zero Unit Cost For All Parents

02: No Change To Unit Cost For Any Parents

03: No Unit Cost Update

04: Update All Costs From Alt Cost

Refresh Descriptions For Raw Materials Flag

Refresh Descriptions For Parent Parts Flag

Refresh Unit Of Measure Fields Flag

Refresh Source Code Flag

RE0071CW 1500 - Reprice Routers In File

Out File

RE0019 1510 - Admin Reprice Routers/ Estimates

Estimating/Routing & Quote Management>Administration>Reprice Router/Estimates - Mode

“PS”: populate the screen

“NS”: screenless mode

Beginning Router

End Router

All Routers Flag

Pull Setup from Workcenter Flag

Pull Runtime from Workcenter Flag

Pull Description from Workcenter Flag

Pull Description from Inventory (Material) Flag

Pull Description from Inventory (Router) Flag

Pull Product Line from Inventory (Router) Flag

Reprice Labor Steps Only Flag

Reprice Material Steps Only Flag

Update Alternate Cost Router Flag

Alternate Cost Reprice Quantity

Zero Unit Cost for Manufactured Parts Flag

Refresh Lead Time on Material Sequences Flag

Refresh Lead Time on Outside Sequences Flag

Update Rate with Inventory Cost Even if Zero Flag

Update Rate with Workcenter Rate Even if Zero Flag

JB0082 2000 - Manual Time Card Input Screen

Shop Floor Control>Transactions> Manual Time Card Input - Mode

SS-Select Scrap – Opens the scrap selection screen

AS-View Scrap – Opens scrap selection screen in view only mode

AR-Add record – Add a scrap record with the passed properties

UR-Update record – Updates a scrap record with the passed properties

GR-Get record

GN-Get next record

UN-Undo all uncommitted changes for the specified scrap reference ID

SC-Save uncommitted changes for the specified scrap reference ID

CS-Copy scrap from one detail record or scrap reference ID to another

DC-Check for disposals for a detail record or scrap reference ID

DS-Delete scrap for a detail record

GS-Get the scrap data tied to a detail record or scrap reference ID

VS-Validate scrap code

AQ-Assign quality numbers for a detail record or scrap reference ID

Job: The job displayed in select scrap or view scrap mode

Suffix: The suffix displayed in select scrap or view scrap mode

Sequence: The sequence displayed in select scrap or view scrap mode

Total Scrap: The scrap quantity to match in select scrap mode

Scrap Reference: The reference ID used to reference changes done in previous calls to JB0082. If no reference ID is explicitly passed, an unused ID will be assigned to this field. It is a 16 digit numeric

    • The following parameters are the fields of the SCRDT file and are used to send and receive parameters from the SCRDT file but the SCRDT-DTL-* parameters are also used as the job detail key fields

SCRDT-DATE: Date the record was created (CCYYMMDD)

SCRDT-TIME: Time the record was created (HHMMSShh)

SCRDT-SEQ: Sequence for that date/time combination

SCRDT-DTL-JOB: Job for the associated detail record

SCRDT-DTL-SUFFIX: Suffix for the associated detail record

SCRDT-DTL-SEQ: Sequence for the associated detail record

SCRDT-DTL-DATE: Date for the associated detail record (YYMMDD)

SCRDT-DTL-KEY-SEQ: Key sequence for the associated detail record

SCRDT-STAT:

  • 0-Temporary, uncommitted status
  • 1-The record has been saved, but no detail record exists yet
  • 2-The record has been saved and a detail record exists SCRDT-QUALITY: The quality record number

SCRDT-REASON-CODE: The scrap reason code for that record

SCRDT-QTY: The quantity scrapped in that record

SCRDT-SCRAP-REF: Can be populated explicitly, but will also be populated by JB0082 as necessary

STATUS-ON-SAVE:

  • 0-Temporary, uncommitted status
  • 1-The record has been saved, but no detail record exists yet
  • 2-The record has been saved and a detail record exists. The detail key should be passed in SCRDT-DTL-* DEST-DTL-KEY: Destination detail key used for copying scrap

DEST-SCRAP-REF: Destination scrap reference ID

GET-QUALITY-FLAG: Set to Y assign quality numbers to committed data when scrap data records are saved

UPDATE-QUALITY-FLAG: Set to Y to delete existing quality data when quality records are deleted

Output Parameters:

STATUS:

  • 00-Successful
  • 01-No changes made
  • 02-Disposals exist (Used for check for disposals mode.)
  • 10-Invalid scrap reason
  • 99-Failed RET-PRIMARY-REASON: Scrap reason selected with the greatest quantity

RET-PRIMARY-QTY: Greatest scrap quantity for a selected reason

RET-PRIMARY-QUALITY: Quality number with greatest scrap quantity

JB0027 2001 - Quality Reject/Disposition

Quality>File>Quality Reject/Disposition - Company Code

Quality Number

JB0028 2002 - Shop Floor Control Tasks

Shop Floor Control>Transactions>Tasks - Company Code

Type

'W'=Workorders

'S'=Single Job)

Beginning Workorder

Beginning Suffix

End Workorder

End Suffix

Terminal

JB0052GI 2003 - WIP to Finished Goods

Shop Floor Control>Transactions>WIP to Finished Goods - Company Code

Terminal

Calling Program

Mode - "NS": screenless mode

Pass Detail Job^

Pass Detail Suffix^

Pass Detail Sequence

Pass Detail Fill^

Pass Detail Date^

Pass Detail Key Sequence^

Workorder*

Workorder Suffix*

Transfer Date Year*#

Transfer Date Month*#

Transfer Date Date*#

Close Workorder Flag* (Y or N)

Part Description*#

Quantity*

Cost*

Price*

Print Labels Flag* (Y or N)

Cost Method*

Update Inventory Flag* (Y or N)

Inventory Debit Account*

File Name*

A fully qualified path to a tab delimited file (each column separated by a tab, each row separated by a new line).

Each row should have the following columns:

Lot

Bin

Heat

Serial

Quantity

Expiration Date

Warranty Months

User Field 1

User Field 2

User Field 3

User Field 4

User Field 5

User Field 6

User Field 7

User Field 8

User Field 9

If any of the columns are blank, they are assumed to be empty. A valid or empty bin is required and the total quantity of all the rows in the file must match the quantity that was passed as a parameter to the callwrapper.

^ indicates that this parameter is only used when no mode is specified.

  • indicates that this parameter is only used in screenless mode.
  1. indicates that this parameter is optional. If blank, it will be set to its default value.

Other notes:

If screenless mode is on, all error messages will be suppressed. If an error occurs, the text from the error message will be passed back as a parameter and can be accessed via Variable.Ambient.CallWrapperReturn.

JB0056GI 2005 - Commit Router Material

Shop Floor Control>Transactions>Commit Router Material - Job

Suffix

Sequence

AR002CN 3000 - Customer Order Notes

Accounts Receivable>File>Customer>New/Open>Order Notes - Customer ID

Customer Name

Mode

'CU': Customer Update

'CV': Customer View

'OV': Order View

Type

'C': Customer

'P': Prospect

ORD231 3010 - Contract Part Pricing

Order Entry>File>Contract Part Pricing - Mode

“PS”: populate the screen

“NS”: screenless mode

Effective Date: Date in MMDDYYYY format. If zero, the current date will be used.

Print Modified Rate Tables Flag

Number of Effective Dates to Print

Generate Open Order Price Update Transactions Flag

All Customers Flag

“A”: radio button “All Customers” selected.

“I”: radio button “Include Ranges” selected. If this is used in screenless mode, screenless mode will be turned off so the user can specify the ranges.

“X”: radio button “Exclude Ranges” selected. If this is used in screenless mode, screenless mode will be turned off so the user can specify the ranges.

INVMAIN 3500 - Inventory Master

Inventory>File>New/Open - Company Code

Mode

N- new part

C- copy part

D- delete part

V- view part

O- open part

L- view mode with lead time not protected

E- view mode with product line, description, and UM and Pur UM not protected

P- view mode with source, order qty, and sort, reorder not protected

Switch 2

D- pull up the part options

U- prevent reorder from being disabled

N- screenless mode(for delete only)

Switch 3

S- show cost regardless of option

Part

Part Location

INV220GI 3550 - Issues and Receipts from Inventory

Inventory>Transactions>Stand Alone Issues and Receipts - Company Code

Terminal

Calling Program

User ID

Mode (future use)

Sales Order

Sales Order Line

ENG002 3600 - Maintain Engineering Change Control

Quality>Transactions>Maintain Engineering Change Control - Company Code

Prefix

Number

ENG003 3601 - Engineering Change Control Signoff

Quality>Transactions>Engineering Change Control Signoff - Company Code

Prefix

Number

Part

QL6004 3700 - Cause and Corrective Action Signoff

Quality>Transactions>Cause and Corrective Action Signoff - Company Code

CNC

QL6014 3701 - Vendor Approval Signoff

Quality>Transactions>Vendor Approval Signoff - Company Code

VAP

ORD011 4000 - Order Entry Discounts

Order Entry>File>Discoutns - Company Code

Terminal

Calling Program

User ID

Part

JB0098 5000 - Edit Flex Schedule

Shop Floor Control>File>Flexible Schedule - Mode

VW - View Only

OP or spaces - Open

Schedule (schedule to open)

Suffix (schedule suffix to open)

Return Parameters-

Status

00 - Successful

10 - User canceled

35 - Parameter Error

99 - Failed

UPLSCHED 6000 - Upload Schedule Option

50 Append

51 Delete

52 Append and update

Screen Mode -set to NS for no screen mode

UPLPLDSC 6001 - Upload PL/Discounts Option

50 Append

51 Delete

52 Append and update

Screen Mode -set to NS for no screen mode

UPLQUOTE 6002 - Upload Schedule Screen Mode - set to NS for no screen mode

Option

50 Append

51 Delete

52 Append and update

UPLSALES 6003 - UPSALES MODE: Company Code, Option Selected
ORDUPCM3 6004 - Upload Sales Order Company Code

User

File

UPLSCHED 6006 - Upload Employee Option

50 Append

51 Delete

52 Append and update

Screen Mode -set to NS for no screen mode

UPLITEM 6007 - Item Lot/Bin Master Upload Option

50 Append

51 Delete

52 Append and update

Screen Mode -set to NS for no screen mode

UPLJOBST 6008 - Upload Job Cost Sequence Lines to Router Header Master Option

50 Append

51 Delete

52 Append and update

Screen Mode -set to NS for no screen mode

ORD501GI 7000 - Order History Query by Part Number

Order Entry>View>Orders and History - Customer

Part

Part Location

Hide Cost Fields (Y or N)

RPTOEHDR - 8000 OE Header Report RPTOEHDR: Call order entry header core modules for GAB reports. Requires the calling program to generate an order header tab delimited request file named “cccOEHRQ.ttt.TXT”. The program will return an order header tab delimited response file named “cccOEHDR.ttt.TXT”. If tax detail is requested, the program will return an order header tax detail tab delimited response file named “cccOEHTX.ttt.TXT”. Note that ccc is the company code and ttt is the terminal in all specified file names. All files will be created in the GLOBAL\FILES directory.

Passed parameters to callwrapper:

RPT-ID – The crystal report id

HDG-FLG – Include heading row in response files

0 = Not requested

1 = Requested

OPT01-FLG - Calls module to calculate totals without tax detail

0 = Not requested

1 = Requested

OPT02-FLG – Calls module to calculate totals and return tax detail

0 = Not requested

1 = Requested

Options 03 through 99 are not currently supported

Order Header Request File Columns:

SOURCE TABLE – The table to use to fulfill the request

Q = Quotes

O = Sales orders

D = Detail billing orders

S = Shipments

H = Invoice History

ORDER – The 7 digit order number (always required)

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)

Order header response columns:

SOURCE TABLE – The table to use to fulfill the request

Q = Quotes

O = Sales orders

D = Detail billing orders

S = Shipments

H = Invoice History

ORDER – The 7 digit order number (always required)

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)

STATUS – Status of the module request for this entry (0 is successful, 1 is failed)

CMP-GROSS – Company currency gross order total

CMP-FRT – Company currency freight amount

CMP-TAXES – Company currency total tax amount

CMP-DISC – Company currency total discount amount

CMP-NET – Company currency net order total

ORD-GROSS – Order currency gross order total

ORD-FRT – Order currency freight amount

ORD-TAXES – Order currency total tax amount

ORD-DISC – Order currrency total discount amount

ORD-NET – Order currency net order total

PROFIT – Percent profit on order total

FRT-COST – Company currency freight cost

TAX-CTR – Number of tax authorities (also number of tax detail records returned)

WEIGHT – Total net weight (not provided for invoice history)

COST – Company currency total cost (not provided for invoice history)

CMP-PRCCLS-DISC – Company currency total price class discount (invoice history only)

CMP-PRDLN-DISC – Company currency total product line discount (invoice history only)

CMP-ORDER-DISC – Company currency total order discount (invoice history only)

ORD-PRCCLS-DISC – Order currency total price class discount (invoice history only)

ORD-PRDLN-DISC – Order currency total product line discount (invoice history only)

ORD-ORDER-DISC – Order currency total order discount (invoice history only)

STD-LINE-CTR – Lines excluding freight, progress bill, and material surcharge (invoice history only)

CMP-MATL-SCHRG – Company currency total material surcharges (invoice history only)

CMP-SHIP-CHRG – Company currency total shipping charges (invoice history only)

ORD-MATL-SCHRG – Order currency total material surcharges (invoice history only)

ORD-SHIP-CHRG – Order currency total shipping charges (invoice history only)

Order header tax detail response columns:

SOURCE TABLE – The table to use to fulfill the request

Q = Quotes

O = Sales orders

D = Detail billing orders

S = Shipments

H = Invoice History

ORDER – The 7 digit order number (always required)

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)

TAX-CD – Tax authority code

TAX-DESC – Tax description

TAX-RATE – Tax rate

CMP-TAX-AMT – Company currency total tax amount

CMP-TAXABLE – Company currency total taxable amount

ORD-TAX-AMT – Order currency total tax amount

ORD-TAXABLE – Order currency total taxable amount

The core program sets the RETURN variable to one of the following values:

00 = Successful

01 = Passed parameter error

23 = No order header request records found

35 = File error

99 = Cancel

RPTOELNE 8010 - OE Line Report RPTOELNE: Call order entry line core modules for GAB reports. Requires the calling program to generate an order line tab delimited request file named “cccOELRQ.ttt.TXT”. The program will return an order line tab delimited response file named “cccOELNE.ttt.TXT”. The file will contain data for all options even if not requested. Data for options not requested will be spaces or zeroes. Note that ccc is the company code and ttt is the terminal in all specified file names. All files will be created in the GLOBAL\FILES directory.

Parameters:

RPT-ID – The crystal report id

HDG-FLG – Include heading row in response files

0 = Not requested

1 = Requested

OPT01-FLG – Calls module to calculate total discount percentage

0 = Not requested

1 = Requested

OPT02-FLG – Calls module to calculate extenstion for back order quantity

0 = Not requested

1 = Requested

OPT03-FLG – Calls module to return tax authorities and amounts

0 = Not requested

1 = Requested

Options 04 through 99 are not currently supported

Order Line Request File Columns:

SOURCE TABLE – The table to use to fulfill the request

Q Quotes

O Sales orders

D Detail billing orders

S Shipments

H Invoice History

ORDER – The 7 digit order number (always required)

LINE – The 4 digit line numer (always required). The first 3 digits are always the line number number.

For quotes, the 4th digit is the line suffix

For all other sources, the 4th digit is always zero

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)

Order header response columns:

SOURCE TABLE – The table to use to fulfill the request

Q = Quotes

O = Sales orders

D = Detail billing orders

S = Shipments

H = Invoice History

ORDER – The 7 digit order number (always required)

LINE – The 4 digit line numer (always required). The first 3 digits are always the line number number. For quotes, the 4th digit is the line suffix. For all other sources, the 4th digit is always zero.

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)

STATUS – Status of the module request for this entry (0 is successful, 1 is failed)

Option 01

TOTAL-DISC-PCT – Total discount percentage

Option 02

CMP-BO-QTY-DISC – Company currency total discount based on back order quantity

CMP-BO-QTY-EXT – Company currency extension based on back order quantity

ORD-BO-QTY-DISC – Order currency total discount based on back order quantity

ORD-BO-QTY-EXT – Order currency extension based on back order quantity

Option 03

CMP-TOTAL-TAX – Company currency total tax amount

ORD-TOTAL-TAX – Order currency total tax amount

TAX-CTR – Number of tax authorities assigned

One set of data for each tax authority (maximum of 10)

TAX-ZONE – Tax authority zone (state or country)

TAX-CD – Tax authority code

TAX-APPLY – Whether taxes should be applied (Y is applied)

TAX-AUTH-TYPE – Tax authority type

1 = State

2 = County

3 = City

4 = Other

5 = Country

6 = Province

7 = Local

TAX-TYPE – Tax type

S = Sales or Use Tax

V = VAT Tax

TAX-RATE – Tax rate

TAX-DESC – Tax description

CMP-TAX-AMT – Company currency total tax amount

ORD-TAX-AMT – Order currency total tax amount

CMP-TAXABLE – Company currency total taxable amount

ORD-TAXABLE – Order currency total taxable amount

The core program sets the RETURN variable to one of the following values:

00 = Successful

01 = Passed parameter error

23 = No order line request records found

35 = File error

99 = Cancel

JB032BGI 93000 - Build Payroll Report Table Start Date (CCYYMMDD)

End Date (CCYYMMDD)

Process By

E - Employee

D - Department

G - Group

Starting - Start of the range of the employee, department or group

Ending - End of the range of the employee, department or group

Print - Y to print balance only

Page Flag - Y to insert page break for each employee

Exclude Absences Flag

AR0020GI 100000 - Launch Customer Master

Accounts Receivable>File>Customers - Mode

F - ?

O - Open

N - New

D - Delete

V - View

E - Edit

Customer/Prospect Switch

P - Prospect, leave blank for customer

Customer Number

AR0026B 100050 - Customer Note Maintenance Customer Number

Customer/Prospect Switch

P - Prospect, leave blank for customer

ORD064GM 100100 - Add a Ship-To To a Customer

Accounts Receivable>File>Customers>New/Open>Add'l Ship-To - Customer number

AR0170GI 100200 - View Open AR

Accounts Receivable>View>AR Open Items and History - Customer number

PUR021GI 175000 - Vendor Quotes

Purchasing>File>Vendor Quotes - Part number (full 20)

PURA64GI 175100 - Generate PO From File File Name

Auto Number Flag (Y or N)

Add Comments Flag (Y or N)

Open Po Flag (Y or N)

Tab Delimited File Layout:

Vendor

Part

Location

Due Date

Description

Inventory Unit of Measure

Inventory Cost

Inventory Quantity

Purchase Order Unit of Measure

Purchase Order Cost

Purchase Order Quantity

GL Account

Extension

PUR064GH 175200 - Opens Purchase Order

Purchasing>File>Purchase Orders Manual - Mode

O to open

N for new

D for delete

V for view

H for view history

C for copy

Purchase Order Number

Vendor Number (only used for New)

ORD200 200000 - Sales Orders

Order Entry>File>Sales Orders - Sales Order Number

Mode

V - View

O - Open

N - New

C - Copy

D - Delete

Customer Number

ORD201 200050 - Delete Sales Order Line

Order Entry>File>Sales Orders>Open/Delete>Lines - Order Number

Line

Terminal

ORD803 200060 - Sales Order Total
ORD602 200070 - Sales Order Delete Payment
ORD195GI 200500 - Sales Order History by Customer/ Ship-To

Order Entry>View>Sales Order History>Order History by Customer/Ship-To - Customer number

QL3060 200700 - Sales Order History by Invoice

Order Entry>View> - Invoice number

ORD880 200800 - Create WO from Sales Order Type

C - Cylce

D - Detail

O - Order

Order Number

QL3060 200900 - Reprint Invoice (Screenless)
SHP150 201000 - Quick Ship Simple 1 order 1 Bin
ORD503GI 202000 - Part history by customer and part Customer number

Part/Rev

Location

Hide cost switch: Y to hide costs, N to show costs

ORD0FRT 203000 - Freight Maintenance
ORDUSRT 203100 - User Value Table Maint For Sales Orders

System Support> Administration> Company Options (Standard) > Order Entry Tables > User Fields - Header/Line Flag

H - Header

L - Line

User Field 1 Label

User Field 2 Label

User Field 3 Label

User Field 4 Label

User Field 5 Label

Apply to Items Defined in Tables

A to apply

V for normal

Default User Field

Default Customer

Default Ship-to

Default Part

Default Location

QL1000 205000 - Warranty

Quality > File > Warranty Maintenance - Customer number

QTE200 251000 - Quick quote

Estimating/Routing & Quote Management > File > Quick Quotes - Quote Number

Mode

V - View

O - Open

N - New

C - Copy

D - Delete

QTE504 201500 - Quote History by Part
251001 - New Quick quote Quote Number

Customer

Note: If no quote number is passed, then the quote number will be automatically generated.

QL2002 251100 - New RMA

Quality > Transactions > RMA - Invoice

Order

Order Sequence

INVMAIN 300000 - Inventory Maintenance/View

Mode

N - New

C - Copy

D - Delete

V - View

O - Open

L - Lines

E - ?

P - ?

X - ?

Part/Rev

Location

INV500GI 300010 - Supply and Demand Part/Rev

Location

INV500GI 300011 - Supply and Demand Part/Rev

Location

Switches

INV455 300050 - Contract Part Pricing

Order Entry > File > Contract Part Pricing - Part/Rev

Location

Description

Uses Revision Flag

LOT155GI 300060 - Updates Item Master For Issued Parts Part

Location

Quantity Issued

Sequence

Order

File Name

Tab Delimited File Layout:

Lot, Bin, Heat, Serial and Quantity

INV756 300070 - Updates Inventory Usage Beginning Month

Beginning Year

End Month

End Year

LOT054GI 300080 - Show Bin to Bin Transfer Screen with Part Selected Part

Bin

Single Update Mode (Y for the screen to close after first update)

RE0010GI 400000 - Estimating/Standard Routers

Estimating/Routing & Quote Management>File>Estimating/Standard Routers - Mode

O - Open

V - View

N - New

D - Delete

C - Copy

L - Load

Router

1SHOTGI 400050 - Router Upload runs 1Shot in append only for UPLRTRH loading in ROUTERHD.txt from files - None
BM0048 410000 - Export BOM from TAB File
WOQUERY 450000 - Work Order Query

Shop Floor Control>View>Work Orders - Mode

1 select work order

2 chose work order by customer

3 chose work order by PO

4 chose work order by user code

5 chose work order by work order discount

6 chose work order by part

7 show specific work order

8 show specific work order without cost

9 show specific work order without labor dollars

Workorder Number

Suffix

Active/History switch

A for active

H for history

WIR100 450100 - Issue Material to Job From File File Name

File Layout (Comma Delimited):

Part Length(20)

Rev Length(03)

Location Length(02)

Quantity Length(16)

Lot Length(15)

Bin Length(06)

Heat Length(15)

Serial Length(30)

Workorder Number Length(6)

Workorder Suffix Length(3)

Workorder Sequence Length(6)

WIR100 450101 - Issue Material to Job From File File Name

File Layout (Tab Delimited):

Part Length(20)

Rev Length(03)

Location Length(02)

Quantity Length(16)

Lot Length(15)

Bin Length(06)

Heat Length(15)

Serial Length(30)

Workorder Number Length(6)

Workorder Suffix Length(3)

Workorder Sequence Length(6)

JB0075GI 450150 - Bring Up Reverse Issue Material

Shop Floor Control>Transactions>Reverse Issued Material - Workorder

Suffix

Sequence

Date (CCYYMMDD)

Time (HHMMSShh)

Transaction Date (CCYYMMDD)

Previous Issue Made - Y to not delete the previous issues that were made in the same thread.

SQLGSLOD 500000 - APS Scheduling Information Download

Capacity Planning & Scheduling>File>Download Scheduling File - Mode

Blank to accept input

SP for show progress (progress will be displayed, and window will close when finished)

SI for silent, no visible screens

Default Date(CCYYMMDD)

Valid ReRead-Lead-Flags:

1: The reread for lead time when zero box is checked

2: The reread for lead time when zero on seq is checked

3: Both checkboxes are checked

1SHOTGI 500010 - Runs APS 83 Schedule None
1SHOTGI 500020 - APS 3 Backward
JB0011CL 500030 - Schedule Job Start Date (YYMMDD)

Due Date (YYMMDD)

Workorder

Suffix

Sequence

Schedule

F: Forward Schedule

B: Backward Schedule

H: Scheduling from Current Sequence

HOOK02 600000 - Activate/Inactivate Hook

System Support>Administration>GAB Script Hook Maintenance - Hook

Hook Active Flag (Y or N)

Hook Description

Script

Sync Flag (A for Asynchronous or S for Synchronous)

PR0805 700100 - Access to Paygroup Pay Group

Return Parameters:

Return

00: Successful

04: Read Failed

35: Unsuccessful

Security

Y: Has security

N: No security

TSCH01 800000 - Add to Task Scheduler

System Support>Administration>Task Scheduler Maintenance - Mode

“SA”: Screenless add mode

Task ID - Used only if the task type is Global.

Item to Run - Used only if the task type is NOT Global.

Frequency

“O”: Once

“D”: Daily

'W': Weekly

'M': Monthly

Task Type

'M': Global

'C': Custom

'G': GAB Script

Task Description

Task Active Flag

Start Yet

Start Month

Start Day

Start Hour

Start Minute

Start Second

BJ020LZ 900100 - Print barcode work order extended Work order number, work order suffix, report ID
JB0053 900200 - Print work order pick list
- Starting work order number, starting work order suffix, ending work order number, ending work order suffix
JB0095N 900300 - Print flex schedule
- Starting date, ending date, starting FS number, starting FS suffix, ending FS number, ending FS suffix, show material (Y if so), use extended barcode (Y if so)
ORD175 910040 - Print Order Bookings Begin Date - MMDDYY format for the start date

End Date - MMDDYY format for the end date

Switch - B (Build Data No Preview) L (Runs Report ID 72)

All - Set to Y to use no criteria

Stamp Date - Used when switch is B an written to the BIBK file for all records

Stamp Time - Used when switch is B an written to the BIBK file for all records

ORD0ACKN 910050 - Print Sales Order Order Number

Mode (P)

Ack Title

SHP300 910060 - Print BOL
SHP205 910070 - Print Packing List INVOICE-NO Can use invoice, order & seq, or pck-no

ORDER Can use invoice, order & seq, or pck-no

SEQ Can use invoice, order & seq, or pck-no

SUPPRESS-DATE Set to “Y” to hide the due date

SUPPRESS-CNDN Set to “Y” to bypass Customs Invoice

LABELS-ONLY Set to “Y” to only print labels

NO-SCREENS Set to “Y” to bypass user input

PCK-NO Can use invoice, order & seq, or pck-no

QKPRT-NAME File name of a btrieve file that contains the PCK-NO and order of the shipments to be printed

SHIP-DATE CCYYMMDD

ORD054 910100 - Print sales order pick list Sales order number
ORD054 910200 - Print Sales Order Pick List Beginning Order Numer

Ending Order

All Orders Flag

Start Date(CCYYMMDD)

End Date (CCYYMMDD)

All Dates Flag

ORD055 910201 - Print Shipment Pick List Beginning Order Number

Ending Order Number

All Orders Flag

Start Date

End Date

All Dates Flag

PUR1LZ 915000 - Print PO

Purchasing>Reports>Purchase Orders - Purchase Order Number

Switch

S- Screenless

Screenless History Flag

Print Open Qty Flag

Use Vendor Currency Flag

QTL010 920000 - Print Quote

Estimating/Routing & Quote Management>Reports>Quotes -

JB032BGI 930000 - Build Payroll Report Table Start Date

End Date

Process By

Starting

Ending

Print

Page Flag

Excl Absences

Empl By

FIXBMATL 1001 - Print barcode work order extended Parameters:

0. Beginning router

1. Ending router

BM0034P 1020 - Print barcode work order extended Parameters:

0. RUNID

1. LOCATION

2. QTY

3. PARENT-PT-RNG-FILE

4. PRINT-ALL-PARTS

BMR060E 1030 - BOM Cost Buildup Description
JB0052GI 2004 - WIP to FG Description
JB0083 2006 - Edit Work Order Detail Parameters:

Date (MMDDYY)

Employee#

JB0010GI 2007 - New/Edit/View Work Order Description
JB0083 2008 - Edit Work Order Detail Description
JB0010GI 2009 - New/Edit/View Work Order Parameters:

Work Order

Work Order Suffix

Switch

O: Open

N: New

V: View

JB0079 2020- Description Parameters:

0. Transaction ID

BMJ501 2050 - Description Parameters:

0. Work Order

1. Quantity

2. Due Date

3. Part Number

JB0066 2060 - Description Parameters:

0. From Work Order

1. From Work Order Suffix

2. To Work Order

3. To Work Order Suffix

4. To Work Order Seq

5. Transfer Date

6. Closed Flag

7. Quantity

8. Cost

9. Price

JB0019GI 2070 - Description Parameters:

0. Beginning Work Order

1. Beginning Work Order Suffix

2. Ending Work Order

3. Ending Work Order Suffix

JB0122 2080 - Description Parameters:

0. Report Selection 

0 – Current (Default) 

1 - History 


1. Work Orders

0 – Closed and Open Workorders (Default) 

1 – Closed Workorders 

2 – Open Workorders 


2. Print Detail 

0 – Yes (Default) 

1 – No 


3. Separate Prem Time 

0 – No (Default) 

1 - Yes 


4. Use Projected Sales 

0 – No (Default) 

1 - Yes 


5. Print Detail Comments 

0 – No (Default) 

1 - yes 


6. Beginning Date CCYYMMDD 


7. Ending Date CCYYMMDD 


8. All Dates 

0 – No (Default) 

1 - Yes 


9.Type of Detail 

0 – All Detail (Default) 

1 – Labor Detail 

2 – Material Detail 

3 – Outside Detail 


10. Beginning WO 


11. Beginning Suffix 


12. Ending WO 


13. Ending Suffix 


14. All Work Orders 

0 – No (Default) 

1 - Yes 

Note: Dates and Type of Detail only used when Print Detail is set to Yes. 

GL0806 2100 - Description Description
GL0806 2101 - Description Description
AP043IVC 2110 - Description Description
LOT001 2200 - Description Parameters:

0. ITMST-FILENAME

AR0140GI 3050 - AR0140GI - Print customer statements Parameters:

Start

End

Date

Attn

"Y": Yes

"N": No


Country

"Y": Yes

"N": No


Total

"Y": Yes

"N": No


Heading Date

Beginning Branch

Ending Branch


Branch

"Y": Yes

"N": No


Print Zero

"Y": Yes

"N": No

SHP150 3100 - Quick Ship - Screenless - All Customers/Orders/Bins Quick Ship - Screenless - All Customers/Orders/Bins - SHP150

Parameters:

All Carriers Flag 

Carrier 

All Promise Dates Flag 

Beginning Promise Date 

Ending Promise Date 

Print Packing List Flag 

Print Bill of Lading Flag 

Print BOL Labels Flag 

Print Shipping Labels Flag 

No Delivery Before Date 

Must Deliver By Date 

Use Customer Bill To for 3rd Party Freight Customer Flag

SHP150 3101 - Quick Ship - Screenless - All Customers/Orders/Bins Parameters:

All Carriers Flag 

Carrier 

All Promise Dates Flag 

Beginning Promise Date 

Ending Promise Date 

Print Packing List Flag 

Print Bill of Lading Flag 

Print BOL Labels Flag 

Print Shipping Labels Flag 

No Delivery Before Date 

Must Deliver By Date 

Use Customer Bill To for 3rd Party Freight Customer Flag

Service Type

Must Ship Complete

PUR100GI 3200 - PO Receipts Description
PUR011GI 3210 - Description Parameters:

0. REQ-NUMBER

PR0002GI 3300 - Description Parameters:

0. MODE ("N"=New, "O"=Open, "V"=View)

1. EMPLOYEE NUMBER

PR0064P 3310- Description Parameters:

0. RUNID

1. BEG-DATE

2. END-DATE

3. EC-RANGE-FILENAME

4. ALL-EC-SELECTED

5. DD-RANGE-FILENAME

6. ALL-DD-CD-SELECTED

7. DD-401K-SELECTED

QTE003GI 3800 - Description Parameters:

Quote Number

Screenless

"Y": Turns on screenless mode


Mode

"W": Won all lines

"L": Loss all lines

"C": Close all lines

QTE003GI 3801 - Description Description
ORD011 4001 - Order Entry Discounts PARAMS:

CMPNY 

TRMNL 

CALLING-PGM 

USER-ID

PART

ORD098 4010 - New Shipments Description
JBUTL001 5100 - Add router lines to a work order Parameters:

1. WO

2. WO Suffix

3. Router Number

4. Schedule

"B": Backward schedule

"F": Forward schedule

"H": schedule from here

JBUTL001 5101 - Delete all sequences from a work order Parameters:

1. WO

2. WO Suffix

6005 - Description Description
UPLBOMTX 6009 - Upload BOM Text Description
UPLBOMH 6010 - Upload BOM Master Description
UPLPRHIS 6011 - Upload Payroll history master Description
UPLCUTL/#$#2#$# 6012 - Cutlist master upload Description
UPLCUST 6013 - Customer upload Parameters:

1) Mode

  "1": Append
  "2": Delete
  "3": Update
UPLPROSP 6014 - Prospect upload Parameters:

1) Mode

  "1": Append
  "2": Delete
  "3": Update
UPLTIMA3/U 6015 - Time & Attendance upload Description
PUR102 6016 - PO Receipts upload Description
UPLJBMUL 6017 - Job Master upload Description
UPLBOMC 6018 - Description Parameters:

0. MODE:

1 = Append

2 = Delete

UPLRTRH 6020 - Description Parameters:

0. MODE

    1 = append

    2 = delete

1. PASSED-FILE-NAME

UPLRTRH/A 6021 - Description Parameters:

0. MODE

1 = append

2 = delete

1. PASSED-FILE-NAME

XGL006 6030 - Description Parameters:

0. INPUT FILENAME

1. BATCH

2. POST DATE (CCYYMMDD)

3. ACCOUNT

4. TRANSACTION TYPE ("10" = INVOICE, "20" = JE, "21" = BRANCH JE)

ORD805 7010 - OE/Quote Delete Module Parameters:

File Type

Is Transaction

Order

Line

Seq

Invoice Only

PO

User

Action

Shipped

Parent

Ignore Backings

No Messages

OEFLU

ORDADLN 7020- Add Orders/Quotes Detail Line - ORDADLN Parameters:

Order/Quote Number

Transaction

Full Path

ORDADLN 7021 - Description Description
ORD143 7030 - Create default order entry invoice job stream for the specified company code Description
ORD740 7035 - Update XSRVY(survey) file for a quote line Description
ORD742 7039 - Description Description
ORD743 7040 - Transfer/Moved Orders Module Description
ORD743 7041 - Transfer/Moved Orders Module Parameters:

1. ORDER

2. NEW LOCATION

3. MOVE FLAG ("Y" = Move, " " = Transfer, "B" = Blanket)

4. LINE FILE

5. SHIP TO (shipto to be used on new blanket release sales order)

6. HEADER DUE DATE (due date that should be put on the order header. If it is not sent, the due date will default to the current date. Should be in CCYYMMDD format)

XOR746 7045 - Updates part location Description
ORD748 7048 - Description Description
ORD888 7050 - Description Description
ORD107 7060 - Create and update an invoice batch for all shipments in open invoice status for an order Parameters:

0) Order Number

ORD193GI 7070 - Order Entry History Inquiry Parameters:

0. Order

1. Customer

INV060 7100 - update allocations Part Allocation to Sales Order

Parameters:

- 0. "R" - Screenless Mode (this probably is required on 7102/7103?)

- 1. PART-Char(17)

- 2. PART-REV-Char(3)

- 3. LOCN

- 4. QTY-TO-ALLOCATE

- 5. ORDER_NO as LPad(Order_No,"0",7)example "0019750"

- 6. ORDER_LINE as Left(RECORD_NO,3) example "001"

- 7. LOT

- 8. BIN

- 9. HEAT

-10. SERIAL

INV060 7101 - update allocations Part Allocation Delete (UnAllocate)

Parameters:

- 0. "R"

- 1. Part(17)

- 2. Rev(3)

- 3. Location

- 4. Order_No(0000000)

- 5. Line_No(001)

- Possible that the following may be optional to use Lot/Bin/Heat/Serial

- 6. blank (Lot leave blank for Order/line delete)

- 7. blank (Bin leave blank for Order/line delete)

- 8. blank (Heat leave blank for Order/line delete)

- 9. blank (Serial leave blank for Order/line delete)

-10. "D" for delete

INV060 7102 - User Mode Parameters:

0. PART-17

1. PART-REV

2. LOCN

3. LOT

4. BIN

5. HEAT

6. SERIAL

7. ORD-QTY

8. USER

INV060 7103 - Work Order Mode Parameters:

0. PART-17

1. PART-REV

2. LOCN

3. LOT

4. BIN

5. HEAT

6. SERIAL

7. ORD-QTY

8. JOB

9. WO-SUFFIX

10. WO-SEQ

INV304P 7110 - Description Description
INV304P 7111 - Description Description
INV921 7120 - Description No parameters.
INV308P 7130 - Description Parameters: 

0. RunID 

1. All Dates selected (1 is yes, 0 is no) 

2. Beginning Date (ccyymmdd format) 

3. Ending Date (ccyymmdd format) 

4 All Transaction Codes selected (1 is yes, 0 is no) 

5. Transaction Code range filename (can hold more than one range)

INV500GI 7200 - Description Parameters:

0. PART

1. LOCN

2. MODE

PSA040P 8015 - Summary by customer/month report - PSA040P Parameters:

0. Run ID

1. Beginning Date

2. End Date

psa050p 8020 - Profitability by Customer - core preprocessor Description
psa050p 8021 - Profitability by Customer - core preprocessor Description
PSA001P 8100 - Description Description
PSA000P 8101 - Description Description
PSA000P 8102 - Preprocessor for GAB/Crystal for All Sales Analysis in Detail Reports - PSA000P  Parameters:

0. Run ID

1. BI Report ID

2. All Dates Selected

3. Start Date

4. End Date

5. All Parts Selected

6. Part Range File Name

7. All Product Lines Selected

8. Product Line Range File Name

9. All Customers Selected

10. Customer Range File Name

11. All Sales Reps Selected

12. Sales Rep Range File Name

13. All Branches Selected

14. Branch Range File Name

15. All Orders Selected

16. Order Range File Name

17. Ignore Parent Cost

PSA002P 8110 - Description Description
INV502P 8120 - Description Parameters:

0. RUNID

1. ALL-PARTS-SELECTED

2. PART-RANGE-FILENAME

3. ALL-SORT-SELECTED

4. SORT-RANGE-FILENAME

5. ALL-PL-SELECTED

6. PL-RANGE-FILENAME

7. NEG-NET

PSA015P 8130 - Description Parameters:

0. RUNID

1. BI-REPORT-ID

2. ALL-CUST-SELECTED

3. CUST-RANGE-FILENAME

4. ALL-DATES-SELECTED

5. START-DATE

6. END-DATE

7. ALL-STATES-SELECTED

8. STATE-RANGE-FILENAME

9. STATE-TYPE

10. PROGRESS-BILL-FLAG

PSA013P 8140 - Sales Taxes by State report GAB Preprocessor Parameters:

0. RunID 

1. All Dates selected (1 is yes, 0 is no) 

2. Beginning Date (format CCYYMMDD) 

3. Ending Date (format CCYYMMDD) 

4. All States/Zones selected (1 is yes, 0 is no) 

5. State/Zone range filename (can hold more than one range) 

6. VAT instead of Sales Tax (1 is yes, 0 is no)

XPSA13P 8170 - Description Parameters:

0. RUNID

1. START-DATE

2. END-DATE

PSA085P 8180 - Description Parameters:

0. RUNID

1. ALL-CUST-SELECTED

2. CUST-RANGE-FILENAME

3. ALL-DATES-SELECTED

4. START-DATE

5. END-DATE

APPINIT 8200 - Create the initial file dump for the requested data sources and initial load to the CRM App. Multiple data sources may be requested. Parameters:

0. Prospect Flag

"Y" = create file dump for prospects


1. Customer Flag

"Y" = create file dump for customers


2. Ship To Flag

"Y" = create file dump for additional ship to ids


3. Part Flag

"Y" = create file dump for parts and part cross references


4. Quote Flag

Y” create file dump for quote headers and lines


5. Sales Order Flag

"Y" = create file dump for sales order headers, lines, and ship schedules


6. Shipment Flag

"Y" = create file dump for shipment headers, lines, and ship schedules


7. Invoice History Flag

"Y" = create file dump for history headers and lines


8. Work Order Flag

"Y" = create file dump for work order headers and operations as well as work order to sales order cross references

ARHSTPP 8300 - Description Parameters:

0. RUNID

1. START-DATE

2. END-DATE

3. ALL-DATES-SELECTED

4. ALL-CUSTS-SELECTED

5. CUST-RANGE-FILENAME

OPTCHG 9000 - Description Parameters:

0. Option ID

1. Option sequence

2. Option value

OLL304W 9200 - Log a passed employee into a Work Order Operation on the Shop Floor Parameters:

0. Work Order

1. Work Order Suffix

2. Work Order Sequence

3. Work Center

4. Employee

OLL304W 9201 - Description Description
1SHOTGI 51 - Description Parameters:

Company Code

Program

AR0020GI 100001 - AR / customer Description
PUR064GH 175200 - PO Opens PO 

Params

MODE - O to open 

- N for new 

- D for delete 

- V for view 

- H for view history 

- C for copy 

PO-NUM – The PO selected for V, H, D , or O 

VENDOR-NUM – Only used on new order to skip the vendor selection screen 


ORD880 200801 - sales order generate WO Parameters:

0. FILE-TYPE

"C" - Cycle, "D" - Detail, "O" - Order

1. ORDER

2. LINE

3. LINE FLAG

ORD880 200802 - Sales Order Generate WO - ORD880 Parameters:

0. FILE-TYPE

"C" - Cycle, "D" - Detail, "O" - Order

1. ORDER

2. LINE

3. LINE FLAG

4. GEN WO FLAG

ORD880 200803 - Sales Order Generate WO Parameters:

0. FILE TYPE

1. ORDER

2. LINE

3. LINE FLAG (1=YES, 0=NO)

4. GENERATE WO FLAG (1=YES, 0=NO)

5. DUE-DATE

6. PART

7. ROUTER

8. NO RTR BOM FLAG (1=YES, 0=NO)

9. NO DATE BYPASS FLAG (1=YES, 0=NO)

10. SCREENLESS FLAG (1=YES, 0=NO)

11. PROCESS NO ORD FLAG (1=YES, 0=NO)

12. LOCATION

13. ORD QTY

QTE200 251001 - New Quick quote Parameter:

Quote Number

Customer

JB0075GI 450150 - Reverse Issue material from job Bring Up Reverse Issue Material

PARAMS: 

WO

SUFF

SEQ

DATE CCYYMMDD

TIME HHMMSShh

TRAN-DATE CCYYMMDD

PREV-ISSUE-MADE Send Y to not delete the previous issues that were made in the same thread.

1SHOTGI 500040 - aps3 40 APS 40

No Parameters.

1SHOTGI 500050 - aps3 0 APS 0

No Parameters.

1SHOTGI 500060 - aps3 77 Description
BJ020LZ/LE 900101 - print bar coded work order extended Description
SEC005 100 - Validate User functions Description
ORD876 4100 - Determine customer sales for a specific period Determine customer sales for a specific period

Parameters:

PASS-CUST – Customer number (required)

PASS-BEG-DATE – Beginning invoice date (required)

PASS-END-DATE – Ending invoice data (required)

GROSS – Gross sales in company currency

FREIGHT – Freight in company currency

TAXES – Taxes in company currency

DISCOUNT – Discount amount in company currency (sign reversed from other values)

SHIP-CHRG – Shipping charges in company currency

MATL-SCHRG – Material surcharges in company currency

NET – Net sales in company currency (equal to sum of all other company currency values)

CUR-GROSS – Gross sales in order currency

CUR-FREIGHT – Freight in order currency

CUR-TAXES – Taxes in order currency

CUR-DISCOUNT – Discount amount in order currency (sign reversed from other values)

CUR-SHIP-CHRG – Shipping charges in order currency

CUR-MATL-SCHRG – Material surcharges in order currency

CUR-NET – Net sales in order currency (equal to sum of all other order currency values)

ORD877 4110 - Update external order discount on all quotes or orders for a customer Update external order discount on all quotes or orders for a customer

Parameters:

FILE-TYPE – Designate what file to update (required)

       O:      Orders
       Q:      Quotes

PASS-CUST – Customer number (required)

TX0800 8000 - Create VAT Reporting File and Extract for Reporting Callwrapper mode 8000:

RPTOEHDR: Call order entry header core modules for GAB reports. Requires the calling program to generate an order header tab delimited request file named “cccOEHRQ.ttt.TXT”. The program will return an order header tab delimited response file named “cccOEHDR.ttt.TXT”. If tax detail is requested, the program will return an order header tax detail tab delimited response file named “cccOEHTX.ttt.TXT”. Note that ccc is the company code and ttt is the terminal in all specified file names. All files will be created in the GLOBAL\FILES directory.


Passed parameters to callwrapper:

RPT-ID – The crystal report id

HDG-FLG – Include heading row in response files

0 = Not requested

1 = Requested


OPT01-FLG – Calls module to calculate totals without tax detail

0 = Not requested

1 = Requested


OPT02-FLG – Calls module to calculate totals and return tax detail

0 = Not requested

1 = Requested


Options 03 through 99 are not currently supported


Order Header Request File Columns:

SOURCE TABLE – The table to use to fulfill the request

Q = Quotes

O = Sales orders

D = Detail billing orders

S = Shipments

H = Invoice History


ORDER – The 7 digit order number (always required)

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)


Order header response columns:

SOURCE TABLE – The table to use to fulfill the request

Q = Quotes

O = Sales orders

D = Detail billing orders

S = Shipments

H = Invoice History

ORDER – The 7 digit order number (always required)

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)

STATUS – Status of the module request for this entry (0 is successful, 1 is failed)

CMP-GROSS – Company currency gross order total

CMP-FRT – Company currency freight amount

CMP-TAXES – Company currency total tax amount

CMP-DISC – Company currency total discount amount

CMP-NET – Company currency net order total

ORD-GROSS – Order currency gross order total

ORD-FRT – Order currency freight amount

ORD-TAXES – Order currency total tax amount

ORD-DISC – Order currrency total discount amount

ORD-NET – Order currency net order total

PROFIT – Percent profit on order total

FRT-COST – Company currency freight cost

TAX-CTR – Number of tax authorities (also number of tax detail records returned)

WEIGHT – Total net weight (not provided for invoice history)

COST – Company currency total cost (not provided for invoice history)

CMP-PRCCLS-DISC – Company currency total price class discount (invoice history only)

CMP-PRDLN-DISC – Company currency total product line discount (invoice history only)

CMP-ORDER-DISC – Company currency total order discount (invoice history only)

ORD-PRCCLS-DISC – Order currency total price class discount (invoice history only)

ORD-PRDLN-DISC – Order currency total product line discount (invoice history only)

ORD-ORDER-DISC – Order currency total order discount (invoice history only)

STD-LINE-CTR – Lines excluding freight, progress bill, and material surcharge (invoice history only)

CMP-MATL-SCHRG – Company currency total material surcharges (invoice history only)

CMP-SHIP-CHRG – Company currency total shipping charges (invoice history only)

ORD-MATL-SCHRG – Order currency total material surcharges (invoice history only)

ORD-SHIP-CHRG – Order currency total shipping charges (invoice history only)


Order header tax detail response columns:

SOURCE TABLE – The table to use to fulfill the request

Q = Quotes

O = Sales orders

D = Detail billing orders

S = Shipments

H = Invoice History

ORDER – The 7 digit order number (always required)

SEQUENCE – The 4 digit shipment sequence (required for shipments and invoice history)

INVOICE – The 6 digit invoice number (only required for invoice history)

TAX-CD – Tax authority code

TAX-DESC – Tax description

TAX-RATE – Tax rate

CMP-TAX-AMT – Company currency total tax amount

CMP-TAXABLE – Company currency total taxable amount

ORD-TAX-AMT – Order currency total tax amount

ORD-TAXABLE – Order currency total taxable amount


The core program sets the RETURN variable to one of the following values:

00 = Successful

01 = Passed parameter error

23 = No order header request records found

35 = File error

99 = Cancel

AR0020GI 100000 - AR / customer Launch customer master

Parameters: mode, customer/prospect switch, customer number

Modes available: F, O, N, D, V, and E

Customer/prospect switch: P for prospect, *!*ZDR*!* for customer

AR0026B 100050 - customer notes Customer note maintenance

Parameters: customer number, customer/prospect switch

ORD064GM 100100 - Description Add a ship-to to a customer

Parameters: customer number

AR0170GI 100200- view open AR View open AR

Parameters: customer number

PUR021GI 175000 - vendor quotes Vendor Quotes

Parameters: part number (full 20)

PURA64GI 175100 - Generate PO Generate PO From File

Parameter: 

FILE-NAME

AUTO-NUMBER-FLAG: Y or N

ADD-COMMENTS-FLAG: Y or N

OPEN-PO-FLAG: Y or N


Tab Delimited File Layout:

VENDOR, PART, LOCN, DUE DATE, DESC, INV UM, INV-COST, INV QTY, PO UM, PO COST, PO QTY, GL ACCT, EXTENSION

ORD201 200050 - open sales order line Delete Sales Order Line

Parameters: Order, Line, Terminal

ORD201 200051 - view sales order line Description
ORD803 200060 - sales order total Description
ORD602 200070 - sales order delete payment Description
QL3060 200700- reprint invoice Sales order history by invoice

Parameters: invoice number

ORD880 200800- sales order generate WO Create WO from Sales Order

The new program will generate work orders for every sales order line that doesn't have one already

Parameters: Type, OrderNumber

Valid Types: C - Cycle, D - Detail, O - Order

QL3060 200900- reprint invoice (screenless) Description
QL3060 200905- reprint credit memo (screenless) Description
SHP150 201000 - Quick Ship Simple 1 order 1 bin Description
ORD503GI 202000 - part history by customer and part Part history by customer and part

Parameters: customer number, part/rev, location, hide cost switch

Hide cost switch: Y to hide costs, N to show costs

ORD0FRT 203000- freight maint Description
ORDUSRT 203100 - Launchs User Value Table Maint For Sales Orders User Value Table Maint For Sales Orders

Parameter: Header/Line Flag,User Field 1 Label,User Field 2 Label, User Field 3 Label, User Field 4 Label, User Field 5 Label, Mode

Valid Header/Line Flag: H or L for header or line 

Valid Sync Flag Values: A to maintain the user field apply table or V for normal mode

This will launch the user field maintenance tables for sales orders.

QL1000 205000 - warranty Warranty

Parameters: customer number

QL2002 251100 - New RMA New RMA

Parameters: 

Invoice

Order Order Sequence

QTE504 201500- quote history by part Description
INVMAIN 300000- inventory maint/view Inventory maintenance/view

Parameters: mode, part/rev, loc

Mode: N, C, D, V, O, L, E, P and X are valid

INV455 300050- part price Contract Part Pricing

Parameters: Part (including Rev), Loc, Description, Uses Rev

Mode: Uses Rev should be "Y" if true

LOT155GI 300060- Updates Item master for issued parts Updates Item Master For Issued Parts

Parameter: PART, LOCATION, QTY-ISSUE, SEQ, ORDER, TAB DELIMITED FILE

Tab Delimited File Layout:

Lot, Bin, Heat, Serial and Quantity

INV756 300070- Updates Inventory Usage Updates Inventory Usage

Parameter: Beginning Month, Beginning Year, End Month, End Year

LOT054GI 300080- Show bin to bin transfer screen Show bin to bin transfer screen with part selected

Parameter: Part, Bin, Single Update Mode (Y for the screen to close after first update)

BM0048 410000- Export BOM From TAB File Description
WOQUERY 450000- work orders query Work order query

Parameters: mode, work order number, suffix, active/history switch

Mode: 0 - 8 are valid

Active/history switch: A for active, H for history

450000 - Work order query

Valid Modes:

1 select work order 

2 chose work order by customer 

3 chose work order by PO 

4 chose work order by user code 

5 chose work order by work order discount 

6 chose work order by part 

7 show specific work order 

8 show specific work order without cost 

9 show specific work order without labor dollars

WIR100 450100- ISsue material to Job from file Issue Material to Job From File

Parameters: 

File

File Layout:

PART Length(20)

REV Length(03)

LOCN Length(02)

QTY Length(16)

LOT Length(15)

BIN Length(06)

HEAT Length(15)

SERIAL Length(30)

WO-NUM Length(6)

WO-SUF Length(3)

WO-SEQ Length(6)


WIR100/T 450101- ISsue material to Job from file Issue Material to Job From File

Parameters: 

File


File Layout:

PART Length(20)

REV Length(03)

LOCN Length(02)

QTY Length(16)

LOT Length(15)

BIN Length(06)

HEAT Length(15)

SERIAL Length(30)

WO-NUM Length(6)

WO-SUF Length(3)

WO-SEQ Length(6)

This is the same as mode 450100, except the file should be tab-delimited, instead of comma-delmited.

SQLGSLOD 500000- Download Scheduling Files APS Scheduling information download

Parameter: Mode, Default Date(CCYYMMDD), ReRead-Lead-Flag

Valid Modes: 

- Blank to accept input 

- SP for show progress (progress will be displayed, and window will close when finished) 

- SI for silent, no visible screens 


Valid ReRead-Lead-Flags:

- 1: The reread for lead time when zero box is checked 

- 2: The reread for lead time when zero on seq is checked 

- 3: Both checkboxes are checked

JB0011CL 500030- APS3 Schedule Job Schedule Job

Parameters:

START-DATE- a number with the format of YYMMDD 

DUE-DATE- a number with the format of YYMMDD 

WO 

SUFFIX 

SEQ 

SCHEDULE -a flag with the following values 

F: Forward Schedule 

B: Backward Schedule 

H: Scheduling from Current Sequence


HOOK02 600000 - Activate hook Activate/Inactivate Hook 

Parameter: Hook, Hook Active, Hook Description, Script, Sync Flag

Valid Hook Active Values: A for active N for inactive

Valid Sync Flag Values: A to be asynchronous or S to be synchronous

This will add the script as a new sequence for the hook number passed.

HOOK02 600001- Activate hook w/ widget Description
HOOK02 600002- Activate hook w/ widget and runtime Activate/Inactivate Hook 

Parameters:

0. Hook

1. Hook Active ("A" for active, "N" for inactive)

2. Hook Description

3. Script

4. Sync Flag ("A" to be asynchronous, "S" to be synchronous)

5. Widget ("1" for Widget, "0" for Normal)

6. Runtime Version ("1.00" or "2.00")

This will add the script as a new sequence for the hook number passed.

OPTINST 700000- Initiliizes company options (Internal use ONLY!) Description
OPTINST 700001- Initiliizes company options (Internal use ONLY!) Description
PR0805 700100- Checks if user has access to pass- pay group Checks if active user has access to pay group 

Parameters:

Pay Group


Return Parameters:

RETURN 

00: Successful 

04: Read Failed 

35: Unsuccessful 

RET-SECURITY 

Y: Has security 

N: No security 

JB0053 900200- print work order pick list Print work order pick list

Parameters: starting work order number, starting work order suffix, ending work order number, ending work order suffix

ORD175 910040- Order Booking Report Print Order Bookings 

Parameters: 

Begin Date - MMDDYY format for the start date 

End Date - MMDDYY format for the end date 

Switch - B (Build Data No Preview) L (Runs Report ID 72)

All - Set to Y to use no criteria 

Stamp Date - Used when switch is B an written to the BIBK file for all records 

Stamp Time - Used when switch is B an written to the BIBK file for all records

ORD0ACKN 910050- print sales order Order Number

Mode (P)

Ack Title

SHP300 910060- print BOL Description
SHP205 910070 - Printing packing list INVOICE-NO Can use invoice, order & seq, or pck-no

ORDER Can use invoice, order & seq, or pck-no

SEQ Can use invoice, order & seq, or pck-no

SUPPRESS-DATE Set to “Y” to hide the due date

SUPPRESS-CNDN Set to “Y” to bypass Customs Invoice

LABELS-ONLY Set to “Y” to only print labels

NO-SCREENS Set to “Y” to bypass user input

PCK-NO Can use invoice, order & seq, or pck-no

QKPRT-NAME File name of a btrieve file that contains the PCK-NO and order of the shipments to be printed

SHIP-DATE CCYYMMDD

ORD054/C 910100- print sales order pick list Print sales order pick list

Parameters: sales order number

ORD054 910200- print sales order pick list more opitons Print Sales Order Pick Lists

Parameter: Order, Last Order, All Orders Flag(Set to Y to print all orders),Start Date(CCYYMMDD),End Date (CCYYMMDD), All Dates Flag (Set to Y to print all dates)

ORD055 910201- print shipment pick list more opitons Print shipment pick list

PARAMS:

ORDER 

LAST-ORDER 

ALL-ORDERS-FLAG 

- “Y”: Select all orders 

START-DATE 

END-DATE 

ALL-DATES-FLAG 

- “Y”: Select all dates

QTL010 915000- print quote print PO
                       "PUR1LZ/I" 

Purchasing>Reports>Purchase Orders

Purchase Order Number

Switch

S- Screenless

Screenless History Flag

Print Open Qty Flag

Use Vendor Currency Flag

QTL010 920000- print quote Print Quote

  Estimating/Routing & Quote Management>Reports>Quotes

JB032BGI 930000- build payroll report table. Start Date

End Date

Process By

Starting

Ending

Print

Page Flag

Excl Absences

Empl By

XJB120G 990000- Description Description

Example

F.Intrinsic.Control.If(V.Local.sQuoteText.Trim,<>,"")
	F.Intrinsic.String.Concat(V.Caller.FilesDir,"\QUOTE.TXT",V.Local.sParam)
	F.Intrinsic.File.String2File(V.Local.sParam,V.Local.sQuoteText)
	F.Intrinsic.File.Exists(V.Local.sParam,V.Local.bExist)
	F.Intrinsic.Control.If(V.Local.bExist,=,True)
		F.Global.General.CallWrapperSync(6002,"NS!*!52")
	F.Intrinsic.Control.EndIf
F.Intrinsic.Control.EndIf

Remarks

  • This applies to:

Function.Global.General.CallWrapperAsync

Function.Global.General.CallWrapperSync

  • This command requires you to be on the current version of Global Shop
  • Parameters are delimited with !*!
  • Blank parameters should be denoted as *!*ZDR*!*
  • Parameters must have leading zeroes, when appropriate.
  • Due to the way data is stored in the background, only a single instance of each wrapper may be active at any given time.
  • Variable.Ambient.CallWrapperReturn returns the information for the program called using the callwrapper


Function.Global.General.CallWrapperAsyncBio

Function.Global.General.CallWrapperAsyncBio

Syntax

Arguments

Examples

Remarks


Function.Global.General.CallWrapperSyncBio

Function.Global.General.CallWrapperSyncBio

Syntax

Arguments

Examples

Remarks


Function.Global.General.CheckSig

Description

Syntax

Function.Global.General.CheckSig

Arguments

Example

Remarks


Function.Global.General.CreateSoftLock

This command creates a soft lock with the specified mode and key, returning a long integer status value.  Valid modes are as follows: RT - Router lock WO - Work order lock Status return values are as follows: 0 - lock is already present 1 - lock granted

Syntax

Function.Global.General.CreateSoftLock(mode, key, long return)

Arguments

mode
key
long return)

Examples

Remarks


Function.Global.General.DestroySoftLock

This command creates a soft lock with the specified mode and key, returning a long integer status value.  Valid modes are as follows: RT - Router lock WO - Work order lock Status return values are as follows: 0 - no existing lock present 1 - lock successfully destroyed

Syntax

Function.Global.General.DestroySoftLock(mode, key, long return)

Arguments

mode
key
long return)

Examples

Remarks


Function.Global.General.FireHook

Syntax

Function.Global.General.FireHook(hook number [long])

Function.Global.General.FireHook(hook number [long], element 0 ID [string], element 0 value [string], ..., element n ID [string], element n value [string])

Arguments

hook number

long

element 0 ID

string

element 0 value

string

...
element n ID

string

element n value

string

Examples

Remarks


Function.Global.General.GetCompanyCodes

This function returns a string, listing all of the company codes present inside Global Shop. Note: ***NORETURN*** is the return value in situations that no company codes are found.

Syntax

Function.Global.General.GetCompanyCodes(StringReturn)

Arguments

StringReturn

Examples

Remarks


Function.Global.General.GetMenuPathFromJobstreamid

This command will return the full menu path from a passed jobstream ID.

Syntax

Function.Global.General.GetMenuPathFromJobstreamID(jobstream ID, return string)

Arguments

Example

Remarks


Function.Global.General.GetMenuPathFromJobstreamID

This command will return the full menu path from a passed jobstream ID.

Syntax

Function.Global.General.GetMenuPathFromJobstreamID(jobstream ID, return string)

Arguments

jobstream ID
return string)

Examples

Remarks


Function.Global.General.GetMenuPathFromProg

Function.Global.General.GetMenuPathFromProg

Syntax

Arguments

Examples

Remarks


Function.Global.General.GetPassedidFromHandle

Syntax

Function.Global.General.GetPassedIDFromHandle(Handle, Return Variable Passed ID)

Arguments

Handle

Long

Return Variable Passed ID

Long Variable

Example

variable.local.iX.declare(long)
variable.local.iy.declare(long)
variable.local.iWnd.declare(long)
variable.local.sID.declare(string)
function.intrinsic.api.getmouseposition(v.lo.ix,v.lo.iy)
function.intrinsic.api.gethandlefromposition(v.lo.ix,v.lo.iy,v.lo.iWnd)
Function.Global.General.GetPassedIDFromHandle(variable.local.iWnd, variable.local.sID)

Remarks


Function.Global.General.GetScriptOrigin

This function returns a long integer indicating the origin of specified signature (.SIG) file. Possible return values are as follows: -2 = specified signature file was not found -1 = illegally modified program / non-matching signature 0 = Global Shop signed program 1 = customer-authored or modified program

Syntax

Function.Global.General.GetScriptOrigin(signature filename, long return)

Arguments

signature filename
long return

Examples

Remarks


Function.Global.General.GSSVersionCheck

This function returns a boolean value to indicate if the specified target GSS version requirement has been met.  For example, if you are running 2012.1 and the target version is specified as 2012.2, the boolean return will be False.

Syntax

Function.Global.General.GSSVersionCheck(target version, boolean return)

Arguments

target version
boolean return

Examples

Remarks


Function.Global.General.IsHookActive

This function evaluates a delimited string of hook numbers, and returns a Boolean value based on if there are active sequences on at least one of the hooks. The string of hooks needs to be delimited with *!*.

Syntax

Function.Global.General.IsHookActive(Hook(s) [String], Boolean Return)

Arguments

Hoo

Examples

Remarks


Function.Global.General.IsinUpdate

This function returns a boolean, indicating if the GAB program is being called from GSSUpdate.

Syntax

Function.Global.General.IsInUpdate(Boolean Return)

Arguments

Example

Remarks


Function.Global.General.IsInUpdate

This function returns a boolean, indicating if the GAB program is being called from GSSUpdate.

Syntax

Function.Global.General.IsInUpdate(Boolean Return)

Arguments

Boolean Return

Examples

Remarks


Function.Global.General.Islicensed

Syntax

Function.Global.General.IsLicensed(Module Number, Boolean Return)

Arguments

Module Number

Long

Return Variable Boolean

True if Licensed, False if not

Example

Function.Global.General.IsLicensed(1, v.local.bLicense)

Remarks


Function.Global.General.IsLicensedByModuleName

Function.Global.General.IsLicensedByModuleName

Syntax

Arguments

Examples

Remarks


Function.Global.General.LaunchHelpPage

This function launches browser that is directed to the specified Global Shop help topic.

Syntax

Function.Global.General.LaunchHelpPage()

Arguments

Examples

Remarks


Function.Global.General.LaunchMenuTask

Syntax

Function.Global.General.LaunchMenuTask(menu selection ordinal [long], sequence [long], long return [long])

Function.Global.General.LaunchMenuTask(menu selection ordinal [long], return [long])

Arguments

menu selection ordinal

long

return

long

Examples

Remarks


Function.Global.General.OverrideCompany

Syntax

Function.Global.General.OverrideCompany(company code [string])

Arguments

company code

string

Examples

Remarks


Function.Global.General.ReadCompanyName

This function returns the company name, given a company code.  Note: This command can only be used with Global Shop versions 2010 and higher. Note: Variable.Ambient.CompanyName can be used when you want to return the company name of the current company code.

Syntax

Function.Global.General.ReadCompanyName(company code, string return)

Arguments

company code
string return

Examples

Remarks


Function.Global.General.ReadLibraryReferences

This function returns a string, delimited with *!*, containing the include file references (Program.External.Include.Library) within the specified GAS program file.

Syntax

Function.Global.General.ReadLibraryReferences(GAS filename, string return)

Arguments

GAS filename
string return

Examples

Remarks


Function.Global.General.ReadOption

This function reads a stored company option value, given an appropriate ID. Because company options allow for multiple stored values (one for each data type), you must specify the target data type when querying the ID. Specifying a default value on the ReadOption call is mandatory; this default value will be returned should the company option value not be present.

Syntax

Function.Global.General.ReadOption(id, data type, default, return) or

Function.Global.General.ReadOption(id, data type, default, sequence, return)

Arguments

Valid data types:

0 = Boolean

1 = String

2 = Float

3 = Long

4 = Date/Time

Example

Remarks

  • The data type of the default and return variables should match the type specified in the data type argument.


Function.Global.General.ReadOptionCommon

This function reads an option value in the common database, given an ID number, suffix number, sequence number, and data type. You can specify a default value that will be returned by the function, if the option is not present in the common database.

Syntax

Function.Global.General.ReadOptionCommon(ID, suffix, sequence, data type, default value, return)

Arguments

The data types are as follows:

0 - Boolean

1 - String

2 - Float

3 - Long

4 - Date

5 - Time

Example

Remarks

  • This command can only be used on Global Shop versions 2010, and higher.


Function.Global.General.ReadSoftLock

This command creates a soft lock with the specified mode and key, returning a long integer status value.  Valid modes are as follows: RT - Router lock WO - Work order lock Status return values are as follows: 0 - no lock present 1 - lock present

Syntax

Function.Global.General.ReadSoftLock(mode, key, long return)

Arguments

mode
key
long return)

Examples

Remarks


Function.Global.General.RegisterProcess

This function registers a process with the menu.  Registered processes will keep the user from exiting the Global Shop menu, while the process PID is still resident. Note: This command requires 2010.2.

Syntax

Function.Global.General.RegisterProcess(PID, program, program description, long return)

Function.Global.General.RegisterProcess(program description, long return)

Arguments

program description
long return

Examples

Remarks


Function.Global.General.ResetPassedDataElements

Clears out existing Data Elements passed from the GSS Screens to GAB or Data Elements from one GAB script to another GAB Script.

Syntax

Function.Global.General.ResetPassedDataElements

Arguments

Example

Function.Global.General.ResetPassedDataElements

Remarks


Function.Global.General.SaveOption

Syntax

Function.Global.General.SaveOption(ID [long], sequence [string], boolean value [bool], flag value, text 0 value  [string], text 1 value  [string], float value [float], date value [date], long long value [long])

Arguments

ID

long

sequence

string

boolean value

bool

flag value
text 0 value

string

text 1 value

string

float value

float

date value

date

long long value

long

Examples

Remarks


Function.Global.General.SaveOptionCommon

This function saves an option value in the common database, given an ID number, suffix number, sequence number, and data type.

Syntax

Function.Global.General.SaveOptionCommon(ID, suffix, sequence, data type, value)

Arguments

The data types are as follows:

0 - Boolean

1 - String

2 - Float

3 - Long

4 - Date

5 - Time

Example

Remarks

  • This command can only be used on Global Shop versions 2010, and higher.


Function.Global.General.SetPassedDataElement

Sets Data Elements passed from the GAB script to GSS Screens or Data Elements from one GAB script to another GAB Script.

Syntax

Function.Global.General.SetPassedDataElements(Name, Value)

Arguments

Name

String Variable to Set the Name of the Passed Variable

Value

Variable of the Value for the Named Argument

Example

Function.Global.General.SetPassedDataElements(“Part”,”123456789”)

Remarks

  • If the name matches that of another element, it will edit the existing element, rather than add a new one.


Function.Global.General.SignalSP2

Syntax

Function.Global.General.SignalSP2

Arguments

Example

Remarks


Function.Global.General.SignGas

Creates a Signature file for a script on the fly as long as the user is licensed for GAB.

Syntax

Function.Global.General.SignGAS(FQ FileName)

Arguments

FQ Filename

Filename of GAB Script

Example

Function.Global.General.SignGAS(“G:\Global\Plugins\GAB\GAS\Test_Script.gas”)

Remarks


Function.Global.General.SpellCheck

This function checks/corrects the passed text, returning the corrected text. Note: This command requires that the GS spelling module be properly installed on each workstation requiring the functionality. Note: This command requires Global Shop 2011.x, or higher.

Syntax

Function.Global.General.SpellCheck(text, string return)

Arguments

text
string return

Examples

Remarks


Function.Global.General.SpellingErrorsPresent

This function checks the passed text, and returns a True if the spell checking component detects one or more spelling errors. Note: This command requires that the GS spelling module be properly installed on each workstation requiring the functionality. Note: This command requires Global Shop 2011.x, or higher.

Syntax

Function.Global.General.SpellingErrorsPresent(text, boolean return)

Arguments

text
boolean return

Examples

Remarks


Function.Global.General.UpdateProcess

Function.Global.General.UpdateProcess

Syntax

Arguments

Examples

Remarks


Function.Global.Hook.AddHookSequenceAssociation

Syntax

Function.Global.Hook.AddHookSequenceAssociation(hookNumber [string], syncFlag [boolean], scriptPath [string], scriptName [string], traceSeqFlag [boolean], scriptType [string], runtime [long], notes [string], widgetFlag [string], returnVariable [long])

Arguments

hookNumber

string

syncFlag

boolean

scriptPath

string

scriptName

string

traceSeqFlag

boolean

scriptType

string

runtime

long

notes

string

widgetFlag

string

returnVariable

long

Examples

Remarks


Function.Global.Hook.UpdateHookSequenceAssociation

Syntax

Function.Global.Hook.UpdateHookSequenceAssociation(hookNumber [string], hookSeq [string], syncFlag [boolean], scriptPath [string], scriptName [string], traceSeqFlag [boolean], scriptType [string], runtime [long], notes [string], widgetFlag [string])

Arguments

hookNumber

string

hookSeq

string

syncFlag

boolean

scriptPath

string

scriptName

string

traceSeqFlag

boolean

scriptType

string

runtime

long

notes

string

widgetFlag

string

Examples

Remarks


Function.Global.HotFix.RollBack

This function is used to rollback the last applied hotfix. Note: This command requires 2010.2+ Note: This command requires Global Shop-generated signature

Syntax

Function.Global.HotFix.RollBack(return)

Arguments

return

Examples

Remarks


Function.Global.HotFix.Unpack

This function applies a hotfix to the current Global Shop installation.

Syntax

Function.Global.HotFix.UnPack(FQ hotfix file, MD5 hash, return)

Argument

Example

Remarks

  • This command requires 2010.2+
  • This command requires Global Shop-generated signature


Function.Global.HotFix.UnPack

This function applies a hotfix to the current Global Shop installation. Note: This command requires 2010.2+ Note: This command requires Global Shop-generated signature

Syntax

Function.Global.HotFix.UnPack(FQ hotfix file, MD5 hash, return)

Arguments

FQ hotfix file
MD5 hash
return

Examples

Remarks


Function.Global.HotFix.Validate

Syntax

Function.Global.HotFix.Validate(FQ hotfix file [string], MD5 hash [string], Hotfix directory [string], return)

Arguments

FQ hotfix file

string

MD5 hash

string

Hotfix directory

string

return

Examples

Remarks


Function.Global.International.GetLabelTranslation

Function.Global.International.GetLabelTranslation

Syntax

Arguments

Examples

Remarks


Function.Global.International.GetLanguagesByUserID

This command will return the primary and secondary languages, in a string delimited with *!*, for the specified user ID number.

Syntax

Function.Global.International.GetLanguagesByUserID(user ID, string return)

Arguments

user ID
string return

Examples

Remarks


Function.Global.International.GetLanguagesByUserName

This command will return the primary and secondary languages, in a string delimited with *!*, for the specified user name and company code.

Syntax

Function.Global.International.GetLanguagesByUsername(user name, company code, string return)

Arguments

Example

Remarks


Function.Global.International.GetLanguagesByUsername

This command will return the primary and secondary languages, in a string delimited with *!*, for the specified user name and company code.

Syntax

Function.Global.International.GetLanguagesByUsername(user name, company code, string return)

Arguments

user name
company code
string return

Examples

Remarks


Function.Global.Inventory.AddPartToBatch

This function creates an inventory part in a batch to post in Global Shop.  Parts added to the batch will not be created unless Function.Global.Inventory.PostPartBatch is called before the GAB program terminates. This function can be used in lieu of Function.Global.Inventory.CreatePart, if multiple parts need to be created. Note: If you are using part/rev, the part field must contain the rev in the last three positions.  Function.Intrinsic.String.GSSPartString is the easiest method of building the composite part number.

Syntax

Function.Global.Inventory.AddPartToBatch(part, unit of measure, description, location, product line, source code, alt description 1, alt description 2, price)

Arguments

part
unit of measure
description
location
product line
source code
alt description 1
alt description 2
price

Examples

Remarks


Function.Global.Inventory.Callsd

This command invokes the view-only version of the supply & demand screen.

Syntax

Function.Global.Inventory.CallSD(part, rev, location) or

Function.Global.Inventory.CallSD(part, rev, location, company code)

Arguments

Example

Remarks

  • If the 3 parameter version of this command is used, the current company code is assumed.


Function.Global.Inventory.CreatePart

This function creates an inventory part in Global Shop. Passing a calling program of UPLOADED will supress all message boxes. Note: If you are using part/rev, the part field must contain the rev in the last three positions. Function.Intrinsic.String.GSSPartString is the easiest method of building the composite part number.

Syntax

Function.Global.Inventory.CreatePart(part, unit of measure, description, location, product line, source code, alt description 1, alt description 2, price, calling program)

Arguments

part
unit of measure
description
location
product line
source code
alt description 1
alt description 2
price
calling program

Examples

Remarks


Function.Global.Inventory.GetDisplayBOM

This function retrieves the long BOM and revision, given the 17/3 BOM and revision.  The returned long BOM and revision are delimited with *!*. Note: This command requires 2012.1, and the use of long part/router/BOM designators

Syntax

Function.Global.Inventory.GetDisplayBOM(BOM, revision, long BOM return)

Arguments

BOM
revision
long BOM return

Examples

Remarks


Function.Global.Inventory.GetDisplayCustomerPart

Function.Global.Inventory.GetDisplayCustomerPart

Syntax

Arguments

Examples

Remarks


Function.Global.Inventory.GetDisplayManufacturerPart

Function.Global.Inventory.GetDisplayManufacturerPart

Syntax

Arguments

Examples

Remarks


Function.Global.Inventory.GetDisplayPart

This function retrieves the long part and revision, given the 17/3 part and revision.  The returned long part and revision are delimited with *!*. Note: This command requires 2012.1, and the use of long part/router/BOM designators

Syntax

Function.Global.Inventory.GetDisplayPart(part, revision, long BOM return)

Arguments

part
revision
long BOM return

Examples

Remarks


Function.Global.Inventory.GetDisplayRouter

This function retrieves the long router and revision, given the 17/3 router and revision.  The returned long router and revision are delimited with *!*. Note: This command requires 2012.1, and the use of long part/router/BOM designators

Syntax

Function.Global.Inventory.GetDisplayRouter(router, revision, long router return)

Arguments

router
revision
long router return

Examples

Remarks


Function.Global.Inventory.GetDisplayUserPart

Function.Global.Inventory.GetDisplayUserPart

Syntax

Arguments

Examples

Remarks


Function.Global.Inventory.GetGSSBOM

This function retrieves the short (20 character) BOM designator, given the long BOM and revision. Note: This command requires 2012.1, and the use of long part/router/BOM designators

Syntax

Function.Global.Inventory.GetGSSBOM(display BOM, display revision, short BOM return)

Arguments

display BOM
display revision
short BOM return

Examples

Remarks


Function.Global.Inventory.GetGSSCustomerPart

Function.Global.Inventory.GetGSSCustomerPart

Syntax

Arguments

Examples

Remarks


Function.Global.Inventory.GetGSSManufacturerPart

Function.Global.Inventory.GetGSSManufacturerPart

Syntax

Arguments

Examples

Remarks


Function.Global.Inventory.GetGSSPart

This function retrieves the short (20 character) part designator, given the long part and revision. Note: This command requires 2012.1, and the use of long part/router/BOM designators

Syntax

Function.Global.Inventory.GetGSSPart(display part, display revision, short part return)

Arguments

display part
display revision
short part return

Examples

Remarks


Function.Global.Inventory.GetGSSRouter

This function retrieves the short (20 character) router designator, given the long router and revision. Note: This command requires 2012.1, and the use of long part/router/BOM designators

Syntax

Function.Global.Inventory.GetGSSRouter(display router, display revision, short router return)

Arguments

display router
display revision
short router return

Examples

Remarks


Function.Global.Inventory.GetGSSUserPart

Function.Global.Inventory.GetGSSUserPart

Syntax

Arguments

Examples

Remarks


Function.Global.Inventory.GetPartInfo

This function, given a part number, location, and (optionally) revision, returns a delimited string. If the part/revision/location does not correspond to a part in inventory, the function will return ***NOPARTFOUND***. Otherwise, the return is string delimited with *!*.

Syntax

Function.Global.Inventory.GetPartInfo(part, loc, string return) or

Function.Global.Inventory.GetPartInfo(part, rev, loc, string return)

Arguments

Example

Remarks

  • The delimited return items are as follows: Product line, Description, Inventory UM, Onhand quantity, Cost, Price, Sort code, Lead time
  • The return string can be parsed with Function.Intrinsic.String.Split.


Function.Global.Inventory.PostPartBatch

This function posts the inventory part batch to Global Shop. This is used in conjunction with Function.Global.Inventory.AddPartToBatch.

Syntax

Function.Global.Inventory.PostPartBatch

Arguments

Example

Remarks


Function.Global.Mapper.CallMapper

Syntax

Function.Global.Mapper.CallMapper(Project, Table, Option, Override, Sync)

Arguments

Project
Table
Option
Override
Sync

Example

Remarks


Function.Global.Messaging.ConsolidateEmails

This function will consolidate emails sent using the QueueMessage command.

Syntax

F.Global.Messaging.ConsolidateEmails(MetaSearch,Company Code, UserID as Long, Calling Program as String, Subject as String, Sender (email*!*name), Body as String, ReadReceipt as Boolean, Meta Target)

Argument

Example

Remarks

  • Meta Search is the search string delimited by *!*. Example "001000*!*15*!*0". This string will be searched for in the Meta0 field on Courier_EmailBody.
  • For UserID, use F.Global.Security.GetUserId to get the long id for a user.
  • Meta Target is the data that will be written to the Meta fields on Courier_EmailBody. Double delimted with *!* for items in a field and @!@ for the meta fields. Example "001000*!*15*!*0@!@Meta1@!@Meta2"


Function.Global.Messaging.CreateCompanyMessage

Function.Global.Messaging.CreateCompanyMessage

Syntax

Arguments

Examples

Remarks


Function.Global.Messaging.CreateEmfMessage

Description

Syntax

Arguments

Example

Remarks


Function.Global.Messaging.CreateEmMessage

This function sends an email with an attachment, via Courier.

Syntax

Function.Global.Messaging.CreateEMmessage(to email, to name, sender email, sender name, subject, body, attachment,delete attachment boolean)

Arguments

Example

Remarks

  • The current version of Courier is a prerequisite for the use of this command
  • This command supports a single attachment only
  • Courier must be running for the emails to be sent


Function.Global.Messaging.CreateInternalMessage

Create and internal message

Syntax

Function.Global.Messaging.CreateInternalMessage(GSS User as string, message as string)

Arguments

None

Example

F.Intrinsic.String.Concat("Employee ID: ",V.Passed.009993,V.Ambient.NewLine,V.Local.sMessage)
F.Intrinsic.String.Concat(V.Local.sMessage,"Employee Name: ",V.Passed.009994,V.Ambient.NewLine,V.Local.sMessage)
F.Intrinsic.String.Concat(V.Local.sMessage,"Job: ",V.Passed.000004,V.Ambient.NewLine,V.Local.sMessage)
F.Intrinsic.String.Concat(V.Local.sMessage,"PM Type: ",V.Screen.fPMReq!ddlType.Text,V.Ambient.NewLine,V.Local.sMessage)
F.Intrinsic.String.Concat(V.Local.sMessage,"Explanation: ",V.Screen.fPMReq!mltxt1.Text,V.Local.sMessage)
V.Local.sSql.Set("Select GS_USER from ATG_PM_REQD_USERS")
F.ODBC.Connection!con.OpenRecordsetRO("rst",V.Local.sSql)
F.Intrinsic.Control.DoUntil(V.ODBC.con!rst.EOF,=,True)
  F.Global.Messaging.CreateInternalMessage(V.ODBC.con!rst.FieldVal!GS_USER,V.Local.sMessage)
  F.ODBC.con!rst.MoveNext
F.Intrinsic.Control.Loop 

Remarks

  • Must have GS Version 2011.1


Function.Global.Messaging.CreateSMSMessage

Syntax

Function.Global.Messaging.CreateSMSmessage(carrier, SMS number, sender email, subject, body)

Arguments

Carrier values:

0: ATT

1: T-Mobile

2: Virgin Mobile

3: Sprint

4: Verizon

Examples

Remarks

  • The current version of Courier is a prerequisite for the use of this command
  • Courier must be running for the SMS messages to be sent
  • Please make sure the recipient wants to receive SMS messages; for many cellular users these messages are not free to receive
  • Messages will not be sent properly if the wrong carrier is specified


Function.Global.Messaging.DeleteMessage

Function.Global.Messaging.DeleteMessage

Syntax

Arguments

Examples

Remarks


Function.Global.Messaging.GetCompanyPrimaryEmail

This function returns the primary email address listed on the company (and not one of the associated contacts, given a passed company ID and company type.  Valid company types 0 = Vendor 1 = Customer 2 = Prospect

Syntax

Function.Global.Messaging.GetCompanyPrimaryEmail(company ID, company type, string return)

Arguments

company ID
company type
string return

Examples

Remarks


Function.Global.Messaging.InternalMessageAddConfigurationCondition

Adds a condition to the message configuration. Valid values for Operation: 0 = Is 1 = Not 2 = Less Than 3 = Less Than or Equal To 4 = Greater Than 5 = Greater Than or Equal To 6 = Contains (string parameters only) 7 = Does Not Contain (string parameters only) 8 = Begins With (string parameters only) 9 = Ends With (string parameters only) Valid values for Value Type: 0 = Literal Value 1 = Parameter If Value Type is Parameter (1), then use Value Parameter ID parameter. Otherwise, use the Literal Value parameter.

Syntax

Function.Global.Messaging.InternalMessageAddConfigurationCondition(Configuration ID (Long), Parameter ID (Long), Operation (Long), Value Type (Long), Value Parameter ID (Long), Literal Value (String))

Arguments

Configuration ID

Examples

Remarks


Function.Global.Messaging.InternalMessageAddConfigurationRecipient

Add a recipient to the message configuration. Valid values for Recipient Type: 0 = Internal User 10 = Internal Group 20 = Email User 30 = Email Group 40 = Email Customer 50 = Email Vendor 100 = Email Other Primary and Secondary language codes are ignored for Users and Groups because they are determined by the value set for that User or Group's system language settings.

Syntax

Function.Global.Messaging.InternalMessageAddConfigurationRecipient(Configuration ID [Long], Recipient Type [Long], Recipient [String], Primary Language Code [Long], Secondary Language Code [Long])

Arguments

Configuration ID

Long

Recipient Type

Long

Recipient

String

Primary Language Code

Long

Secondary Language Code

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageAddEventDynamicRecipient

Function.Global.Messaging.InternalMessageAddEventDynamicRecipient

Syntax

Arguments

Examples

Remarks


Function.Global.Messaging.InternalMessageAddEventParameter

Adds the specified parameter to the event. Returns a unique ID that identifies the parameter for this event (to use with Function.Global.Messaging.InternalMessageAddEventParameterValue).

Syntax

Function.Global.Messaging.InternalMessageAddEventParameter(Event ID [Long], Parameter ID [Long], Event Parameter ID returned  [Long])

Arguments

Event ID

Long

Parameter ID

Long

Event Parameter ID returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageAddEventParameterValue

This is to be used when creating a parameter with discrete, limited number of values. When the user tries to create a condition for a configuration using this parameter, a dropdown list will appear with every value that was added using this command.

Syntax

Function.Global.Messaging.InternalMessageAddEventParameterValue(Event Parameter ID [Long], Literal Value [String], Display Name International ID [Long], Display Name [String])

Arguments

Event Parameter ID

Long

Literal Value

String

Display Name International ID

Long

Display Name

String

Examples

Remarks


Function.Global.Messaging.InternalMessageCreate

Creates a message. If no configuration is being used, pass -1. If no triggered by user, pass -1.

Syntax

Function.Global.Messaging.InternalMessageCreate(Configuration ID [Long], Date [Date], Triggered By User ID [Long], Message Title [String], Message Text [String], Message ID returned [Long])

Arguments

Configuration ID

Long

Date

Date

Triggered By User ID

Long

Message Title

String

Message Text

String

Message ID returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageCreateConfiguration

Creates a new message configuration and returns the ID.

Syntax

Function.Global.Messaging.InternalMessageCreateConfiguration(Company Code [String], Name International ID [Long], Name [String], Event ID [Long], Enabled [Boolean], Any Condition [Boolean], Message Title [String], Message Text [String], Configuration ID returned [Long])

Arguments

Company Code

String

Name International ID

Long

Name

String

Event ID

Long

Enabled

Boolean

Any Condition

Boolean

Message Title

String

Message Text

String

Configuration ID returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageCreateConfigurationPreset

Creates a new message configuration presset that is available from the Preset dropdown list when creating a new configuration from System Support > File > Message Configurations and returns the ID.

Syntax

Function.Global.Messaging.InternalMessageCreateConfigurationPreset(Company Code [String], Name International ID [Long], Name [String], Event ID [Long], Enabled [Boolean], Any Condition [Boolean], Message Title [String], Message Text [String], Configuration ID returned [Long])

Arguments

Company Code

String

Name International ID

Long

Name

String

Event ID

Long

Enabled

Boolean

Any Condition

Boolean

Message Title

String

Message Text

String

Configuration ID returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageCreateDynamicRecipient

Function.Global.Messaging.InternalMessageCreateDynamicRecipient

Syntax

Arguments

Examples

Remarks


Function.Global.Messaging.InternalMessageCreateEvent

Creates a new message event that is available from the Event dropdown list when creating a new configuration from System Support > File > Message Configurations.

Syntax

Function.Global.Messaging.InternalMessageCreateEvent(Hook ID [Long], Name International ID [Long], Name [String], Event ID returned [Long])

Arguments

Hook ID

Long

Name International ID

Long

Name

String

Event ID returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageCreateEventGSS

Same as the Function.Global.Messaging.InternalMessageCreateEvent command, but creates an event that is a standard Global Shop Messaging event. Note: This function can only be called from scripts signed by Global Shop Solutions.

Syntax

Function.Global.Messaging.InternalMessageCreateEventGSS(Hook ID [Long], Name International ID [Long], Name [String], Event ID  returned [Long])

Arguments

Hook ID

Long

Name International ID

Long

Name

String

Event ID  returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageCreateParameter

Creates a new parameter that can be used by events. Valid values for Data Type: 0 = String 1 = Long 2 = Float 3 = Date 4 = Boolean Browser ID is used for standard parameters. Not supported for custom parameters at this time; pass 0 for Browser ID.

Syntax

Function.Global.Messaging.InternalMessageCreateParameter(Passed Variable Name [String], Display Name International ID [Long], Data Type [Long], Browser ID [Long], Parameter ID returned [Long])

Arguments

Passed Variable Name

String

Display Name International ID

Long

Data Type

Long

Browser ID

Long

Parameter ID returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageDeleteConfiguration

Deletes the configuration with the specified ID, along with it's associated conditions, receipients, and messages. Note: If users have messages in their queues that were generated from this configuration, they will be deleted.

Syntax

Function.Global.Messaging.InternalMessageDeleteConfiguration(Configuration ID [Long])

Arguments

Configuration ID

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageDeleteConfigurationCondition

Deletes the condition with the specified ID from the configuration.

Syntax

Function.Global.Messaging.InternalMessageDeleteConfigurationCondition(Condition ID ([ong])

Arguments

Condition ID

Examples

Remarks


Function.Global.Messaging.InternalMessageDeleteConfigurationRecipient

Deletes the recipient with the specified ID from the configuration.

Syntax

Function.Global.Messaging.InternalMessageDeleteConfigurationRecipient(Recipient ID [Long])

Arguments

Recipient ID

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageDeleteFromQueue

Deletes the message with the specified ID from the user's internal message queue. (This will only remove it from the user's queue. The message will not be deleted for other users.)

Syntax

Function.Global.Messaging.InternalMessageDeleteFromQueue(Queue ID [Long])

Arguments

Queue ID

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageGetConfigurationConditions

Returns a double-delimited string of each configuration preset for the specified event ID. Each configuration preset is delimited by *!*. The following elements will be returned for each configuration preset, delimited by #$#, in the following order: Configuration IDName International IDNameEvent IDAny ConditionMessage TitleMessage Text

Syntax

Function.Global.Messaging.InternalMessageGetConfigurationConditions(Configuration ID [Long], Conditions returned [String])

Arguments

Configuration ID

Long

Conditions returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetConfigurationPresetsForEvent

Returns a double-delimited string of each configuration preset for the specified event ID. Each configuration preset is delimited by *!*. The following elements will be returned for each configuration preset, delimited by #$#, in the following order: Configuration IDName International IDNameEvent IDAny ConditionMessage TitleMessage Text

Syntax

Function.Global.Messaging.InternalMessageGetConfigurationPresetsForEvent(Event ID [Long], Presets returned [String])

Arguments

Event ID

Long

Presets returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetConfigurationRecipients

Returns a double delimited list of each recipient for the specified configuration ID. Each recipient is delimited by *!*. The following elements will be returned for each recipient, delimited by #$#, in the following order: Message Recipient IDRecipient TypeRecipientPrimary Language CodeSecondary Language Code

Syntax

Function.Global.Messaging.InternalMessageGetConfigurationRecipients(Configuration ID [Long], Recipients returned [String])

Arguments

Configuration ID

Long

Recipients returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetConfigurationsForCompany

Returns a double-delimited string of each configuration for the specified company code. Each configuration is delimited by *!*. The following elements will be returned for each configuration, delimited by #$#, in the following order: Configuration IDName International IDNameEvent IDAny ConditionMessage TitleMessage Text

Syntax

Function.Global.Messaging.InternalMessageGetConfigurationsForCompany(Company Code [String], Configurations returned [String])

Arguments

Company Code

String

Configurations returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetConfigurationsForEventName

Returns a double-delimited string of each configuration for the specified company code and event name. Each configuration is delimited by *!*. The following elements will be returned for each configuration, delimited by #$#, in the following order: Configuration IDName International IDNameEvent IDAny ConditionMessage TitleMessage Text

Syntax

Function.Global.Messaging.InternalMessageGetConfigurationsForEventName(Company Code [String], Event Name [String], Configurations returned [String])

Arguments

Company Code

String

Event Name

String

Configurations returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetConfigurationsForEventNameid

Returns a double-delimited string of each configuration for the specified company code and event international name ID. Each configuration is delimited by *!*.

Syntax

Function.Global.Messaging.InternalMessageGetConfigurationsForEventNameID(Company Code (String), Event International Name ID (Long), Configurations (String, returned))

Arguments

The following elements will be returned for each configuration, delimited by #$#, in the following order:

Configuration ID

Name International ID

Name

Event ID

Any Condition

Message Title

Message Text

Example

Remarks


Function.Global.Messaging.InternalMessageGetConfigurationsForEventNameID

Returns a double-delimited string of each configuration for the specified company code and event international name ID. Each configuration is delimited by *!*. The following elements will be returned for each configuration, delimited by #$#, in the following order: Configuration IDName International IDNameEvent IDAny ConditionMessage TitleMessage Text

Syntax

Function.Global.Messaging.InternalMessageGetConfigurationsForEventNameID(Company Code [String], Event International Name ID [Long], Configurations returned [String])

Arguments

Company Code

String

Event International Name ID

Long

Configurations returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetEventDynamicRecipients

Function.Global.Messaging.InternalMessageGetEventDynamicRecipients

Syntax

Arguments

Examples

Remarks


Function.Global.Messaging.InternalMessageGetEventParameters

Returns a double-delimited string of each parameter for the specified event ID. Each parameter is delimited by *!*. The following elements will be returned for each parameter, delimited by #$#, in the following order: Parameter IDPassed Parameter NameDisplay Name International IDData TypeBrowser

Syntax

Function.Global.Messaging.InternalMessageGetEventParameters(Event ID [Long], Parameters [String])

Arguments

Event ID

Long

Parameters

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetEventParameterValues

Returns a double-delimited string of each discrete value for the specified parameter and event ID (if any exist). Each event parameter value is delimited by *!*. The following elements will be returned for each event value parameter, delimited by #$#, in the following order: ValueDisplay Name International IDDisplay Name

Syntax

Function.Global.Messaging.InternalMessageGetEventParameterValues(Event ID [Long], Parameter ID [Long], Values [String])

Arguments

Event ID

Long

Parameter ID

Long

Values

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetEvents

Returns a double-delimited string of each event. Each event is delimited by *!*. The following elements will be returned for each event, delimited by #$#, in the following order: Event IDHook IDName International IDName

Syntax

Function.Global.Messaging.InternalMessageGetEvents(Events returned [String])

Arguments

Events returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageGetParameterid

Returns the ID of the parameter with the specified name.

Syntax

Function.Global.Messaging.InternalMessageGetParameterID(Parameter passed name (String), Parameter ID (Long, returned))

Arguments

Example

Remarks


Function.Global.Messaging.InternalMessageGetParameterID

Returns the ID of the parameter with the specified name.

Syntax

Function.Global.Messaging.InternalMessageGetParameterID(Parameter passed name [String], Parameter ID returned [Long])

Arguments

Parameter passed name

String

Parameter ID returned

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageGetQueueForUser

Returns a double-delimited string of all the messages in the queue of the specified user. Each message is delimited by *!*. The following elements will be returned for each message, delimited by #$#, in the following order: Queue IDStatusMessage IDConfiguration IDDateTriggered By UserMessage TitleMessage TextEvent IDCompany Code

Syntax

Function.Global.Messaging.InternalMessageGetQueueForUser(User ID [Long], Messages returned [String])

Arguments

User ID

Long

Messages returned

String

Examples

Remarks


Function.Global.Messaging.InternalMessageQueuetoUser

Adds the specified message to the recipient's queue.

Syntax

Function.Global.Messaging.InternalMessageQueueToUser(Recipient User ID (Long), Message ID (Long))

Arguments

Example

Remarks


Function.Global.Messaging.InternalMessageQueueToUser

Adds the specified message to the recipient's queue.

Syntax

Function.Global.Messaging.InternalMessageQueueToUser(Recipient User ID [Long], Message ID [Long])

Arguments

Recipient User ID

Long

Message ID

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageUpdateConfiguration

Update the specified configuration.

Syntax

Function.Global.Messaging.InternalMessageUpdateConfiguration(Configuration ID [Long], Name International ID [Long], Name [String], Event ID [Long], Enabled [Boolean], Any Condition [Boolean], Message Title [String], Message Text [String])

Arguments

Configuration ID

Long

Name International ID

Long

Name

String

Event ID

Long

Enabled

Boolean

Any Condition

Boolean

Message Title

String

Message Text

String

Examples

Remarks


Function.Global.Messaging.InternalMessageUpdateConfigurationCondition

Update the specified configuration condition.

Syntax

Function.Global.Messaging.InternalMessageUpdateConfigurationCondition(Condition ID [Long], Parameter ID [Long], Operation [Long], Value Type [Long], Value Parameter ID [Long], Value [String])

Arguments

Condition ID

Long

Parameter ID

Long

Operation

Long

Value Type

Long

Value Parameter ID

Long

Value

String

Examples

Remarks


Function.Global.Messaging.InternalMessageUpdateConfigurationRecipient

Update the specified configuration recipient.

Syntax

Function.Global.Messaging.InternalMessageUpdateConfigurationRecipient(Message Recipient ID [Long], Recipient Type [Long], Recipient [String], Primary Language Code [Long], Secondary Language Code [Long])

Arguments

Message Recipient ID

Long

Recipient Type

Long

Recipient

String

Primary Language Code

Long

Secondary Language Code

Long

Examples

Remarks


Function.Global.Messaging.InternalMessageUpdateQueueMessagestatus

Update the status of the specified message in the user's queue.

Syntax

Function.Global.Messaging.InternalMessageUpdateQueueMessageStatus(Queue ID (Long), Status (Long))

Arguments

Valid values for status are:

0 = Unread

1 = Read

2 = Archived

Example

Remarks


Function.Global.Messaging.InternalMessageUpdateQueueMessageStatus

Update the status of the specified message in the user's queue. Valid values for status are: 0 = Unread 1 = Read 2 = Archived

Syntax

Function.Global.Messaging.InternalMessageUpdateQueueMessageStatus(Queue ID [Long], Status [Long])

Arguments

Queue ID

Long

Status

Long

Examples

Remarks


Function.Global.Messaging.IsAddressValid

This function attempts to validate a passed string as an email address by looking for the following: 1. no embedded spaces in the string 2. an @ symbol 3. at least one . after the @ 4. no ; characters

If the above criteria are met, the function will return True.

Syntax

Function.Global.Messaging.IsAddressValid(email address, Boolean return)

Arguments

Email address

string

Return

boolean

Examples

Remarks

  • Note: It is not possible for GAB to determine if a properly formatted email address does correspond to an actual email mailbox.


Function.Global.Messaging.IsCourierRunning

This function returns a long integer indicating the following: 0 - Courier is not running 1 - Courier version 1.x is running 2 - Courier version 2.x is running Note: Courier 2.x is only available on 2011.x releases of Global Shop

Syntax

Function.Global.Messaging.IsCourierRunning(long return)

Arguments

long return

Examples

Remarks


Function.Global.Messaging.QueueMessage

Syntax

Function.Global.Messaging.QueueMessage(sCoCode, iUserID, CallingPrgm, Subject, SenderEmail*!*sSenderName, Recipients, Body)

or

Function.Global.Messaging.QueueMessage(sCoCode, iUserID, CallingPrgm, Subject, SenderEmail*!*sSenderName, Recipients, Body, Mode, sReplyToAddress, bReadReceipt, sAdditionalHeaders, dateDeferredDelivery, sMeta0, sMeta1, sMeta2, sMeta3, sMeta4)

or

Function.Global.Messaging.QueueMessage(sCoCode, iUserID, CallingPrgm, Subject, SenderEmail*!*sSenderName, Recipients, Body, Mode, sReplyToAddress, bReadReceipt, sAdditionalHeaders, dateDeferredDelivery, sMeta0, sMeta1, sMeta2, sMeta3, sMeta4, AttachmentFileName*!*AttachmentFilePath, bDeleteAttach)

Arguments

Example

Remarks

  • This command can only be used in conjunction with Courier 2.x.
  • Courier 2.x is only available on 2011.x releases of Global Shop
  • The recipients parameter is double delimited. The recipients are delimited with a @!@, while the recipient's name and recipient's email address are delimited with a *!*.
  • Multiple attachments can be specified delimited with a @!@.


Function.Global.Messaging.ReSendMessage

This function re-sends an email previously sent through Courier, using the specified EHID.

Syntax

Function.Global.Messaging.ResendMessage(EHID, boolean return)

Argument

Example

v.local.iRet.Declare(Long)
v.local.bRet.Declare(Boolean)
Gui.F_Courier.gsflxCourier.GetTextMatrix(0,V.Args.key,V.Local.iRet)
F.Global.Messaging.ResendMessage(V.Local.iRet,V.Local.bRet)
F.Intrinsic.Control.If(V.Local.bRet,=,True)
F.Intrinsic.UI.Msgbox("The message was successfully sent")
F.Intrinsic.Control.EndIf

Remarks

  • This command can only be used in conjunction with Courier 2.x.
  • Courier 2.x is only available on 2011.x releases of Global Shop


Function.Global.Messaging.ResendMessage

This function re-sends an email previously sent through Courier, using the specified EHID. Note: This command can only be used in conjunction with Courier 2.x. Note: Courier 2.x is only available on 2011.x releases of Global Shop

Syntax

Function.Global.Messaging.ResendMessage(EHID, boolean return)

Arguments

EHID
boolean return

Examples

Remarks


Function.Global.Mobile.GetCustomHeader

This function will return the following header information from Wireless_header table, for the Transaction ID - TXID, passed. Transaction type, Successful flag & Attempted flag, separated by *!*. If no connection name is specified, then it will default to the Wireless_header table of the company code calling the script.

Syntax

Function.Global.Mobile.GetCustomHeader(TXID, connection, string return)

Function.Global.Mobile.GetCustomHeader(TXID, string return)

Arguments

TXID
string return

Examples

Remarks


Function.Global.Mobile.GetCustomLine

This function will return all the field values on a transaction seperated by *!*. If no connection name is specified, then it will default to the Wireless_Lines table of the company code calling the script.

Syntax

Function.Global.Mobile.GetCustomLine(TXID, connection, string return)

Function.Global.Mobile.GetCustomLine(TXID, string return)

Arguments

TXID
string return

Examples

Remarks


Function.Global.Mobile.GetCustomPrinter

This function will return default printer and label printer names for the given TXID separated by *!*. If no connection name is specified, then it will default to the Wireless_header table of the company code calling the script.

Syntax

Function.Global.Mobile.GetCustomPrinter(TXID, connection, string return)

Function.Global.Mobile.GetCustomPrinter(TXID, string return)

Arguments

TXID
string return

Examples

Remarks


Function.Global.Mobile.GetPrinterNameFromID

This function returns the printer name, if a mobile printer ID is passed. Function.Global.Mobile.GetCustomPrinter can be used to get Mobile Printers- default and label, for a selected transaction ID.

Syntax

Function.Global.Mobile.GetPrinterNamefromID(UPID as string, PName as string)

Arguments

Example

Remarks


Function.Global.Mobile.GetPrinterNamefromID

This function returns the printer name, if a mobile printer ID is passed. Function.Global.Mobile.GetCustomPrinter can be used to get Mobile Printers- default and label, for a selected transaction ID.

Syntax

Function.Global.Mobile.GetPrinterNamefromID(UPID [string], PName [string])

Arguments

UPID

string

PName

string

Examples

Remarks


Function.Global.Mobile.SetCustomResult

This function will write the results of a mobile transaction to Mobile_Custom_Results table in GlobalCommon.

Syntax

Function.Global.Mobile.SetCustomResult(company code, TXID, result)

Arguments

company code
TXID
result

Examples

Remarks


Function.Global.Object.CallMethod

Syntax

Function.Global.Object.CallMethod(Object name [string], DB object name [string], connection index [long], method name [string], mode [long], parameter 0 [any], .., parameter n, return [any])

Function.Global.Object.CallMethod(Object name [string], DB object name [string], connection index [long], method name [string], mode [long], return [any])

Arguments

Object name

string

DB object name

string

connection index

long

method name

string

mode

long

return

any

Examples

Remarks


Function.Global.Object.CloseConnection

Syntax

Function.Global.Object.CloseConnection(DB Object name [string], connection index [long])

Arguments

DB Object name

string

connection index

long

Examples

Remarks


Function.Global.Object.Create

Syntax

Function.Global.Object.Create(Object name [string], type [string])

Function.Global.Object.Create(Object name [string], type [string], global scope [Boolean])

Function.Global.Object.Create(Object name [string], type [string], global scope [Boolean], Parent [string])

Arguments

Object name

string

type

string

global scope

Boolean

Parent

string

Examples

Remarks


Function.Global.Object.CreateDB

Syntax

Function.Global.Object.CreateDB(DB Object Name as String, Connection Index return as Integer)


Function.Global.Object.CreateDB(DB Object Name as String, Company as String, Connection Index return as Integer)


Function.Global.Object.CreateDB(DB Object Name as String, Company as String, Server Name as String, Connection Index return as Integer)


Function.Global.Object.CreateDB(DB Object Name as String, Company as String, Server Name as String, Global scope flag as Boolean, Connection Index return as Integer)

Argument

DB Object Name
Company
Server Name
Global scope
Connection Index return

Example

Function.Global.Object.CreateDB("PSQLDB", "MLA", "MYGSSSERVER",v.local.iret)

Remark

  • If company and server name is not passed, then it is assumed to use the current company and server. If scope is not passed then it is assumed scope is Global.
  • Returns the connection index of the connection that was added to the DB object.


Function.Global.Object.Delete

Syntax

Function.Global.Object.Delete(Data Object Name as String, DB Object Name as String, DB Connection Index as Long, Status Code Return as Long)


Argument

DB Object Name
DB Object Name
DB Connection Index
Status Code Return

Example

Function.Global.Object.Delete("oPart","GlobalDB",v.local.icon,v.local.iret) 

Remark

  • In order to use this method, you would first use Function.Global.Object.SetValue to set the key value properties of the object. Then invoke this method to delete that record from the database where the key matches.
  • The return is the status code, anything other than 0 means the object failed to delete.


Function.Global.Object.ExportToXML

This function will serialize a object and save the object's current state in the specified XML file.


Syntax

Function.Global.Object.ExportToXML(Data Object Name as String, File Path as String)


Argument

DB Object Name
File Path

Example

Function.Global.Object.ExportToXML("oPart","C:\My Documents\Part.xml") 

Remark


Function.Global.Object.GetCount

Syntax

Function.Global.Object.GetCount(Object collection name [string], return [long])

Function.Global.Object.GetCount(Object name [string], collection name, return [long])

Arguments

Object name

string

collection name
return

long

Examples

Remarks


Function.Global.Object.GetObject

Function.Global.Object.GetObject

Syntax

Arguments

Examples

Remarks


Function.Global.Object.GetValue

Syntax

Function.Global.Object.GetValue(Object name [string], property name [string], index [long], return [any])

Function.Global.Object.GetValue(Object name [string], property name [string], return [any])

Arguments

Object name

string

property name

string

return

any

Examples

Remarks


Function.Global.Object.ImportFromXML

This function will deserialize a xml and restore a object to the state save in the specified XML file.


Syntax

Function.Global.Object.ImportFromXML(Data Object Name as String, File Path as String)


Argument

DB Object Name
File Path

Example

Function.Global.Object.ImportFromXML("oPart","C:\My Documents\Part.xml") 

Remark

  • Note* This is for single instance objects. You can determine single instance objects from collection objects by the type name being pluralized or not.


Function.Global.Object.ImportFromXMLCollection

This function will deserialize a xml and restore a collection object to the state save in the specified XML file.

Syntax

Function.Global.Object.ImportFromXMLCollection(Data Object Name as String, File Path as String)


Argument

DB Object Name
File Path

Example

Function.Global.Object.ImportFromXMLCollection("oParts","C:\My Documents\Parts.xml") 

Remark

  • Note* This is for collection objects. You can determine single instance objects from collection objects by the type name being pluralized or not.


Function.Global.Object.Insert

Syntax

Function.Global.Object.Insert(Data Object Name as String, DB Object Name as String, DB Connection Index as Long, Status Code Return as Long)

Argument

DB Object Name
DB Object Name
DB Connection Index
Status Code Return

Example

Function.Global.Object.Insert("oPart","GlobalDB",v.local.icon,v.local.iret) 

Remark

  • In order to use this method, you would first use Function.Global.Object.SetValue to set the key value properties of the object. Then invoke this method to insert that record into the database.
  • The return is the status code, anything other than 0 means the object failed to insert.


Function.Global.Object.Load

This would load a would load a collection data object with all parts with a part number range from Z to S.

The return is the status code, anything other than 0 means the object failed to load.


Syntax

Function.Global.Object.Load(Data Object Name as String, DB Object Name as String, DB Connection Index as Long, Mode Number as Long, args 0+n, Status Code Return as Long)

Argument

DB Object Name
DB Object Name
DB Connection Index
Mode number
Args 0+n
Status Code Return

Example

Function.Global.Object.Load("oParts","GlobalDB",v.local.icon, 700, "Z-S",v.local.iret) 

Remark


Function.Global.Object.LoadDataTable

This would load a collection of inventory parts for mode 700 where part is "Z-S". The two properties loaded to the data table are part number and description.

Syntax

Function.Global.Object.LoadDataTable(DataTableName as string, EO Object Name, EOType, ConnectionName as string, Connection Index as integer, Mode as Integer, Properties as delimited (::) string, Global as Boolean,Parent as Boolean, args 0+n)

Function.Global.Object.LoadDataTable(DataTableName as string, EO Object Name, EOType, ConnectionName as string, Connection Index as integer, Mode as Integer, Global as Boolean,Parent as Boolean, args 0+n)


Arguments

Examples

Function.Global.Object.LoadDataTable("PartTbl","oParts","Inventory.Parts","GlobalDB",v.local.icon,700,"PartNumber::description.part", "Z-S","",v.local.iret) 

Remarks

  • The function no longer requires the "Properties" argument. The function will now return the properties defined in the mode as the data table columns.


Function.Global.Object.OpenConnection

Syntax

Function.Global.Object.OpenConnection(DB object name [string], company code [string], return [long])

Function.Global.Object.OpenConnection(DB object name [string], company code [string], server [string], return [long])

Function.Global.Object.OpenConnection(DB object name [string], return [long])

Arguments

DB object name

string

return

long

Examples

Remarks


Function.Global.Object.OverridePath

Syntax

Function.Global.Object.OverridePath(FQ path [string])

Arguments

FQ path

string

Examples

Remarks


Function.Global.Object.SetValue

Syntax

Function.Global.Object.SetValue(Object name [string], Property name [string], property value [any])

Arguments

Object name

string

Property name

string

property value

any

Examples

Remarks


Function.Global.Object.Update

Syntax

Function.Global.Object.Update(Data Object Name as String, DB Object Name as String, DB Connection Index as Long, Status Code Return as Long)

Argument

DB Object Name
DB Object Name
DB Connection Index
Status Code Return

Example

Function.Global.Object.Update("oPart","GlobalDB",v.local.icon,v.local.iret) 


Remark

  • In order to use this method, you would first use Function.Global.Object.SetValue to set the key value properties of the object and the properties wished to be changed. Then invoke this method to update that record in the database.
  • The return is the status code, anything other than 0 means the object failed to update.


Function.Global.PDT.Playback

Syntax

Function.Global.PDT.Playback(module, selection ID, Jobstream, long PID return)

Arguments

module
selection ID
Jobstream
long PID return

Examples

Remarks


Function.Global.PDT.PlaybackFile

Syntax

Function.Global.PDT.PlaybackFile(filename [string], long PID return [long])

Arguments

filename

string

long PID return

long

Examples

Remarks


Function.Global.PDT.PlaybackID

Syntax

Function.Global.PDT.PlaybackID(PDT ID [long], long PID return [long])

Arguments

PDT ID

long

long PID return

long

Examples

Remarks


Function.Global.PDT.Record

Syntax

Function.Global.PDT.Record(module, selection ID, Jobstream, filename, long PID return)

Arguments

module
selection ID
Jobstream
filename
long PID return

Examples

Remarks


Function.Global.Presentation.Clear

Clears a chart or chart element.

Syntax

F.Global.Presentation.Clear(Chart Name as string, Return as string)

F.Global.Presentation.Clear(Chart Name as string, Member Of as string, Member Name as string, Return as string)

Arguments

Chart elements available:

ChartArea

Series

Axis

DataPoint

Legend

Annotation

Title

Stripline

CustomLabel

LegendCellColumn

LegendItem

LegendCell

To clear all elements in a collection, pass blank string "" instead of specifying ordinal or name of an individual item, e.g., pass the following for member name:

Series, Axis, Legend, Annotation, Title, Stripline: ""

DataPoint: ["{Series Name or ordinal}"]

CustomLabel: ["{Axis Name or ordinal}"]

LegendCellColumn: ["{Legend Name or ordinal}"]

LegendItem: ["{Legend Name or ordinal}"]

LegendCell: ["{Legend Name or ordinal}:{LegendItem Name or Ordinal"]

Example

Remarks


Function.Global.Presentation.ClearChart

Function.Global.Presentation.ClearChart

Syntax

Arguments

Examples

Remarks


Function.Global.Presentation.CreateChart

Creates a chart.

Syntax

F.Global.Presentation.CreateChart(Chart Name as string, Return as string)

Arguments

Example

Remarks

  • You can turn on chart logging (outputs GABCP*{DateTimeStamp}.debug log files in %temp%) by creating one of the two files in %temp%:o"GABCPErr.DO": Outputs debug files only if errors occurred or if the chart was never renderedo"GABCP.DO": Always outputs a debug file=======


Function.Global.Presentation.CreateChartMember

Description

Syntax

F.Global.Presentation.CreateChartMember(Chart Name as string, Member Of as string, Member Name as string, Style Type or Value as string, Return as string)

F.Global.Presentation.CreateChartMember(Chart Name as string, Member Of as string, Member Name as string, Style Type as string, Value as string, Return as string)

Arguments

Chart elements available (NOTE!: Make sure to get a list of Chart Types and Annotation Types):

Series: sStyleType = "{Chart Type}"

DataPoint: See SetDataPointProperty.AddXY for formats of sValues

Annotation: sStyleType = "{Annotation Type}" (Note: Annotation Type is required upon creation)

Title: See CreateTitle for formats of sValues

CustomLabel: See SetCustomLabelCollectionProperty.Add for formats of sValues

LegendCellColumn: See SetLegendCellColumnCollection.Add for formats of sValues

LegendItem: See SetLegendItemCollection.Add for formats of sValues

LegendCell: See SetLegendCellCollection.Add for formats of sValues

Chart elements available:

Series: sStyleType = "{Chart Type}", sValues = "{Datapoints as double delimitted string}"

Example

Remarks


Function.Global.Presentation.Render

Description

Syntax

F.Global.Presentation.Render(Chart Name as string, Output path as string, Return as string)

F.Global.Presentation.Render(Chart Name as string, Output path as string, Overwrite File as boolean, Return as string)

F.Global.Presentation.Render(Chart Name as string, Output path as string, Overwrite File as boolean, Width as Long, Height as Long, Return as string)

Arguments

Example

Remarks


Function.Global.Presentation.RenderChart

Function.Global.Presentation.RenderChart

Syntax

Arguments

Examples

Remarks


Function.Global.Presentation.SetChartProperty

Description

Syntax

F.Global.Presentation.SetChartProperty(Chart Name as string, Property as string, Value as String, Return as string)

F.Global.Presentation.SetChartProperty(Chart Name as string, Member Of as string, Property as string, Value as String, Return as string)

F.Global.Presentation.SetChartProperty(Chart Name as string, Member Of as string, Member Name as string, Property as string, Value as String, Return as string)

Arguments

Chart Properties Only, e.g., chart width or chart height Chart elements available: Chart, Chart Area Chart elements available: Series, Axis, DataPoint, Legend, Annotation, Title, Stripline, CustomLabel, LegendCellColumn, LegendItem, LegendCell

Example

Remarks


Function.Global.Registry.AddValue

AddValue stores user defined data into the CommonDatabase registry tables for retrieval with Function.Global.Registry.ReadValue

Syntax

Function.Global.Registry.AddValue(UserID [long], Company [string], Program [string], RegID [long], Seq [long], Encrypt [bool], sVal [string], bVal [bool], iVal [long], fVal [float], dVal [date], tVal [time])

Arguments

UserID

long

Company

string

Program

string

RegID

long

Seq

long

Encrypt

bool

sVal

string

bVal

bool

iVal

long

fVal

float

dVal

date

tVal

time

Examples

Remarks


Function.Global.Registry.ReadValue

ReadValue reads user defined data into the CommonDatabase registry tables previously written with for retrieval with Function.Global.Registry.AddValue.

Syntax

Function.Global.Registry.ReadValue(UserID [long], Company [string], Program [string], RegID [long], Seq [long], field [long], default [any], return [any])

Function.Global.Registry.ReadValue(UserID [long], Company [string], Program [string], RegID [long], Seq [long], field [long], default [any], [Option] [long], [Order] [long], return [any])


Arguments

UserID

long

Company

string

Program

string

RegID

long

Seq

long

field

long

The field argument accepts the following values:

  • 0 - Boolean
  • 1 - Long
  • 2 - Float
  • 3 - Date
  • 4 - Time
  • 5 - String
default

any

option

long

RegistryOptions

  • ExactMatch = 0
  • AllowEmptyUser = 1
  • AllowEmptyCompany = 2
  • AllowEmptyProgram = 4
order

long

RegistryOrders

  • UserCompanyProgram = 0
  • UserProgramCompany = 1
  • CompanyProgramUser = 2
  • CompanyUserProgram = 3
  • ProgramUserCompany = 4
  • ProgramCompanyUser = 5
return

any


Examples

Remarks


Function.Global.Security.CheckUserAccess

This function returns a true or false depending on whether a user has access to the specified program. If no user or company is specified, they are assumed to be the values passed by the calling program.

Syntax

Function.Global.Security.CheckUserAccess(program, bool return) or

Function.Global.Security.CheckUserAccess(user, company code, program, bool return)

Arguments

Example

Remarks


Function.Global.Security.CheckUserAccessIPM

This function returns a boolean indicating if the currently logged in user has access to execute a jobstream, or a specific program in a jobstream.

Syntax

Function.Global.Security.CheckUserAccessIPM(Menu jobsteam ID, boolean return) or

Function.Global.Security.CheckUserAccessIPM(Menu jobstream ID, Jobstream sequence ID, boolean return)

Arguments

Menu jobstream ID
Jobstream sequence ID
Return

Boolean

Remarks

  • This command can only be used with Global Shop versions 2010 and higher.
  • This command replaces the deprecated Function.Global.Security.CheckUserAccess function.


Function.Global.Security.GetAllUserGroups

Syntax

Function.Global.Security.GetAllUserGroups(string return variable) or

Function.Global.Security.GetAllUserGroups(Company code, string return variable)

Arguments

Example

Remarks

  • The return is a *!* delimited string. Use F.in.String.Split to parse it
  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.GetAllUsers

Syntax

Function.Global.Security.GetAllUsers(string return variable) or

Function.Global.Security.GetAllUsers(Company code, string return variable)

Arguments

Example

Remarks

  • The return is a *!* delimited string. Use F.in.String.Split to parse it
  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.GetDSNCredentials

Function.Global.Security.GetDSNCredentials

Syntax

Arguments

Examples

Remarks


Function.Global.Security.GetEmpNoFromUser

This function returns a string value containing the Global Shop username(s) associated with an employee number. If no results are returned, the string will contain ***NORETURN***. If more than one result is returned, the string will be delimited with *!*.

Syntax

Function.Global.Security.GetEmpNoFromUser(employee number, string return)

Arguments

employee number
string return

Examples

Remarks


Function.Global.Security.GetFullName

Syntax

Function.Global.Security.GetFullName(string return variable) or

Function.Global.Security.GetFullName(Company code, string return variable)

Arguments

Example

Remarks

  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.GetGroupEmails

Sytnax

Function.Global.Security.GetGroupEmails(Group, string return variable) or

Function.Global.Security.GetGroupEmails(Group, Company code, string return variable)

Arguments

Example

Remarks

  • The return is a *!* delimited string. Use F.in.String.Split to parse it
  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.GetGroupMembers

Syntax

Function.Global.Security.GetGroupMembers(Group, string return variable) or

Function.Global.Security.GetGroupMembers(Group, Company code, string return variable)

Arguments

Example

Remarks

  • The return is a *!* delimited string. Use F.in.String.Split to parse it.
  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.GetGroupNameFromGroupID

This command will return the name of the group when passed the group ID. Function returns "***NORETURN***" if the group ID is not found.

Syntax

Function.Global.Security.GetGroupNameFromGroupID(Group ID, return string)

Arguments

Group ID
return string

Examples

Remarks


Function.Global.Security.GetLoggedInTerminalCount

This command returns the number of users currently logged into Global Shop.

Syntax

Function.Global.Security.GetLoggedInTerminalCount(long return)

Argument

Example

Remarks


Function.Global.Security.GetLoggedInTerminalNumbers

This command returns the terminal numbers currently logged into Global Shop.

Syntax

Function.Global.Security.GetLoggedInTerminalNumbers(string return)

Arguments

Example

Remarks

  • The string return is delimited by colons. Function.Intrinsic.String.Split can be used to turn the return value into an array for processing.


Function.Global.Security.GetPayGroupsFromUserid

This function returns a string value containing the paygroup membership(s) associated with a Global Shop user ID. If no results are returned, the string will contain ***NORETURN***. If more than one result is returned, the string will be delimited with *!*.

Syntax

Function.Global.Security.GetPaygroupsFromUserID(company code, user ID, string return)

Arguments

None

Example

Remarks

None


Function.Global.Security.GetPaygroupsFromUserID

This function returns a string value containing the paygroup membership(s) associated with a Global Shop user ID.  If no results are returned, the string will contain ***NORETURN***.  If more than one result is returned, the string will be delimited with *!*.

Syntax

Function.Global.Security.GetPaygroupsFromUserID(company code, user ID, string return)

Arguments

company code
user ID
string return

Examples

Remarks


Function.Global.Security.GetUserEmail

Syntax

Function.Global.Security.GetUserEmail(User,string return variable) or

Function.Global.Security.GetUserEmail(Company code, User, string return variable)

Arguments

Example

Remarks

  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.GetUserFromEmail

Syntax

Function.Global.Security.GetUserFromEmail(Email [string], Return [string])

Arguments

Email

string

Return

string

Examples

Remarks


Function.Global.Security.GetUserFromEmpNo

Description

Syntax

Arguments

Example

Remarks


Function.Global.Security.GetUserGroups

Syntax

Function.Global.Security.GetUserGroups(User, string return variable) or

Function.Global.Security.GetUserGroups(User, Company code, string return variable)

Arguments

Example

Remarks

  • The return is a *!* delimited string. Use F.in.String.Split to parse it
  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.GetUserGroupsByID

Syntax

Function.Global.Security.GetUserGroupsByID(user, company code, string return)

Function.Global.Security.GetUserGroupsByID(user, string return)

Arguments

user
string return

Examples

Remarks


Function.Global.Security.GetUserID

This function returns the user ID number that corresponds to the passed username and company code.

Syntax

Function.Global.Security.GetUserID(user, company code, long return)

Arguments

Example

Remarks


Function.Global.Security.GetUserIDFromEmail

Function.Global.Security.GetUserIDFromEmail

Syntax

Arguments

Examples

Remarks


Function.Global.Security.GetUserNameFromEmail

Function.Global.Security.GetUserNameFromEmail

Syntax

Arguments

Examples

Remarks


Function.Global.Security.GetUserNameFromid

GetUsernameFromID

This function returns a string value containing the Global Shop username and company code, delimited with *!*, that corresponds to the specified long integer user ID. If no result is returned, the string will contain ***NORETURN***.

Syntax

Function.Global.Security.GetUsernameFromID(user id, string return)

Arguments

Example

Remarks


Function.Global.Security.GetUsernameFromID

This function returns a string value containing the Global Shop username and company code, delimited with *!*, that corresponds to the specified long integer user ID.  If no result is returned, the string will contain ***NORETURN***.

Syntax

Function.Global.Security.GetUsernameFromID(user id, string return)

Arguments

user id
string return

Examples

Remarks


Function.Global.Security.IsInGroup

Syntax

Function.Global.Security.IsInGroup(User, Group, bool return variable) or

Function.Global.Security.IsInGroup(User, Group, Company code, bool return variable)

Arguments

Example

Remarks

  • The Pervasive version of Global Shop is a prerequisite for the use of these commands
  • The appropriate DSN must be present on the client machines for these commands to work
  • These commands default to the current company code, if none is provided


Function.Global.Security.UpdateMenuBI

Syntax

Function.Global.Security.UpdateMenuBI(Function, system, menu, description, BI report ID, company code)

Arguments

Function Values

A: Add

U: Update

D: Delete

System Values

1: AP

2: GL

5: AR

7: Order entry

8: Sales analysis

11: BI

12: CRM

13: Project management

17: Purchasing

18: Inventory

19: Quality

22: Payroll

29: BOM

60: Estimating/routing & quote management

61: Shop floor control

62: Capacity planning and scheduling

64: On-line system

67: Shipping and receiving

90: System support

Menu Values

F: File

V: View

T: Transactions

R: Reporting

A: Administration

Example

Remarks

  • The BI report ID must be valid at the time this command is called


Function.Global.Security.UpdateMenuGAB

Syntax

Function.Global.Security.UpdateMenuGAB(Function, system, menu, description, hook number, company code)

Arguments

Function Values

A: Add

U: Update

D: Delete

System Values

1: AP

2: GL

5: AR

7: Order entry

8: Sales analysis

11: BI

12: CRM

13: Project management

17: Purchasing

18: Inventory

19: Quality

22: Payroll

29: BOM

60: Estimating/routing & quote management

61: Shop floor control

62: Capacity planning and scheduling

64: On-line system

67: Shipping and receiving

90: System support

Menu Values

F: File

V: View

T: Transactions

R: Reporting

A: Administration

Example

Remarks

  • The GAB hook number must be valid at the time this command is called


Function.Global.Security.ValidateUser

Syntax

Function.Global.Security.ValidateUser(password, boolean return) or

Function.Global.Security.ValidateUser(user, password, boolean return) or

Function.Global.Security.ValidateUser(company code, user, password, boolean return)

Arguments

Example

Remarks

  • With the shorter alternate syntax versions of ValidateUser, company code is assumed to be the same as the calling process company code. When the user is omitted, it is assumed to be the same as the currently logged in user.
  • Passwords are case-sensitive, but usernames are not.


Function.Global.ShipIntegration.AddPackage

Function.Global.ShipIntegration.AddPackage

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.ClearAllSessions

Function.Global.ShipIntegration.ClearAllSessions

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.ClearSession

Function.Global.ShipIntegration.ClearSession

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.CloseShipments

Function.Global.ShipIntegration.CloseShipments

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.DeletePackage

Function.Global.ShipIntegration.DeletePackage

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.GetRates

Function.Global.ShipIntegration.GetRates

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.GetSessionID

Function.Global.ShipIntegration.GetSessionID

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.QuoteSession

Function.Global.ShipIntegration.QuoteSession

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.RawRequest

Function.Global.ShipIntegration.RawRequest

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.RawResponse

Function.Global.ShipIntegration.RawResponse

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.ReadAccount

Function.Global.ShipIntegration.ReadAccount

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.SaveAccount

Function.Global.ShipIntegration.SaveAccount

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.SetSessionAddress

Function.Global.ShipIntegration.SetSessionAddress

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.ShipSession

Function.Global.ShipIntegration.ShipSession

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.StartSession

Function.Global.ShipIntegration.StartSession

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.TrackShipment

Function.Global.ShipIntegration.TrackShipment

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.UPSValidation

Function.Global.ShipIntegration.UPSValidation

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.ValidateAddress

Function.Global.ShipIntegration.ValidateAddress

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.VoidPackage

Function.Global.ShipIntegration.VoidPackage

Syntax

Arguments

Examples

Remarks


Function.Global.ShipIntegration.VoidShipment

Function.Global.ShipIntegration.VoidShipment

Syntax

Arguments

Examples

Remarks


Function.Global.SSF.ReadFile

Syntax

Function.Global.SSF.ReadFile(filename, b ret)

Arguments

Example

Remarks

  • The boolean return on ReadFile indicates if the file was found.
  • The "default" on ReadItem is the value to return if the item can't be located in the SSF file.
  • The User parameter on ReadItem and WriteItem can be left as "", or it can be specified as something like v.caller.user, if you need to store user-specific entries.
  • Do not use "=" in a key name.
  • Do not put a CrLf in any parameter.


Function.Global.SSF.ReadItem

Syntax

Function.Global.SSF.ReadItem(section, key, user, default, ret var)

Arguments

Example

Remarks

  • The boolean return on ReadFile indicates if the file was found.
  • The "default" on ReadItem is the value to return if the item can't be located in the SSF file.
  • The User parameter on ReadItem and WriteItem can be left as "", or it can be specified as something like v.caller.user, if you need to store user-specific entries.
  • Do not use "=" in a key name.
  • Do not put a CrLf in any parameter.


Function.Global.SSF.WriteFile

Syntax

Function.Global.SSF.WriteFile(filename)

Arguments

None

Example

Remarks

  • Do not use "=" in a key name.
  • Do not put a CrLf in any parameter.


Function.Global.SSF.WriteItem

Syntax

Function.Global.SSF.WriteItem(section, key, user, value)

Arguments

None

Example

Remarks

  • The User parameter on ReadItem and WriteItem can be left as "", or it can be specified as something like v.caller.user, if you need to store user-specific entries.
  • Do not use "=" in a key name.
  • Do not put a CrLf in any parameter.


Function.Global.Task.CallAsyncGAS

Function.Global.Task.CallAsyncGAS

Syntax

Arguments

Examples

Remarks


Function.Global.Task.CallSyncGAS

Function.Global.Task.CallSyncGAS

Syntax

Arguments

Examples

Remarks


Function.Global.Task.CallWrapperAsync

Function.Global.Task.CallWrapperAsync

Syntax

Arguments

Examples

Remarks


Function.Global.Task.CallWrapperAsyncBio

Function.Global.Task.CallWrapperAsyncBio

Syntax

Arguments

Examples

Remarks


Function.Global.Task.CallWrapperSync

Function.Global.Task.CallWrapperSync

Syntax

Arguments

Examples

Remarks


Function.Global.Task.CallWrapperSyncBio

Function.Global.Task.CallWrapperSyncBio

Syntax

Arguments

Examples

Remarks


Function.Global.Task.InvokeWithLaunchFile

Syntax

Function.Global.Task.InvokeWithLaunchFile(additional element list, FQP, program, PID return)

Arguments

additional element list
FQP
program
PID return

Examples

Remarks


Function.Global.Task.LaunchMenuTask

Function.Global.Task.LaunchMenuTask

Syntax

Arguments

Examples

Remarks


Function.Global.VMS.AddFile

This command adds a Document Control file to VMS.

Syntax

F.Global.VMS.AddFile(File ID as Long, Compressed as Boolean)

Arguments

Example

Remarks


Function.Global.VMS.Addtohistory

This command adds a VMS file to the database to store a revision.

Syntax

F.Global.VMS.AddToHistory(File ID as Long, Notes as String)

Arguments

Example

Remarks


Function.Global.VMS.AddToHistory

This command adds a VMS file to the database to store a revision.

Syntax

Function.Global.VMS.AddToHistory(File ID as Long, Notes as String)

Arguments

File ID as Long
Notes as String

Examples

Remarks


Function.Global.VMS.CancelCheckout

This command cancels the checking out of a file to the current user. If Working Directory is left blank, the default Working Directory will be used.

Syntax

F.Global.VMS.CancelCheckOut(File ID as Long, [Working Directory as FQN])

Arguments

Example

Remarks


Function.Global.VMS.CancelCheckOut

This command cancels the checking out of a file to the current user. If Working Directory is left blank, the default Working Directory will be used.

Syntax

Function.Global.VMS.CancelCheckOut(File ID [Long], Working Directory as FQN)

Arguments

File ID

Long

Working Directory as FQN

Examples

Remarks


Function.Global.VMS.Checkin

This command checks a file back into VMS. If Shadow Directory is left blank, the default Shadow Directory will be used.

Syntax

F.Global.VMS.CheckIn(File ID as Long, [Shadow Directory as FQN])

Arguments

Example

Remarks


Function.Global.VMS.CheckIn

This command checks a file back into VMS. If Shadow Directory is left blank, the default Shadow Directory will be used.

Syntax

Function.Global.VMS.CheckIn(File ID [Long], Shadow Directory FQN)

Arguments

File ID

Long

Shadow Directory FQN

Examples

Remarks


Function.Global.VMS.Checkout

This command checks out a VMS document to the current user. If Working Directory is left blank, the default Working Directory will be used.

Syntax

F.Global.VMS.CheckOut(File ID as Long,[Working Directory as FQN], Notes as String, Open File as Boolean)

Arguments

Example

Remarks


Function.Global.VMS.CheckOut

This command checks out a VMS document to the current user. If Working Directory is left blank, the default Working Directory will be used.

Syntax

Function.Global.VMS.CheckOut(File ID [Long], Working Directory as FQN, Notes [String], Open File [Boolean])

Arguments

File ID

Long

Working Directory as FQN
Notes

String

Open File

Boolean

Examples

Remarks


Function.Global.VMS.GetFileTypeMax

This command returns the maximum number of revisions that will be stored in the database for the given file extension.

Syntax

F.Global.VMS.GetFileTypeMax(File Extension as String, Long Return)

Arguments

Example

Remarks


Function.Global.VMS.GetFileTypeMaxVersions

Function.Global.VMS.GetFileTypeMaxVersions

Syntax

Arguments

Examples

Remarks


Function.Global.VMS.GetInfoFromFID

Function.Global.VMS.GetInfoFromFID

Syntax

Arguments

Examples

Remarks


Function.Global.VMS.GetSecurity

This command returns the security level as a long for the given File Type, Link Type, and User ID. The File Type is the ID for the file extension set up in VMS Options. The Link Type is the ID used for Document Control/VMS Links. The User ID is the ID of the user. Use F.Global.Security.GetUserID to get the ID for a user.

The returned value is a compound return based on the following values-

0 – No permissions

2 – User can see document change notes

4 – User can see previous versions

8 – User can Check In/Check out files

16 – User can Add files to VMS

Example- if the return is 30, the user can do everything. If the return is 6, the user can only see previous versions and the document change notes.

Syntax

F.Global.VMS.GetSecurity(File Type as Long, Link Type as Long, User ID as Long, Long Return)

Arguments

Example

Remarks


Function.Global.VMS.GetShadowDirectory

This command returns the default Shadow Directory set up in VMS Options.

Syntax

F.Global.VMS.GetShadowDirectory(File Extension as String, String Return)

Arguments

Example

Remarks


Function.Global.VMS.GetVMSInfo

This command returns a delimited string of information for the given VMS File. The returned values will be-

File Name

Description

GSUser (will return -1 if not checked out)

Reason (blank if not checked out)

File Type (file extension)

Link ID as Long

Link Type as Long

Compressed as Boolean

Working Directory (will return 0 if not checked out)

Syntax

F.Global.VMS.GetVMSInfo(File ID as Long, String Return)

Arguments

Example

Remarks


Function.Global.VMS.GetWorkingDirectory

This command returns the default Working Directory set up in VMS Options.

Syntax

F.Global.VMS.GetWorkingDirectory(String Return)

Arguments

Example

Remarks


Function.Global.VMS.IsinVMS

This command checks to see if a file is in VMS, and returns a boolean value.

Syntax

F.Global.VMS.IsInVMS(File ID as Long, Boolean Return)

Arguments

Example

Remarks


Function.Global.VMS.IsInVMS

This command checks to see if a file is in VMS, and returns a boolean value.

Syntax

Function.Global.VMS.IsInVMS(File ID [Long], Boolean Return)

Arguments

File ID

Long

Boolean Return

Examples

Remarks


Function.Global.VMS.RemoveFile

Function.Global.VMS.RemoveFile

Syntax

Arguments

Examples

Remarks


Function.Global.WebService.IssueCommand

This function executes commands on Global Shop web services. Note: This command requires Global Shop-generated signature

Syntax

Function.Global.WebService.IssueCommand(mode, request type, service user, service password, site, target, parameter names, parameter values, method, boolean return)

Arguments

mode
request type
service user
service password
site
target
parameter names
parameter values
method
boolean return

Examples

Remarks


Function.Global.WebService.LoadImplementationPlan

Syntax

Function.Global.WebService.LoadImplementationPlan(datatable name [string], implementation plan ID [long])

Arguments

datatable name

string

implementation plan ID

long

Examples

Remarks


Function.Global.WorkFlow.AddDocument

Function.Global.WorkFlow.AddDocument

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.AddLine

Adds Line

Syntax

F.Global.WorkFlow.AddLine(WFID As Long, Description, Notify As Long, Status As Long, SignOffReq As Long, DependencyID As Long, UserGrp As String, UserGrpFlag As Boolean, WIDChain As Long, PerCompleted As Long, SignOffUserGrp As String, SignOffUserGrpFlag As Boolean, User1 As String, User2 As String, User3 As String, User4 As String, User5 As String, DueDate as Date, sRet as string)

Arguments

Example

Remarks


Function.Global.Workflow.AddLineDependency

Add a line dependency. DepType is 1 Header, 0 Line

Syntax

F.Global.WorkFlow.AddLineDependency(WFID As Long, Line As Long, DepType As Long, DepWFID As Long, DepLine As Long)

Arguments

Example

Remarks


Function.Global.WorkFlow.AddTemplateDocument

Function.Global.WorkFlow.AddTemplateDocument

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.AddTemplateLine

Adds template line

Syntax

F.Global.WorkFlow.AddTemplateLine(ID As Long, Description, Notify As Long, Status As Long, SignOffReq As Long, DependencyID As Long, UserGrp As String, UserGrpFlag As Boolean, WIDChain As Long, PerCompleted As Long, SignOffUserGrp As String, SignOffUserGrpFlag As Boolean, User1 As String, User2 As String, User3 As String, User4 As String, User5 As String, RetLineID As Long, RetLineNum As Long)

Arguments

Example

Remarks


Function.Global.Workflow.AddTemplateLineDependency

Add a line dependency. DepType is 1 Header, 0 Line

Syntax

F.Global.WorkFlow.AddTemplateLineDependency(WFID As Long, Line As Long, DepType As Long, DepWFID As Long, DepLine As Long)

Arguments

Example

Remarks


Function.Global.Workflow.CheckDuplicateTitle

Check duplicate title

Syntax

F.Global.WorkFlow.CheckDuplicateTitle(Title As String, Optional bIsTemplate As Boolean, bRet as boolean)

Arguments

Example

Remarks


Function.Global.Workflow.CheckLineDependency

Check line dependency

Syntax

F.Global.WorkFlow.CheckLineDependency(WFID As Long, Line As Long, bRet as boolean)

Arguments

Example

Remarks


Function.Global.Workflow.CompleteLine

Set worklow line as completed

Syntax

F.Global.WorkFlow.CompleteLine(WFID As Long, Line As Long)

Arguments

Example

Remarks


Function.Global.Workflow.Create

Creates a WorkFlow

Syntax

F.Global.WorkFlow.Create(Title As String, DueDate As Date, StartDate As Date, ParentID As Long, User As String, Status As Long, iRet As Long)

Arguments

Example

Remarks


Function.Global.Workflow.CreateDocumentReference

Create doc reference for a work flow line

Syntax

F.Global.WorkFlow.CreateDocumentReference(WFID As Long, Line As Long, DocID As Long, iRef as long)

Arguments

Example

Remarks


Function.Global.Workflow.CreateFromTemplate

Create workflow from a template ID, Returns workflow IDcreated.

Syntax

F.Global.WorkFlow.CreateFromTemplate(ID As Long, Title As String, StartDate As Date, DueDate As Date, User As String, Status As Long, iRet as long)

Arguments

Example

Remarks


Function.Global.Workflow.CreateTemplate

Create a work flow template

Syntax

F.Global.WorkFlow.CreateTemplate(Title As String, ParentID As Long, User As String, Status As Long, iIDRet as long)

Arguments

Example

Remarks


Function.Global.WorkFlow.CreateTemplateDocumentReference

Function.Global.WorkFlow.CreateTemplateDocumentReference

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.Delete

Deletes a WorkFlow

Syntax

F.Global.WorkFlow.Delete(WFID As Long)

Arguments

Example

Remarks


Function.Global.WorkFlow.DeleteDocument

Function.Global.WorkFlow.DeleteDocument

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.DeleteDocumentReference

Function.Global.WorkFlow.DeleteDocumentReference

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.DeleteLine

Deletes WorkFlow Line

Syntax

F.Global.WorkFlow.DeleteLine(WFLineID As Long)

Arguments

Example

Remarks


Function.Global.Workflow.DeleteLineDependency

Delete line dependency. DepType

Syntax

F.Global.WorkFlow.DeleteLineDepepedency(WFID As Long, Line As Long, DepType As Long, DepWFID As Long, DepLine As Long)

Arguments

Example

Remarks


Function.Global.Workflow.DeleteNote

Delete workflow note

Syntax

F.Global.WorkFlow.DeleteNote(WFLineID As Long)

Arguments

Example

Remarks


Function.Global.Workflow.DeleteTemplate

Deletes WorkFlow template

Syntax

F.Global.WorkFlow.DeleteTemplate(ID As Long)

Arguments

Example

Remarks


Function.Global.WorkFlow.DeleteTemplateDocument

Function.Global.WorkFlow.DeleteTemplateDocument

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.DeleteTemplateDocumentReference

Function.Global.WorkFlow.DeleteTemplateDocumentReference

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.DeleteTemplateLine

Delete Line

Syntax

F.Global.WorkFlow.DeleteTemplateLine(ID As Long, Line As Long)

Arguments

Example

Remarks


Function.Global.Workflow.DeleteTemplateLineDependency

Delete line dependency. DepType

Syntax

F.Global.WorkFlow.DeleteTemplateLineDependency (WFID As Long, Line As Long, DepType As Long, DepWFID As Long, DepLine As Long)

Arguments

Example

Remarks


Function.Global.WorkFlow.DeleteTemplateNote

Function.Global.WorkFlow.DeleteTemplateNote

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.Export

Function.Global.WorkFlow.Export

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ExportTemplate

Function.Global.WorkFlow.ExportTemplate

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.GetDocRefID

Returns Doc ID

Syntax

F.Global.WorkFlow.GetDocRefID(WFID As Long, Line As Long, DocID As Long, iRef as long)

Arguments

Example

Remarks


Function.Global.WorkFlow.GetDocumentReferenceID

Function.Global.WorkFlow.GetDocumentReferenceID

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.GetDocumentReferences

Returns document reference or file

Syntax

F.Global.WorkFlow.GetDocumentReferences(WFID As Long, Line As Long, DocID As Long, sRet)

Arguments

Example

Remarks


Function.Global.Workflow.GetIDFromTitle

Description

Syntax

Arguments

Example

Remarks


Function.Global.Workflow.GetLineID

Returns line ID

Syntax

F.Global.WorkFlow.GetLineID(WFID As Long, LineNo As Long, Optional bIsTemplate As Boolean, iRetLineID as long)

Arguments

Example

Remarks


Function.Global.WorkFlow.GetTemplateDocumentIDFromFileNAME

Function.Global.WorkFlow.GetTemplateDocumentIDFromFileNAME

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.GetTemplateDocumentReferenceID

Function.Global.WorkFlow.GetTemplateDocumentReferenceID

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.GetTemplateDocumentReferences

Function.Global.WorkFlow.GetTemplateDocumentReferences

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.GetTemplateidFromTitle

Syntax

F.Global.WorkFlow.GetTemplateIDFromTitle("New Work Order Creation",V.Local.iWF)

Arguments

Example

F.Global.WorkFlow.GetTemplateIDFromTitle("New Work Order Creation",V.Local.iWF)
  F.Intrinsic.Control.If(V.Local.iWF,=,-1)
    F.Intrinsic.UI.Msgbox("Template Work Flow: New Work Order Creation Does Not Exists. No Work Flow Created")
  F.Intrinsic.Control.end
    F.Intrinsic.Control.EndIf
F.Global.workflow.CREATEFROMTEMPLATE(V.Local.iWF,V.Local.sTitle,V.Ambient.Now,V.Local.dateDue,V.Caller.User,1,V.Local.iWF)  

Remarks


Function.Global.Workflow.GetTemplateLineid

Returns line ID

Syntax

F.Global.WorkFlow.GetTemplateLineID(ID As Long, LineNo As Long, iRet as long)

Arguments

Example

Remarks


Function.Global.WorkFlow.Import

Function.Global.WorkFlow.Import

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ImportTemplate

Function.Global.WorkFlow.ImportTemplate

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.Read

Reads a WorkFlow

Syntax

F.Global.WorkFlow.Read(WFID As Long, Title As String, DueDate As Date, StartDate As Date, ParentID As Long, Status As Long, CompletionDate As Date, CreationDate As Date, UserCreated As String, Template As Long)

Arguments

Example

Remarks


Function.Global.Workflow.ReadAllReferenceData

Return delimited string of reference data

Syntax

F.Global.WorkFlow.ReadAllRefenceData(WFID As Long, Position As Long, Optional bIsTemplate As Boolean, RefData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadAssignedLines

Function.Global.WorkFlow.ReadAssignedLines

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadAssignedLinesWithFilter

Function.Global.WorkFlow.ReadAssignedLinesWithFilter

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadCompletion

Function.Global.WorkFlow.ReadCompletion

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadDocument

Function.Global.WorkFlow.ReadDocument

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadExploded

Function.Global.WorkFlow.ReadExploded

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadLinebyID

Returns a delmited string in the following order Description, Notify As Long, Status As Long, SignOffReq As Long, DependencyID As Long, CompletionDate As Date, UserGrp As String, UserGrpFlag As Boolean, CompletedBy As String, WIDChain As Long, PerCompleted As Long, SignOffUserGrp As String, SignOffUserGrpFlag As Boolean, User1 As String, User2 As String, User3 As String, User4 As String, User5 As String

Syntax

F.Global.WorkFlow.ReadLineByID(WFLineID As Long, sRet as string)

Arguments

Example

Remarks


Function.Global.Workflow.ReadLinebyNum

Returns a delimited string in the following order Description, Notify As Long, Status As Long, SignOffReq As Long, DependecnyID As Long, CompletionDate As Date, UserGrp As String, UserGrpFlag As Boolean, CompletedBy As String, WIDChain As Long, PerCompleted As Long, SignOffUserGrp As String, SignOffUserGrpFlag As Boolean, User1 As String, User2 As String, User3 As String, User4 As String, User5 As String

Syntax

F.Global.WorkFlow.ReadLineByNum(WFID As Long, LineNo As Long, sRet as string)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadLineDependency

Function.Global.WorkFlow.ReadLineDependency

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadLinePriority

Function.Global.WorkFlow.ReadLinePriority

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadLines

Return delimited strings of line ID and Line Numbers

Syntax

F.Global.WorkFlow.ReadLines(WFID As Long, LineID As String, LineNumbers As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadLinesTemplate

Function.Global.WorkFlow.ReadLinesTemplate

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadMetaData

Read header or line work flow meta 0 to 9 with data – 1 to return all as a delimited string

Syntax

F.Global.WorkFlow.ReadMetaData(ID As Long, IDType As Long, Position As Long, MetaData As String)

Arguments

Example

Remarks


Function.Global.Workflow.ReadNote

Read workflow note

Syntax

F.Global.WorkFlow.ReadNote(WFLineID As Long, Notes As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadPriority

Function.Global.WorkFlow.ReadPriority

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadReferenceData

Read header work flow reference 0 to 9 with data

Syntax

F.Global.WorkFlow.ReadReferenceData(WFID As Long, Position As Long, RefData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadReferenceLineData

Function.Global.WorkFlow.ReadReferenceLineData

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadTemplate

Reads template

Syntax

F.Global.WorkFlow.ReadTemplate(ID As Long, Title As String, ParentID As Long, Status As Long, CreationDate As Date, UserCreated As String)

Arguments

Example

Remarks


Function.Global.Workflow.ReadTemplateallReferenceData

Return delimited string of reference data

Syntax

F.Global.WorkFlow.ReadTemplateAllReferenceData(WFID As Long, Position As Long, RefData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadTemplateDocument

Function.Global.WorkFlow.ReadTemplateDocument

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadTemplateExploded

Function.Global.WorkFlow.ReadTemplateExploded

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadTemplateLine

Function.Global.WorkFlow.ReadTemplateLine

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadTemplateLinebyID

sRet is a delimited string of data in the following order Description, Notify Status SignOffReq , DependecyID , CompletionDate, UserGrp, UserGrpFlag, CompletedBy, WIDChain, PerCompleted, SignOffUserGrp, SignOffUserGrpFlag, User1, User2, User3, User4, User5

Syntax

F.Global.WorkFlow.ReadTemplateLineByID(LineID As Long, sRet as string)

Arguments

Example

Remarks


Function.Global.Workflow.ReadTemplateLinebyNum

sRet is a delimited string of data in the following order Description, Notify Status SignOffReq , DependecyID , CompletionDate, UserGrp, UserGrpFlag, CompletedBy, WIDChain, PerCompleted, SignOffUserGrp, SignOffUserGrpFlag, User1, User2, User3, User4, User5

Syntax

F.Global.WorkFlow.ReadTemplateLineByNum(ID As Long, LineNo As Long, sRet as String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadTemplateLineDependency

Function.Global.WorkFlow.ReadTemplateLineDependency

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.ReadTemplateLinePriorityOffset

Function.Global.WorkFlow.ReadTemplateLinePriorityOffset

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadTemplateLines

Returns two delimited strings one with line id's and line number

Syntax

F.Global.WorkFlow.ReadTemplateLines(ID As Long, LineID As String, LineNumbers As String)

Arguments

Example

Remarks


Function.Global.Workflow.ReadTemplateMetaData

Read header or line work flow meta 0 to 9 with data – 1 to return all as a delimited string

Syntax

F.Global.WorkFlow.ReadTemplateMetaData(ID As Long, IDType As Long, Position As Long, MetaData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadTemplateNote

Function.Global.WorkFlow.ReadTemplateNote

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.ReadTemplateReferenceData

Read header work flow reference 0 to 9 with data

Syntax

F.Global.WorkFlow.ReadTemplateReferenceData(WFID As Long, Position As Long, RefData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.ReadTemplateReferenceLineData

Function.Global.WorkFlow.ReadTemplateReferenceLineData

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.Save

Function.Global.WorkFlow.Save

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.SaveLine

Function.Global.WorkFlow.SaveLine

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.SaveNote

Save workflow note to line id

Syntax

F.Global.WorkFlow.SaveNote(WFLineID As Long, Notes As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.SaveTemplate

Function.Global.WorkFlow.SaveTemplate

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.SaveTemplateLine

Function.Global.WorkFlow.SaveTemplateLine

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.SaveTemplateLinePriorityOffset

Function.Global.WorkFlow.SaveTemplateLinePriorityOffset

Syntax

Arguments

Examples

Remarks


Function.Global.WorkFlow.SaveTemplateNote

Function.Global.WorkFlow.SaveTemplateNote

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.SetLineCompletionPercenTage

Sets line percent complete

Syntax

F.Global.WorkFlow.SetLineCompletionPercentage(WFID As Long, Line As Long, PercentCompleted As Long)

Arguments

Example

Remarks


Function.Global.Workflow.SetMetaData

Set header or line work flow meta 0 to 9 with data, ID Type 1 is for header 0 for line

Syntax

F.Global.WorkFlow.SetMetaData(ID As Long, IDType As Long, Position As Long, MetaData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.SetPriority

Function.Global.WorkFlow.SetPriority

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.SetReferenceData

Set header work flow reference 0 to 9 with data

Syntax

F.Global.WorkFlow.SetReferenceData(WFID As Long, Position As Long, RefData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.SetReferenceLineData

Function.Global.WorkFlow.SetReferenceLineData

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.SetTemplateMetaData

Set header or line work flow meta 0 to 9 with data, ID Type 1 is for header 0 for line

Syntax

F.Global.WorkFlow.SetTemplateMetaData(ID As Long, IDType As Long, Position As Long, MetaData As String)

Arguments

Example

Remarks


Function.Global.Workflow.SetTemplateReferenceData

Set header work flow reference 0 to 9 with data

Syntax

F.Global.WorkFlow.SetTemplateReferenceData(WFID As Long, Position As Long, RefData As String)

Arguments

Example

Remarks


Function.Global.WorkFlow.SetTemplateReferenceLineData

Function.Global.WorkFlow.SetTemplateReferenceLineData

Syntax

Arguments

Examples

Remarks


Function.Global.Workflow.SignoffLine

Sign off a work flow line by user or group

Syntax

F.Global.WorkFlow.SignOffLine(WFID As Long, Line As Long, UserGrp As String, SignOffType As String)

Arguments

Example

Remarks


Function.Global.Workstation.GetComponentName

Syntax

Function.Global.WorkStation.GetComponentName(component ID, String return)

Arguments

component ID
String return

Examples

Remarks


Function.Global.Workstation.GetComponentPass

Syntax

Function.Global.WorkStation.GetComponentPass(component ID, status, long return)

Arguments

component ID
status
long return

Examples

Remarks


Function.Global.Workstation.GetComponentPriority

Syntax

Function.Global.WorkStation.GetComponentPriority(component ID, status, long return)

Arguments

component ID
status
long return

Examples

Remarks


Function.Global.WorkStation.GetComponentStatus

Function.Global.WorkStation.GetComponentStatus

Syntax

Arguments

Examples

Remarks


Function.Global.XML

Program.Sub.Main.Start

V.Local.shold.Declare(String)

f.gl.XML.createDocument("xmlDoc",false,true,false,false)

'calling createDOC arguments name, async, preserve whitespace, validate on parse, Resolve Externals can raise error 1010

f.gl.XML.SetRoot("xmlDoc","MyRoot")

'calling SetRoot arguments doc_name, root_name can raise error 1050

F.Intrinsic.String.Concat(V.Ambient.NewLine,V.Ambient.Tab,V.Local.shold)

f.gl.XML.appendTextNode("xmlDoc","root",V.Local.shold)

'calling appendTextNode arguments doc_name, node_name (root) to appent to root can raise error 1070

f.gl.XML.createElementNode("xmlDoc","mynode1","")

'calling createElementNode arguments doc_name, node_name, value can raise error 1055

f.gl.XML.createElementNode("xmlDoc","mynode2","Value1")

F.Intrinsic.String.Concat(V.Ambient.NewLine,V.Ambient.Tab,V.Ambient.tab,V.Local.shold)

f.gl.XML.appendTextNode("xmlDoc","mynode1",V.Local.shold)

f.gl.XML.appendNode("xmlDoc","mynode1","mynode2")

f.gl.XML.destroyNode("xmlDoc","mynode2")

'calling DestroyNode arguments doc_name, node_name can raise error 1060

f.gl.XML.appendNodeToRoot("xmlDoc","myNode1")

'calling appendNodeToRoot arguments doc_name, node_name can raise error 1061

f.gl.XML.destroyNode("xmlDoc","myNode1")

f.gl.XML.appendTextNode("xmlDoc","root",V.Ambient.NewLine)

f.gl.XML.saveDocument("xmlDoc","C:\","text.xml")

'calling saveDoc arguments doc_name, path, file can raise error can raise error 1030

f.gl.XML.closeDocument("xmlDoc")

'calling closeDoc arguments doc_name can raise error 1040

F.Intrinsic.UI.Msgbox("Completed")

Program.Sub.Main.End


Function.Global.XML.AppendNode

Syntax

Function.Global.XML.AppendNode(Doc Name, Node Name, Node Name)

Arguments

Doc Name

String Variable or Value of the doc name

Node Name

String Variable or Value of the Parent Node

Node Name

String Variable or Value of the Child Node

Example

Function.Global.XML.AppendNode(“xmlDoc”,”mynode1”, mynode2)

Remarks


Function.Global.XML.AppendNodeInSet

Appends node to current node in the set

Syntax

Function.Global.XML.AppendNodeInSet(DocName, SetName, NodeName)

Arguments

Example

Remarks


Function.Global.XML.AppendNodeToRoot

Syntax

Function.Global.XML.AppendNodeToRoot(Doc Name, Node Name)

Arguments

Doc Name

String Variable or Value of the doc name

Node Name

String Variable or Value of the Node Name

Example

Function.Global.XML.AppendNodeToRoot(“xmlDoc”,”mynode1”)

Remarks


Function.Global.XML.AppendTextNode

Syntax

Function.Global.XML.AppendTextNode(Doc Name, Node Name, Value)

Arguments

Doc Name

String Variable or Value of the doc name

Node Name

String Variable or Value of the Parent Node

Node Name

String Variable or Value of the Child Node

Example

Variable.Local.sHold.Declare(String)
f.intrinisic.String.Concat(V.Ambient.NewLine, V.Ambient.Tab, v.local.sHold)
Function.Global.XML.AppendTextNode(“xmlDoc”,”mynode1”, v.local.shold)

Remarks


Function.Global.XML.Back

Returns boolean if at BOF

Syntax

Function.Global.XML.Back(DocName,SetName, BOF Ret)

Arguments

Examples

Remarks


Function.Global.XML.CloseDocument

Syntax

Function.Global.XML.CloseDocument(Doc Name)

Arguments

Doc Name

String Variable or Value of the doc name

Example

Remarks


Function.Global.XML.CloseSet

Closes node set

Syntax

function.global.xml.closeSet(DocName,SetName)

Arguments

Example

Remarks


Function.Global.XML.CreateAttributeNode

Syntax

Function.Global.XML.AppendNode(Doc Name, Attribute Name, Value)

Arguments

Doc Name

String Variable or Value of the doc name

Attribute Name

String Variable or Value for the Attribute Name

Value

Variable or Value of the Attribute

Example

Function.Global.XML.AppendNode(“xmlDoc”,”Align”,”Left”)

Remarks


Function.Global.XML.CreateDocument

Syntax

Function.Global.XML.CreateDocument(Doc Name, async, preserve whitespace,validate on parse, Resolve External)

Arguments

Doc Name

String Variable or Value of the doc name

Async

Boolean True to allow others to access page at same time

Preserve Whitespace

Boolean - Should always be true

Validate on Parse

Boolean

Resolve External

Boolean – Should be False

Example

Function.Global.XML.CreateDocument(“xmlDoc”, True, True, False, False)

Remarks


Function.Global.XML.CreateElementNode

Syntax

Function.Global.XML.CreateElementNode(Doc Name, Attribute Name, Value)

Arguments

Doc Name

String Variable or Value of the doc name

Element Name

String Variable or Value for the Element Name

Value

Variable or Value of the Attribute

Example

Function.Global.XML.CreateElementNode(“xmlDoc”,”mynode1”,”Value1”)

Remarks


Function.Global.XML.DeleteChildInSet

Deletes node in current node in the set

Syntax

Function.Global.XML.DeleteChildInSet(DocName, SetName, NodeName)

Arguments

Example

Remarks


Function.Global.XML.DestroyAttributeNode

Function.Global.XML.DestroyAttributeNode

Syntax

Arguments

Examples

Remarks


Function.Global.XML.DestroyNode

Syntax

Function.Global.XML.DestroyNode(Doc Name, Node Name or Attribute)

Arguments

Doc Name

String Variable or Value of the doc name

Node Name

String Variable or Value for the Node Name or Attribute Name

Example

Function.Global.XML.DestroyNode(“xmlDoc”,”mynode1”) or
Function.Global.XML.DestroyNode(“xmlDoc”,”Align”)

Remarks

  • Attribute must be destroyed before reusing the same name


Function.Global.XML.LoadDocument

Loads an existing XML document

Syntax

Function.Global.XML.LoadDocument(DocName, File, Async, Preserve Whitespace, Validate on Parse, Resolve Externals)

Arguments

Example

Remarks


Function.Global.XML.Next

Returns boolean if at EOF

Syntax

Function.Global.XML.Next(DocName,SetName, EOF Ret)

Arguments

Example

Remarks


Function.Global.XML.Query

Opens a set with a valid XQuery

Syntax

Function.Global.XML.Query(Document as string, NodeSet as string, XQuery as string) or

Function.Global.XML.Query(Document as string, NodeSet as string, XQuery as string, ReturnSingleNode as boolean)

Arguments

Examples

Remarks


Function.Global.XML.ReadNodeAttribute

Syntax

Function.Global.XML.ReadNodeAttribute(DocName, Name, Attribute, Return)

Arguments

DocName
Name
Attribute
Return

Examples

Remarks


Function.Global.XML.ReadNodeSetAttribute

Returns the attribute value of the active node in the document.  Note Attribute name is case sensitive.

Syntax

Function.Global.XML.ReadNodeSetAttribute(DocName, SetName, Attribute, Return)

Arguments

DocName
SetName
Attribute
Return

Examples

Remarks


Function.Global.XML.ReadNodeSetBound

Syntax

Function.Global.XML.ReadNodeSetBound(Doc, Nodeset, return)

Arguments

Example

Remarks

  • The string return contains the lower and upper boundary delimited by a *!*.


Function.Global.XML.ReadNodeSetValue

Returns the values of the current node in the set.

Syntax

Function.Global.XML.ReadNodeSetValue(DocName, SetName, Argument, Return)

Arguments

Examples

Remarks


Function.Global.XML.ReadNodeValue

Syntax

Function.Global.XML.ReadNodeValue(DocName, Node, Argument, Return)

Arguments

-text

-nodeName

-nodeType

-tagName

-baseName

-prefix

Example

Remarks


Function.Global.XML.SaveDocument

Syntax

Function.Global.XML.SaveDocument(Doc Name, Path, File)

Arguments

Doc Name

String Variable or Value of the doc name

Path

String Variable or Value for the Path

File

String Variable or Value for the File Name

Example

Function.Global.XML.SaveDocument(“xmlDoc”,”C:\”,”text.xml”)

Remarks


Function.Global.XML.SetAttributeToNode

Syntax

Function.Global.XML.SetAttributeToNode(Doc Name, Parent Node, Attribute)

Arguments

Doc Name

String Variable or Value of the doc name

Parent Node

String Variable or Value for the Parent Node Name

Attribute

String Variable or Value for the Attribute

Example

Function.Global.XML.SetAttributeToNode(“xmlDoc”,”mynode1”,”Align”)

Remarks


Function.Global.XML.SetAttributeToRoot

Syntax

Function.Global.XML.SetAttributeToRoot(Doc Name, Attribute)

Arguments

Doc Name

String Variable or Value of the doc name

Attribute

String Variable or Value for the Attribute

Example

Function.Global.XML.SetAttributeToNode(“xmlDoc”, ”Align”)

Remarks


Function.Global.XML.SetNodeSetPosition

Syntax

Function.Global.XML.SetNodeSetPosition(Doc, Nodeset, Position, return)

Arguments

Example

Remarks

  • Returns true if the status was successful


Function.Global.XML.SetNodeSetValue

Sets the current value of the current position of the node set

Syntax

Function.Global.XML.SetNodeSetValue(DocName, SetName, Argument, Value)

Arguments

Example

Remarks


Function.Global.XML.SetRoot

Syntax

Function.Global.XML.SetRoot(Doc Name, Root Node)

Arguments

Doc Name

String Variable or Value of the doc name

Root Node

String Variable or Value for the Root Node Name

Example

Function.Global.XML.SetRoot(“xmlDoc”,”MyRoot”)

Remarks


Function.Global.XML.TraverseNode

Syntax

Function.Global.XML.TraverseNode(DocName, NodeName, ReturnNodeName, Direction, Status)

Arguments

Example

Remarks

  • Returns a node based on direction valid directions are:

0 - parent node

1 - NextSibling

2 - PerviousSibling

3 - FirstChild

4 - LastChild

  • Returns true if the status was successful


Function.Global.XML.TraverseNodeSet

Function.Global.XML.TraverseNodeSet(DocName, SetName, ReturnNodeName, Direction, Status)

Same as above but using the current node of the node set

Syntax

Arguments

Examples

Remarks