Skip to main content

RtBaseline_GetAFTransferAttributeValue

The RtBaseline_GetAFTransferAttributeValue method/function returns a matrix with the value of the AFAttribute of an AFTransfer. The format of the returned matrix depends on the selected attribute value and the query specifications.

Web Method Synopsis (C# Syntax)​

public DataSet RtBaseline\_GetAFTransferAttributeValue( 
 string sAFTransferPath, 
 string sAFAttribute, 
 string sAFAnalysisPath, 
 DateTime dSearchStart, 
 DateTime dSearchEnd 
 string sColSpecs);

Output Result​

DATASET ® Returns a matrix of the retrieved results based on transfer selection and attribute selected. If the attribute contains a TABLE, this method can return the whole table or a portion of the table (based on the 'sColSpecs' value). If the attribute is a scalar value (Float32, string, DateTime… etc), the returned table is a simple matrix formed by 1 row and 1 column (column name = “VALUE”) and the type of the column is the type of the AFAttribute selected. 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​

sAFTransferPath (STRING) ® The AFTransfer PATH that must exist in the following format: \\Server\Database\Transfer. If only the element name is passed, the web service tries to look up the element in the configured default SERVER and DATABASE configured in the machine that is running the Web Services.

sAFAttribute (STRING) ® The AFAttribute name.

sAFAnalysisPath (STRING) ® The Sigmafine AFAnalysis path. Specify the Sigmafine path according to the model configuration with the following format: \\Server\Database\Model\AFAnalysis.

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

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

sColSpecs (STRING) ® This field is used only for those AFAttributes that are returning TABLES. The field specifies which columns pick up from the source table instead of having the whole table. If no specifications are provided, a table, with one column and 1 row containing the number of records contained in the source TABLE, is returned. The field uses the specific syntax described below:

Column1;Column2;Column3;…… ColumnN

ClosedEXAMPLE: RtBaseline_GetAFAttributeValue

ValueTime;ForecastValue