Routines for scimcach.kb


ASGetSCIM

File Name

scimcach.kb

Syntax

ASGetSCIM(VAL SCIM: LIST OF STRING, REF MetaData, Data: LIST OF STRING);

Parameters

SCIM - currently selected SCIM

MetaData - describes network message data

Data - network message data

Returns

Integer

Side Effects

None

Description

Gets the next level of the SCIM from the application server.

Dialog Forms Called

None


ASGiveComponent

File Name

scimcach.kb

Syntax

ASGiveComponent(VAL System: STRING, REF MetaData, Data: LIST OF STRING)

Parameters

System - current System

MetaData - describes a network message

Data - data from a network message

Returns

None

Side Effects

None

Description

On the application server, sends the component list to the client.

Dialog Forms Called

None


ASGiveItem

File Name

scimcach.kb

Syntax

ASGiveItem(VAL System, Component: STRING, REF MetaData, Data: LIST OF STRING);

Parameters

System - current system

Component - current component

MetaData - describes network message

Data - data for network message

Returns

None

Side Effects

None

Description

On the application server, sends item list to client.

Dialog Forms Called

None


ASGiveModule

File Name

scimcach.kb

Syntax

ASGiveModule(VAL System, Component, Item: STRING, REF MetaData, Data: LIST OF STRING);

Parameters

System - current system

Component - current component

Item - current item

MetaData - describes a network message

Data - data for a network message

Returns

None

Side Effects

None

Description

On the application server, sends the module list to the client.

Dialog Forms Called

None


ASGiveSCIM

File Name

scimcach.kb

Syntax

ASGiveSCIM(VAL SCI: LIST OF STRING, REF MetaData, Data: LIST OF STRING);

Parameters

SCI - currently selected SCIM

MetaData - describes the network message

Data - data for a network message

Returns

None

Side Effects

None

Description

The next level of the SCIM is calculated and sent to the client.

Dialog Forms Called

None


ASGiveSystem

File Name

scimcach.kb

Syntax

ASGiveSystem(REF MetaData, Data: LIST OF STRING);

Parameters

MetaData - describes network mesage

Data - data for a network message

Returns

None

Side Effects

None

Description

Used on the application server to give a system list to a client.

Dialog Forms Called

None


ASLoadComponent

File Name

scimcach.kb

Syntax

ASLoadComponent(VAL System: STRING);

Parameters

System - current system

Returns

None

Side Effects

None

Description

Gets a component list for system from the application server.

Dialog Forms Called

None


ASLoadItem

File Name

scimcach.kb

Syntax

ASLoadItem(System, Component: STRING);

Parameters

System - current system

Component - current component

Returns

None

Side Effects

None

Description

Loads the item list from the application server.

Dialog Forms Called

None


ASLoadModule

File Name

scimcach.kb

Syntax

ASLoadModule(System, Component, Item: STRING)

Parameters

System - current system

Component - current component

Item - current item

Returns

None

Side Effects

None

Description

Loads modules from the application server.

Dialog Forms Called

None


ASLoadProblemCodes

File Name

scimcach.kb

Syntax

ASLoadProblemCodes

Parameters

None

Returns

None

Side Effects

None

Description

The problem codes are loaded from the application server.

Dialog Forms Called

None


ASLoadSystem

File Name

scimcach.kb

Syntax

ASLoadSystem

Parameters

None

Returns

None

Side Effects

None

Description

Loads the systems from the application server.

Dialog Forms Called

None


AssociatedProblemType

File Name

scimcach.kb

Syntax

AssociatedProblemType(VAL System, Component: STRING);

Parameters

System - selected system

Component - selected component

Returns

String

Side Effects

None

Description

Retuens the problem type that is associated with the component.

Dialog Forms Called

None


AssociateProblemType

File Name

scimcach.kb

Syntax

AssociateProblemType(System, Component, Problem_Type: STRING);

Parameters

System - current system

Component - component to associate to Problem_Type

Problem_Type - problem type to associate to component

Returns

None

Side Effects

None

Description

In the cache, a link is created between component and Problem_Type.

Dialog Forms Called

None


DeleteComponent

File Name

scimcach.kb

Syntax

DeleteComponent(VAL System, Component: STRING);

Parameters

System - current system

Component - component to delete

Returns

None

Side Effects

None

Description

Component is removed from the cache.

Dialog Forms Called

None


DeleteItem

File Name

scimcach.kb

Syntax

DeleteItem(VAL System, Component, Item: STRING);

Parameters

System - current system

Component - current component

Item - item To delete

Returns

None

Side Effects

None

Description

Item is removed from the cache.

Dialog Forms Called

None


DeleteModule

File Name

scimcach.kb

Syntax

DeleteModule(VAL System, Component, Item, Module: STRING);

Parameters

System - current system

Component - current component

Item: Current Item

Module - module to delete

Returns

None

Side Effects

None

Description

Module is removed from the cache.

Dialog Forms Called

None


DeleteProblemCode

File Name

scimcach.kb

Syntax

DeleteProblemCode(VAL problem_code: STRING)

Parameters

problem_code - code to remove from cache

Returns

None

Side Effects

None

Description

Problem code is removed from the cache.

Dialog Forms Called

None


DeleteProblemType

File Name

scimcach.kb

Syntax

DeleteProblemType(Problem_Type: STRING);

Parameters

Problem_Type - type to remove

Returns

None

Side Effects

None

Description

Problem type is removed from the cache.

Dialog Forms Called

None


DeleteSeverityLevel

File Name

scimcach.kb

Syntax

DeleteSeverityLevel(VAL severity_level: INTEGER);

Parameters

severity_level - level to remove from cache

Returns

None

Side Effects

None

Description

Severity level is removed from the cache.

Dialog Forms Called

None


DeleteSystem

File Name

scimcach.kb

Syntax

DeleteSystem(Val System: STRING);

Parameters

System - system to delete from cache

Returns

None

Side Effects

None

Description

Removes system from the cache.

Dialog Forms Called

None


FindComponent

File Name

scimcach.kb

Syntax

FindComponent(VAL System, Component: STRING): INTEGER;

Parameters

System - current system

Component - current component

Returns

Integer

Side Effects

None

Description

The index of component is returned.

Dialog Forms Called

None


FindItem

File Name

scimcach.kb

Syntax

FindItem(VAL System, Component, Item: STRING): INTEGER;

Parameters

System - current system

Component - current component

Item - current item

Returns

Integer

Side Effects

None

Description

The index of the item is returned.

Dialog Forms Called

None


FindModule

File Name

scimcach.kb

Syntax

FindModule(VAL System, Component, Item, Module: STRING)

Parameters

System - current system

Component - current component

Item - current item

Module - current module

Returns

Integer

Side Effects

None

Description

The index of the module is returned.

Dialog Forms Called

None


FindProblemType

File Name

scimcach.kb

Syntax

FindProblemType(VAL Problem_Type: STRING): INTEGER IS

Parameters

ProblemType - problem type to find

Returns

Integer

Side Effects

None

Description

The index of the problem type in the cache is returned.

Dialog Forms Called

None


FindSystem

File Name

scimcach.kb

Syntax

FUNCTION FindSystem(VAL System: STRING): INTEGER;

Parameters

System - current system

Returns

Integer

Side Effects

Nothing

Description

The cache index for the system is returned.

Dialog Forms Called

None


ForceTo3t

File Name

scimcach.kb

Syntax

ForceTo3t;

Parameters

None

Returns

Nothing

Side Effects

All subsequent calls to SCIM function causes the client to use the application server.

Description

Sets the global variable, which causes SCIMcach to be 3 tiered.

Dialog Forms Called

None


GetMetaPos

File Name

scimcach.kb

Syntax

GetMetaPos(VAL NumFields, CurrentPos: INTEGER);

Parameters

NumFields - list length of MetaData

CurrentPos - current element pos of data

Returns

Integer

Side Effects

None

Description

Returns the index of MetaData to use.

Dialog Forms Called

None


GetRecordPos

File Name

scimcach.kb

Syntax

GetRecordPos(VAL NumFields, CurrentPos: INTEGER);

Parameters

NumFields - list length of MetaData

CurrentPos - current element pos of data

Returns

Integer

Side Effects

None

Description

Gets the record number in data that is current.

Dialog Forms Called

None


GetSCIMLevel

File Name

scimcach.kb

Syntax

GetSCIMLevel(MetaData, Data: LIST OF STRING);

Parameters

MetaData - ParamName list of string

Data - ParamValue list of string

Returns

Nothing

Side Effects

None

Description

This procedure gets a level of the SCIM, based on the data that is passed in with MetaData and data.

Dialog Forms Called

None


InsertComponent

File Name

scimcach.kb

Syntax

PROCEDURE InsertComponent(VAL System, Component: STRING);

Parameters

System - current system

Component - current component

Returns

None

Side Effects

None

Description

Component is added to the cache.

Dialog Forms Called

None


InsertItem

File Name

scimcach.kb

Syntax

InsertItem(VAL System, Component, Item: STRING);

Parameters

System - current system

Component - current component

Item - item to insert

Returns

None

Side Effects

None

Description

Item is added to the cache.

Dialog Forms Called

None


InsertModule

File Name

scimcach.kb

Syntax

InsertModule(VAL System, Component, Item, Module: STRING);

Parameters

System - selected system

Component - selected component

Item - selected item

Module - module to insert

Returns

None

Side Effects

None

Description

Module is added to the cache.

Dialog Forms Called

None


InsertProblemCode

File Name

scimcach.kb

Syntax

InsertProblemCode(VAL problem_code: STRING)

Parameters

problem_code - ProblemCode to insert

Returns

None

Side Effects

None

Description

Inserts the problem code into the cache.

Dialog Forms Called

None


InsertProblemType

File Name

scimcach.kb

Syntax

InsertProblemType(VAL Problem_Type: STRING);

Parameters

Problem_Type - new problem type to insert

Returns

None

Side Effects

None

Description

Problem type is added to the cache.

Dialog Forms Called

None


InsertSeverityLevel

File Name

scimcach.kb

Syntax

InsertSeverityLevel(VAL severity_level: INTEGER, VAL description: STRING);

Parameters

severity_level - integer value of severity level to insert

Returns

None

Side Effects

None

Description

description of severity level to insert Inserts the new severity level into the cache

Dialog Forms Called

None


InsertSystem

File Name

scimcach.kb

Syntax

InsertSystem(VAL System: STRING) IS

Parameters

System - system to insert

Returns

Nothing

Side Effects

None

Description

System is added to the cache.

Dialog Forms Called

None


LoadComponent

File Name

scimcach.kb

Syntax

LoadComponent(VAL System: STRING)

Parameters

System - current system

Returns

None

Side Effects

None

Description

Loads the component list from the database or application server.

Dialog Forms Called

None


LoadItem

File Name

scimcach.kb

Syntax

LoadItem(VAL System, Component: STRING);

Parameters

System - current system

Component - current component

Returns

None

Side Effects

None

Description

Loads the item list from the database or application server.

Dialog Forms Called

None


LoadModule

File Name

scimcach.kb

Syntax

LoadModule(System, Component, Item)

Parameters

System - current system

Component - current component

Item - current item

Returns

None

Side Effects

None

Description

The module list is loaded from the database or application server.

Dialog Forms Called

None


LoadProblemCodes

File Name

scimcach.kb

Syntax

LoadProblemCodes

Parameters

None

Returns

None

Side Effects

None

Description

The problem codes are loaded from the database or application server.

Dialog Forms Called

None


LoadProblemType

File Name

scimcach.kb

Syntax

LoadProblemType

Parameters

None

Returns

None

Side Effects

None

Description

The problem types are loaded.

Dialog Forms Called

None


LoadSeverityLevels

File Name

scimcach.kb

Syntax

LoadSeverityLevels

Parameters

None

Returns

None

Side Effects

None

Description

The severity levels are loaded from the database.

Dialog Forms Called

None


LoadSystem

File Name

scimcach.kb

Syntax

LoadSystem;

Parameters

None

Returns

None

Side Effects

None

Description

Loads the system list from the database or application server.

Dialog Forms Called

None


QueryAndFilterSystems

File Name

scimcach.kb

Syntax

QueryAndFilterSystems(Security: INTEGER);

Parameters

Security - the current set of rights for an end user

Returns

List of string

Side Effects

None

Description

A list of systems that are visible to the current user are returned.

Dialog Forms Called

None


QueryComponents

File Name

scimcach.kb

Syntax

QueryComponents (VAL System: STRING);

Parameters

System - current system

Returns

List of String

Side Effects

None

Description

A list of components for the system is returned.

Dialog Forms Called

None


QueryItems

File Name

scimcach.kb

Syntax

QueryItems (VAL System, Component: STRING);

Parameters

System - current system

Component - current component

Returns

List of string

Side Effects

None

Description

A list of items for System and Component is returned

Dialog Forms Called

None


QueryModules

File Name

scimcach.kb

Syntax

QueryModules (VAL System, Component, Item: STRING);

Parameters

System - current system

Component - current component

Item - current item

Returns

List of string

Side Effects

None

Description

Returns items for System, Component, Item.

Dialog Forms Called

None


QueryProblemCodes

File Name

scimcach.kb

Syntax

QueryProblemCodes;

Parameters

None

Returns

List of string

Side Effects

None

Description

A list of all problem codes are returned.

Dialog Forms Called

None


QueryProblemTypes

File Name

scimcach.kb

Syntax

QueryProblemTypes;

Parameters

None

Returns

List of String

Side Effects

None

Description

A list of problem types is returned

Dialog Forms Called

None


QuerySeverityLevels

File Name

scimcach.kb

Syntax

QuerySeverityLevels;

Parameters

None

Returns

List of string

Side Effects

None

Description

A list of all severity levels is returned.

Dialog Forms Called

None


QuerySystems

File Name

scimcach.kb

Syntax

Systems:= QuerySystems(whdl: WINDOW);

Parameters

whdl - the currently active window

Returns

List of string

Side Effects

None

Description

A list of systems is returned that are supported by the currently supported organizations as reported by whdl. TSD_MSG_GETORGLIST will be sent to whdl to determine the supported orgs.

Dialog Forms Called

None


QuerySystemsByOrgs

File Name

scimcach.kb

Syntax

Systems:= QuerySystemsByOrgs(ValidOrgs: LIST OF STRING);

Parameters

ValidOrgs - a list of orgs which are currently supported

Returns

List of string

Side Effects

None

Description

A list of systems is returned which are owned by one of the valid orgs passed in.

Dialog Forms Called

None


SCIM_Cache_Event

File Name

scimcach.kb

Syntax

SCIM_Cache_Event(REF SelectedNode: TREENODE) IS

Parameters

SelectedNode - current SCIM node in the tree

Returns

None

Side Effects

None

Description

This is the event handler which can be delegated to have the SCIM handled by a tree control.

Dialog Forms Called

None


UnCacheSCIM

File Name

scimcach.kb

Syntax

UnCacheSCIM;

Parameters

None

Returns

None

Side Effects

None

Description

Dumps the entire SCIM cache and starts a new cache.

Dialog Forms Called

None