X3 Script Keywords Glossary at L.V. Expertise X3
X3 Script Keywords Glossary at L.V. Expertise X3
The Sage X3 scripting language includes a list of keywords. Not all these keywords are used, but they
remain reserved words in the language.
Keyword use
When a keyword exists, it is recognized as an element of the language regardless of its letter case. Otherwise, a
symbol is automatically created in upper case.
For example, For is a keyword in the Sage X3 scripting language; therefore, you cannot use for, fOr, foR, FOr, FoR,
fOR or FOR to define a symbol (variable, instance, class name, and so forth) in any scripting program.
Likewise, a variable called FOO can be spelled foo, Foo, fOo, foO, FOo, FoO, fOO, which represents the same variable.
The script editor will automatically rewrite it FOO.
This will change in the future when a new policy is defined, but for now it is important to have a list of all the
keywords to avoid using them inadvertently.
Keyword status
Though deprecated, some of these keywords still exist for compatibility reasons with earlier versions.
The following tables provide lists of keywords with their status and a link to the corresponding documentation if
available. for readability reasons, the deprecated and internal keywords have been put on separated tables.
The different statuses for these keywords are:
Deprecated Classic: The keyword must not be used in version 7 style programming, and also in version 6
style programming for Classic mode. It must therefore be replaced in V6 code to use it in Classic mode.
Deprecated: The keyword must not be used in version 7 style programming, although it can still be used in
version 6. Its availability in future versions is not guaranteed.
Internal: This keyword can only be used by the supervisor layers. Its use is strongly discouraged since its
behavior is subject to change without notice.
Public: This keyword already exists in version 6 and can be used without restrictions.
New: This keyword has been introduced in version 7 and can be used without restrictions.
Links are available from the keyword to the detailed documentation when applicable.
List of keywords
System variables or methods Instructions of the language Functions of the language
adxftl Public Defines the cache size for database "Read" operations
adxifs Public Field separator for sequential file operations
adxwrb Public Defines the cache size for database "Writeb" operations
currind Public Current index used by default on a database table
currlen Public Defines the size of the current key (see currkey)
dbgmode Public variable that enables or disable the ability to run the debugger.
fstat Public Returns a status (return code) of last database or sequential file operation
getaccessorenabled New Defines if the "Get" accessor is enabled on an instance
updtick New Column storing the "revision number" for a database table line
2. Language instructions
Public and new keywords
Assign Public Assigns a variable given by a string value with a computed value
Blbfile Public BLOB declaration
Columns Public Defines a list of columns that will be read on a database table on "For" loops
Commit Public Triggers a "Commit" of modifications done in the database
Look Public Performs a select on a database without filling the [F] buffer
Method New Method declaration
Nohint Public Disables default hints sent to the database in SQL queries
Onerrgo Public Declares a label in which a branch will be done if an error occurs
Prev Public Reads the previous line in different database access syntaxes
Putseq Public Writes data in binary mode in a file
Rewritebykey New Updates the current line in the database (with a condition on "Updtick")
Rollback Public Performs a rollback on the current database transaction
To Public Used in the "For" syntax to define the end value for a variable loop
Trbegin Public Starts a database transaction
GetNextChildByName Internal
GetLastChildByName Internal
GetNbChild Internal
GetChildByName Internal
GetChildByType Internal
GetRootElement Internal
GetParent Internal
checkpath New i=checkpath(s,i) checks the path validity against engine sandbox
rules
chr$ Public s=chr$(i) Character from ASCII code
freeheap Public n=freeheap Gives free memory available in the object heap
freemem Public n=freemem Gives free memory in the common memory segment
getBit Public b=getbit(i,i) Extracts out of an integer the value of the bit in the
rank i
getenv$ Public s=getenv(s) Access to variable environment values
setBit Public i=setbit(i,i,b) Sets the one of the bits of an integer to a given value
sgn Public i=sgn(n) Returns the sign (+1/-1) of a number
time$ Public s=time$ Returns a string giving the current time on the server
timestamp$ Public s=timestamp$ Returns a string containing the digital representation
of a time stamp
tolower Public s=tolower(s) Transforms the upper case characters in a string into
lower case
toSData Public s=toSData(s,s,s) Transforms an X3 where sentence in a valid SData
expression
toupper Public s=toupper(s) Transforms the lower case characters in a string into
upper case
touuid New s=touuid(u) Transforms a string representation of a "UUID" into a
"UUID"
trtcou Public s=trtcou Returns the name of the current executed Sage X3
script file
type Public i=type(p) Returns the type of a variable
adxioa internal
adxnfs Internal
adxpam Deprecated
adxpid Internal
clactxvar Internal
callstack Internal S=callstack(i)
dbgbreakpointadd Internal
dbgbreakpointget Internal
dbgbreakpointlist Internal
Dbgbreakpointremove Internal
Dbgbreakpointupdate Internal
dbgevalue Internal
dbgevalue2 Internal
dimctx Internal n=dimctx(s,n)
entete Deprecated
errnremote Internal s=errnremote
filcom Internal
filecla Internal
filelev Internal
filetyp Internal
freesyssnapshot Internal
funciu Deprecated
getsysmodified Internal
graph$ Deprecated
inpmode Deprecated
IsOpenAdxd Internal
jsonproto Internal
maskabr Deprecated
maskcla Deprecated
maskcou Deprecated
masklev Deprecated
masknam Deprecated
masknbf Deprecated
maskrk Deprecated
masksiz Deprecated
tab$ Deprecated
typectx Internal i=typctx(s,n)
varinit Deprecated
varmode Deprecated
Index Home