Skip to main content

RtBaseline_GetAFTransfers

RtBaseline_GetAFTransfers is the main data extraction function for AFTransfers. It returns a matrix based on the input parameters given to the method.

Web Method Synopsis (C# Syntax)​

public DataSet RtBaseline\_GetAFTransfers( 
 string sAFPath, 
 string sRuleOutput, 
 DateTime dSearchStart, 
 DateTime dSearchEnd, 
 string sSource, 
 string sDestination, 
 bool bShowUoM);

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​

sAFPath (STRING) ® This field 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) ® Column-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 AFTransfer name, description, and GUID is provided to the caller (3 columns). This field uses the specific syntax described below:

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

ClosedEXAMPLE: RtBaseline_GetAFTransfers

MyMovementTemplate.Area;MyMovementTemplate.Category;MyMovementTemplate.Quantity

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

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

sSource (STRING) ® Source of the AFTransfer. If this field is not specified, no transfer SOURCE filter is applied.

sDestination (STRING) ® Destination of the AFTransfer. If this field is not specified, no transfer DESTINATION filter is applied. If both SOURCE and DESTINATION are empty, all AFTransfers found in the given period are retrieved (potentially huge result-set).

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)