DiscoRetrieveClass()

The DiscoRetrieveClass(); stitcher rule is used to retrieve the class of a discovered device during the discovery process, so that users can determine device type while the discovery is still running.

This rule is used at the following points in the discovery process:
  • During the data collection stage the rule is used by the AssocAddressRetProcessing.stch stitcher. This stitcher uses the output from this rule to update the AssocAddress returns table with class information. This provides the information needed to display device type while discovery is still running.
  • During the data processing stage the rule is used by the AddClass stitcher to set the class of the chassis objects.

Syntax

The DiscoRetrieveClass(); statement uses the following syntax.

DiscoRetrieveClass ( record position , source format );
The information in the output class record is class ID, class name, and the name of the visual icon used to represent the class.

Arguments

The following table lists the properties of the arguments of this stitcher rule.
Table 1. Arguments of DiscoRefresh()
Argument Description Accepts constants Accepts variables Accepts eval clauses
record position Position in the record stack from which to extract the record. This is equivalent to what you would retrieve using an eval statement with a single ampersand. Yes No No
source format The source format of the class data. Possible values include workingEntities and ncim. The DiscoRetrieveClass(); rule translates the data from the source format into the format expected by the AOC files. Yes No No

Example: Helper server

The following example shows how the DiscoRetrieveClass(); rule can be used to retrieve class data and load it into a variable.

Record  classRec = NULL;
classRec = DiscoRetrieveClass(0, "workingEntities");