CloseEtlUnpivot

Syntax

bool CloseEtlUnpivot(EtlId tEtl, CloseEtlUnpivotArg tArg)

Parameters

tEtl. Opened ETL task instance moniker.

tArg. Operation execution parameters.

Description

The CloseEtlUnpivot operation closes data extraction settings in the crosstab mode.

Comments

To execute the operation, in the tEtl field specify moniker of opened ETL task instance, and in the tArg.save field specify whether the changed settings must be saved. The moniker can be obtained after executing the OpenEtl operation. If the tArg.save field is set to true, the settings will be saved to the source, for which the CreateEtlUnpivot operation was executed.

The operation result determines whether the settings were closed successfully.

Example

Below is the example of closing data extraction settings in the crosstab mode in ETL task. The request contains moniker of opened ETL task instance and returns whether changes should should be saved. The response contains whether settings were closed successfully.

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">
<CloseEtlUnpivot xmlns="http://www.fsight.ru/PP.SOM.Som">
<tEtl xmlns="">
  <id>ENAIMHDOPOEIGOAEIKGJBOMLGNPEKPJEOIFKLAKCKCFCJHKN!M!S!LBCNODJDOPOEIGOAEAACBDDFIJKHDGKNEHKAKNNDFDEABINKC</id>
  </tEtl>
<tArg xmlns="">
  <save>true</save>
  </tArg>
  </CloseEtlUnpivot>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <CloseEtlUnpivotResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</CloseEtlUnpivotResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "CloseEtlUnpivot" : 
  {
   "tEtl" : 
    {
     "id" : "ENAIMHDOPOEIGOAEIKGJBOMLGNPEKPJEOIFKLAKCKCFCJHKN!M!S!LBCNODJDOPOEIGOAEAACBDDFIJKHDGKNEHKAKNNDFDEABINKC"
    },
   "tArg" : 
    {
     "save" : "true"
    }
  }
}

JSON response:

{
 "CloseEtlUnpivotResult" : "1"
}
public static bool CloseEtlUnpivot(string moniker)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tClose = new CloseEtlUnpivot()
    {
        tArg = new CloseEtlUnpivotArg()
        {
            save = true
        },
        tEtl = new EtlId() { id = moniker }
    };
    // Close data extraction settings in the crosstab mode
    var result = somClient.CloseEtlUnpivot(tClose);
    return result;
}

See also:

Working with ETL Task