BeginDataBlock

Submits the first HTTP data block in a Data Sources submission.

Individual data blocks can contain no more than 10,000 data rows (to keep the HTTP POST below 10MB), so you might need to submit data in multiple data blocks.

DataSource.BeginDataBlock Parameters

Parameter Type Required Description
reportSuiteID xsd:string

Yes

The ID of the report suite where you want to submit the data block.

dataSourceID xsd:string

Yes

The ID of the Data Source where you want to submit the data block. You can get this ID by calling

DataSource.GetIDs

.

blockName xsd:string

No

The name of the file that appears in the Data Sources log. If not specified, a block name is generated for you.

columnNames tns:colArray

Yes

The names of the data columns (the column headings) submitted via Data Sources.

rows tns:rowArray*

Yes

The data to submit to Analytics collection servers.

endOfBlock xsd:string

No

Indicates if this is the last block in the data submission. You can use the endOfBlock parameter in the following ways.

Self-terminating: Include <endOfBlock/> to indicate that this is the last block in the data source. Data Sources then queues the Data Source for processing.

With Parameter: Include either false or 0 as an endOfBlock parameter to indicate this block is NOT the last in the data source.

If supported by your SOAP client, you can also exclude the endOfBlock parameter to indicate that this block is not the last in the data source.

*The XML for the row parameter in the BeginDataBlock call is similar to the following. This XML sample does not include the <endOfBlock/> parameter, indicating that additional data is forthcoming through a DataSource.AppendDataBlock call.

<reportSuiteID xsi:type="xsd:string">myReportSuite</reportSuiteID>
<dataSourceID xsi:type="xsd:string">12345</dataSourceID>
<blockName xsi:type="xsd:string">myTestFile</blockName>
<columnNames xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]">
  <item xsi:type="xsd:string">date</item>
  <item xsi:type="xsd:string">evar 1</item>
  <item xsi:type="xsd:string">event 2</item>
</columnNames>
<rows xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:colArray[2]">
  <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]">
    <item xsi:type="xsd:string">1/1/2009</item>
    <item xsi:type="xsd:string">product1</item>
    <item xsi:type="xsd:string">2.50</item>
  </item>
  <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]">
    <item xsi:type="xsd:string">1/2/2009</item>
    <item xsi:type="xsd:string">product2</item>
    <item xsi:type="xsd:string">4.25</item>
  </item>
</rows>

DataSource.BeginDataBlock Response

Parameter Type Description
status xsd:string Indicates if the call was successful. Valid return values include Failed or Success. If the call fails, Data Sources returns an error message.
blockID xsd:int The ID used to append additional data blocks to this Data Sources submission. This parameter is assigned a value only when the data block does not include the <endOfBlock/> tag.
fileID xsd:int The ID generated by the Processing Queue to identify a particular Data Sources submission. This value is a uniform identifier, independent of the particular data submission method (HTTP vs. FTP). This parameter is assigned a value only when the data block includes the <endOfBlock/> tag.

Comments (0)

Must be logged in to comment. or register now to comment!