Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Functional Listing of Shareable Tools

Functional Listing of Shareable Tools
Batch Jobs (z/OS)
BATCH – Submits a batch job to a particular queue, views the status of the batch jobs, and views the queues that are available. (E)
BATCHLOAD_CARDS – Defines input and output to the Batch Load utilities (S6BBRTBL/hrnbrtbl). (E)
$BATCHOPT(batch_option, option_value) – Sets the batch options associated with a SCHEDULE TO statement’s batch request, which sends the batch job to a queue. (C)
BATCHUNLD_CARDS(unload_source) – Defines the control cards required by the Batch Unload utilities. (E)
Data Object Broker Information and Operations
DASTATS – Returns statistical data collected by the Data Object Broker for an individual segment. (F)
DISPLAY_USERS – Displays a list of all users currently logged in to TIBCO Object Service Broker. (E)
HURON_STATS – Displays statistics for performance analysis and problem determination. (E)
OPSTATS – Returns statistical data collected by the Data Object Broker. (F)
S6BNOTIFY – Sends a Notification message to TIBCO Hawk. (C)
S6BTROFF – Terminates tracing initiated by the complementary shareable tool S6BTRON. (C)
S6BTRON – Initiates tracing of rules execution in the current session. (C)
Dates and Times
$ADD_DATE(date, component, amount) – Adds or subtracts a component (such as a day, week, month, or year) to or from a date and returns a new date value. (F)
$CREATE_DATE(pic_string, date_string) – Converts a string with a specified format to a value of semantic type date. (F)
$DATE_DEFAULT – Returns the default date format used by the installation. (F)
$DATE_LENGTH(pic_string) – Returns the maximum string length of a given date format. (F)
$DATE_PIC(pic_string, date) – Converts a value of semantic type date to a semantic type string. (F)
$DATE_REF(component, duration, date, round) – Adds or subtracts a given number of days to or from a reference date, and converts the number of days returned to units of a day, a week, a month, or a year. (F)
HOUR – Returns the hour of the day when the current transaction started. (F)
LEAPYEAR(year) – Returns a logical value indicating whether a given year is a leap year. (F)
LOCALTIME – Returns the local time when the transaction started. (F)
MINUTE – Returns the minute in the hour the transaction started. (F)
REALTIME – Returns a string containing the current time of day. (F)
$REALTIMER – Returns the number of micro-seconds since 1 January 1980. (F)
SECOND – Returns the second within the minute that the transaction started. (F)
$SLEEP(milliseconds) – Causes the Execution Environment to go dormant. (C)
$SYSTEMDATE – Returns the date when $SYSTEMDATE is called. (F)
TIME – Returns a string containing the time of the day when the transaction started. (F)
$TRXDATE – Returns the start date of the transaction that called this tool. (F)
UTCDATE – Returns the Coordinated Universal Time (UTC) date when UTCDATE is called. (F)
UTCTIME – Returns a string containing the current Coordinated Universal Time (UTC) time. (F)
YEAR – Returns the two-digit year when the transaction started. (F)
Debugging
DEBUG(rulename) – Invokes the interactive Rule Debugger. (CE)
$GTFSET(function, keyname, userid, termid, all, dob) – Enables or disables the rules tracing facility in the Execution Environment and the Data Object Broker.
@MESSAGEDUMP – Writes traced messages to this table in HEX form, when @TRACEMESSAGES.DUMP is set to Y. (TBL)
@MESSAGETRACE – Stores table access message requests between the Execution Environment and the Data Object Broker collected when using trace facility. (TBL)
@TRACEMESSAGES – Records message traffic between the Execution Environment and the Data Object Broker. (TBL)
Definitions of Objects
COPY_DEFN(objecttype, instancename, library, environment, srclocation, destlocation, parentonly) – Copies the definition of one or more objects from a source location to a destination location. (C)
COPYDEFN – Copies the definition of one or more TIBCO Object Service Broker objects or object sets. (E)
DEFINE_OBJECTSET(objsetname) – Defines a set of objects or modifies an existing set. (E)
DELETE_DEFN(objecttype, instancename, library, environment, location, parentonly) – Deletes the definition of an object. (C)
DIFF_DEFN(objecttype, instance1, library1, environment1, location1, instance2, library2, environment2, location2, details) – Compares the definitions of two objects and list the differences. (F)
DIFFDEFN – Compares the definitions of one or more pairs of objects and list the differences. (E)
External Databases and Servers
CHANGE_SERVERID(table_name, old_serverid, new_serverid) – Updates the server ID of any external TIBCO Object Service Broker data types. (E)
@CONFIGURESERVER(type) – Sets and modifies the server configuration parameters for a particular server ID. (E)
DATACOM – Displays a menu to manage the definition of CA-Datacom data. (E)
ESTIMATETBLDFN(num_fields) – Returns an estimate of the maximum CTABLESIZE and XTABLESIZE required for each table type. (E)
$HTTPREQUEST –Returns the HTTP response code from an HTTP request. (F)
IDMS – Displays the main menu used to define a CA-IDMS database to TIBCO Object Service Broker. (E)
IMS – Displays the main menu used to define an IMS/DB database to TIBCO Object Service Broker. (E)
@PEERSERVERID – Directs remote TIBCO Object Service Broker table accesses to a particular peer server on a remote TIBCO Object Service Broker system. (TBL)
RESETXPARM(component, entity, parm name, location) – Resets overrides on server parameters or on default field values set in the Table Definer. (C)
@SERVERERROR(RETURN_MESSAGE) – Returns the last message from the message stack to enable special parsing or handling of the message, which resulted from a request to the TIBCO Object Service Broker external DBMS server. (C)
SETXPARM(component, entity, parm name, value, location) – Overrides a server parameter or the Table Definer default value for a field at table access time. (C)
@STATICSQL – Defines and generates static SQL to be used to access DB2 data. (E)
External Memory and Routines
$GETENVCOMMAREA(segment#) – Retrieves data passed into TIBCO Object Service Broker from a calling environment that is not TIBCO Object Service Broker. (F)
HLIPREPROCESSOR(hostlang, imbedlang, infile, outfile, listfile, options) – Invokes a language pre-processor to run against COBOL source programs that contain embedded TIBCO Object Service Broker access statements or SQL statements. (C)
@MAP – Registers and allocates storage for use with MAP tables. (TBL)
RETURN_CODE – Returns the return code from the last call of a TIBCO Object Service Broker external routine. (F)
S6BCALL – Invokes a TIBCO-supplied callable routine that requires a specialized environment. (C)
S6BFUNCTION – Invokes a TIBCO supplied function that requires a specialized environment. (F)
$SETENVCOMMAREA(value, segment#) – Passes data from TIBCO Object Service Broker into a calling environment that is not TIBCO Object Service Broker. (F)
$SETSESSIONEND(action, value) – Sets what execution is to take place when a TIBCO Object Service Broker session ends by returning data from the session to an external environment. (C)
Installation of Components
@INSTALL(component [path]) – Requests the installation of the specified component. (CE)
@UNINSTALL(component) – Requests that the specified component be uninstalled. (CE)
Load from/Unload to External Files
BATCHLOAD_CARDS – Defines input and output to the Batch Load utilities (S6BBRTBL/hrnbrtbl). (E)
BATCHUNLD_CARDS(unload_source) – Defines the control cards required by the Batch Unload utilities. (E)
EXPOCC_SIZE(table) – Returns the minimum record size required to hold the occurrences of the table being unloaded. (F)
LLOAD(importfile, media) – Loads definitions and data of TIBCO Object Service Broker objects that were previously unloaded from files with names in mixed case or lowercase. (CE)
LOAD(importfile, media) – Loads definitions and data of TIBCO Object Service Broker objects that were previously unloaded. (CE)
LOADER – Loads definitions and data of TIBCO Object Service Broker objects that were previously unloaded, with selection control. (CE)
UNLOAD – Unloads definitions of valid TIBCO Object Service Broker object types from a source system to a z/OS data set or a Windows or Solaris file. Data from table object types could also be unloaded. (E)
UNLOAD_DATA(tablespec, selection, location) – Unloads the data of a table to a z/OS data set or a Windows or Solaris file. (C)
UNLOAD_DEFN(objecttype, objectname, library, location, presentationenv, parentonly) – Unloads the definition of a TIBCO Object Service Broker object to a z/OS data set or a Windows or Solaris file. (C)
UNLOADLIBRARY(library, location) – Unloads all rules in the specified library at the specified location to a z/OS data set or a Windows or Solaris file. (C)
Mathematical Calculation
ABS(value) – Returns the absolute value of a number. (F)
MAX(x, y) – Returns the larger of two given values. (F)
MIN(x, y) – Returns the smaller of two given values. (F)
MOD(dividend, divisor) – Returns the modulus from dividing the dividend by the divisor. The function MOD handles negative dividends and divisors. (F)
NUM_CHK(val) – Determines if a given string satisfies the TIBCO Object Service Broker definition of a numeric literal. (F)
RANDOM(rangelimit) – Returns a random integer between one and the specified limit. (F)
RANDOMSEED(seed) – Sets the starting seed for the random number generator. (C)
REMAINDER(dividend, divisor) – Returns the remainder from dividing the dividend by the divisor. (F)
ROUND(value) – Returns the specified value rounded to the nearest integer. (F)
Menus
DEFINE_MENU(menu) – Creates and modifies menus and login screens used within TIBCO Object Service Broker user-defined applications. (E)
DISPLAY_MENU(menuname) – Calls a specific menu into an application. (C)
Messages and Message Logs
ENDMSG(message) – Sets the transaction completion message. (C)
GETENDMSG – Returns the current value of the end-of-transaction message. (F)
LOG_BROWSE – Displays the contents of the message log. (C)
MESSAGE(utility, msg_num, tokenlist) – Returns a customized message by taking a root message in the MESSAGES table and inserting customizing tokens. (F)
MESSAGE_LOG(msglog, destin) – Preserves the contents of the message log across transactions. (C)
MSGLOG(string) – Inserts the specified string as a line in the TIBCO Object Service Broker message log. (C)
RETURN_SYSMSG – Returns the last $SYSCALL system error message when an exception is raised. RETURN_SYSMSG is a low-level tool that must be called immediately after an exception is trapped. (F)
S6BCALL(’api_call’,parameters) – Invokes a TIBCO-supplied callable routine that requires a specialized environment. (C)
Message Oriented Middleware
@MOMCLOSE(connection, queue) – Closes a Message Oriented Middleware (MOM) message queue. (F)
@MOMCOMMIT(connection) – Commits all changes to queues from a single Message Oriented Middleware (MOM) message manager. (C)
@MOMCONNECT(name) – Connects to a Message Oriented Middleware (MOM) message queue (MQ) manager. (F)
@MOMDISCONN(connection) – Disconnects from a Message Oriented Middleware (MOM) message manager. (F)
@MOMGET(connection, queue, table) – Reads a message from a Message Oriented Middleware (MOM) message queue. (C)
@MOMINIT(buflen, mon_type) – Identifies the type of Message Oriented Middleware (MOM) message manager, and initializes its environment (map and control structures) to enable subsequent @MOM calls. (C)
@MOMMAPLENGTH(table_name) – Returns the length of a MAP table. (F)
@MOMOPEN(connection, name) – Opens a Message Oriented Middleware (MOM) message queue. (F)
@MOMOPTION(description) – Queries the numeric equivalent of a Message Oriented Middleware (MOM) option. (F)
@MOMPUT(connection, queue, table, len) – Writes a message to a Message Oriented Middleware (MOM) message queue. (C)
@MOMROLLBACK(connection) – Backs out all database changes from a single Message Oriented Middleware (MOM) message manager since the start of the transaction or since the previous @MOMCOMMIT. (C)
@MOMSETOPT(description) – Sets a MOM option to a specified value. (C)
@MOMSPECIALCMD(manager_name, queue_name, command) – Sends a Message Oriented Middleware (MOM) command to a queue listener task. (C)
@MOMVALIDRC – Checks the return code of a previous command. (C)
@MQSMAP and @MQSMAP_PORT– Registers and allocates storage for use with the MQSMAP table. @MQSMAP is for use on z/OS and @MQSMAP_PORT on Open Systems. (TBL)
Printing and Output
$BLANKPAGE(titles_yn) – Outputs a blank page. (C)
$FLUSHPRINT – Releases output into the print spool. (C)
$NEWPAGE – Positions subsequent output to the top of a new page. (C)
PRINT_DATA(tablespec, select, sourceloc) – Prints the data of a TIBCO Object Service Broker table. (C)
PRINT_DEFN(object, instance, library, environment, srcloc, parentonly) – Prints the definition of a TIBCO Object Service Broker object. (C)
$PRINTFIELD(string, pos, length, fill, just) – Writes the specified string into the current printline. (C)
$PRINTLINE(text) – Prints a string. (C)
PRINTTABLE(tablespec, pagelength, pagewidth, media) – Prints a table. (C)
PRT_VSCR(vscr, page_length, page_width, page_start, media, mask) – Prints the screen fields of a defined screen in a page format, with or without a mask. (C)
$PUTLINE – Prints the current line constructed by $PRINTFIELD. (C)
$RESETPRINT(length, width, page_number, media) – Resets the output arguments. (C)
$SETP#POS(line_number, left_string, center_string, right_string) – Defines the position and content of page number lines. (C)
$SETPRINT(length, width, page_number, media, clear_title_yn) – Initializes the print attributes or, if they are already set, uses it to clear the titles for the output on the following pages. (C)
$SETTITLE(line_number, left_string, center_string, right_string) – Sets a title or footer to be printed on subsequent pages of output. (C)
$SKIPLINE(count) – Outputs zero or more blank lines. (C)
$TOCPRINT(fill_char) – Prints table of contents. (C)
$TOCPUT(section_name, spacing, numbering_yn) – Puts a line in the table of contents. (C)
S6BCALL – Invokes a TIBCO-supplied callable routine that requires a specialized environment. (C)
S6BFUNCTION – Invokes a TIBCO-supplied function that requires a specialized environment. (C)
Promotions
ADMIN_RIGHTS – Obtains, releases, or transfers the promotion rights on objects. (E)
DBMAINTLVL – Displays the maintenance level of your TIBCO Object Service Broker database, including any database PTFs applied beyond the maintenance level. (E)
MANAGE_APPLY – Invokes the Promotion facility on the target system. (E)
MANAGE_REQUESTS – Invokes the Promotion facility on the source system. (E)
MANAGE_RIGHTS – Releases or transfers a user’s promotion rights on rules, screens, reports, menus, object sets, and tables. (E)
@PROMBINDOBJS – Restores the bind flag settings for the objects updated by @PROMUNBINDOBJS. (E)
PROM_MAIN – Invokes directly the Promotion system. (E)
@PROMUNBINDOBJS – Stores the current setting of the bind flag for a set of objects and reset the values to N in the metadata tables. (E)
RMANAGE_REQUESTS – Manages change requests for systems where the source system is remote to the target system. (E)
Read from/Write to External Files
ALLOCDSN(ddname, dsname) – Allocates a file to a z/OS DDNAME. (C)
@CLOSEDSN – Closes and frees the current file. (C)
$LISTDSN(dsname_level, buffer_address) – Lists the non-VSAM data sets and Generation Data Group (GDG) data sets of a certain level, using the z/OS Catalog Search Interface services. (C)
$LISTPDS(pds_name, buffer_address, member_name) – Lists the member names of a partitioned data set (PDS), or retrieves the statistics for a PDS member. (C)
@OPENDSN(dsname) – Specifies the name of the file that is subsequently used by @READDSN or @WRITEDSN. (C)
@READDSN – Returns the next record from the current file. (F)
@WRITEDSN(string) – Writes a record to the current file. (C)
XMLPARSE – Initiates the parsing of an XML document. (C)
XMLSTART(xmldocname, predicate, parm) – Generates an XML document based on the passed data access arguments. (C)
XMLSTARTDSN(outdsn, xmldocname, predicate, parm) – Generates an XML document based on the passed data access arguments and places it in the specified file. (C)
XMLSTARTSETDEST(tablendpec, fieldspec) – Sets up the output table and field for XMLSTART. (C)
XMLSTARTTAB(tablename, format, predicate, parm) – Returns a table to the OIG client. (C)
Reports
DEFINE_REPORT(reportname) – Defines a new TIBCO Object Service Broker report or modifies an existing one. (E)
GENERATE_REPORT(reportname) – Defines a new report or modifies an existing report using the Report Generator. (E)
$RPTIMMEDIATE(reportname, media) – Sends the records to the output as they are read, without sorting. (C)
$RPTOCCLIMIT(reportname, occlimit) – Limits the number of occurrences used to generate the report. (C)
$RPTOVERLAP(report, reporttable, reportfield, BLANKOVERLAP) – Designates the report tables or report fields that are not to be printed on the overlapping page of a merged report. (C)
$RPTPARMS(reportname, length, width, eject, pagenumber) – Controls explicitly the physical output of a report. (C)
$RPTPRINT(reportname, media) – Prints a report to the media specified. (C)
$RPTSKIPLINES(reportname, reporttable, element, linesbefore, linesafter) – Controls explicitly the spacing of a report. (C)
$SETRPTATTRIBUTE(report, attribute, value) – Sets the attributes of the report that is to be printed. (C)
$SETRPTMEDIUM(report, mediumtype, medium) – Sets the medium to which a report is to be printed. (C)
Rules and Rules Libraries
$CALLRULE(rulecall) – Invokes a procedural rule. (C)
CHANGERULE – Makes multiple text changes across multiple rules in a library. (CE)
COPYLIB(source_lib, dest_lib) – Copies all the rules from a source library to a destination library. (C)
DEFINE_LIBRARY(libraryname) – Defines a new library, displays a list of the rules in a library, or displays a list of the rules libraries. (E)
EDITRULE(rulename) – Defines a new TIBCO Object Service Broker rule or modifies an existing one. (E)
$EXCEPTION – Returns the name of the last exception signalled within the current transaction by either a SIGNAL statement, a $SIGNAL call, or the system (GETFAIL, ZERODIVIDE, and so on). (F)
$EXCEPTIONOBJECT – Returns the name of the object (for example, a table) associated with the last exception signalled within the current transaction, if that exception is of the type that can be trapped with an ON exception_name object_name: statement. (F)
$FUNCTION(rulecall) – Invokes a functional rule. (C)
INSTALLIB – Returns the name of the currently designated installation library. (F)
LIBID – Returns the name of the currently designated local library. (F)
NOOP – Does nothing. (C)
$RULE_EXISTS(rule) – Checks whether a rule with the given name would be a candidate for execution. The rule can be a rule in the current search path, a TIBCO Object Service Broker routine, or an external routine with an available and executable load module. (F)
$RULENAME(level, transactioncount) – Retrieves the name of a rule from the current execution stack. (F)
RULEPRINTER(rule) – Prints a rule or prints an application structure using the root rule as the base. (E)
SEARCHLIB – Searches all rules or specified rules in a library for a given string. (CE)
$SIGNAL(exception, tablename) – Raises the specified exception. (C)
SYSTEMLIB – Returns the name of the currently designated system library. (F)
$TRXMODE – Retrieves the transaction mode of the current rule. (F)
$TYPECAST – Converts a variable according to the arguments supplied. (F)
Screens
$BEEP(repetition) – Issues the specified number of beeps from the terminal. (C)
CONFIRMACTION(screen, confirmmsg, key, defaultmsg, table, commandfield) – Issues a confirmation message for a PF key action or for a specified command. (C)
CURSOR_FLDCOL(screen) – Returns the relative column number within the field containing the cursor. (F)
CURSORFIELD(screen) – Returns the name of the field where the cursor is located. (F)
CURSOROCC#(screen) – Returns the occurrence number within the screen table where the cursor is positioned. (F)
CURSOROCC_VALUE(screen, scrtbl, scrfld) – Returns the value of a particular screen field that is selected by the cursor. (F)
CURSORTABLE(screen) – Returns the name of the screen table where the cursor is positioned. (F)
DELETESCREENDATA(screen) – Deletes all the occurrences from all the screen tables of a screen. (C)
DRAW(screenname) – Defines a new TIBCO Object Service Broker screen or modifies an existing one. (E)
ENTERKEY(screen) – Returns the name of last key used when the specified screen appeared. (F)
EVENTSCREEN – Returns the name of the screen that activates the current screen validation rule. (C)
EXIT_DISPLAY – Signals the standard exception EXIT_DISPLAY. (C)
FCNKEY_MSG(screen) – Creates a string containing the function keys defined for a screen. (F)
$GETATTRIBUTE(screen, table, field, attribute) – Queries the current attributes for the field of the screen table, in the specified screen. (F)
$GETCOLOUR(screen, table, field, color_type) – Queries the current color of a screen field. (F)
@PRESENTATIONENV – Returns the name of the presentation environment for the current session. (F)
PROCESS_FCNKEY(screen) – Processes the function keys while a screen is being displayed. (C)
SCREENCOL – Returns the number of columns on the user’s physical screen. (F)
SCREENMSG(name, msg) – Displays the given message in the message area of the specified screen. (C)
SCREENROW – Returns the number of rows on the user’s physical screen. (F)
$SETATTRIBUTE(screen, table, field, attribute, flag) – Sets attributes for the field of the screen table, in the specified screen. (C)
$SETCOLOUR(screen, table, field, color_type, color) – Sets the color of a screen field. (C)
SETCURSOR(screen, table, field) – Positions the cursor in the field of the screen table, in the specified screen. (C)
SETCURSOR_POS(screen, table, field, occurrence_number, column_offset) – Positions the cursor in the column of the field of the occurrence, in the screen table of the screen. (C)
Searches for Objects
CROSSREFSEARCH(querystring, querykind, library) – Searches the cross reference index of the specified library to answer a query. (C)
KEYWORDMGR – Ensures that the TIBCO Object Service Broker keyword system conforms to the established formatting standards and that the keyword index table is up-to-date. (E)
KEYWORDSEARCH(querystring, object_type) – Searches the keyword index of a default library to answer a query. (C)
REFMAKER(library) – Rebuilds the global cross reference index. (E)
SEARCH – Searches the keyword or cross reference indexes to answer a query. (E)
SEARCHLIB – Searches all rules or specified rules in a library for a given string. (CE)
Secondary Indexes
SIXBUILD(table, secondary_key) – Creates a secondary index online for a TDS table. (C)
SIXBUILD_CARDS – Defines the control cards required by the Batch Secondary Index Build utilities. (E)
SIXDELETE(table, secondary_key) – Deletes an existing secondary index. (CE)
Security
AUDITLOG – Invokes the Query Audit Log tool. (CE)
BATCH_ENABLE(wipe_existing) – Enables all the object sets previously processed using @MAKEMEMBERS. (C)
CREATEUSERS(input_table, modeluser) – Creates a list of new user IDs and adds them to the TIBCO Object Service Broker system. (E)
@MAKEMEMBERS(objectset) – Creates the member list for an object set to be enabled through the BATCH_ENABLE utility. (CE)
@MNG_USERS – Modifies your user security profile. (E)
PURGELOG_BATCH(fromdate, todate, file) – Purges the audit log data from the TIBCO Object Service Broker audit log table and archive to an external file. (CE)
PURGELOG_SCREEN – Specifies the archive file for the audit log data and purges the audit log data to the specified archive file. (CE)
SEC_REBIND(object, parmcat, name) – Rebinds all security data previously bound in the Execution Environment storage. (C)
SECURITY – Invokes the TIBCO Object Service Broker Security Manager main menu. (E)
Selection Lists
DEFINE_OBJLIST(table) – Defines, for a table, an object list to appear using the Object Manager or modifies an existing object list definition. (E)
OBJECT_MGMT(tablespec) – Displays the contents of a table and enables a predefined set of commands that are unique to the table to operate on the display. (E)
OBJECTMGR(tablespec) – Displays the contents of a table and enables a predefined set of commands that are unique to the table to operate on the display. (C)
OPTIONLISTER(optionlistname) – Displays options in columns and returns the ones selected (C).
SELECT_OBJ(name, type, unit, author, library, location, children, subtype) – Provides a screen that can be used to list and select objects that meet specified criteria. (C)
Session Options and Parameters
$GETOPT(option_name) – Returns the value of a session parameter or option. (F)
$GETTRANSACTION(name) – Gets a transaction name set by $SETTRANSACTION. (F)
REMOTELOCATION – Returns the current value of the default remote location. (F)
@SESSION – Alters session-related items maintained by this table. (TBL)
@SESSIONCOUNTS – Obtains information on events occurring within the Execution Environment during a session. (TBL)
SESSMGR – Displays the login interface to the Session Manager (workbench).
$SETOPT(parameter, value) – Sets the value of a session parameter or option. (C)
$SETTRANSACTION(field, value) – Returns the current name of a TIBCO Object Service Broker transaction and sets a new name. (F)
SETREMOTELOC(remoteloc) – Sets the default remote location for distributed data processing. (C)
USERID – Returns a string containing the user ID. (F)
Strings and Text
FROM_UNICODE(unistring, externalcodepage) – Converts a Unicode string to Raw Data encoded in an external Code page.(F)
GEN_TED(tablespec, screenname, screentablename) – Presents a screen where text can be entered and edited under the control of the text editor. (C)
GENBIN(value, length) – Returns a syntax V string containing the same internal binary value as the input numeric value, right-justified.(F)
GENFLOAT(value, length) – Returns a syntax V string containing the same internal float representation as the input float value, left-justified. (F)
GENPACK(value, length, decimal) – Returns a syntax V string containing the same internal packed decimal value as the input syntax P value, right-justified. (F)
$GET_DECIMALS(value) – Retrieves the number of decimal places for an expression. (F)
$GET_MAXSIZE(value) – Retrieves the dictionary size of an expression. (F)
$GET_SIZE(value) – Retrieves the size of an expression. (F)
$GET_SYNTAX(value) – Retrieves the syntax of an expression. (F)
$GET_TYPE(value) – Retrieves the semantic type of an expression. (F)
$GETBINARY(string, offset, length) – Stores character data in binary format. (F)
GETCHAR(string) – Returns the first character from the specified string, removing it from the string. (F)
$GETFLOAT(string, offset, length) – Stores character data in floating format. (F)
$GETPACKED(string, offset, length) – Stores character data in packed decimal format. (F)
HEADSTRING(string, length) – Returns the head portion of the specified string. (F)
LENGTH(string) – Returns the length of the specified string. (F)
LIT_TO_VAL(string) – Converts a string to a typeless field as described in the string. (F)
LOWER_EBCDIC(string) – Converts a string to lowercase EBCDIC characters. (F)
LOWER_UNICODE(string) –Converts a string to lowercase Unicode characters. (F)
LOWERCASE(string) – Converts all uppercase characters in a string to lowercase characters. (F)
MATCH(string, pattern) – Returns the starting position, in characters, of the specified pattern in the specified string, relative to the start of the string. (F)
PAD(string, length, padcharacter, just) – Returns a string padded to a specified length using a pad character, positioning the string to the left, right or center of the padding. (F)
PARSE(grammar_usage, string) – Breaks up an input string into tokens and applies grammar rules to the tokens. (C)
PATTERN_MATCH(string, pattern) – Determines whether a string matches a given pattern. (F)
PEEL(peelchars, string) – Returns the result of removing the specified leading and trailing characters from the specified string. (F)
PEEL_HEAD(char, string) – Removes the specified leading characters from a given string. (F)
PEEL_TAIL(char, string) – Removes the specified trailing characters from a given string. (F)
$PIC(value, mask) – Returns a number in a format specified by a mask. (F)
QUOTE(string) – Returns a string with single quotation marks around it and doubles any single quotation marks in the string. (F)
SCRIPT(source, dest) – Uses commands to format text from a table and store the formatted text in another table. (C)
SEARCH_REPLACE(input_string, replace_this, with_this, else_with_this) – Replaces all occurrences of a pattern with specified characters. (F)
SUBSTRING(string, start, length) – Returns a selected portion of a string. (F)
TAILSTRING(string, length) – Returns the tail portion of the string. (F)
TED(text_input) – Displays a table for text editing. (E)
TEXTSETUP(setupname) – Defines a setup for formatting a text document. (E)
TOKEN(string) – Parses an input string and returns the first token and the string with the token removed. (F)
TO_UNICODE(rdstring, externalcodepage) – Converts a raw data string encoded in an external code page to Unicode.(F)
$TYPECAST(type, syntax, size, decimals, value) – Converts a variable according to the arguments supplied. (F)
$UNPIC(picVal, mask) – Determines the original value submitted given a masked value produced by $PIC and the display mask that produced it. (F)
UNQUOTE(string) – Returns a string with the single quotation marks removed. (F)
UPPER_EBCDIC(string) – Converts a string to uppercase EBCDIC characters. (F)
UPPER_UNICODE(string) – Converts a string to uppercase Unicode characters. (F)
UPPERCASE(string) – Converts all lowercase characters in a string to uppercase characters. (F)
VAL_TO_LIT(string) – Converts a field to a string containing a token describing its value. (F)
VALID_NAME(name) – Determines if a given string satisfies the TIBCO Object Service Broker definition of an identifier. (F)
Table Definitions and Data
BROWSER(tablespec) – Displays the contents of a TIBCO Object Service Broker table for viewing. (CE)
CLEARTABLE_APPL(table, select) – Deletes occurrences from a table or table instance. (E)
$CLRTAB(tablename, parm1, parm2, parm3, parm4) – Deletes (clears) the data rows from a table or table instance without reading the data rows. (C)
COPY_DATA(srctabspec, select, desttabspec, srclocation, destlocation, overwrite) – Copies data from one table or table instance to another table or table instance. (C)
COPYTABLE_APPL – Copies selected occurrences from a source table to a destination table. (E)
COUNTOCCURRENCES(table, selection) – Returns the number of occurrences that meet a selection criteria. (F)
DEFINE_TABLE(tbl_name) – Defines a new TIBCO Object Service Broker table or modifies an existing one. (E)
DELETE_DATA(tablespec, select, location) – Deletes the data from a table or table instance. (C)
DIFF_DATA(table1, field1, location1, selection1, table2, field2, location2, selection2, printresult) – Compares the data of two tables or table instances and lists the differences. (F)
EVENTTABLE – Returns the name of the table that activated the current derived field rule, trigger rule, or validation rule. (F)
FLDMGR(fieldname) – Adds fields to the global field dictionary. (E)
FORALLA(table, parm, selection, ordering) – Returns the first table occurrence that satisfies the selection criteria. Use if the value of every table parameter and every selection criterion is 99 or fewer characters long. (C)
@FORALLA(table, parm, selection, ordering) – Returns the first table occurrence that satisfies the selection criteria. Use if the value of any table parameter or of any selection criterion is 100 or more characters long. (C)
FORALLB(table) – Returns the next table occurrence that satisfies the selection criteria following a call to FORALLA. (C)
FORALLE(table) – Releases internally the resources used by FORALLA on a table. (C)
MOVTAB(tablename, segmentID) – Changes the segment number of a table. (CE)
INDEXCHK – Estimates the maximum number of data rows a table can contain before reaching the maximum index levels. (E)
NLS – Enables the database administrator to set code page values in translation tables. (E)
OBJECTMGR(tablespec) – Displays the contents of a table and enables a predefined set of commands that are unique to the table to operate on the display. (C)
PARMVALUE(parmname) – Returns the value of the parameter from the table that was accessed when the trigger or validation rule was activated. (F)
PARSE_TAM(string) – Breaks up an input string into a table specification, and optionally, the WHERE clause and the ORDERED clause of the corresponding table access statement. (C)
PROCESS_TABLE(tablespec, selection, ordering, processrule) – Provides specific processing for every occurrence in a table that is selected, ordered, or both selected and ordered. (C)
RETURN_MESSAGE – Returns the system error message whenever an exception is raised. RETURN_MESSAGE is a low-level tool that must be called immediately after an exception is trapped. (F)
SETNLSBIT(table, flag) – Sets the NLS bit for the specified table, in the RESERVED field of the TABLES table. (C)
SIMPLESELECT(selection) – Processes a selection string into a format that can be used by the FORALLA tool. (C)
SOE(tablespec) – Edits a single occurrence in a table. (CE)
STE(tablename) – Invokes the Table Editor. (CE)
STEBROWSE(input) – Views the contents of a TIBCO Object Service Broker table. (E)
TABLEPRINT(tablespec) – Prints the contents of a table or of a set of joined tables. (E)
Trigger or Validation Rules
EVENTSCREEN – Returns the name of the screen that activates the current screen validation rule. (C)
EVENTTABLE – Returns the name of the table that activated the current derived field rule, trigger rule, or validation rule. (F)
PARMVALUE(parmname) – Returns the value of the parameter from the table that was accessed when the trigger or validation rule was activated. (F)

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved