Getting Information about ETL Task Objects: the GetEtl Operation

Below is the example of using the GetEtl operation to get information about the objects that are used to build data export/import chains in ETL task. The request contains moniker of opened ETL task instance and the pattern indicating whether information about the specified objects must be obtained. The response contains the obtained information.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

</tEtl>

</object>

</pattern>

</tArg>

</GetEtl>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</id>

ETL_INDICATOR

<n>ETL task for factor loading</n>

7011

</obDesc>

</obInst>

<its>

<it>

<id>PLAINDATAEXCELPROVIDER1</id>

<n>Excel import (97-2003)1</n>

<type>PlainDataExcelProvider</type>

</it>

<it>

<id>PLAINDATAMETABASECONSUMER1</id>

<n>Repository consumer1</n>

<type>PlainDataMetabaseConsumer</type>

</it>

<it>

<id>PLAINDATACOPY1</id>

<type>PlainDataCopy</type>

T_INDICATOR

<n>Table</n>

7011

</obDesc>

</consumer>

<actionOnProblem>DiscardInvalidRecords</actionOnProblem>

</plainDataCopy>

</settings>

</it>

</its>

</objects>

</meta>

</GetEtlResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetEtl" : 
  {
   "tEtl" : 
    {
     "id" : "S1!M!S!L1"
    },
   "tArg" : 
    {
     "pattern" : 
      {
       "obInst" : "true",
       "objects" : "Get",
       "object" : 
        {
         "settings" : "true"
        }
      }
    }
  }
}

JSON response:

{
 "GetEtlResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!L1"
    },
   "meta" : 
    {
     "obInst" : 
      {
       "obDesc" : 
        {
         "@fullUrl" : "\/",
         "@isShortcut" : "0",
         "@isLink" : "0",
         "i" : "ETL_INDICATOR",
         "n" : "ETL task for factor loading",
         "k" : "7012",
         "c" : "4097",
         "p" : "7011",
         "h" : "0",
         "isPermanent" : "1",
         "isTemp" : "0"
        }
      },
     "dirty" : "0",
     "objects" : 
      {
       "its" : 
        {
         "it" : 
          [
            {
             "k" : "1",
             "id" : "PLAINDATAEXCELPROVIDER1",
             "n" : "Excel import (97-2003)1",
             "vis" : "1",
             "type" : "PlainDataExcelProvider",
             "settings" : ""
            },
            {
             "k" : "3",
             "id" : "PLAINDATAMETABASECONSUMER1",
             "n" : "Repository consumer1",
             "vis" : "1",
             "type" : "PlainDataMetabaseConsumer",
             "settings" : ""
            },
            {
             "k" : "5",
             "id" : "PLAINDATACOPY1",
             "n" : "Copy data1",
             "vis" : "1",
             "type" : "PlainDataCopy",
             "settings" : 
              {
               "plainDataCopy" : 
                {
                 "provider" : "",
                 "consumer" : 
                  {
                   "obDesc" : 
                    {
                     "@fullUrl" : "\/",
                     "@isShortcut" : "0",
                     "@isLink" : "0",
                     "i" : "T_INDICATOR",
                     "n" : "Table",
                     "k" : "7013",
                     "c" : "769",
                     "p" : "7011",
                     "h" : "0"
                    },
                   "keyFieldNames" : ""
                  },
                 "clearConsumer" : "1",
                 "commitCount" : "1024",
                 "actionOnProblem" : "DiscardInvalidRecords"
                }
              }
            }
          ]
        }
      }
    }
  }
}

public static GetEtlResult GetETLInfo(EtlId moniker)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tGet = new GetEtl()
    {
        tArg = new GetEtlArg()
        {
            pattern = new EtlMdPattern()
            {
                objects = ListOperation.Get,
                @object = new EtlObjectPattern() 
                {
                    settings = true
                }
            }
        },
        tEtl = moniker
    };
    //Get information about ETL task objects
    var result = somClient.GetEtl(tGet);
    return result;
}