Skip to main content

RtBaseline_GetAFElementValues

The RtBaseline_GetAFElementValues method/function returns a matrix with the following characteristics:

  • ROWS: list of the AFAttributes.
  • COLUMNS: list of the configuration and values related to each AFAttribute listed.

Web Method Synopsis (C# Syntax)​

public DataSet RtBaseline\_GetAFElementValues( 
 string sAFElementPath, 
 string sRuleOutput, 
 string sAFAnalysisPath, 
 DateTime dSearchStart, 
 DateTime dSearchEnd 
 bool bFromTag, 
 bool bShowUoM,
 bool bShowAdjust,
 string sGroupByCategory);

Output Result​

DATASET® Returns a matrix of the retrieved results based on element selection and output column-set format, as specified in the input parameters. For an EAI scenario, the output format is a standard XML DIFFGRAMM document. (For further information, refer to Microsoft XML DIFFGRAM v1.x and v2.x specifications.)

Input Parameters​

sAFElementPath (STRING) ® This is the Sigmafine AFAnalysis or Database path. Specify the Sigmafine specific path according to the model or the database configuration with the following format:

\\Server\Database\Model\AFAnalysis --> for model

\\Server\Database --> for database

sRuleOutput (STRING) ® Attribute-list specifications. This field specifies the number, the name, and the format of the columns that will be returned by this method. If no specifications are provided, only the selected AFElement name, description, and GUID is provided to the caller (3 rows). This field uses the specific syntax described below:

AFTemplate1.AFAttrib_A;AFTemplate1\>.\<AFAttrib_B\>;……\<AFTemplateN\>.\<AFAttrib_X\>

ClosedEXAMPLE: RtBaseline_GetAFElementValues

MyPumpTemplate.Area;MyPumpTemplate.Category;MyPumpTemplate.Efficiency

sAFAnalysisPath (STRING) ® Sigmafine AFAnalysis path. Specify the Sigmafine specific path according to the model configuration with the following format:

\\Server\Database\Analysis.

dSearchStart (DATETIME) ® Start time of the search specified in standard XML format.

dSearchEnd (DATETIME) ® Start time of the search specified in standard XML format.

bFromTag (BOOLEAN) ® This flag indicates if the read operation must be done from the indicated AF attributes or from the PI-TAGS configured upon the attributes. (Option valid only for those users running a PI System as historian.)

TRUE® read operation from PI-TAGS

FALSE® (DEFAULT) read operation from AFATTRIBUTE (standard behavior)

bShowUoM (BOOLEAN) ® This flag indicates if in the returned DataSet the values of each requested attribute/field for each element should be returned together with its Unit Of Measure. This causes all returned fields to be automatically converted to string with the precision specified in the WEB.CONFIG file.

TRUE® output format with UoM (all return fields in string format)

FALSE® (DEFAULT) output format without UoM (fields will be returned with their specific type (Float32, Currency, DataTime, Integer… etc)

bShowAdjust (BOOLEAN) ® This flag indicates, if in the returned DataSet, whether the values of each requested attribute/field for the selected element should be returned together with the ADJUSTMENT information (only combined with the right specification of the MODEL ANALYSIS path, otherwise it is skipped). The Adjustment information is returned as additional columns in STRING format.

TRUE® output format with Adjustment information

FALSE® (DEFAULT) output without Adjustment information

sGroupByCategory (STRING) ® This field indicates the group results for the specified ATTRIBUTE category.