Home page
Release Information
Reality on the Web
MultiValue Compatibility
Documentation Overview
Installation Guides
User's Reference
General
About this Section
Contents
Conventions
New Features in Reality V14.1
MultiValue Compatibility
Case-insensitivity
Other MultiValue Features

Other Enhancements
TCL
DataBasic
SQL for Reality
Administration
Installing Updates
Documentation

Restrictions

Introduction to Reality
Overview
Multiple Databases
Reality Files on Foreign Databases
SQL-View
SQL Access
External Interfaces
Multiple Versions
Database Types
System Configuration
Database Management Utilities
Operational Facilities
Optional Facilities

Entering and Operating in a Reality Database
Entering Reality on a UNIX Host
Entering Reality on a Windows Host
Reality User-id and Account
Operating at TCL

Database Structure
File Structure
Two-level User File Structure
File-specifier

Dictionaries, Data Sections and Indexes
SYSTEM Dictionary
Master Dictionaries
File Dictionaries
Data Sections
Index Sections

Security
Database Security
Host System Security

Database Management Facilities
Terminal Control Language
English Retrieval Language
DataBasic Programming Language
Proc: The Stored Procedure Language
TCL Macros
Editors

Operating Facilities
Spooler
Save and Restore Utilities
Magnetic Tape Unit Operation Utilities
Terminal Independent Process Handler
File Triggers

Case Sensitivity
MultiValue Compatible Databases
Data Case-insensitivity
Keyword Case-insensitivity
Item-id Case-insensitivity

File and Item Structures
File Structure
Groups
Frame Size

Item Structure
Direct Item
Indirect Item

Character-oriented Item
Attributes
Values
Subvalues
Example of Character-oriented Item

Account Definition Item
Synonym Account Definition Item
Remote Account Definition Item
LOGON Item
File Definition Item
File Synonym Definition Item
Single Level Dictionary File
Remote File Synonym Definition Item
Implicitly Specified Remote System
Implicitly Specified Local System

Command Definition Items
Overview
TCL-I Command Definition Items
TCL-II Command Definition Items
English Command Definition Items
Cataloged DataBasic Program Definition Items
Proc Definition Items
TCL Macros
Command Synonym Definition Items
Connective, Modifier, and Relational Operators

Data Level Descriptor
Single Level Dictionary Files

Data Definition Item
Index Definition Item
Data Item

File and File Index Management
Overview
Reality File Types
Creating a File
Deleting Files and Items
Copying an Item
Reformatting Data
Searching for an Item-id
Searching for a String
Listing Files in an Account
Listing/Sorting Items in a File
Moving and Renaming Files
File Hashing Statistics
Comparing Items
Managing Indexes
Optimising File Size (Partition Database only)

Creating Files
Files on Foreign Databases

Indexing
Accessing Indexes
TCL Commands for Managing Indexing
Indexes in the Database File Structure

Sizing Files and Indexes
Files
Indexes
Automatic File Sizing
Creating an Automatically Sized File
Converting an Existing File to use Automatic File Sizing
Expanding and Contracting Manually
Other Automatic File Sizing Tasks

Manual Resizing
Changing the Modulo of a File
Using CREATE-FILE for Resizing
Using Reallocation Parameters
Dynamic Resizing (Partition Database Only)
Resizing System Files

Changing the Modulo of a Dictionary
Changing the Modulo of an Index

Selecting the Modulo for a File
Selecting the Modulo for an Index

TCL and General User Commands
Introduction to the Terminal Control Language
Command Definition Items
Synonym Command Definition Items
Further Information
TCL Input Processing
TCL-I Commands
TCL-II Commands
English Commands
Item-List-Generating Commands
Cataloged DataBasic Programs
TCL Macros
Procs

General Procedures
Use of the Return Key
Continuation Character
Typeahead
Screen Control
Editing Functions
TCL Stacker

Customising the Master Dictionary
Command Synonym Definition Items
Adding Commands

TCL Macros
Types of Macro
Creating Macros
Executing Macros
COMMENT Command
DISPLAY Command
PROMPT Command
REM Command

Command Reference
. (Dot - TCL Stacker Recall Command)
A
ADDD
ADDX
AFS-CLEAR command
AFS-SET command
ALLOW-TANDEM

B
BLOCK-PRINT
BLOCK-TERM
BTX

C
CASE
CHARGE-TO
CHARGES
CLEAR-FILE
CLEAR-MSG
CLEAR-OPTION
COMP
COMPARE
COPY
CP
CREATE-FILE
CREATE-INDEX
CT

D
DATAPRODUCTS
DATE-FORMAT
DEFINE-INDEX
DEL-LANG
DELETE
DELETE-FILE
DELETE-INDEX
DIR-VIEW
DIVD
DIVX
DO
DTX

E
ENCRYPT-SET

F
FDB-CLEAR
FDB-SET
FDB-SHOW
FIELDREAD
FIND

H
HASH-TEST
HUSH

I
ICOUNT
ISELECT
ISTAT

L
LIST4
LISTDFILES
LISTF2/3/4
LISTFILES
LIST-INDEXES
LISTQFILES
LISTVERBS
LOAD-ALPHA
LOAD-COLL
LOAD-FR
LOAD-LANG
LOGTO
LOOP-ON

M
MAN
MESSAGE and MSG
MOVE-FILE
MULD
MULX

N
NOHUSH

O
OFF

P
P
PASSWORD
PD
PEEK
POKE
PRINT-ERR
PRINTRONIX

R
RENAME-FILE
RESET-ALPHA
RUNOFF

S
SEARCH
SELECT-INDEX
SET80 and SET132
SET-ALPHA
SET-COLL
SET-DEC
SET-ENVIRONMENT
SET-FILE
SET-LANG
SET-MONEY
SET-OPTION
SET-STACK
SET-THOUS
SHOW-MODULI
SLEEP
SORT2/3/4
SQL-VIEW
SUBD
SUBX
SYS

T
TANDEM
TERM
TIME
TYPEAHEAD-OFF and ON

U
USER

V
VERIFY-INDEX

W
WHO

X
XTB
XTD

Decimal, Hexadecimal, and ASCII Table

Operation
About this Section
Contents
References
Conventions

Spooler
Overview of Printing and the Spooler
Introducing the Spooler
Spooler Maintenance
Printer Control

Print Job Assignment (Print Reports)
Assignment Table

Print Jobs
Job-id
PRINT.JOB.CONTROL file
Job file
Putting Jobs on Hold

Formqueues
Creating a Formqueue
Public and Private Formqueues
Banners

Despoolers
Creating a Despooler Definition
Starting a Despooler
Multiple Despoolers and Formqueues
Checking for Despooler Errors
Monitoring Despoolers
Resolving Despooler Problems

Output Devices
System Printer
Private Printer
Reality Port
Network Printer
Tape Device
Despooling to a File

Printer Interface Scripts (UNIX Host Only)
Remote Spooling
Setting Up
Operation
Alternative to Remote Spooling

Network Printing
Printer Sharing
Printer Sharing using npu (UNIX only)

Printer Control Features
Printer Independence
Prologues and Epilogues

Procedure for Setting Up Printers
Using Printers
Windows
UNIX
Examples

Example of Setting Up Multiple Formqueues and Despoolers
Setting Up the Despoolers
Setting Up the Formqueues

Transaction Handling/Logging
Transaction Handling
Transaction Logging

General Spooler Procedures
BUILD.DESPOOLERS - Creating Port and Tape Despooler Records
BUILD.PRINTERS
DESPOOLER.DETAIL - Listing All Despoolers on a Database
DSPMON - Managing Despoolers
PORT-DESPOOL - Despooling Print Jobs to a Port
RESET.DESPOOLER - Resetting the Despooler System
SP-ASSIGN - Assigning Print Report Characteristics
SP-CLOSE - Closing A Print Job
SP-COPY - Copying Print Jobs to Another Job File
SP-DESC - Entering/Displaying a Print Job Description
SP-EJECT - Ejecting Blank Pages from a Printer
SP-FIX - Cleaning Up Print Jobs After a Program Crash
SP-FORMQUEUE - Listing All Print Jobs in a Formqueue
SP-LOOK - Displaying the Current Spooler Assignment
SP-TAPEOUT- Transferring Print Jobs from Tape to a Formqueue

SP-STATUS and Related Procedures
SP-STATUS
Action Code 1 Create Queue and SP-CREATE
SP-CREATE with RealityX 3.1 Syntax
Action Codes 2 and 3 (SP-FORM and SP-TYPE)
Action Code 4 Change Device and SP-DEVICE
SP-DEVICE with RealityX 3.1 Syntax
Action Code 5 Change Page Skip and SP-SKIP
Action Code 6 List Print Jobs and SP-JOBS
Action Code 7 Delete Queue and SP-FQDELETE
Action Code 8 Change Translation and SP-TRANSLATE
Action Code 9 Start Despooler and START-DESPOOLER
Action Code 10 Stop Despooler and STOP-DESPOOLER
Action Code 11 Toggle FQ/ sys q's
Action Code 12 Despooler List and SP-DESPOOLERS

SP-JOBS and Related Procedures
SP-JOBS
Action Code 1 Switch All Jobs and SP-MOVEQ
Action Code 2 Switch One Job and SP-SWITCH
Action Code 3 Change Options and SP-OPTS
Action Code 4 Change #Copies and SP-COPIES
Action Code 5 Delete Job and SP-DELETE
Action Code 6 Stop Printing and SP-STOP
Action Code 7 Resume Printing and SP-RESUME
Action Code 8 Edit Print Job and SP-EDIT
Action Code 9 Suspend Printing and SP-SUSPEND
Action Code 10 Top Priority and SP-PRIORITY
Action Code 11 SP-STATUS and SP-STATUS
Action Code 12 Kill Printing and SP-KILL
Action Code 13 Align Printer and SP-ALIGN
Action Code 14 Clear Queue and SP-CLEAR
Action Code 15 FQ/System Jobs
Action Code 16 Display Detail and SP-DETAIL
Action Code 17 Reset Selection
Action Code 18 Change Job File
Action Code 19 Re-queue Hold File and SP-QUEUEHOLD

Spooling System Maintenance
SPM Command: Spooler Maintenance
FORM.QUEUES File Maintenance
FORM.QUEUES File Maintenance Menu (FQM)
Option 1 - Queue Type
Option 2 - Page Skip
Option 3 - Print Banner
Option 4 - Tape Block Size
Option 5 - Tape Density
Option 6 - Tape Label Type
Option 7 - Printer Page Width
Option 8 - Printer Page Length
Option 9 - Number of Lines to Skip at Top of Page
Option 10 - Default Job File
Option 11 - Formqueue Description
Option 12 - Prologue Item-id
Option 13 - Epilogue Item-id
Option 14 - Control Program
Option 15 - Private Queue Reference
Option 16 - Assigned Despoolers

DESPOOLER.CONTROL File Maintenance
Despooler Maintenance Menu
Option 1 - Device Type
Option 2 - Device Name
Option 3 - Printer Independence Item-id
Option 4 - Translation Table Number
Option 5 - Prologue Item-id
Option 6 - Device Description
Option 7 - Device Location
Option 8 - Assigned Formqueues
Option 9 - Permanent or Shared
Option 10 - Printer Hold Time
Option 11 - Despooler Sleep Time

PRINTER COMMAND STRING Maintenance
PCS Maintenance Menu
Creating a PCS
Option 1 - Building a PCS Using the Editor
Option 2 - Building a PCS Using the Screen Editor
Option 3 - Processing the PCS Source Definition
Option 4 - Producing the PCS Output

Additional Information
Status Conditions and Values
Status Conditions
Status Values in Numeric Order

SPOOL.JOBS Dictionary Items
List of Dictionary Items

Spooler File Formats
PRINT.JOB.CONTROL File
FORM.QUEUES File
DESPOOLER.CONTROL File

Checking for Spooler Errors

Save and Restore
Overview
Logical Saves
Physical Saves
tlmenu

Restore Procedures
Restoring a Database
Restoring Accounts
Restoring Files and Items
Restoring Files onto a Foreign Database

Notes on Save and Restore
Reality Files on Foreign Databases
Excluding Accounts/Files from Backup
Transferring Data between Different Versions of Reality
Error Messages

Save Commands
ACCOUNT-SAVE
FILE-SAVE
F-S
IMG.SAVE
IMG.VERIFY
M-A-S
realdump
SAVE
SAVE-IMAGE
VERIFY-IMAGE
VERIFY-SAVE
OLD-SAVE Commands
OLD-ACCOUNT-SAVE
OLD-FILE-SAVE
OLD-SAVE

Restore Commands
ACCOUNT-RESTORE
IMG.LOAD
LOAD-IMAGE
M-A-R
realload
SEL-RESTORE

Multideck Save/Restore Utility (dbsave)
Purpose
Syntax
Options
Restrictions
Files
Main Menu
Multideck Calibration
Calibrate System
Calibrate Account

Multideck System Save
Multideck System Restore
Configuration File
Example

Tape Operation and Commands
Summary of Tape Unit Commands by Category
Overview of Tape Operations
Precautions When Using Tape
Attaching a Tape Unit
Tape Unit Numbers
Data Channels
Detaching a Tape Unit
Multiple Tape Units
Sequencing of Tape Units
Error Messages
Remote Tape
Tape Images
Data Encryption
Record Size
Tape Labels
Paper Label Details
Data Label Formats
Label Suppression

Tape Commands
ASSIGN
CHECK
CLEAR-ASSIGN
DISCTOTAPE
SPACE
TAPETODISC
T-ATT
T-BCK
T-CHK
T-COPY
T-DET
T-DEVICE
T-DUMP and ST-DUMP
T-ERASE
T-FWD
T-LOAD
T-RDLBL
T-READ
T-RETENSION
T-REW
T-STACKER
T-STATUS
T-UNLOAD
T-VERIFY
T-WEOF

Using TIPH
Introduction
TIPH Output
TIPH Input
PH-HISTORY File

PH-ALLOCATE
PH-DELETE
PH-KILL
PH-LINES
PH-START
PH-STATUS

Administration
About this Section
Contents
References
Conventions

An Overview of Reality Administration
Introduction
Types of Database

Administration in the Host System Environment
Administration in Reality

Introduction to the Reality Environment
Overview
System Accounts
SYSMAN Account
SYSPROG Account
SYSFILES Account
ACC File
BLOCK-CONVERT File
ERRMSG File
FEATURES File
NEWAC File
PH-HISTORY File
POINTER-FILE
PROCLIB File
SERVICE-LOG File
TCL.LOG File
USER.LOG File

GLOBAL.MD Account
BASIC.CONVERSION Account
DENAT Account
Training Accounts

Licences
User Licences
Optional Features
Installing Software Keys
Reserved Licences
Database Configuration
Licence Expiry

Administration from Reality
Securing the Database Using SSM
Introduction
Database Access Profiles
Environments
Data Encryption

User-based Security
User Profile
User Passwords
Security Profile
Assignment of Security Profile to User Profile

Location-based Security
Physical Location Identifier (PLId)
Network Profile
PLId Formats
Partial PLId
Consistent Circuit Identifier (CCI)

The SSM Command
SSM Screen
Profiles Screens

SSM Option 1 - Define Network Profiles
NETWORK File Maintenance Options

SSM Option 2 - Define User Profiles
Choosing a User-id
USERS File Maintenance Options
Setting Up Remote Database Details on Windows

SSM Option 3 - Define Security Profiles
SECURITY File Maintenance Options
Restricted Access Lookup File
Host Command Shell Security

SSM Option 4 – Define Environment Settings
Environment Options

SSM Option 5 - Encryption Key Maintenance
Setting up Security for External Access
RealWeb
Web Services
RealEdit
SQL for Reality

Securing the Security System
Overview
SYSMAN Account
SYSTEM File
System Debugger

Database Account Management
Introduction to Accounts
What is an Account?
What are Accounts for?
What Happens at Logon?
User-ids, Locations and Accounts
The Account Master Dictionary and Command Definition Items
Other Items in MD
File Lock Codes
Access to Files
English Definition Items and Command Synonyms
Creating Accounts
Deleting Accounts
Renaming Accounts
More Information

Retrieval and Update Lock Codes and Keys
Entering Lock Codes and Keys
Account and User Locks and Keys
File Locks
Code Comparison
Lock and Key
Sample Update and Retrieval Lock Codes

Logon Processor
Logon Prompt
First Logon Message: 'LOGON' in ERRMSG
Welcome Message: '335' in ERRMSG
Editing Logon Prompt and Message
Logon Control Programs
User Logon Program
Global Logon Program
Account Logon Program
TCL-inhibit Program

Controlling Logons
Monitoring Database Users
Locks and the Locking Systems
Read/update Locks (Group Locks)
Item Locks
Item Deadlock Detection

Execution Locks
Monitoring and Maintaining Locks

Data Encryption
Configuring Reality to use Data Encryption
Encryption Keys
Encrypted Files
Giving Users Access to Encrypted Files
Copying Encrypted Data to another Host
Notes

File Triggers
How to Associate a Trigger with a File
Commands that might run Triggers

File Statistics Reports
Contents of the Report
STAT-FILE File
Group Format Errors

Reporting System Usage
USER.LOG
Account Statistics
Command Logging

Maintaining ACC File
Determining Free Space Availability
Improving Database Efficiency
Database Setup
Create/Update Proc
Database Start-up Proc

Miscellaneous Commands
Command Reference
%FULL
A
AFS-CONTRACT
AFS-ENABLE
AFS-EXPAND
AFS-HOLD
AFS-SELECT
AFS-TRIM
ACCOUNT-FILE-STATS
ALL-FILE-STATS
ANALYZE

B
BREAK
BREAK-KEY-OFF
BREAK-KEY-ON

C
CLAIM
CLEAR-BASIC-LOCKS
CLEAR-ITEM-LOCKS
CONVERT-FILE
CREATE-ACCOUNT
Creating a Local Account
Creating a Remote Account
Creating a Synonym Account

CREATE-TRIGGER
CSV-COPY
CUSTOMER.IDENT

D
DBUPDATE
DEFINE-ENVIRONMENT
DELETE-ACCOUNT
DELETE-TRIGGER

E
ENABLE
ENABLE-LOGONS
EVFU-SETUP

I
INHIBIT-LOGONS

L
LIST-EXECUTION-LOCKS
LIST FEATURES
LIST-FILE-STATS
LIST-GROUP-LOCKS
LIST-ITEM-LOCKS
LIST-LOCKS
LISTPF
LISTPROCS
LIST-$STAT-FILE*
LIST-TRIGGERS
LISTU
LOAD-REK
LOGOFF
LOGON

M
MAKE-SPECIAL
CSV View
Environment File
File View
Item Lock List View
Index Views
Licence View

N
NET-LOGON

O
OPTIMUM-FRAME-SIZE
OPTIMUM-MODULO

P
POVF

R
RESIZE-FILE

S
SAVE-REK
SET-ADMIN-KEY
SET-PRIORITY
SET-PRIV
SETUP-ACCOUNT
SHOW-ITEM-LOCKS
SHUTDOWN
SIZE-MONITOR
START-AUDIT-LOG
START-SUPPORT-LOG
STOP-AUDIT-LOG
STOP-SUPPORT-LOG
SYS-UPDATE

U
UPDATE-ACCOUNT
UPDATE-ALL-ACCOUNTS
UPDATE-SERVICE-LOG

V
VERIFY-SYSTEM

W
WHERE

Reality on the Host
Reality in the Host Environment
Overview
Differences between UNIX and Windows
Reality Software
The realman Directory
Defining the Live Version
Reality Executables Directory

Database Structure
DataBase Types
Database Directory

Reality/Host Integration
System Security

Administration from the Host
Starting and Stopping Reality
Automatic Startup
Manual Startup
Automatic Shutdown
Manual Shutdown

Creating and Removing a Database
Creating a Database
Enlarging a Database
Removing a Database

Locking and Unlocking a Database
Locking a Database
Unlocking a Database

Improving Database Efficiency
Monitoring File Size
Dynamic Resizing of Files
Resizing System Files

Checking a Database for Errors
Checking the Database Automatically at Startup

Database Setup
Host Utilities
chkdev
install_fix
Install_Key
installkeys
Install_rt
Install_SN
killreal
lockdbase
mkdbase
Using mkdbase
mkdbase Menu Interface
mkdbase Command Line Interface
realfstab File

perror
realdbck
reality
realresize
Realrts
realserv
realstart
realusers
rmdbase
show_key
sizemon
unlockdbase

Reality Configuration on the Host
User-Ids
Starting Reality Automatically
Password Integration (UNIX only)
Environment Variables
Reality Version
Database, User-id and Account
Setting Environment Variables at Logon
Available Environment Variables

Database Configuration Parameters
AllowLogonPlease
AutoFileSize
ClearTempDir
CompressTapeImage
DateFormat
DbStart
DefaultSystemPrinterType
DeferCloseMax
DeferCloseLevel
ForceFreeSpaceUpd
ForcePasswordCheck
FrameSize
FSCheckpointPath
HashType
ItemLockTimeOut
ListAllItemLocks
MaxPortNum
NumConnections
NumDataSects
NumIndexSects
NumItemLocks
NumPseudoPorts
PortRange
RealDbCk
RealIdleDespoolerSleep
ShareModulo
ShareSize
shmsz
SkipLogonProc
SuppressPasswordLogging
TempDir
Tape Definitions
Remote Tape Device Definitions
Data Encryption
Tape Images
Typical Configuration
Examples

Daemon Log Rotation
SYS Security Files
PLId to Port Mapping
Setting Up the Devices File
PLId and Port Specifications
Keywords
Examples

Checking the Devices File for Errors

Reserved Licences
Setting Up the Number of Reserved Licences
Setting Up Privileged Ports

Reality Break Character
Setting Up and Releasing Reality Private Printers (UNIX only)
Converting to a Private Printer
Setting Up Printer Security
Starting the Printer
Restoring a System Printer

Allocating TIPH Ports (UNIX only)

Backup and Recovery on the Host
Introduction
UNIX Back-up and Recovery Utilities
Databases Based on Host Files
Partition Databases using Multiple Partitions
Backup Procedures
Recovery Procedures

Networking
Routing Information
Network Security Features
Setting-up Remote Logon
Setting-up Remote File Access
Setting-up Interprocess Communication
Setting-up Network Printing
Setting-up Network Logon
Location-Based Security
Log Files
Network Error Messages
Windows Network Administration Utility
Destination Hosts
Alternative Hosts
Listening Entries
Remote Databases
Local Databases
Session Manager Options
Setting up Defaults

System Alerts
Configuring System Alerts
Raising System Alerts
realevent
ALERT command

Database Isolation
Creating Instances
Deleting Instances
Updating the Instance Software
Administering a Reality Instance
realbind
realclone
realroot

Dealing with System Problems
Introduction
Training Users to Report Problems

Common User Problems and Solutions
Abnormal Termination
Terminal Related Problems
Incorrect Terminal Operation (UNIX)
No Keystroke Echo
Keyboard Inoperative
Terminal Inoperative

Tape Errors
Parity Errors on Tape
Cannot Attach to Tape Image Device

Terminal/PC Locked
Permission Denied Message (UNIX Only)
Unable to Logon
Unable to Start Reality
Ethernet Problems on a UNIX Host
Hashes Returned when Reading from a File
Proc or TCL Macro Fails
Documentation Problems

Networking Problems
Problems following Solaris Upgrade

Serious Problems
Serial Numbers
Problems with One Terminal
Reality on Windows Fails to Start
Aborts and Core Dumps

Log Files
Error Numbers
Example Messages

System Debugger
Introduction
Interrupting Execution
Loss of Data
Aborts
Commands

MultiValue Compatibility
File Modifiers
Tape Images (Pseudo-floppy)
FLOPPYTOTAPE
TAPETOFLOPPY

SP-ASSIGN
ACCOUNT-RESTORE
VERIFY-SAVE
MIGRATE.ACCOUNT

TCL Commands Listed by Category

English Reference
DataBasic Reference
Proc Reference
Editors
Resilience
SQL for Reality
UNIX-Connect
External Interfaces
Other Documents