Attribute Reference

Built-in attributes can be referenced in method logic anywhere within their scope.

 The values of some built-in attributes can be changed, although many are read-only and can be used only for reference.

Note: Ensure to suffix the names of built-in attributes with the underscore character when you reference built-in attributes in method logic. For example, _UserMAINT.

Designation of Characteristics

The first characteristics column designates the attribute's primitive property:

The second characteristics column designates the attribute's length property:

The third characteristics column designates the attribute's write characteristics:

The platform column designates the host platform on which the command is supported:

Built-in attributes can be referenced in method logic anywhere within their scope.

 The values of some built-in attributes can be changed, although many are read-only and can be used only for reference.

Attribute

Characteristics

Description

Platform

ActMth

N

4

R

For ispecs, set to the current accounting month in the form YYMM. For reports, set to the ActMth value from the last event record read.

WMJ

Backup

S

1

R

Retain output directed to TP devices – "Y" or "N".

M

Device

S

2

W

Set to the type of device to which outputstream output is directed – "DI", "DP", "LP", "RP", "TP", "VD", or spaces.

WMJ

Exists

B

-

W

Exists is a read-writable built-in extract file attribute that indicates whether the Glb.Status built-in segment attribute should be set following an attempt to access an extract file that doesn’t exist

WMJ

FormDepth

N

4

W

Set to the number of printable lines of outputstream output on a page.

WMJ

 FormID

S

20

W

Set to the name of the stationery to use for printing of outputstream output by ROC.

WMJ

Glb.2PC

S

1

W

Superseded. Use Glb.TwoPC instead.

 

Glb.ActionKey

S

2

R

Value of the function key pressed or "EX" or "BY"

 

Glb.Add

S

3

R

 

Intended for use in place of the literal "ADD", for the purpose of translating Maint values in multi-language applications.

WMJ

Glb.AltUser

S

17

W

Alternative username for TPS output

M

Glb.AppName

S

12

R

Name of the current application group

 

Glb.AppNo

N

1

R

Number of the current application group

 

Glb.ASCPrt

S

17

W

Set to the output alias associated with the user from which the referencing report originates.

WMJ

Glb.ASCPrtHost

S

17

W

Name of the host associated with the Glb.ASCPrt printer

M

Glb.Backup

S

1

W

Retain output directed to TP devices – "Y" or "N"

M

Glb.Balance

 

 

 

Superseded. Use copy ispecs or copy events instead.

 

Glb.Base

N

4

R

Used in conjunction with the DateConvert logic command – set to the year upon which relative day numbers are based.

WMJ

Glb.CCS

N

5

R

Coded character set identifier

M

Glb.Century

N

2

W

Used in conjunction with the DateConvert logic command – specifies either the century or the Glb.Zeros built-in segment attribute for initialization.

WMJ

Glb.Century_Start

N

4

W

Used in conjunction with the DateConvert logic command – specifies the first year of a 100 year period, so that all six-digit dates are interpreted as being in that period.

WMJ

Glb.Change

S

30

R

Set to the name of the variable whose change in value invoked the printing of the current heading or footing of the referencing report.

WMJ

Glb.ChargeCode

S

45

W

The chargecode to be used with the Run and Start commands for reports

M

Glb.Chg

S

3

R

 

Intended for use in place of the literal "CHG", for the purpose of translating Maint values in multiple-language applications.

WMJ

Glb.Close

S

5

R

Set to "CLOSE" if a manual or programmatic stop is received by the referencing report.

WMJ

Glb.Copy

N

2

R

Set to the current iteration number of the referencing copy ispec or copy event.

WMJ

Glb.CorStatus

S

5

R

Status of coroutine execution

M

Glb.Date

S

7

R

Set to the date the referencing ispec transaction was initiated, or the date the referencing report was started.

WMJ

Glb.Dbg_DB

N

1

W

Debug trace level

 

Glb.Dbg_LG

N

1

W

Debug trace level

 

Glb.Dbg_OLTP

N

1

W

Debug trace level

 

Glb.DC_ Attributes

   

Used in conjunction with the DateConvert logic command – they are set to the formatted date, examples listed below:

WMJ (all)

Glb.DC_CCYY_MM_DD

S

10

2000/03/23

 

Glb.DC_CCYY_MMM_DD

S

11

2000 MAR 23

 

Glb.DC_CCYYDDD

2000083

 

Glb.DC_CCYYMMDD

8

20000323

 

Glb.DC_CCYYMMMDD

9

2000MAR23

 

Glb.DC_DayNum

6

015788

 

Glb.DC_DD_MM_CCYY

10

23/03/2000

 

Glb.DC_DD_MM_YY

8

23/03/00

 

Glb.DC_DD_MMM_CCYY

11

23 MAR 2000

 

Glb.DC_DD_MMM_YY

23 MAR 00

 

Glb.DC_DDMMCCYY

23032000

 

Glb.DC_DDMMMCCYY

23MAR2000

 

Glb.DC_DDMMMYY

23MAR00

 

Glb.DC_DDMMYY

230300

 

Glb.DC_In_Alpha

25

2000 MARCH 23

 

Glb.DC_MM_DD_CCYY

10

03/23/2000

 

Glb.DC_MM_DD_YY

8

03/23/00

 

Glb.DC_MMDDCCYY

8

03232000

 

Glb.DC_MMDDYY

8

032300

 

Glb.DC_MMM_DD_CCYY

 S

11

MAR 23 2000

 

Glb.DC_MMM_DD_YY

 S

9

MAR 23 00

 

Glb.DC_MMMDDCCYY

 S

9

MAR232000

 

Glb.DC_MMMDDYY

 S

7

MAR2300

 

Glb.DC_Today

 S

15

THURSDAY

 

Glb.DC_UK_Alpha

 S

25

23 MARCH 2000

 

Glb.DC_US_Alpha

 S

25

MARCH 23 2000

 

Glb.DC_WeekNo

 N

2

13

 

Glb.DC_YY_MM_DD

8

00/03/23

 

Glb.DC_YY_MMM_DD

9

00 MAR 23

 

Glb.DC_YYDDD

 N

5

00083

 

Glb.DC_YYMMDD

 N

6

000323

 

Glb.DC_YYMMMDD

 S

7

00MAR23

 

Glb.DC_CC

N

2

W

Used in conjunction with the DateConvert logic command – set to the century involved in the date conversion.

WMJ

Glb.DeadLock

N

1

W

Deadlock indicator

 

Glb.Del

S

3

R

 

Intended for use in place of the literal "DEL", for the purpose of translating Maint values in multiple-language applications.

WMJ

Glb.DestEnv

S

10

W

Specifies the name of the target application database.

WMJ

Glb.DestHost

S

17

W

Used with external automatic entries – specifies the name of the host where the target application database is located.

WMJ

Glb.Destination

S

15

W

Used with automatic entries – specifies the name of the target application database.

WMJ

Glb.DestNoForm

S

17

W

Used with NOF external automatic entries – specifies the batch file that initiates the particular NOF program.

WMJ

Glb.DestXnID

S

6

R

Transaction ID

M

Glb.Device

S

2

W

Set to the type of device to which report output is directed – "DI", "DP", "LP", "RP", "TP", "VD", or spaces.

WMJ

Glb.DLRecover

N

1

W

Restart after deadlock error

 

Glb.DLRetry

N

5

W

Deadlock retry function indicator

 

Glb_DMS_READS

N

12

R

Provides the total number of database reads for the instance for the duration of a report or an online application.

M

Glb_DMS_WRITES

N

12

R

Provides the total number of database writes for the instance for the duration of a report or an online application.

M

Glb.Error

S

5

W

For persistent ispecs, specifies whether to perform the automatic update of input data. For the Store built-in method, specifies whether to perform an internal automatic entry.

WMJ

Glb.ExamKey

S

30

W

Examiner trace record comment.

M

Glb.ExName

S

14

R

AccessExternal exception dataname.

M

Glb.ExtExt

S

80

R

AccessExternal exception text.

M

Glb.Fail

S

5

W

Contains “*****”, the value of Glb.Status when a command fails.

WMJ

Glb.FileInfo

S

1

W

Control the overwriting of the print file attributes by system attributes such as Glb.Title and Glb.SaveDays.

M

Glb.Filler

 

 

 

Superseded. On migration it is replaced by an attribute named Filler. When more than one GLB.FILLER  exists, they are replaced with Filler, Filler1, FillerN etc.

 

Glb.FormDepth

N

4

W

Set to the number of printable lines of report output on a page.

WMJ

Glb.FormID

S

20

W

Set to the name of the stationery to use for printing of report output by ROC.

WMJ

Glb.FullLength

N

4

W

Set to the length (in bytes) of the value of the variable specified by the closest preceding GetLength method call.

WMJ

Glb.FullStn

S

251

W

Set to the same station name as Glb.Stn.

WMJ

Glb.GUI

S

1

W

Set to the type of terminal from which the referencing transaction originates.

WMJ

Glb.High

S

V

R

 

Set to the maximum absolute string value that can be represented by the type of host on which the application is running.

WMJ

Glb.HTimeOut

N

6

W

Used with external automatic entries – specifies the HUB timeout.

WMJ

Glb.HubStatus

S

15

W

Set to the result of an external automatic entry.

WMJ

Glb.HubTimeOut

N

6

W

Used with external automatic entries – specifies the HUB timeout.

WMJ

Glb.InitFullStn

S

251

R

Set to the initiating terminal or username of the referencing report.

WMJ

Glb.InitStn

S

17

R

Set to the initiating terminal or username of the referencing report.

WMJ

Glb.InputData

S

1920

R

Data for current transaction

M

Glb.Inq

S

3

R

Intended for use in place of the literal "INQ", for the purpose of translating Maint values in multiple-language applications.

WMJ

Glb.IsDebug

B

-

R

Enables alternate logic paths to be taken, based on whether the system is running in debug mode or not. Read-only boolean flag is set to true when debugging, else set to false.

WMJ

Glb.Language

S

10

W

Specifies the presentation language of the application user interface to the accessing client.

WMJ

Glb.Length

N

4

W

Set to the length of a specified value, including any initial and embedded spaces.

WMJ

Glb.LineCount

N

4

W

Set to the number of lines of report output printed on the current page of the referencing report.

WMJ

Glb.LineUp

S

1

W

"Y" indicates special stationery is being used and needs lining up before printing commences

M

Glb.LineUpName

S

30

W

Set to the number of lines of report output printed on the current page of the referencing report

M

Glb.Low

S

V

R

Set to the minimum absolute string value that can be represented by the type of host on which the application is running.

WMJ

Glb.Machine

S

1

R

Set to the type of host on which the application is running – "A", "U", "1", "N", or "P".

WMJ

Glb.MainSQLCode

+

9

W

Set when the Main method of an SQLScript is invoked using the Determine Actual logic command – to the status code of the last-executed SQL statement.

WJ

Glb.MainSQLMessage

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.MainSQLState

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.MainSQLWarn

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.Match

S

1

W

Used in conjunction with the Match logic command – set to string characters (upto 64 characters) that identifies the next extract file to be read.

WMJ

Glb.Max

N

V

R

Set to the maximum absolute numeric value that can be represented by the type of host on which the application is running. Sets the numeric primitives to all 9s.

WMJ

Glb.MaxCopy

N

2

R

Set to the value of the copy ispec or copy event's Max Copies property.

WMJ

Glb.Min

N

V

R

Set to the minimum numeric value that can be represented by the type of host on which the application is running. Sets all unsigned number-primitives to zero, and all signed number-primitives to negative all 9s.

WMJ

Glb.MixNo

N

10

R

Set to the PID number of the referencing report at runtime.

WMJ

Glb.NumCopies

N

3

W

Set to the number of copies of the referencing report that are to be printed.

WMJ

Glb.OLTPService

S

15

R

OLTP Service name

WMJ

Glb.OLTPSubType

S

16

W

Most recent OLTP buffer subtype name

WMJ

Glb.OLTPType

S

8

R

Most recent OLTP buffer type name

WMJ

Glb.OLTPValue

+

9

W

OLTP application-defined return code

WMJ

Glb.Origin

S

10

R

Used with external automatic entries – set to the name of the originating database.

WMJ

Glb.OriginEnv

S

10

R

Used with external automatic entries – set to the name of the originating application database.

WMJ

Glb.OriginHost

S

17

R

Used with external automatic entries – set to the name of the originating host.

WMJ

Glb.OriginIspec

S

5

R

Origin Ispec name

 

Glb.OriginPtn

S

19

R

Partition name switched from

 

Glb.OriginXnID

S

6

R

Origin transaction ID

 

Glb.PageCount

N

5

W

Set to the current report output page number.

WMJ

Glb.Param

S

U

W

Specifies the parameters for external class methods migrated from the LDL CALL logic command.

WMJ

Glb.ParamFlag

S

1

W

Specifies that parameter data is attached to the Wake logic statement calling the referencing report.

WMJ

Glb.Pitch

N

3

W

Print pitch

M

Glb.PostSQLCode

N

9

W

Set when the Destruct method of an SQLScript is invoked using the Determine Actual logic command – to the status code of the last-executed SQL statement.

WJ

Glb.PostSQLMessage

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.PostSQLState

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.PostSQLWarn

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.PreSQLCode

N

9

W

Set when the Construct method of an SQLScript is invoked using the Determine Actual logic command – to the status code of the last-executed SQL statement.

WJ

Glb.PreSQLMessage

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.PreSQLState

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.PreSQLWarn

 

 

 

Superseded. Refer to SQL Script Related Attributes.

 

Glb.PrevIspec

S

5

W

Previous ispec

 

Glb.PrintAt

S

10

W

"END" or "RELEASE"

M

Glb.PrintBanner

S

1

W

"Y" or "N"

M

Glb.PrintHost

S

17

W

Printer host name

M

Glb.Priority

N

2

Y

Report run priority

M

Glb.Priv

N

2

W

Set to the privilege level of the transaction originator of the referencing ispec, or the output printer device of the referencing report – in the range 0 through 15.

WMJ

Glb.Product

S

10

R

Set to the runtime software product on which the application is running.

Deprecated attribute – Use Glb.IsDebug instead.

WMJ

Glb.PrtParam

S

U

W

Data for USERPRT handler

 

Glb.Pur

S

3

R

Intended for use in place of the literal "PUR", for the purpose of translating Maint values in multiple-language applications.

WMJ

Glb.Recover

N

1

W

Set to whether the referencing report has been restarted by recovery.

WMJ

Glb.RepGenDate

N

8

R

Set to the build date of the referencing report.

WMJ

Glb.RepGenTime

N

4

R

Set to the build time of the referencing report.

WMJ

Glb.RepLang

S

10

R

Set to the language to which the referencing report was built.

WMJ

Glb.RepName

S

10

R

Set to the name of the referencing report.

WMJ

Glb.RepUnique

N

15

R

Report unique number

M

Glb.RepVersion

N

4

R

Set to the version number of the referencing report.

WMJ

Glb.Request

S

1

R

Set to the request origin of the referencing ispec – "Y" or space.

WMJ

Glb.ROCFlag

S

1

R

Set to whether ROC is set – "R" or space.

WMJ

Glb.SaveDays

N

2

W

Set to the number of days that report output is to be retained by ROC.

WMJ

Glb.Secondary

S

1

R

Secondary database run

M

Glb.Self

S

10

R

Used with external automatic entries – set to the name of the application database currently executing.

WMJ

Glb.SelfDB

S

10

R

Current database name

M

Glb.SelfEnv

S

10

R

Used with external automatic entries – set to the name of the current application database.

WMJ

Glb.SelfHost

S

17

R

Used with external automatic entries – set to the name of the host on which the current application is running.

WMJ

Glb.SelfXnID

S

6

R

System transaction ID

 

Glb.Shadow

S

1

R

Set to the outputstream currently being output.

WMJ

Glb.Source

S

1

R

Set to the message type of the referencing ispec transaction – "G", "N", "O", "T", or space.

WMJ

Glb.Spaces

S

V

R

Intended for use in place of a literal value of spaces.

WMJ

Glb.StaLang

S

10

R

Set to the presentation language currently in use by the client initiating the referencing transaction.

WMJ

Glb.Station

S

17

W

Set to the transaction originator of the referencing ispec, or specifies the destination of the referencing report.

WMJ

Glb.Status

S

5

W

Indicates the result status of certain logic commands.

WMJ

Glb.Stn

S

17

W

Set to the transaction originator of the referencing ispec, or specifies the destination of the referencing report.

WMJ

Glb.StnHost

S

17

W

Host name

M

Glb.Style

S

10

R

Set to the type of terminal or program from which the referencing transaction originates.

WMJ

Glb.SubSys

N

2

R

Subsystem number

M

Glb.SysGenDate

N

8

R

Set to the build date of the application.

WMJ

Glb.SysGenTime

N

4

R

Set to the build time of the application.

WMJ

Glb.SysVersion

N

4

R

Set to the version number of the current application.

WMJ

Glb.Task

N

2

W

Provides a result for the running of the referencing report.

WMJ

Glb.Time

N

8

R

Set to the system time, in the format HHMMSSTT.

WMJ

Glb.Title

S

60

W

Set to the name used for report output, overriding the default name of the referencing report.

WMJ

Glb.Today

S

7

R

Set to the date the referencing ispec transaction was initiated, or the date the referencing report was started.

WMJ

Glb.Todays_Date_Num

N

6

R

Set to the date the referencing ispec transaction was initiated, or the date the referencing report was started.

WMJ

Glb.Todays_Day

N

2

R

Set to the day of the month the referencing ispec transaction was initiated, or the day of the month the referencing report was started.

WMJ

Glb.Todays_Month

S

3

R

Set to the month (three-character string) the referencing ispec transaction was initiated, or the month the referencing report was started.

WMJ

Glb.Todays_Month_Num

N

2

R

Set to the month (number) the referencing ispec transaction was initiated, or the month the referencing report was started.

WMJ

Glb.Todays_Year

N

2

R

Set to the year the referencing ispec transaction was initiated, or the year the referencing report was started.

WMJ

Glb.Total

+

12

W

Used in conjunction with the DateConvert and Determine Total logic commands.

WMJ

Glb.TPGroup

S

10

W

TPS printer group

M

Glb.TranState

N

1

R

Transaction state flag

M

Glb.TwoPC

S

1

W

Specifies the default transaction commit level of an external automatic entry.

WMJ

Glb.Unique

N

12

R

Intended for use as a unique number for each transaction.

WMJ

Glb.User

S

17

W

Used to associate a user name with output from ROC standard reports, for security purposes.

WMJ

Glb.UserCode

S

17

R

Used to identify the current user sign-on identifier – set to the network user ID.

WMJ

Glb.VersionID

S

20

R

Set to a short description of the current version of the application.

WMJ

Glb.Work

S

U

W

Intended for use transferring information between ispecs.

WMJ

Glb.YYMMDD

N

6

R

Set to the current date.

WMJ

Glb.Zeros

N

V

R

Intended for use in place of a literal value of zero.

WMJ

Input_Date

S

7

W

Set to the date on which the transaction initiated.

WMJ

Ispec

S

5

W

Set to the name of the current ispec.

WMJ

IsTemporary

B

-

W

Set to determine whether the external file attached to the extract file is to be deleted at the end of processing

WMJ

LineCount

N

4

W

Set to the number of lines of output printed on the current page of the referencing outputstream.

WMJ

LineUp

S

1

W

"Y" indicates special stationery is being used and needs lining up before printing commences

M

LineUpName

S

30

W

Set to the number of lines of report output printed on the current page of the referencing report

M

Maint

S

3

W

Used for maintaining ispec records – "ADD", "CHG", "DEL", "INQ", or "PUR"

WMJ

Name

S

256

W

Set to the name of the external file attached to the extract file.

WMJ

NumCopies

N

3

W

Set to the number of copies of the referencing outputstream that are to be printed.

WMJ

PageCount

N

5

W

Set to the current outputstream output page number.

WMJ

Pitch

N

3

W

Print pitch

M

PrintAt

S

10

W

"END" or "RELEASE"

M

PrintBanner

S

1

W

"Y" or "N"

M

PrintHost

S

17

W

Printer host name

M

Record

N

8

W

If set to a specific value, the extract file is read from the record after that specified number. If not set to a number, the read starts from the first record.

WMJ

SaveDays

N

2

W

Set to the number of days that outputstream output is to be retained by ROC.

WMJ

Source

S

1

R

Set to a value derived from the source of input of a record to the database – "G", "N", "O", "T", or space.

WMJ

Station

S

17

W

Specifies the destination of the referencing outputstream.

WMJ

Station

S

17

W

Specifies the destination of the referencing outputstream.

WMJ

Title

S

60

W

Set to the name used for output, overriding the default name of the referencing outputstream.

WMJ

TranNo

N

6

R

Incremented for each transaction – in the range 000001 through 999999.

WMJ

User

S

17

W

Used to associate a user name with output from ROC standard outputstreams, for security purposes.

WMJ