File Name
Syntax
ActOnTAMTables(VAL TBName, RefTable, ResultRow_1, ResultRow_2, ResultRow_3: STRING )
Parameters
TBName - table that is currently being checked
RefTable - reference table that is being verified against the table that is being checked
ResultRow_1 - relevant data from select statement
ResultRow_2 - relevant data from select statement
ResultRow_3 - relevant data from select statement
Returns
None
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Secure Report action for TAM. If the table that is being checked needs an action taken upon it, the function that is being called takes that action.
Dialog Forms Called
None
File Name
Syntax
ActOnTAMTables(VAL TBName, RefTable, ResultRow_1, ResultRow_2, ResultRow_3: STRING )
Parameters
TBName: Table that is currently being checked
RefTable: Reference table that is being verified against the table that is being checked
ResultRow_1: Relevant data from select statement
ResultRow_2: Relevant data from select statement
ResultRow_3: Relevant data from select statement
Returns
None
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Secure Report action for TAM. If the table that is being checked needs an action taken upon it, the function that is being called will take that action. This is a dummy version to allow TPM or TCM to parse when TAM is not installed.
Dialog Forms Called
None
File Name
Syntax
Asset_OkToPaste(VAL wHdl: WINDOW, VAL table: STRING, VAL ID: STRING, VAL child_org: STRING, VAL parent_org: STRING): BOOLEAN
Parameters
wHdl: Window handle of the calling dialog
table: object for which this is in reference to (i.e.location, inventory category, change category, connection)
ID: primary key id for table (i.e. location_id, h_object_id, category, connection_id)
child_org: organization_id that is currently assigned to the object
parent_org: organization_id of node that the object is being pasted under
Returns
True or False
Side Effects
None
Description
This function checks if its okay to paste the node under another object given the new object's organization_id. Disallow from paste if might violate rules in a multi-customer environment. This is a dummy version to allow TPM or TCM to parse when TAM is not installed.
Dialog Forms Called
None
File Name
Syntax
Asset_OkToPaste(VAL wHdl: WINDOW, VAL table: STRING, VAL ID: STRING, VAL child_org: STRING, VAL parent_org: STRING): BOOLEAN
Parameters
wHdl - window handle of the calling dialog box
table - object for which this is a reference (location, inventory category,
change category, connection)
ID - primary key ID for table (location_id, h_object_id, category, connection_id)
child_org - organization ID that is currently assigned to the object
parent_org - organization ID of node under which the object is pasted
Returns
True or False
Side Effects
None
Description
This function checks whether to paste the node under another object, given the new object's organization ID. Disallows paste if it might violate rules in a multi-customer environment.
Dialog Forms Called
None
File Name
Syntax
AssetAuditAPI( VAL whdl: WINDOW, VAL organization_id: STRING, VAL location_id: STRING, VAL h_object_id: STRING , VAL connection_id: STRING )
Parameters
wHdl - WINDOW
location_id - STRING
organization_id- STRING
Returns
Nothing
Side Effects
None
Description
This is a dummy version to allow TPM or TCM to parse when TAM is not installed. This procedure is used to invoke the Asset Audit dialog from outside applications.
Dialog Forms Called
None
File Name
Syntax
AssetAuditAPI( VAL whdl: WINDOW, VAL organization_id: STRING, VAL location_id: STRING, VAL h_object_id: STRING , VAL connection_id: STRING )
Parameters
wHdl - parent window handle
location_id - location ID of the location for which to find assets. This is
part of the search string for assets and is used to get and display
the corresponding location in the search field.
organization_id - organization ID
Returns
Nothing
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Audit dialog box with appropriate instance data. The AuditEventData record structure is not used when this routine is called, to prevent the calling KB from using inv_rec. This routine calls the RequestAssetAudit function to display the Asset Audit dialog box.
Dialog Forms Called
None
File Name
Syntax
AssetTransferAPI( VAL whdl: WINDOW, VAL location_id: STRING, VAL organization_id: STRING, VAL table_name: STRING)
Parameters
wHdl - WINDOW
location_id - STRING
organization_id- STRING
table_name - STRING
Returns
Nothing
Side Effects
None
Description
This is a dummy version to allow TPM or TCM to parse when TAM is not installed. This procedure is used to invoke the Asset Transfer dialog from outside applications.
Dialog Forms Called
None
File Name
Syntax
AssetTransferAPI( VAL whdl: WINDOW, VAL location_id: STRING, VAL organization_id: STRING, VAL table_name: STRING)
Parameters
wHdl - parent window handle
location_id - location ID of the location to find assets for. This
is part of the search string for assets and is used to
get and display the corresponding Location in the search field.
organization_id- organization ID
table_name - parent form name
Returns
Nothing
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Transfer dialog box with appropriate instance data. The AssetTransferData record structure is not used when this routine is called, to prevent the calling KB from using inv_rec. This routine calls the RequestAssetTransfer function to display the Asset Transfer dialog box.
Dialog Forms Called
None
File Name
Syntax
AssetValuationAPI ( VAL whdl: WINDOW, VAL location_id: STRING, VAL organization_id: STRING, VAL h_object_id: STRING )
Parameters
wHdl - WINDOW
location_id - STRING
organization_id- STRING
h_object_id - STRING
Returns
Nothing
Side Effects
None
Description
This is a dummy version to allow TPM or TCM to parse when TAM is not installed. This procedure is used to invoke the Asset Valuation dialog from outside applications.
Dialog Forms Called
None
File Name
Syntax
AssetValuationAPI ( VAL whdl: WINDOW, VAL location_id: STRING, VAL organization_id: STRING, VAL h_object_id: STRING )
Parameters
wHdl - parent window handle
location_id - location ID of the location to find assets for. This
is part of the search string for assets and is used to
get and display the corresponding location in the search field
organization_id - organization ID
h_object_id - Object ID
Returns
Nothing
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Valuation dialog box with appropriate instance data. The ValuationData record structure is not used when this routine is called to prevent the calling KB from using inv_rec. This routine calls the RequestAssetValuation function to display the asset valuation dialog box.
Dialog Forms Called
None
File Name
Syntax
CheckTAMTables
Parameters
None
Returns
None
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Secure Report for TAM.
Dialog Forms Called
None
File Name
Syntax
CheckTAMTables
Parameters
None
Returns
None
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Secure Report for TAM. This is a dummy version to allow TPM or TCM to parse when TAM is not installed.
Dialog Forms Called
None
File Name
Syntax
Do_TAM_Purge(VAL PurgeWhdl: WINDOW, VAL Orgs: LIST OF STRING): INTEGER
Parameters
PurgeWhdl - window handle of the calling dialog box
Orgs - organiztion ID of the organization being purged
Returns
Integer indicating success or failure
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Purge action for TAM.
Dialog Forms Called
None
File Name
Syntax
Do_TAM_Purge(VAL PurgeWhdl: WINDOW, VAL Orgs: LIST OF STRING): INTEGER
Parameters
PurgeWhdl: window handle of the calling dialog
Orgs: organiztion_id of the organization being purged
Returns
Integer indicating success or failure
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Purge action for TAM. This is a dummy version to allow TPM or TCM to parse when TAM is not installed.
Dialog Forms Called
None
File Name
Syntax
EFMInstalled: BOOLEAN
Parameters
None
Returns
TRUE or FALSE
Side Effects
None
Description
This function returns TRUE to identify that TAM code has been installed. This function is used at run tim to enable/disable TAM functionality from TPM or TCM
Dialog Forms Called
None
File Name
Syntax
EFMInstalled: BOOLEAN
Parameters
None
Returns
TRUE or FALSE
Side Effects
None
Description
This function returns TRUE to identify that TAM code has been installed. This function is used at run time to enable/disable TAM functionality from TPM or TCM.
Dialog Forms Called
None
File Name
Syntax
ExamineAssetView( VAL is_inventory_id: INTEGER , VAL w: WINDOW )
Parameters
is_inventory_id - unique identifier for the asset
w - window handle of the calling dialog box
Returns
None
Side Effects
None
Description
This is a routine that can be called by contracts to display the asset information in the Asset dialog box.
Dialog Forms Called
None
File Name
Syntax
ExamineAssetView( VAL is_inventory_id: INTEGER , VAL w: WINDOW )
Parameters
is_inventory_id: unique identifier for the asset
w: window handle of the calling dialog
Returns
None
Side Effects
None
Description
This is a routine that can be called by Contracts to display the asset information in the Asset Notebook. This is a dummy version to allow TPM or TCM to parse when TAM is not installed.
Dialog Forms Called
None
File Name
Syntax
GetConnectionIDs( VAL inv_id: INTEGER): LIST OF STRING
Parameters
inv_id - inventory ID
Returns
List of string
Side Effects
None
Description
This procedure is used to return the list of connection IDs associated with a particular asset.
Dialog Forms Called
None
File Name
Syntax
GetConnectionIDs(VAL inv_id: INTEGER): LIST OF STRING
Parameters
inv_id: is_inventory id
Returns
LIST OF STRING
Side Effects
None
Description
This procedure is used to return the list of connection id associated with a particular asset.
Dialog Forms Called
None
File Name
Syntax
GetInvID(VAL asset_tag: STRING): INTEGER
Parameters
asset_tag - asset tag of selected asset
Returns
SQL return result
Side Effects
None
Description
This function returns the inventory ID for the asset tag passed in.
Dialog Forms Called
None
File Name
Syntax
GetInvID(VAL asset_tag: STRING): INTEGER
Parameters
asset_tag - asset tag of selected asset
Returns
SQL return result
Side Effects
None
Description
This is a dummy version to allow EE to parse when EFM is not installed.
Dialog Forms Called
None
File Name
Syntax
GetInvRec( VAL is_inventory_id: INTEGER ): IS_InventoryRec
Parameters
is_inventory_id - id of selected asset
Returns
inventory record
Side Effects
None
Description
This function retrieves the asset record based on the inventory ID.
Dialog Forms Called
None
File Name
Syntax
GetInvRec( VAL is_inventory_id: INTEGER ): IS_InventoryRec
Parameters
is_inventory_id - id of selected asset
Returns
inventory record
Side Effects
None
Description
This is a dummy function so that EE can parse w/o EFM
Dialog Forms Called
None
File Name
Syntax
GetSomeInvList(VAL what: STRING, VAL where: STRING, REF invList: LIST OF IS_InventoryRec, VAL wHdl: WINDOW, VAL organization_ID: STRING): INTEGER
Parameters
what - column names to bring back from select stmt
where - where clause appended to select stmt
invList - list of is_inventory records
wHdl - window handle of the calling dialog
organization_ID - the organization_ID used in context when multi-customer support enabled. Irrelevant otherwise.
Returns
integer
Side Effects
None
Description
This function retrieves the a list of asset records based on the where clause passed in
Dialog Forms Called
None
File Name
Syntax
GetSomeInvList(VAL what: STRING, VAL where: STRING, REF invList: LIST OF IS_InventoryRec, VAL wHdl: WINDOW, VAL organization_ID: STRING): INTEGER
Parameters
what - column names to bring back from select statement
where - where clause appended to select statement
invList - list of is_inventory records
wHdl - window handle of the calling dialog box
organization_ID - the organization ID used in
context when multi-customer support
is enabled.
Returns
Integer
Side Effects
None
Description
This function retrieves the a list of asset records based on the where clause passed in
Dialog Forms Called
None
File Name
Syntax
QuickFindAssetAPI(VAL wHdl: WINDOW, VAL people_id: INTEGER, VAL location_id: STRING, VAL organization_id: STRING, VAL h_object_id: STRING, VAL connection_id: STRING, VAL fromCallReg: BOOLEAN, VAL fromContract: BOOLEAN, VAL supported_organization: STRING )
Parameters
wHdl - parent window handle
people_id - people ID of the person for which to find assets. This
is part of the search string for assets and is
used to display the user name in the Search Field
location_id - location ID of the location for which to find assets. This
is part of the search string for assets and is used to
get and display the corresponding location in the search field.
organization_id- organization ID
Returns
Nothing
Side Effects
None
Description
This is a generic routine that can be called to invoke the Asset Quick Find dialog with appropriate instance data. The AssetQbeData record strucutre is not used when this routine is called to prevent the calling KB from having to use inv_rec. This routine calls the RequestAssetInquiry function to display the quick asset find dialog.
Dialog Forms Called
None
File Name
Syntax
QuickFindAssetAPI(VAL wHdl: WINDOW, VAL people_id: INTEGER, VAL location_id: STRING, VAL organization_id: STRING, VAL h_object_id: STRING, VAL connection_id: STRING, VAL fromCallReg: BOOLEAN, VAL fromContract: BOOLEAN, VAL supported_organization: STRING )
Parameters
wHdl - Parent window handle
people_id - People_id of the person to find assets for. This
is part of the search string for assets and is
used to display the user name in the Search Field
location_id - Location_id of the location to find assets for. This
is part of the search string for assets and is used to
get and display the corresponding Location in the search field
organization_id- Similar to use of organization_id
Returns
Nothing
Side Effects
None
Description
This is a dummy version to allow TPM or TCM to parse when TAM is not installed. This procedure invokes the Asset Transfer dialog from outside applications.
Dialog Forms Called
None