OpenEtl: Operation

The OpenEtl operation opens an ETL task and returns the moniker that is required for working with task objects.

Comments

To execute the operation, in the tOb parameter specify moniker of the object that is an ETL task, and in the tArg parameter specify parameters of opening. Metadata of ETL task that is required to create a moniker can be obtained on executing the GetObjects operation. The tArg parameter may contain the mode of task opening (view or edit) and the pattern for metadata getting. The pattern specifies the information to be retrieved on executing the operation.

The operation results in the moniker of the opened instance of ETL task, and also the metadata if the tArg.metaGet field was defined on executing the operation. For further work with the opened task, use the GetEtl and SetEtl operations. Use the CloseEtl operation to close an opened instance of ETL task.

Example

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">

</tOb>

<args>

</args>

</tArg>

</OpenEtl>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</id>

</OpenEtlResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "OpenEtl" : 
  {
   "tOb" : 
    {
     "id" : "S1!M!7012"
    },
   "tArg" : 
    {
     "args" : 
      {
       "bind" : "true",
       "openForEdit" : "true"
      }
    }
  }
}

JSON response:

{
 "OpenEtlResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!L1"
    }
  }
}

The OpenETL function specified below opens an ETL task. The repository connection moniker and task identifier are sent as input parameters. The example uses the FindObjectById function, which code is given in the Getting Object Description by Its Identifier example. The result of the operation is the result of the function.

public static OpenEtlResult OpenETL(MbId mb, string id)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tOpen = new OpenEtl()
    {
        tArg = new OpenEtlArg()
        {
            args = new EtlOpenArgs()
            {
                bind = true,
                openForEdit = true
            }
        },
        tOb = new OdId() { id = mb.id + "!" + FindObjectById(mb, id).k }
    };
    //Open ETL task
    var tResult = somClient.OpenEtl(tOpen);
    return tResult;
}

OpenEtl

Syntax