Routines for netc_db.kb


CountNetCensusConfigIDs

File Name

netc_db.kb

Syntax

CountNetCensusConfigIDs( REF advHandle: INTEGER, REF censusHandle: INTEGER )

Parameters

advHandle - TSD default connection currently in use

censusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: the number of records in the NetCensus config table

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects a count of records from the NetCensus Table config (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the return of the function.

Dialog Forms Called

None


GetABlockOfConfigIDs

File Name

netc_db.kb

Syntax

GetABlockOfConfigIDs( REF advHandle: INTEGER, REF censusHandle: INTEGER, REF configIDList: LIST OF STRING, REF config_id: STRING, VAL logicalUnitOfWork: INTEGER )

Parameters

advHandle - TSD default connection currently in use

censusHandle - The NetCensus database connetion used

to connect to the NetCensus database

configIDList - list of config_ids to be returned

config_id - used as a starting point for a query, can

be unknown and if so, this will start the query at the

beginning and in the natural order of the data

logicalUnitOfWork - the number of records to process or

also known as the number of records that constitues

a block of configIDs

Returns

INTEGER: database select return value

By REFERENCE - configIDList

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects the config_id from the NetCensus Table config (lower case naming of the assettag is mandated because of case sensitive operating systems) and a list of config ids in the configIDList parameter.

Dialog Forms Called

None


GetAssetTagConfigs

File Name

netc_db.kb

Syntax

GetAssetTagConfigs( REF configList: LIST OF STRING, REF CensusHandle: INTEGER ):

Parameters

configList - List of config_ids

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: the database select return value

By REFERENCE - configList

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects all config_ids from the NetCensus table assettag (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the configList parameter.

Dialog Forms Called

None


GetAttribDefRec

File Name

netc_db.kb

Syntax

GetAttribDefRec( REF aDefRec: Attribute_DefRec, VAL H_Object: STRING, VAL attrib_name: STRING )

Parameters

aDefRec - ATTRIBUTE_DEF record

H_Object - H_OBJECT_ID used as part of the select

attrib_name - attrib_name used as part of the select

Returns

INTEGER: database return value

Side Effects

None

Description

Selects a record from the TSD ATTRIBUTE_DEF table using h_object_id and attrib_name as filters

Dialog Forms Called

None


GetConfigAndProdIds

File Name

netc_db.kb

Syntax

GetConfigAndProdIds( REF configProdList: LIST OF ConfigProdRec, REF CensusHandle: INTEGER )

Parameters

configProdList - List of ConfigProdRec

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: database select return value

By REFERENCE - configProdList

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects config_id and prod_id from the NetCensus Table compon (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the configProdList parameter.

Dialog Forms Called

None


GetConfigIDComponents

File Name

netc_db.kb

Syntax

GetConfigIDComponents( REF CensusHandle: INTEGER )

Parameters

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: The number of records in the NetCensus

table compon

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects a count of records from the NetCensus Table compon (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the return of the function.

Dialog Forms Called

None


GetConfigIds

File Name

netc_db.kb

Syntax

GetConfigIds( REF configList: LIST OF STRING, VAL where: STRING, REF CensusHandle: INTEGER )

Parameters

configList - List of config_id's

where - passed in where clause to be used as part of

of the selection criteria. Can be unknown.

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: database select return value

By REFERENCE - configList

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects all configIDs from the NetCensus Table config (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the configList parameter.

Dialog Forms Called

None


GetNetCensusAssetTags

File Name

netc_db.kb

Syntax

GetNetCensusAssetTags( REF tagList: LIST OF TagClass, VAL where: STRING, REF CensusHandle: INTEGER )

Parameters

tagList - record structure consisting of config_id

prod_id and tag_num used to populate an MCLB

where - passed in where clause to be used as part of

of the selection criteria. Can be unknown.

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: database select return code

By REFERENCE - TagList

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects the config_id, prod_id and tag_num from the NetCensus assettag table (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the tagList parameter.

Dialog Forms Called

None


GetNetCensusComponents

File Name

netc_db.kb

Syntax

GetNetCensusComponents( REF componentList: LIST OF ComponClass, VAL where: STRING, REF CensusHandle: INTEGER )

Parameters

componentList - List of NetCensus ComponClass records

where - passed in where clause to be used as part of

of the selection criteria. Can be unknown.

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: database select return value

By REFERENCE - componentList

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects all config_id, prod_id, comment, serial_num size and unit fields from the NetCensus table compon (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the componentList parameter.

Dialog Forms Called

None


GetNetCensusConfigInfo

File Name

netc_db.kb

Syntax

GetNetCensusConfigInfo( REF config: ConfigClass, VAL where: STRING, REF CensusHandle: INTEGER )

Parameters

config - NetCensus ConfigClass

where - passed in where clause to be used as part of

of the selection criteria. Can be unknown.

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: database select return value

By REFERENCE - config

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects everything from the NetCensus Table config (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the config parameter.

Dialog Forms Called

None


GetNetCensusDataSourceConfigID

File Name

netc_db.kb

Syntax

GetNetCensusDataSourceConfigID( VAL config_id: STRING )

Parameters

config_id: NetCensus config_id to look for

Returns

STRING: sql_cfg_name used to connect to NetCensus database

Side Effects

None

Description

Takes the config_id for the NetCensus asset and looks for if in the TSD EXTERNAL_MAP table and returns the sql_cfg_name which was used to connect to the NetCensus database.

Dialog Forms Called

None


GetNetCensusProductInfo

File Name

netc_db.kb

Syntax

GetNetCensusProductInfo( REF product: ProductClass, VAL where: STRING, REF CensusHandle: INTEGER )

Parameters

product - ProductClass

where - passed in where clause to be used as part of

of the selection criteria. Can be unknown.

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: database select return value

By REFERENCE - product

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects everything from the NetCensus Table product (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the product parameter.

Dialog Forms Called

None


GetNetCensusProducts

File Name

netc_db.kb

Syntax

GetNetCensusProducts( REF productList: LIST OF ProductClass, REF CensusHandle: INTEGER )

Parameters

productList - List of ProductClass

CensusHandle - The NetCensus database connetion used

to connect to the NetCensus database

Returns

INTEGER: database select return value

By REFERENCE - productList

Side Effects

Sets the connection temporarily to the NetCensus database connection then back to the orginal connection.

Description

Selects everything from the NetCensus Table product (lower case naming of the assettag is mandated because of case sensitive operating systems) and returns the information in the productList parameter.

Dialog Forms Called

None


PhysAttribExists

File Name

netc_db.kb

Syntax

PhysAttribExists( VAL testRec: PhysAttribRec )

Parameters

testRec - TSD PhysAttribRec

Returns

BOOLEAN: TRUE if PM_ATTRIB_VALUE record found,

FALSE if not found

By REFERENCE - testRec

Side Effects

None

Description

Selects a record from the TSD PM_ATTRIB_VALUE based on PM_OBJECT_ID

Dialog Forms Called

None