System Publics (SPUB)

Code

Notes

call stbl("+DIR_SYP")+"bam_inquiry.bbj",gui_dev,Form!,"<table_id>","VIEW", table_chans$[all],"<key_prefix>","<key_id>","","","","",""

Calls the Barista inquiry system for the specified table and key prefix

call stbl("+DIR_SYP")+"bam_run_prog.bbj","<table_id>",user_id$,"","", table_chans$[all],"",dflt_data$[all]

Calls the Barista runtime and launches the form for the specified table

Program Name

Description

Parameter List

bac_create_table.bbj

Create a work file based on an existing Barista table alias.

Parameter

In

Out

rd_table_alias$

Table alias, C(16), uppercase.

rd_disk_file$

"" to use the file name from the alias record, or a fully qualified filename.

File name.

rd_table_chans$[]

This array always exists in the Barista environment; pass it as given.

rd_create_action$

"ERASE" to erase existing file if it already exists, otherwise ""

rd_create_status$

""

Returns "" if successful, otherwise returns a human-readable error message.

bac_error.bbj

Report a program error to the user.

Parameter

In

Out

rd_err_prog$

Program name

rd_err_line$

Error line number

rd_err_num$

BBx error number (ERR)

rd_err_text$

Error message, typically ERRMES(⌀1)

rd_err_act$

N/A

Returns the user's chosen action:

"EXIT"

"RETRY"

"ESCAPE"

bac_key_template.bbj

Get Template For Selected Key.

Parameter

In

Out

rd_table_id$

Table alias, C(16), uppercase.

rd_table_key$

Key name, C(16), uppercase.

rd_key_template$

N/A

Template that describes the structure of this key.

rd_table_chans$[]

This array always exists in the Barista environment; pass it as given.

rd_status$

N/A

Returns "" if successful, otherwise returns a human-readable error message.

bac_message.bbj

Display or Query System Message.

Parameter

In

Out

rd_msg_id$

Message ID defined in Administration, Maintenance, System Messages.

rd_msg_tokens$[]

Single-dimension array of replacement tokens, to be inserted into the message based on place-holders %1, %2, etc. rd_msg_tokens$[1] replaces %1, rd_msg_tokens$[2] replaces %2, and so on.

rd_msg_opt$

Pass "" to display a dialog window for the user, or "<<TEXT>>" to retrieve the message text without displaying a dialog.

If "<<TEXT>>" was passed in, returns the formatted message, otherwise returns the user's selection.

rd_table_chans$[]

This array always exists in the Barista environment; pass it as given.

Assumes the current language, STBL("+LANGUAGE_ID"). These messages are maintained in Administration, Maintenance, System Messages.

bas_sequences.bbj

Get Next Sequence Number. Assign defined sequence numbers during updates, reports, etc.

Parameter

In

Out

rd_sequence_id$

Sequence Number ID defined in AdministrationMaintenanceSequence Numbers.

rd_sequence_no$

N/A

Next sequence number.

rd_table_chans$[]

This array always exists in the Barista environment; pass it as given.

Sequence numbers are maintained in Administration, Maintenance, Sequence Numbers.

bac_open_tables.bbj

Open/Create Tables

Parameter

In

Out

rd_open_beg

Index of the first element of rd_open_tables$[] to be processed, or 0 to start at the beginning.

0

rd_open_end

Index of the last element of rd_open_tables$[] to be processed, or 0 to process through the end.

0

rd_open_tables$[]

Array of table aliases.

If rd_open_opts$[i] includes "A", rd_open_tables$[i] returns the disk file name, otherwise it's unchanged.

rd_open_opts$[]

• F=Find existing channel for file if open

• A=Get actual disk file name based on alias

• O=Open disk file

• N=Force open on new channel

• T=Retrieve template record

• L=Lock file

• C=Close file

• S=Skip error messages if file open unsuccessful

• I=Initialize file

• D=Define file if not found

rd_open_chans$[]

Pass an empty array.

Each element returns the channel number of the corresponding file.

rd_open_tpls$[]

Pass an empty array.

Each element returns the record template for the corresponding file.

rd_table_chans$[]

This array always exists in the Barista environment; pass it as given.

rd_open_batch

Unused

rd_open_status$

N/A.

Returns "" for success, or a human-readable error message.

bac_winsize.bbj

Barista stores persistent information about windows in the [Windows] section of .usr files in the barista/settings/enu/ directory (assuming the English – U.S. language code). The rdc_winsize utility saves and reads that information. Developers can use rdc_winsize to manage persistent information for their custom-built windows.

Parameter

In

Out

rd_win_key$

Unique Window ID.

rd_win_type$

"U" = User-defined custom window, not associated with a Barista form.

"W" = Maintenance or Options Entry Form.

"G" = Maintenance or Options Entry Grid.

"I" = Inquiry Window.

The "W", "G", and "I" codes are reserved for internal Barista use only.

rd_col_str$

Unused.

rdWindow!

A BBjWindow object.

rd_action$

"SAVE" or "READ"

rd_win_coord[]

N/A

Returned as a four-element array of X, Y, W, H.

bam_config.bbj

Read or write configuration information in the barista .cfg, .ini, or .usr files.

Parameter

In

Out

rd_cfg_file$

Fully-qualified filename.

rd_cfg_type$

"CFG"

"INI"

"USR"

rd_cfg_proc$

"READ"

"WRITE"

rd_attr_data$[]

RD_ATTR_DATA$[0] is a string of attribute names, each padded out to 20 bytes.

RD_ATTR_DATA$[1:n] contains the data corresponding to each of the attribute names listed in RD_ATTR_DATA$[0]

rd_convert_0a$

By default, rdm_config converts all occurences of "$0A$" in rd_attr_data$[] to $0A$. To disable this behavior, pass rd_convert_0a$ as "NO".

bam_enable.bbj

Enable/Disable MDI tool buttons, menu items and controls on forms.

Parameter

In

Out

rd_gui_dev

This variable always exists in the Barista environment; pass it as given.

rd_able_proc$

• "CREATE"=Create rd_able_map$ of all controls listed in rd_able_ctls$ (See below)

• "ENABLE"=Enable all controls listed in rd_able_ctls$ (See below)

• "DISABLE" =Disable all controls listed in rd_able_ctls$ (See below)

• "CHECK"=Check menu controls listed in rd_able_ctls$ (See below)

• "UNCHECK" =Uncheck menu controls listed in rd_able_ctls$ (See below)

• "ACTIVE" =Set status to active for all controls listed in rd_able_ctls$ (See below)

• "UPDATE" =Update status of all controls based on current values in rd_able_map$ (See below)

rd_disp_mode$

• "INIT"=Initializes any previous rd_able_map$ string and settings."

• "CLEAR"=Clear control contents when enabling or disabling.

• "FORCE"=Override current rd_able_map$ status and perform function specified in rd_able_proc$

• "MDI"=Specifies the program is running within the Barista Framework MDI. (Mandatory)

• "IDLE"=When used in conjunction with rd_able_proc$=

• "CREATE"=Sets all controls to idle (always disabled)

rd_able_ctls$

Semicolon-delimited variable length strings consisting of:

• Control number:"00000"

• Type (B=Button, M=Menu, E=Entry)

Used in conjunction with rd_able_proc$ commands to manipulate various commands.

rd_able_map$

Semicolon-delimited variable length strings containing the current enable/disable status of all controls on the user interface, including menu and toolbar items Consists of:

• Control number:"00000"

• Type (B=Button, M=Menu, E=Entry)

• Status (""=Enabled, "D"=Disabled, "I"/"X"=Always disabled).

Updated status.

rd_able_ctx$

Variable length semicolon-delimited strings defining the context for each control on a form, each consisting of:

• Control number:"00000"

• Type (B=Button, M=Menu, E=Entry)

• "-" (hyphen)

• Control context:"0000"

rd_able_ctx

Context of controls on a form if the form consists of one context

rdSysGUI!

This variable always exists in the Barista environment; pass it as given.

rd_rec_data$[]

Internal Barista use only

rd_ctl_xref_str$

Internal Barista use only

rd_attr_def_tbl$[]

Table Attribute Definition Array.

See Barista Data Structures.

rd_attr_def_col$[]

Column Attribute Definition Array.

See Barista Data Structures.

rd_attr_tbl$[]

Table Attribute Array.

See Barista Data Structures.

rd_attr_col$[]

Column Attribute Array.

See Barista Data Structures.

bam_enable_pop.bbj

Enable/Disable Popup Menu Items

Parameter

In

Out

Form!

This standard Barista variable identifies the current form.

rd_enable_str$

List of popup menu items to enable.

rd_disable_str$

List of popup menu items to disable.

bam_grid_init.bbj

Initialize and configure a custom-created BBjGrid control.

Parameter

In

Out

Notes

rd_gui_dev

This variable always exists in the Barista environment; pass it as given.

rdGridTemp!

A custom-defined BBjGrid control.

rd_flags$

One or more of the following:

• AUTO=Enable auto-sort.

• CALENDAR=

• CELL=Clicking in the grid selects a individual cell, as opposed to the complete row.

• CHECKS=Signifies the grid contains checkboxes in one or more columns.

• COLH=Add column headers at the top.

• DATES= Signifies the grid contains dates in one or more columns.

• DOCV=Internal Barista code used for Document Output System.

• DRAG=Enable drag-and-drop.

• EDIT=Editable.

• HIGHO=Selects outline highlighting, as opposed to color.

• ICONS=Internal Barista code used for Framework Menu System.

• LIGHT=Lightens the color of horizontal and vertical grid line per Barista standards.

• LINES=Show horizontal and vertical grid lines.

• MULTI=Enable multi-cell selection.

• NOSCROLL=Suppress scrollbars.

• NOSIZE=Disallow resizing.

• PROP=Formats grid to Barista property sheet standards.

• ROWH=Add row headers on the left edge.

• SIZEC=Auto-resize last column.

• SORT=Make the columns sortable.

• TIGHT=Reduce the row height.

• VBOTTOM=Set vertical alignment to bottom.

• VCENTER=Set vertical alignment to center.

• VTOP=Set vertical alignment to top.

rd_num_rows

Number of rows.

rd_attr_def_col$[]

Column Attribute Definition Array. (See Barista Data Structures)

rd_inq_disp_col$

Variable length string defining which column ids are initially displayed. Each segment contains <table_id.column_id> and is padded to 40 bytes.

rd_attr_col$[]

Column Attribute Array. (See Barista Data Structures)

rdListVect!

Unused.

bam_inquiry.bbj

File Inquiry System

Parameter

In

Out

rd_gui_dev

This variable always exists in the Barista environment; pass it as given.

Form!

This standard Barista variable identifies the current form.

rd_alias_id$

Table alias to query.

rd_inq_mode$

• "DRILL"=Places inquiry into drilldown mode (future)

• "MULTI"=Allows selection of multiple rows

• "VIEW"=View only; does not allow selections.

• "ALL"=Overrides hide/show status and displays all columns.

rd_table_chans$[]

This array always exists in the Barista environment; pass it as given.

rd_key_pfx$

Key prefix.

rd_key_id$

Key name.

rd_selected_key$

Start value.

User-selected value.

rd_filter_defs$[]

Unused

bam_prog_bar.bbj

Display standard Barista progress meter during long-running processes (updates or reports)

Parameter

In

Out

rdSysGUI!

This variable always exists in the Barista environment; pass it as given.

rdBaseWin!

Identifies the calling form.

rdBarWin!

Identifies the progress form.

rd_meter_title$

Progress Bar Title

rd_total_recs

Total number of records.

rd_proc_recs

Current number of records.

rd_curr_data$

The text to display if "TXT" is specified in rd_action$ (below)

rd_action$

One or more of the following:

• "WIN"=Display window.

• "MTR"=Display progress bar.

• "TXT"=Display text specified in rd_curr_data$.

• "LST"=Display list box.

• "LSR"=Display list box in reverse order.

• "END"=End of job.

• "OK"=Add end of job "OK" button.