Consumer Template: ETL

Consumer template contains settings of custom consumer object that is available to use on developing ETL tasks. Template settings enable the user to specify a macro in the Fore/Fore.NET language that contains implementation of the consumer object. After creating and setup of the template, the corresponding object is available on the Consumers tab. The same operations used for main ETL task objects are available for this object.

To open the dialog box with template parameters setup:

Select the Insert > Consumer> Create New Template main menu item.
Select the Edit item in the context menu of the required template in the Consumers panel area.

Example of Class Code that Implements Custom Consumer

The consumer that implements the IDtRecordsetConsumer interface:

Class DataConsumer: Object, IDtRecordsetConsumer
    Public Sub Put(Value: Array);
    Begin

    End Sub Put;

    Public Sub Clear;
    Begin

    End Sub Clear;
End Class DataConsumer;

The consumer that implements the IDtCustomConsumer interface:

Class DataConsumer: Object, IDtCustomConsumer
    _Metabase: IMetabase;
    _KeepCalcFields: Boolean;

    Public Sub Clear;
    Begin

    End Sub Clear;

    Public Function ImplementPut: Boolean;
    Var
        Result: Boolean;
    Begin
        Return Result;
    End Function ImplementPut;

    Public Sub Put(Value: Array);
    Begin

    End Sub Put;

    Public Sub PutRow(Values: Array);
    Begin

    End Sub PutRow;

    Public Function WritingRowsCount: Integer;
    Var
        Result: Integer;
    Begin
        Return Result;
    End Function WritingRowsCount;

    Public Sub Open;
    Begin

    End Sub Open;

    Public Sub Close;
    Begin

    End Sub Close;

    Public Sub Save(Element: IXMLDOMElement);
    Begin

    End Sub Save;

    Public Sub Load(Element: IXMLDOMElement);
    Begin

    End Sub Load;

    Public Sub FieldsFromFile;
    Begin

    End Sub FieldsFromFile;

    Public Sub ClearFields;
    Begin

    End Sub ClearFields;

    Public Function get_Active: boolean;
    Var
        Result: Boolean;
    Begin
        Return Result;
    End Function get_active;

    Public Function get_fields: IDtFieldDefinitions;
    Var
        Result: IDtFieldDefinitions;
    Begin
        Return Result;
    End Function get_fields;

    Public Function get_GetType: DtObjectType;
    Begin
        Return DtObjectType.TDtUserConsumerEx
    End Function get_GetType;

    Public Function get_Metabase: IMetabase;
    Begin
        Return _Metabase;
    End Function get_Metabase;

    Public Sub set_Metabase(Value: IMetabase);
    Begin
        _Metabase := Value;
    End Sub set_Metabase;

    Public Function get_KeepCalcFields: Boolean;
    Begin
        Return _KeepCalcFields;
    End Function get_KeepCalcFields;

    Public Sub set_KeepCalcFields(Value: Boolean);
    Begin
        _KeepCalcFields:=Value;
    End Sub set_KeepCalcFields;
End Class DataConsumer;

Public Class DataConsumer: IDtCustomConsumer
    _Metabase: IMetabase;
    _Fields: DtFieldDefinitions;
    _Active: boolean;
    _KeepCalcFields: boolean;

    Public Sub Clear();
    Begin

    End Sub;

    Public Function ImplementPut(): Boolean;
    Var
        Result: Boolean;
    Begin
        Return Result;
    End Function;

    Public Sub Put(Value: Array);
    Begin

    End Sub;

    Public Sub PutRow(Values: Array);
    Begin

    End Sub;

    Public Function WritingRowsCount(): Integer;
    Var
        Result: Integer;
    Begin
        Return Result;
    End Function;

    Public Sub Open();
    Begin

    End Sub;

    Public Sub OpenO(Param: System.Int32);
    Begin

    End Sub;

    Public Sub Close();
    Begin

    End Sub;

    Public Sub Save(Element: IXMLDOMElement);
    Begin

    End Sub;

    Public Sub Load(Element: IXMLDOMElement);
    Begin

    End Sub;

    Public Sub SaveToSerializer(Serializer: IMetabaseSerializer);
    Begin

    End Sub;

    Public Sub LoadFromSerializer(Serializer: IMetabaseSerializer);
    Begin

    End Sub;

    Public Sub FieldsFromFile();
    Begin

    End Sub;

    Public Sub ClearFields();
    Begin

    End Sub;

    Public Property Fields: DtFieldDefinitions
        Get
        Begin
            Return _Fields;
        End Get
    End Property;

    Public Property FieldsO[Param: System.Int32]: DtFieldDefinitions
        Get
        Begin
            Return _Fields;
        End Get
    End Property;

    Public Property Active: Boolean
        Get
        Begin
            Return _Active;
        End Get
    End Property;

    Public Property GetType: DtObjectType
        Get
        Begin
            Return DtObjectType.TDtUserConsumerEx
        End Get
    End Property;

    Public Property Metabase: IMetabase
        Get
        Begin
            Return _Metabase
        End Get
        Set
        Begin
            _Metabase := Value
        End Set
    End Property;

    Public Sub FieldsFromFileEx();
    Begin

    End Sub;

    Public Property KeepCalcFields: boolean
        Get
        Begin
            Return _KeepCalcFields;
        End Get
        Set
        Begin
            _KeepCalcFields := Value;
        End Set
    End Property KeepCalcFields;
End Class;