ObjectSearchCache

OMW Data Access

Major Business Rule

Object Name: B98220B

Parent DLL: COBJLIB

Location: Client

Language: C

1.Functional Description

1.1Purpose
This is a generic object search cache used by the Object Management Workbench.  It is designed to store many different kinds of records from the
various OneWorld Object Master tables.  It will store records for the following object types:
• All Object Librarian Object Types
• UBE & APPL versions
• Workflow
• UDC
• Menu
• ActivEra
• Users
• Data Dictionary
•
1.2Setup Notes and Prerequisites
The cache must first be initialized before using.  It also must be terminated after it is no longer
needed.

1.3Special Logic
This function uses the OneWorld caching API.

Data Structure

D98220H - Object Search Cache

Parameter Name Data Item Data Type Req/Opt I/O/Both

cMode EV01 char REQ INPUT

'1' - Load Cache with Search String
'2' - Add Record To Cache
'3' - Reset Cursor
'4' - Get Next Cache Record
'5' - Terminate Cache
'6' - Close Cursor
'7' - Delete All
'8' - Fetch Specific Record

szObjectTypeSearch OMWOT char OPT INPUT

Pass in 'OL' if searching any of the OL or Version object type.  Otherwise, pass in the OMW object type from H92/OT.
^

szObjectSearchType OMWSRTP char OPT INPUT

Use the values from the associated UDC for the Object Type Search:
• OL - H92/OL
• Data Dictionary - H92/DD
• Menu - H92/MN
• UDC - H92/UD
• ActivEra - H92/AV
• Project - H92/PJ
• Workflow - H92/WF
• User - H92/US
^

szSearchString OMWOBJID char OPT INPUT

Input Search String.  Will be used to load the cache for mode 1.
^

szOMWTreeNode OMWTRNODE char OPT BOTH

Tree Node Return or Set Value.  Used to set the cache in mode 2.  Cache return in mode 4.
^

szObjectID OMWOBJID char OPT BOTH

The primary key of an object.  Will be bar '|' delimited if the key has more than one field. Used to set the cache in mode 2.  Cache return in mode 4.
^

szObjectType OMWOT char OPT BOTH

Object Type of the passed in or out record.  If this is a user, this field will be blank.  Used to set the cache in mode 2.  Cache return in mode 4.
^

idCursor APPLID ID OPT BOTH

Cursor for the cache
^

idSearchNum APPLID ID OPT INPUT

1 - Project Search
2 - Object Searchab

^

idhRequest APPLID ID OPT BOTH

Stored hRequest for the search.  This is to implement page at a time processing.ab

^

szDescription OMWTRNODE char OPT INPUT

Object Description that is passed in to concatenate to the object ID to form the tree node during mode 2.
^

idSequence APPLID ID OPT BOTH

Used to remember the last sequence fetched or added into the cache.
^

Related Functions

B98220C OMW SAR Integration

Related Tables

F0004 User Defined Code Types

F0082 Menu Master File

F0083 Menu Text Override File

F0092 Library Lists - User

F0101 Address Book Master

F9000 Task Master

F9001 Task Relationships

F9005 Variant Description

F9020 Solution Explorer Qualifier Rules Header

F9030 Documentation Cross Reference

F9200 Data Item Master

F9203 Data Item Alpha Descriptions

F9210 Data Field Specifications (OneWorld)

F98220 OMW Project Master

F98221 OMW Project Users

F98222 OMW Project Objects

F983051 Versions List

F9860 Object Librarian Master Table

F9862 Object Librarian - Function Detail

F98800 Process Master

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cMode	EV01	char	REQ	INPUT
'1' - Load Cache with Search String '2' - Add Record To Cache '3' - Reset Cursor '4' - Get Next Cache Record '5' - Terminate Cache '6' - Close Cursor '7' - Delete All '8' - Fetch Specific Record
szObjectTypeSearch	OMWOT	char	OPT	INPUT
Pass in 'OL' if searching any of the OL or Version object type. Otherwise, pass in the OMW object type from H92/OT. ^
szObjectSearchType	OMWSRTP	char	OPT	INPUT
Use the values from the associated UDC for the Object Type Search: • OL - H92/OL • Data Dictionary - H92/DD • Menu - H92/MN • UDC - H92/UD • ActivEra - H92/AV • Project - H92/PJ • Workflow - H92/WF • User - H92/US ^
szSearchString	OMWOBJID	char	OPT	INPUT
Input Search String. Will be used to load the cache for mode 1. ^
szOMWTreeNode	OMWTRNODE	char	OPT	BOTH
Tree Node Return or Set Value. Used to set the cache in mode 2. Cache return in mode 4. ^
szObjectID	OMWOBJID	char	OPT	BOTH
The primary key of an object. Will be bar '\|' delimited if the key has more than one field. Used to set the cache in mode 2. Cache return in mode 4. ^
szObjectType	OMWOT	char	OPT	BOTH
Object Type of the passed in or out record. If this is a user, this field will be blank. Used to set the cache in mode 2. Cache return in mode 4. ^
idCursor	APPLID	ID	OPT	BOTH
Cursor for the cache ^
idSearchNum	APPLID	ID	OPT	INPUT
1 - Project Search 2 - Object Searchab ^
idhRequest	APPLID	ID	OPT	BOTH
Stored hRequest for the search. This is to implement page at a time processing.ab ^
szDescription	OMWTRNODE	char	OPT	INPUT
Object Description that is passed in to concatenate to the object ID to form the tree node during mode 2. ^
idSequence	APPLID	ID	OPT	BOTH
Used to remember the last sequence fetched or added into the cache. ^

F0004 User Defined Code Types
F0082 Menu Master File
F0083 Menu Text Override File
F0092 Library Lists - User
F0101 Address Book Master
F9000 Task Master
F9001 Task Relationships
F9005 Variant Description
F9020 Solution Explorer Qualifier Rules Header
F9030 Documentation Cross Reference
F9200 Data Item Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
F98220 OMW Project Master
F98221 OMW Project Users
F98222 OMW Project Objects
F983051 Versions List
F9860 Object Librarian Master Table
F9862 Object Librarian - Function Detail
F98800 Process Master