Quick Reference 1
PF Keys Primary Commands
Supported on Every TIBCO Object Service Broker APPLY object_command Screen [WHERE field relational operator value {& / | field relational operator value}]
Mask Characters Keywords Syntax
You can add a display mask to a field of semantic data type B or P from the Report Definer, Report Generator, AND ASCENDING BROWSE Syntax Valid Lengths (bytes) Screen Definer, and various shareable tools. CALL COMMIT DELETE B 2 – 12 Numeric Mask Characters Binary DESCENDING DISPLAY END C • 1 – 127 (key field or parameter) Digit Leading Example EXECUTE FORALL GET Fixed Length • 1 to the maximum length for an Placeholder Character Character String occurrence 9 0 $PIC(12, '999') => '012' IN INSERT LIKE • 1 – 254 (display fields) Z blank $PIC(12, '$ZZZ') => '$ 12' LOCAL NOT NULL F • 4, 8, and 16 N null $PIC(12, '$NNN') => '$12' Floating Point • 24, 56, and 112 binary digits of preci- ON OR ORDERED sion for the mantissa * * $PIC(12, '$***') => '$*12' -79 75 PRINT REPLACE RETURN • 5.4 x 10 to 7.2 x 10 for approxi- mate range Other Mask Characters ROLLBACK SCHEDULE SIGNAL P 1 – 16 (holds 1 – 31 decimal digits) Packed Decimal Character Purpose TO TRANSFER- UNTIL CALL RD 5 to the maximum length for an occur- V Character after V is decimal placeholder. Raw Data rence UPDATE WHERE + Display plus (+) for positive number and dash UN • 2 to the maximum length for an (-) for negative. Unicode occurrence - Display blank for positive number and dash (-) • Must be even for negative. V • 1 – 127 (key field) Variable Length • 1 to the maximum length for an Character String occurrence • 1 – 254 (display fields) W 4 to the maximum length for an occur- Double-byte or rence Single-byte Valid on z/OS only Character String Quick Reference 3
Wildcard Characters Semantic Data Types Standard Line Commands
You can use LIKE to perform partial matches when using SELECT or FIND. The string that you use must Semantic Possible Valid D Delete the object. Description be enclosed in single quotation marks. You can use the Data Type Operators Syntax following wildcard characters in conjunction with P Print a hardcopy. LIKE: C Integers for Relational B, C, P, Count integral count Concatenation UN, V S Select the object. In the Rule Editor, splits a line. Character Purpose Example (no fractions) Assignment Arithmetic I Insert a new line. * A string of zero or ‘OBJ*’ for a string start- more characters. ing with “OBJ”. D Used for dates; Relational B Date include at least a year Concatenation C Copy a line. A single character. ‘OBJ?’ for any 4-charac- ? Assignment ter string starting with M Move a line to a new position. “OBJ”. Arithmetic (+ or -) A For a move or copy, specify a destination after A B I Unique Relational B, C, P, and ( ) or before ( ) the line where the command is B to be placed. Identifier Identifier Concatenation UN, V Assignment R In the Rule Editor, replicates a line. L Information meeting Relational C Logical a Yes or No Concatenation condition Assignment Logical Q Real Relational B, C, F, Quantity numbers Concatenation P, UN, used for measure- Assignment V ment Arithmetic S Character string data Relational C, RD, String Concatenation UN, V, Assignment W Typeless Literals defined in Relational B, C, F, TIBCO Object Service Concatenation P, RD, Broker rules UN, V, Assignment W Arithmetic Logical Quick Reference 4
Operators Arithmetic Operators Resultant Syntax Addition (+) Decimal Places or Length of ■ First Second A filled square ( ) indicates that the operation can be Result Result for: Count Date Quan- Type- Operator Operator performed; an empty square (❐) indicates that the Syntax tity less Syntax Syntax operation is invalid. + and - * / ** Count Count Date (if ❐ Count Relational Operators COUNT is B(L1) B(L2) B(4) Equality Relational Operators (=, ¬=) binary) B(L1) P(L2,D2 P(8,D D=D2 D=D2 D= D= Date Date (if ❐❐Date ) ) DMA DMA COUNT is X X binary) B(L1) F(L2) F(L2) Quan- ❐❐Quan- Quan- P(L1,D1 B(L2) P(8,D D=D1 D=D1 D= D= Count Date Identifier Logical Quantity String Typeless tity tity tity ) ) DMA DMA ■❐■❐❐❐■ Count Type- Count Date Quan- Type- X X Date ❐■❐❐❐❐■ less tity less P(L1,D1 P(L2,D2 P(8,D D=MIN D= D= Identifier ■❐■❐❐■■ ) ) ) (MAX MIN DMA (D1,D2) (D1+D2 X Logical ❐❐❐■❐❐■ Subtraction (-) , , Quantity ❐❐❐❐■❐■ DMAX) DMAX) Count Date Quantity Typeless ) String ❐❐■❐❐■■ Count Count ❐❐Count P(L1,D1 F(L2) F(L2) ■■■■■■■ Typeless Date Date Count ❐ Date ) Quantity ❐❐Quantity Quantity F(L1) B(L2) F(L1) Ordering Relational Operators (<, >, <=, >=) Typeless Count ❐ Quantity Typeless F(L1) P(L2,D2 F(L1) L=L1 L=L1 L=L1 L=L1 ) F(L1) F(L2) F(L) L=MIN L=MIN L= L=MI Multiplication/Division/Exponentiation (*, /, **) (L1,L2) (L1,L2) MIN N (L1,L2 (L1,L2
Count Date Identifier Logical Quantity String Typeless Count Quantity Typeless ) ) ■❐❐❐❐❐■ Count Count Count Quantity Count ❐■❐❐❐❐■ Date Quantity Quantity Quantity Quantity Resultant Syntax Table Key ❐❐■❐❐❐■ Identifier Typeless Count Quantity Typeless Logical ❐❐❐❐❐❐❐ D Number of decimal places in the result Quantity ❐❐❐❐■❐■ Assignment Operator (=) DMA Maximum number of decimal places that the result X can hold without overflowing the integer portion String ❐❐❐❐❐■■ D1 Number of decimal places in the first operand Typeless ■■■❐■■■ D2 Number of decimal places in the second operand L Length of the result
Concatenation Operator (||) Count Date Identifier Logical Quantity String Typeless The concatenation operator, a double vertical bar (||), Count ■❐■❐❐■■ L1 Length of the first operand is valid between any two semantic data types. If one of Date ❐■❐❐❐■■ L2 Length of the second operand the operands has syntax W, the result has semantic data ■❐■❐❐■■ OP2 Value of the second operand type string and syntax W. In all other cases, the result Identifier has semantic data type string and syntax V. Logical ❐❐❐■❐❐■ Quantity ❐❐❐❐■■■ String ■■■❐■■■ Typeless ■■■■■■■ Quick Reference 5
Logical Operators Date Formats Statements
Word Symbol Meaning For more information, refer to TIBCO Object Service Format Broker Programming in Rules. AND & • Expression evaluates to true (Y), Meaning Example only if both logical operands are Code CALL true rule [(argument{, argument})] / • Valid only in selection criteria W Week # (of year) with no 1 or 25 leading 0 (1 or 2 digits) [WHERE arg_name=arg_value {& arg_name= OR | • Expression evaluates to true (Y), if either (or both) logical operand(s) WW Two digit week # (of year) 01 arg_value}]; is true WWW Abbreviated weekday Mon COMMIT; • Valid only in selection criteria WWWW Full weekday Monday DELETE NOT ¬ • Expression evaluates to true (Y), only if the logical expression is M Numeric month, with no 3 or 10 table [(parm_value{, parm_value})] false leading 0 (1 or 2 digits) [WHERE primary_key = expression]; • Valid in selection criteria and in MM Numeric month (2 digits) 02 the conditions portion of a rule DISPLAY MMM Abbreviated month Mar screen; MMMM Full month March DISPLAY & TRANSFERCALL D Day in month, with no 5 or 14 display screen [& TRANSFERCALL leading 0 (1 or 2 digits) [IN BROWSE/UPDATE] DD Day in month (2 digits) 02 rule [(argument{, argument})]]/ DDD Day in year (3 digits) 074 [WHERE arg_name=arg_value{& YY Last two digits in year 99 arg_name=arg_value}]; YYYY Full year 1999 EXECUTE QQ Two character quarter 2Q [IN BROWSE/UPDATE] JD Julian date 99.074 rule [(argument{, argument})] / CC Two digit century 19 [WHERE arg_name=arg_value {& arg_name=arg_value}]; FORALL table [(parm_value{, parm_value})] [WHERE [¬] field / parm_name relational_operator / LIKE expression { & / | [¬] field relational_operator / LIKE expression}] ORDERED [ASCENDING/DESCENDING] field {& ORDERED [ASCENDING/DESCENDING] field}] [UNTIL exception_name [table] {| exception_name [table]}] : statement; {statement;} END; GET table [(parm_value{, parm_value})] [WHERE [¬] field / parm_name relational_operator / LIKE expression {& / | [¬] field relational_operator / LIKE expression}] [ORDERED Quick Reference 6
[ASCENDING/DESCENDING] field {& ORDERED Exception Hierarchy DELETEFAIL [ASCENDING/DESCENDING] field}] The primary key for a DELETE statement does not exist [WITH MINLOCK]; or a rule running in browse mode is attempting to The following diagram illustrates all system exception update a table. INSERT names in their relative position in the exception hierarchy. Each identification represents a lower level in DISPLAYFAIL table [(parm_value{, parm_value})] / the hierarchy. An error is detected when trying to display a screen. [WHERE parm_name=parm_value A handler for an exception traps the exceptions that are ERROR {& parm_name=parm_value}]; listed beneath it (i.e., lower in the hierarchy). For An error is detected. example, the ERROR exception traps all detectable ON EXECUTEFAIL exception_name[table]: errors and the INTEGRITYFAIL exception traps only the exceptions listed from COMMITLIMIT to An error is detected in the child transaction. statement; VALIDATEFAIL. GETFAIL {statement;} No occurrence satisfies the selection criteria. PRINT INSERTFAIL report; The primary key provided for an INSERT statement REPLACE already exists or a rule running in browse mode is attempting to update a table. table [(parm_value{, parm_value})] / [WHERE parm_name=parm_value INTEGRITYFAIL {& parm_name=parm_value}]; Attempt to violate data integrity detected. JAVAFAIL RETURN A Java exception is raised by a called Java external (expression); routine. ROLLBACK; LOCKFAIL SIGNAL exception_name; Another transaction is accessing this data in a way that prevents you from accessing the data. SCHEDULE NULLVALUE [IN BROWSE/UPDATE] An arithmetic operator is being applied to a numeric [TO queue] null or a numeric null is being passed as an argument rule [(argument{, argument})] / value when a numeric value is required. [WHERE arg_name=arg_value {& OVERFLOW arg_name=arg_value}]; Exceptions A value is too large to be assigned to the target syntax. The conditions that trigger each of these exceptions are TRANSFERCALL The maximum value for the syntax is inserted into the described below in alphabetical order. For more receiving field. All tables are limited to the defined [IN BROWSE/UPDATE] information, refer to TIBCO Object Service Broker dictionary length. As well, screen and report tables are rule [(argument{, argument})] / Programming in Rules. also limited to the display length. [WHERE arg_name=arg_value {& ACCESSFAIL RANGERROR arg_name=arg_value}]; A table access error is detected or a rule running in An argument to a given OSB routine is out of the UNTIL browse mode is attempting to update a table. allowable range. UNTIL exception_name {| exception_name}: COMMITLIMIT REPLACEFAIL statement; The limit on the number of updates between A primary key provided for a REPLACE statement {statement;} synchronization points has been reached. does not exist or a rule running in browse mode is attempting to update a table. END; CONVERSION A value has invalid syntax or cannot be converted to ROUTINEFAIL UNTIL...DISPLAY the target syntax. A call to an OSB routine cannot complete successfully UNTIL exception_name {| exception_name} [DISPLAY DATAREFERENCE and a more specific system exception cannot be {screen}]: An error is detected in selection criteria. signaled. statement; DEFINITIONFAIL RULEFAIL {statement;} An error is detected in the definition of a table. An error results from incorrect rules coding, given that END; the dictionary definition of the database is correct. Quick Reference 7
SECURITYFAIL External Syntax Functional Listing of Shareable Tools Permission for the requested action is denied. SELECTIONFAIL Batch Jobs (z/OS) An error is detected in a table occurrence during the Import, External Syntax VSAM MAP evaluation of selection criteria. Export BATCH – Submits a batch job to a particular queue, views the status of the batch jobs, and views the SERVERBUSY A Alphabetic (Uppercase). ✔ ✔ ✔ queues that are available. (E) The requested external database server is not available ✔ ✔ ✔ to process the transaction. B Binary, signed (half word or full word). BATCHLOAD_CARDS – Defines input and output to SERVERBUSY C Fixed length character string. ✔ ✔ ✔ the Batch Load utilities (S6BBRTBL/hrnbrtbl). (E) The requested external database server is not available to process the transaction. E Little-endian binary, signed. ✔ a ✘ ✔ $BATCHOPT(batch_option, option_value) – Sets the SERVERERROR F Floating point (short, long, or ✔ ✔ ✘ batch options associated with a SCHEDULE TO state- External database server error detected. extended). ment’s batch request, which sends the batch job to a ✘ ✘ ✔ SERVERFAIL F 370 Floating point. queue. (C) G Packed, neutral (X’OF’) sign ✔ ✔ ✔ The connection to an external database server broke BATCHUNLD_CARDS(unload_source) – Defines the during a transaction or the external database server when positive. failed. H Hexidecimal. ✔ ✔ ✔ control cards required by the Batch Unload utilities. (E) STRINGSIZE J ASCII character string. ✘ ✘ ✔ The receiving string field is too short to contain the full K Binary, unsigned. ✔ ✔ ✔ Data Object Broker Information and Operations length of the string value being assigned to it. The value is truncated to the length of the receiving field and M Numeric (zoned), unsigned. ✔ ✔ ✔ DASTATS – Returns statistical data collected by the inserted into that field. N Numeric (zoned), signed. ✔ ✔ ✔ Data Object Broker for an individual segment. (F) UNASSIGNED NL Zoned numeric with sign leading ✔ ✔ ✔ DISPLAY_USERS – Displays a list of all users cur- Reference is being made to a field of a table not ✔ ✔ ✔ assigned a value. NT Zoned numeric with sign trailing rently logged in to TIBCO Object Service Broker. (E) ✔ ✔ ✔ UNDERFLOW O Packed, no sign stored (up to 15 HURON_STATS – Displays statistics for performance digits). A value is too small to be represented in the target ✔ ✔ ✔ analysis and problem determination. (E) syntax (usually exponent errors). The minimum value P Packed, signed (up to 31 digits). for the syntax is inserted into the receiving field. Q Quoted character string. ✔ ✔ ✔ OPSTATS – Returns statistical data collected by the Data Object Broker. (F) VALIDATEFAIL R Little-endian binary, unsigned. ✔ a ✘ ✔ An attempt is being made to update a screen or table RD Raw data ✔ ✔ ✔ S6BNOTIFY – Sends a Notification message to TIBCO with invalid data. For example: ✔ ✔ ✔ Hawk. (C) • An attempt is being made to insert data into a T Text numeric. table that failed a reference check or a non-Y U Packed, unsigned (up to 31 dig- ✔ ✔ ✔ S6BTROFF – Terminates tracing initiated by the com- its). value is being returned from a validation rule. plementary shareable tool S6BTRON. (C) UN Unicode ✔ ✔ ✔ S6BTRON – Initiates tracing of rules execution in the • Invalid data is being inserted into a screen table V Variable character. ✔ ✔ ✔ from a rule (that is, the data failed the screen table current session. (C) W Double-byte and single-byte ✔ b ✔ ✘ reference check). character string. Dates and Times • Invalid data existed on the screen when the user X Fixed length, mixed case charac- ✔ ✔ ✔ ter string. $ADD_DATE(date, component, amount) – Adds or left the screen by using the Validation Exit key. subtracts a component (such as a day, week, month, or Z X’00’ fill character. ✔ ✔ ✔ year) to or from a date and returns a new date value. ZERODIVIDE a. External syntaxes E and R are not valid on z/OS. Attempt to divide by zero detected. b. W is valid for z/OS only. (F) $CREATE_DATE(pic_string, date_string) – Converts a string with a specified format to a value of semantic type date. (F) Quick Reference 8
$DATE_DEFAULT – Returns the default date format YEAR – Returns the two-digit year when the transac- External Databases and Servers used by the installation. (F) tion started. (F) CHANGE_SERVERID(table_name, old_serverid, $DATE_LENGTH(pic_string) – Returns the maximum Debugging new_serverid) – Updates the server ID of any external string length of a given date format. (F) TIBCO Object Service Broker data types. (E) DEBUG(rulename) – Invokes the interactive Rule $DATE_PIC(pic_string, date) – Converts a value of Debugger. (CE) @CONFIGURESERVER(type) – Sets and modifies the semantic type date to a semantic type string. (F) server configuration parameters for a particular server $GTFSET(function, keyname, userid, termid, all, dob) ID. (E) $DATE_REF(component, duration, date, round) – – Enables or disables the rules tracing facility in the Adds or subtracts a given number of days to or from a Execution Environment and the Data Object Broker. DATACOM – Displays a menu to manage the defini- reference date, and converts the number of days tion of CA-Datacom data. (E) @MESSAGEDUMP – Writes traced messages to this returned to units of a day, a week, a month, or a year. table in HEX form, when @TRACEMESSAGES.DUMP ESTIMATETBLDFN(num_fields) – Returns an esti- (F) is set to Y. (TBL) mate of the maximum CTABLESIZE and XTABLESIZE HOUR – Returns the hour of the day when the current required for each table type. (E) @MESSAGETRACE – Stores table access message transaction started. (F) requests between the Execution Environment and the $HTTPREQUEST –Returns the HTTP response code LEAPYEAR(year) – Returns a logical value indicating Data Object Broker collected when using trace facility. from an HTTP request. (F) whether a given year is a leap year. (F) (TBL) IDMS – Displays the main menu used to define a CA- LOCALTIME – Returns the local time when the trans- @TRACEMESSAGES – Records message traffic IDMS database to TIBCO Object Service Broker. (E) action started. (F) between the Execution Environment and the Data IMS – Displays the main menu used to define an Object Broker. (TBL) MINUTE – Returns the minute in the hour the transac- IMS/DB database to TIBCO Object Service Broker. (E) tion started. (F) Definitions of Objects @PEERSERVERID – Directs remote TIBCO Object Ser- REALTIME – Returns a string containing the current COPY_DEFN(objecttype, instancename, library, envi- vice Broker table accesses to a particular peer server time of day. (F) ronment, srclocation, destlocation, parentonly) – Cop- on a remote TIBCO Object Service Broker system. $REALTIMER – Returns the number of micro-seconds ies the definition of one or more objects from a source (TBL) since 1 January 1980. (F) location to a destination location. (C) RESETXPARM(component, entity, parm name, loca- SECOND – Returns the second within the minute that COPYDEFN – Copies the definition of one or more tion) – Resets overrides on server parameters or on the transaction started. (F) TIBCO Object Service Broker objects or object sets. (E) default field values set in the Table Definer. (C) $SLEEP(milliseconds) – Causes the Execution Envi- DEFINE_OBJECTSET(objsetname) – Defines a set of @SERVERERROR(RETURN_MESSAGE) – Returns the ronment to go dormant. (C) objects or modifies an existing set. (E) last message from the message stack to enable special parsing or handling of the message, which resulted DELETE_DEFN(objecttype, instancename, library, $SYSTEMDATE – Returns the date when $SYSTEM- from a request to the TIBCO Object Service Broker environment, location, parentonly) – Deletes the defi- DATE is called. (F) external DBMS server. (C) nition of an object. (C) TIME – Returns a string containing the time of the day SETXPARM(component, entity, parm name, value, DIFF_DEFN(objecttype, instance1, library1, when the transaction started. (F) location) – Overrides a server parameter or the Table environment1, location1, instance2, library2, Definer default value for a field at table access time. $TRXDATE – Returns the start date of the transaction environment2, location2, details) – Compares the defi- (C) that called this tool. (F) nitions of two objects and list the differences. (F) @STATICSQL – Defines and generates static SQL to be UTCDATE – Returns the Coordinated Universal Time DIFFDEFN – Compares the definitions of one or more used to access DB2 data. (E) (UTC) date when UTCDATE is called. (F) pairs of objects and list the differences. (E) UTCTIME – Returns a string containing the current External Memory and Routines Coordinated Universal Time (UTC) time. (F) $GETENVCOMMAREA(segment#) – Retrieves data passed into TIBCO Object Service Broker from a call- Quick Reference 9 ing environment that is not TIBCO Object Service Bro- LLOAD(importfile, media) – Loads definitions and RANDOMSEED(seed) – Sets the starting seed for the ker. (F) data of TIBCO Object Service Broker objects that were random number generator. (C) previously unloaded from files with names in mixed HLIPREPROCESSOR(hostlang, imbedlang, infile, out- REMAINDER(dividend, divisor) – Returns the case or lowercase. (CE) file, listfile, options) – Invokes a language pre-proces- remainder from dividing the dividend by the divisor. sor to run against COBOL source programs that LOAD(importfile, media) – Loads definitions and data (F) contain embedded TIBCO Object Service Broker of TIBCO Object Service Broker objects that were pre- ROUND(value) – Returns the specified value rounded access statements or SQL statements. (C) viously unloaded. (CE) to the nearest integer. (F) @MAP – Registers and allocates storage for use with LOADER – Loads definitions and data of TIBCO Menus MAP tables. (TBL) Object Service Broker objects that were previously unloaded, with selection control. (CE) DEFINE_MENU(menu) – Creates and modifies RETURN_CODE – Returns the return code from the menus and login screens used within TIBCO Object last call of a TIBCO Object Service Broker external rou- UNLOAD – Unloads definitions of valid TIBCO Service Broker user-defined applications. (E) tine. (F) Object Service Broker object types from a source sys- tem to a z/OS data set or a Windows or Solaris file. DISPLAY_MENU(menuname) – Calls a specific menu S6BCALL – Invokes a TIBCO-supplied callable routine Data from table object types could also be unloaded. into an application. (C) that requires a specialized environment. (C) (E) Messages and Message Logs S6BFUNCTION – Invokes a TIBCO supplied function UNLOAD_DATA(tablespec, selection, location) – that requires a specialized environment. (F) ENDMSG(message) – Sets the transaction completion Unloads the data of a table to a z/OS data set or a message. (C) $SETENVCOMMAREA(value, segment#) – Passes Windows or Solaris file. (C) data from TIBCO Object Service Broker into a calling GETENDMSG – Returns the current value of the end- UNLOAD_DEFN(objecttype, objectname, library, environment that is not TIBCO Object Service Broker. of-transaction message. (F) location, presentationenv, parentonly) – Unloads the (F) definition of a TIBCO Object Service Broker object to a LOG_BROWSE – Displays the contents of the message $SETSESSIONEND(action, value) – Sets what execu- z/OS data set or a Windows or Solaris file. (C) log. (C) tion is to take place when a TIBCO Object Service Bro- UNLOADLIBRARY(library, location) – Unloads all MESSAGE(utility, msg_num, tokenlist) – Returns a ker session ends by returning data from the session to rules in the specified library at the specified location to customized message by taking a root message in the an external environment. (C) a z/OS data set or a Windows or Solaris file. (C) MESSAGES table and inserting customizing tokens. Installation of Components Mathematical Calculation (F) @INSTALL(component [path]) – Requests the installa- MESSAGE_LOG(msglog, destin) – Preserves the con- ABS(value) – Returns the absolute value of a number. tion of the specified component. (CE) tents of the message log across transactions. (C) (F) @UNINSTALL(component) – Requests that the speci- MSGLOG(string) – Inserts the specified string as a line MAX(x, y) – Returns the larger of two given values. (F) fied component be uninstalled. (CE) in the TIBCO Object Service Broker message log. (C) MIN(x, y) – Returns the smaller of two given values. Load from/Unload to External Files RETURN_SYSMSG – Returns the last $SYSCALL sys- (F) tem error message when an exception is raised. BATCHLOAD_CARDS – Defines input and output to MOD(dividend, divisor) – Returns the modulus from RETURN_SYSMSG is a low-level tool that must be the Batch Load utilities (S6BBRTBL/hrnbrtbl). (E) dividing the dividend by the divisor. The function called immediately after an exception is trapped. (F) BATCHUNLD_CARDS(unload_source) – Defines the MOD handles negative dividends and divisors. (F) S6BCALL(’api_call’,parameters) – Invokes a TIBCO- control cards required by the Batch Unload utilities. NUM_CHK(val) – Determines if a given string satis- supplied callable routine that requires a specialized (E) fies the TIBCO Object Service Broker definition of a environment. (C) EXPOCC_SIZE(table) – Returns the minimum record numeric literal. (F) Message Oriented Middleware size required to hold the occurrences of the table being RANDOM(rangelimit) – Returns a random integer unloaded. (F) @MOMCLOSE(connection, queue) – Closes a Message between one and the specified limit. (F) Oriented Middleware (MOM) message queue. (F) Quick Reference 10
@MOMCOMMIT(connection) – Commits all changes @MQSMAP is for use on z/OS and $TOCPRINT(fill_char) – Prints table of contents. (C) to queues from a single Message Oriented Middleware @MQSMAP_PORT on Open Systems. (TBL) $TOCPUT(section_name, spacing, numbering_yn) – (MOM) message manager. (C) Printing and Output Puts a line in the table of contents. (C) @MOMCONNECT(name) – Connects to a Message $BLANKPAGE(titles_yn) – Outputs a blank page. (C) S6BCALL – Invokes a TIBCO-supplied callable routine Oriented Middleware (MOM) message queue (MQ) that requires a specialized environment. (C) manager. (F) $FLUSHPRINT – Releases output into the print spool. (C) S6BFUNCTION – Invokes a TIBCO-supplied function @MOMDISCONN(connection) – Disconnects from a that requires a specialized environment. (C) Message Oriented Middleware (MOM) message man- $NEWPAGE – Positions subsequent output to the top ager. (F) of a new page. (C) Promotions @MOMGET(connection, queue, table) – Reads a mes- PRINT_DATA(tablespec, select, sourceloc) – Prints the ADMIN_RIGHTS – Obtains, releases, or transfers the sage from a Message Oriented Middleware (MOM) data of a TIBCO Object Service Broker table. (C) promotion rights on objects. (E) message queue. (C) PRINT_DEFN(object, instance, library, environment, DBMAINTLVL – Displays the maintenance level of @MOMINIT(buflen, mon_type) – Identifies the type of srcloc, parentonly) – Prints the definition of a TIBCO your TIBCO Object Service Broker database, including Message Oriented Middleware (MOM) message man- Object Service Broker object. (C) any database PTFs applied beyond the maintenance ager, and initializes its environment (map and control level. (E) $PRINTFIELD(string, pos, length, fill, just) – Writes structures) to enable subsequent @MOM calls. (C) the specified string into the current printline. (C) MANAGE_APPLY – Invokes the Promotion facility on @MOMMAPLENGTH(table_name) – Returns the the target system. (E) $PRINTLINE(text) – Prints a string. (C) length of a MAP table. (F) MANAGE_REQUESTS – Invokes the Promotion facil- PRINTTABLE(tablespec, pagelength, pagewidth, @MOMOPEN(connection, name) – Opens a Message ity on the source system. (E) media) – Prints a table. (C) Oriented Middleware (MOM) message queue. (F) MANAGE_RIGHTS – Releases or transfers a user’s PRT_VSCR(vscr, page_length, page_width, @MOMOPTION(description) – Queries the numeric promotion rights on rules, screens, reports, menus, page_start, media, mask) – Prints the screen fields of a equivalent of a Message Oriented Middleware (MOM) object sets, and tables. (E) defined screen in a page format, with or without a option. (F) mask. (C) @PROMBINDOBJS – Restores the bind flag settings @MOMPUT(connection, queue, table, len) – Writes a for the objects updated by @PROMUNBINDOBJS. (E) $PUTLINE – Prints the current line constructed by message to a Message Oriented Middleware (MOM) $PRINTFIELD. (C) PROM_MAIN – Invokes directly the Promotion sys- message queue. (C) tem. (E) $RESETPRINT(length, width, page_number, media) – @MOMROLLBACK(connection) – Backs out all data- Resets the output arguments. (C) @PROMUNBINDOBJS – Stores the current setting of base changes from a single Message Oriented Middle- the bind flag for a set of objects and reset the values to ware (MOM) message manager since the start of the $SETP#POS(line_number, left_string, center_string, N in the metadata tables. (E) transaction or since the previous @MOMCOMMIT. (C) right_string) – Defines the position and content of page number lines. (C) RMANAGE_REQUESTS – Manages change requests @MOMSETOPT(description) – Sets a MOM option to for systems where the source system is remote to the a specified value. (C) $SETPRINT(length, width, page_number, media, target system. (E) clear_title_yn) – Initializes the print attributes or, if @MOMSPECIALCMD(manager_name, queue_name, they are already set, uses it to clear the titles for the Read from/Write to External Files command) – Sends a Message Oriented Middleware output on the following pages. (C) (MOM) command to a queue listener task. (C) ALLOCDSN(ddname, dsname) – Allocates a file to a $SETTITLE(line_number, left_string, center_string, z/OS DDNAME. (C) @MOMVALIDRC – Checks the return code of a previ- right_string) – Sets a title or footer to be printed on ous command. (C) @CLOSEDSN – Closes and frees the current file. (C) subsequent pages of output. (C) @MQSMAP and @MQSMAP_PORT– Registers and $LISTDSN(dsname_level, buffer_address) – Lists the $SKIPLINE(count) – Outputs zero or more blank lines. allocates storage for use with the MQSMAP table. non-VSAM data sets and Generation Data Group (C) Quick Reference 11
(GDG) data sets of a certain level, using the z/OS Cat- report fields that are not to be printed on the overlap- NOOP – Does nothing. (C) alog Search Interface services. (C) ping page of a merged report. (C) $RULE_EXISTS(rule) – Checks whether a rule with the $LISTPDS(pds_name, buffer_address, member_name) $RPTPARMS(reportname, length, width, eject, page- given name would be a candidate for execution. The – Lists the member names of a partitioned data set number) – Controls explicitly the physical output of a rule can be a rule in the current search path, a TIBCO (PDS), or retrieves the statistics for a PDS member. (C) report. (C) Object Service Broker routine, or an external routine with an available and executable load module. (F) @OPENDSN(dsname) – Specifies the name of the file $RPTPRINT(reportname, media) – Prints a report to that is subsequently used by @READDSN or @WRIT- the media specified. (C) $RULENAME(level, transactioncount) – Retrieves the EDSN. (C) name of a rule from the current execution stack. (F) $RPTSKIPLINES(reportname, reporttable, element, @READDSN – Returns the next record from the cur- linesbefore, linesafter) – Controls explicitly the spac- RULEPRINTER(rule) – Prints a rule or prints an appli- rent file. (F) ing of a report. (C) cation structure using the root rule as the base. (E) @WRITEDSN(string) – Writes a record to the current $SETRPTATTRIBUTE(report, attribute, value) – Sets SEARCHLIB – Searches all rules or specified rules in a file. (C) the attributes of the report that is to be printed. (C) library for a given string. (CE) XMLPARSE – Initiates the parsing of an XML doc- $SETRPTMEDIUM(report, mediumtype, medium) – $SIGNAL(exception, tablename) – Raises the specified ument. (C) Sets the medium to which a report is to be printed. (C) exception. (C) XMLSTART(xmldocname, predicate, parm) – Gener- Rules and Rules Libraries SYSTEMLIB – Returns the name of the currently des- ates an XML document based on the passed data ignated system library. (F) $CALLRULE(rulecall) – Invokes a procedural rule. (C) access arguments. (C) $TRXMODE – Retrieves the transaction mode of the CHANGERULE – Makes multiple text changes across XMLSTARTDSN(outdsn, xmldocname, predicate, current rule. (F) multiple rules in a library. (CE) parm) – Generates an XML document based on the $TYPECAST – Converts a variable according to the passed data access arguments and places it in the COPYLIB(source_lib, dest_lib) – Copies all the rules arguments supplied. (F) specified file. (C) from a source library to a destination library. (C) Screens XMLSTARTSETDEST(tablendpec, fieldspec) – Sets up DEFINE_LIBRARY(libraryname) – Defines a new the output table and field for XMLSTART. (C) library, displays a list of the rules in a library, or dis- $BEEP(repetition) – Issues the specified number of plays a list of the rules libraries. (E) beeps from the terminal. (C) XMLSTARTTAB(tablename, format, predicate, parm) – Returns a table to the OIG client. (C) EDITRULE(rulename) – Defines a new TIBCO Object CONFIRMACTION(screen, confirmmsg, key, default- Reports Service Broker rule or modifies an existing one. (E) msg, table, commandfield) – Issues a confirmation message for a PF key action or for a specified com- $EXCEPTION – Returns the name of the last exception DEFINE_REPORT(reportname) – Defines a new mand. (C) signalled within the current transaction by either a TIBCO Object Service Broker report or modifies an SIGNAL statement, a $SIGNAL call, or the system CURSOR_FLDCOL(screen) – Returns the relative col- existing one. (E) (GETFAIL, ZERODIVIDE, and so on). (F) umn number within the field containing the cursor. (F) GENERATE_REPORT(reportname) – Defines a new $EXCEPTIONOBJECT – Returns the name of the CURSORFIELD(screen) – Returns the name of the report or modifies an existing report using the Report object (for example, a table) associated with the last field where the cursor is located. (F) Generator. (E) exception signalled within the current transaction, if CURSOROCC#(screen) – Returns the occurrence num- $RPTIMMEDIATE(reportname, media) – Sends the that exception is of the type that can be trapped with ber within the screen table where the cursor is posi- records to the output as they are read, without sorting. an ON exception_name object_name: statement. (F) tioned. (F) (C) $FUNCTION(rulecall) – Invokes a functional rule. (C) CURSOROCC_VALUE(screen, scrtbl, scrfld) – Returns $RPTOCCLIMIT(reportname, occlimit) – Limits the INSTALLIB – Returns the name of the currently desig- the value of a particular screen field that is selected by number of occurrences used to generate the report. (C) nated installation library. (F) the cursor. (F) $RPTOVERLAP(report, reporttable, reportfield, LIBID – Returns the name of the currently designated CURSORTABLE(screen) – Returns the name of the BLANKOVERLAP) – Designates the report tables or local library. (F) screen table where the cursor is positioned. (F) Quick Reference 12
DELETESCREENDATA(screen) – Deletes all the Searches for Objects PURGELOG_BATCH(fromdate, todate, file) – Purges occurrences from all the screen tables of a screen. (C) the audit log data from the TIBCO Object Service Bro- CROSSREFSEARCH(querystring, querykind, library) ker audit log table and archive to an external file. (CE) DRAW(screenname) – Defines a new TIBCO Object – Searches the cross reference index of the specified Service Broker screen or modifies an existing one. (E) library to answer a query. (C) PURGELOG_SCREEN – Specifies the archive file for the audit log data and purges the audit log data to the ENTERKEY(screen) – Returns the name of last key KEYWORDMGR – Ensures that the TIBCO Object Ser- specified archive file. (CE) used when the specified screen appeared. (F) vice Broker keyword system conforms to the estab- SEC_REBIND(object, parmcat, name) – Rebinds all EVENTSCREEN – Returns the name of the screen that lished formatting standards and that the keyword security data previously bound in the Execution Envi- activates the current screen validation rule. (C) index table is up-to-date. (E) ronment storage. (C) EXIT_DISPLAY – Signals the standard exception KEYWORDSEARCH(querystring, object_type) – SECURITY – Invokes the TIBCO Object Service Broker EXIT_DISPLAY. (C) Searches the keyword index of a default library to answer a query. (C) Security Manager main menu. (E) FCNKEY_MSG(screen) – Creates a string containing Selection Lists the function keys defined for a screen. (F) REFMAKER(library) – Rebuilds the global cross refer- ence index. (E) $GETATTRIBUTE(screen, table, field, attribute) – Que- DEFINE_OBJLIST(table) – Defines, for a table, an ries the current attributes for the field of the screen SEARCH – Searches the keyword or cross reference object list to appear using the Object Manager or mod- table, in the specified screen. (F) indexes to answer a query. (E) ifies an existing object list definition. (E) $GETCOLOUR(screen, table, field, color_type) – Que- SEARCHLIB – Searches all rules or specified rules in a OBJECT_MGMT(tablespec) – Displays the contents of ries the current color of a screen field. (F) library for a given string. (CE) a table and enables a predefined set of commands that Secondary Indexes are unique to the table to operate on the display. (E) @PRESENTATIONENV – Returns the name of the pre- OBJECTMGR(tablespec) – Displays the contents of a sentation environment for the current session. (F) SIXBUILD(table, secondary_key) – Creates a second- table and enables a predefined set of commands that ary index online for a TDS table. (C) PROCESS_FCNKEY(screen) – Processes the function are unique to the table to operate on the display. (C) keys while a screen is being displayed. (C) SIXBUILD_CARDS – Defines the control cards OPTIONLISTER(optionlistname) – Displays options required by the Batch Secondary Index Build utilities. SCREENCOL – Returns the number of columns on the in columns and returns the ones selected (C). user’s physical screen. (F) (E) SELECT_OBJ(name, type, unit, author, library, loca- SIXDELETE(table, secondary_key) – Deletes an exist- SCREENMSG(name, msg) – Displays the given mes- tion, children, subtype) – Provides a screen that can be ing secondary index. (CE) sage in the message area of the specified screen. (C) used to list and select objects that meet specified crite- SCREENROW – Returns the number of rows on the Security ria. (C) user’s physical screen. (F) AUDITLOG – Invokes the Query Audit Log tool. (CE) Session Options and Parameters $SETATTRIBUTE(screen, table, field, attribute, flag) – BATCH_ENABLE(wipe_existing) – Enables all the $GETOPT(option_name) – Returns the value of a ses- Sets attributes for the field of the screen table, in the object sets previously processed using @MAKEMEM- sion parameter or option. (F) specified screen. (C) BERS. (C) $GETTRANSACTION(name) – Gets a transaction $SETCOLOUR(screen, table, field, color_type, color) – CREATEUSERS(input_table, modeluser) – Creates a name set by $SETTRANSACTION. (F) Sets the color of a screen field. (C) list of new user IDs and adds them to the TIBCO REMOTELOCATION – Returns the current value of Object Service Broker system. (E) SETCURSOR(screen, table, field) – Positions the cur- the default remote location. (F) sor in the field of the screen table, in the specified @MAKEMEMBERS(objectset) – Creates the member @SESSION – Alters session-related items maintained screen. (C) list for an object set to be enabled through the by this table. (TBL) SETCURSOR_POS(screen, table, field, BATCH_ENABLE utility. (CE) @SESSIONCOUNTS – Obtains information on events occurrence_number, column_offset) – Positions the @MNG_USERS – Modifies your user security profile. occurring within the Execution Environment during a cursor in the column of the field of the occurrence, in (E) the screen table of the screen. (C) session. (TBL) Quick Reference 13
SESSMGR – Displays the login interface to the Session GETCHAR(string) – Returns the first character from QUOTE(string) – Returns a string with single quota- Manager (workbench). the specified string, removing it from the string. (F) tion marks around it and doubles any single quotation marks in the string. (F) $SETOPT(parameter, value) – Sets the value of a ses- $GETFLOAT(string, offset, length) – Stores character sion parameter or option. (C) data in floating format. (F) SCRIPT(source, dest) – Uses commands to format text from a table and store the formatted text in another $SETTRANSACTION(field, value) – Returns the cur- $GETPACKED(string, offset, length) – Stores character table. (C) rent name of a TIBCO Object Service Broker transac- data in packed decimal format. (F) tion and sets a new name. (F) SEARCH_REPLACE(input_string, replace_this, HEADSTRING(string, length) – Returns the head por- with_this, else_with_this) – Replaces all occurrences of SETREMOTELOC(remoteloc) – Sets the default tion of the specified string. (F) a pattern with specified characters. (F) remote location for distributed data processing. (C) LENGTH(string) – Returns the length of the specified SUBSTRING(string, start, length) – Returns a selected USERID – Returns a string containing the user ID. (F) string. (F) portion of a string. (F) Strings and Text LIT_TO_VAL(string) – Converts a string to a typeless TAILSTRING(string, length) – Returns the tail portion field as described in the string. (F) FROM_UNICODE(unistring, externalcodepage) – of the string. (F) Converts a Unicode string to Raw Data encoded in an LOWER_EBCDIC(string) – Converts a string to lower- TED(text_input) – Displays a table for text editing. (E) external Code page.(F) case EBCDIC characters. (F) TEXTSETUP(setupname) – Defines a setup for format- GEN_TED(tablespec, screenname, screentablename) – LOWER_UNICODE(string) –Converts a string to low- ting a text document. (E) Presents a screen where text can be entered and edited ercase Unicode characters. (F) TOKEN(string) – Parses an input string and returns under the control of the text editor. (C) LOWERCASE(string) – Converts all uppercase charac- the first token and the string with the token removed. GENBIN(value, length) – Returns a syntax V string ters in a string to lowercase characters. (F) (F) containing the same internal binary value as the input MATCH(string, pattern) – Returns the starting posi- TO_UNICODE(rdstring, externalcodepage) – Con- numeric value, right-justified.(F) tion, in characters, of the specified pattern in the speci- verts a raw data string encoded in an external code GENFLOAT(value, length) – Returns a syntax V string fied string, relative to the start of the string. (F) page to Unicode.(F) containing the same internal float representation as PAD(string, length, padcharacter, just) – Returns a $TYPECAST(type, syntax, size, decimals, value) – the input float value, left-justified. (F) string padded to a specified length using a pad charac- Converts a variable according to the arguments sup- GENPACK(value, length, decimal) – Returns a syntax ter, positioning the string to the left, right or center of plied. (F) V string containing the same internal packed decimal the padding. (F) $UNPIC(picVal, mask) – Determines the original value as the input syntax P value, right-justified. (F) PARSE(grammar_usage, string) – Breaks up an input value submitted given a masked value produced by $GET_DECIMALS(value) – Retrieves the number of string into tokens and applies grammar rules to the $PIC and the display mask that produced it. (F) decimal places for an expression. (F) tokens. (C) UNQUOTE(string) – Returns a string with the single $GET_MAXSIZE(value) – Retrieves the dictionary size PATTERN_MATCH(string, pattern) – Determines quotation marks removed. (F) of an expression. (F) whether a string matches a given pattern. (F) UPPER_EBCDIC(string) – Converts a string to upper- $GET_SIZE(value) – Retrieves the size of an expres- PEEL(peelchars, string) – Returns the result of remov- case EBCDIC characters. (F) sion. (F) ing the specified leading and trailing characters from the specified string. (F) UPPER_UNICODE(string) – Converts a string to $GET_SYNTAX(value) – Retrieves the syntax of an uppercase Unicode characters. (F) expression. (F) PEEL_HEAD(char, string) – Removes the specified leading characters from a given string. (F) UPPERCASE(string) – Converts all lowercase charac- $GET_TYPE(value) – Retrieves the semantic type of an ters in a string to uppercase characters. (F) expression. (F) PEEL_TAIL(char, string) – Removes the specified trail- ing characters from a given string. (F) VAL_TO_LIT(string) – Converts a field to a string con- $GETBINARY(string, offset, length) – Stores character taining a token describing its value. (F) data in binary format. (F) $PIC(value, mask) – Returns a number in a format specified by a mask. (F) Quick Reference 14
VALID_NAME(name) – Determines if a given string @FORALLA(table, parm, selection, ordering) – SOE(tablespec) – Edits a single occurrence in a table. satisfies the TIBCO Object Service Broker definition of Returns the first table occurrence that satisfies the (CE) an identifier. (F) selection criteria. Use if the value of any table parame- STE(tablename) – Invokes the Table Editor. (CE) Table Definitions and Data ter or of any selection criterion is 100 or more charac- ters long. (C) STEBROWSE(input) – Views the contents of a TIBCO BROWSER(tablespec) – Displays the contents of a Object Service Broker table. (E) FORALLB(table) – Returns the next table occurrence TIBCO Object Service Broker table for viewing. (CE) that satisfies the selection criteria following a call to TABLEPRINT(tablespec) – Prints the contents of a CLEARTABLE_APPL(table, select) – Deletes occur- FORALLA. (C) table or of a set of joined tables. (E) rences from a table or table instance. (E) FORALLE(table) – Releases internally the resources Trigger or Validation Rules $CLRTAB(tablename, parm1, parm2, parm3, parm4) – used by FORALLA on a table. (C) EVENTSCREEN – Returns the name of the screen that Deletes (clears) the data rows from a table or table MOVTAB(tablename, segmentID) – Changes the seg- activates the current screen validation rule. (C) instance without reading the data rows. (C) ment number of a table. (CE) EVENTTABLE – Returns the name of the table that COPY_DATA(srctabspec, select, desttabspec, srcloca- INDEXCHK – Estimates the maximum number of activated the current derived field rule, trigger rule, or tion, destlocation, overwrite) – Copies data from one data rows a table can contain before reaching the max- validation rule. (F) table or table instance to another table or table imum index levels. (E) instance. (C) PARMVALUE(parmname) – Returns the value of the NLS – Enables the database administrator to set code parameter from the table that was accessed when the COPYTABLE_APPL – Copies selected occurrences page values in translation tables. (E) trigger or validation rule was activated. (F) from a source table to a destination table. (E) OBJECTMGR(tablespec) – Displays the contents of a COUNTOCCURRENCES(table, selection) – Returns table and enables a predefined set of commands that the number of occurrences that meet a selection crite- are unique to the table to operate on the display. (C) ria. (F) PARMVALUE(parmname) – Returns the value of the DEFINE_TABLE(tbl_name) – Defines a new TIBCO parameter from the table that was accessed when the Object Service Broker table or modifies an existing trigger or validation rule was activated. (F) one. (E) PARSE_TAM(string) – Breaks up an input string into a DELETE_DATA(tablespec, select, location) – Deletes table specification, and optionally, the WHERE clause the data from a table or table instance. (C) and the ORDERED clause of the corresponding table © 2001 – 2012 TIBCO Software Inc. All rights reserved. DIFF_DATA(table1, field1, location1, selection1, access statement. (C) The information in this quick reference is subject to change table2, field2, location2, selection2, printresult) – Com- without notice. The information in this quick reference is the PROCESS_TABLE(tablespec, selection, ordering, pro- licensed property of TIBCO Software Inc. Use of the pares the data of two tables or table instances and lists cessrule) – Provides specific processing for every information contained herein is restricted pursuant to the the differences. (F) terms and conditions of a license agreement, which appears occurrence in a table that is selected, ordered, or both during download or installation of the software (and which is EVENTTABLE – Returns the name of the table that selected and ordered. (C) duplicated in the license.pdf document). activated the current derived field rule, trigger rule, or The TIBCO Object service Broker technologies described RETURN_MESSAGE – Returns the system error mes- herein are protected under the following patent numbers: validation rule. (F) Australia: - - 671137 671138 673682 646408 sage whenever an exception is raised. Canada: 2284250 - - 2284245 2284248 2066724 FLDMGR(fieldname) – Adds fields to the global field RETURN_MESSAGE is a low-level tool that must be Europe: - - 0588446 0588445 0588447 0489861 Japan: - - - - - 2-513420 dictionary. (E) called immediately after an exception is trapped. (F) USA: 5584026 5586329 5586330 5594899 5596752 5682535 TIB, TIBCO, TIBCO Software, Predictive Business, FORALLA(table, parm, selection, ordering) – Returns SETNLSBIT(table, flag) – Sets the NLS bit for the spec- Information Bus, The Power of Now, and TIBCO Adapter are the first table occurrence that satisfies the selection cri- ified table, in the RESERVED field of the TABLES registered trademarks or trademarks of TIBCO Software Inc. teria. Use if the value of every table parameter and table. (C) in the United States and/or other countries. every selection criterion is 99 or fewer characters long. All other product and company names and marks mentioned SIMPLESELECT(selection) – Processes a selection in this document are the property of their respective owners (C) string into a format that can be used by the FORALLA and are mentioned for identification purposes only. tool. (C)