Output for a Batch File Export (Bulk Async) Call

From $1

    Doc-Wiki-BannerHK.png

    (Click the banner to go to the related Docs.Code.ExactTarget.com page.)

    When you use an Output for a Batch File Export (Bulk Async) call, the resulting data is sent to a file that is then deposited to the ExactTarget secure FTP site or transferred to your own FTP site instead.

    Initial Output

    Each successful batch file export (bulk async) call returns output similar to the following. The <system> value will differ according to the system you called.

    The <batchID> tag contains the unique ID for this request, which you can use to check on the status of the request; see Batch Inquire (Status Check).

    <?xml version="1.0"?>
        <exacttarget>
            <system>
                <tracking>
                    <info>Your request has been recorded</info>
                    <batchID>979804</batchID>
                </tracking>
            </system>
        </exacttarget>

    If an error occurs, the error code will be returned in XML format for the appropriate error trapping routine to be implemented.

    See the help topic for the specific call for information about the output for the file containing the results.

    Results File on ExactTarget Secure FTP Site

    Once the system has successfully completed processing your request, you can download the resulting zipped file from the following site, using the username and password given to you by ExactTarget (contact your ExactTarget representative if you don't have this information):

    ftp://ftp1.exacttarget.com

    When you log in, you'll see your zipped file(s) at the root directory. (If you have multiple accounts, the directory is divided into subfolders named with the member ID for each account. The zipped file will be deposited into the subfolder for the account associated with the user who made the request.)

    ExactTarget supports FTP over SSL encryption on the secure FTP download server. You will need to use passive mode with explicit encryption enabled. The FTP command to enable the secure transmission is AUTH SSL. (This encryption is not the same as SFTP, which uses SSH to tunnel the FTP connection.)

    When you unzip the zipped output file, you'll find your results in XML format, as you would when making a standard (synchronous) API call.

    The zipped output file will be available on the secure FTP site for a period of 72 hours after processing.

    Results File Deposited to Your Own FTP Site

    All batch (bulk async) calls offer the option of having the resulting file transferred directly to your own FTP site instead of having to retrieve it from the ExactTarget secure FTP site.

    Only nonsecure FTP sites are supported by this option. You cannot specify an SFTP address in the <location> tag.

    To use this option, you include a <results> node at the end of your call, before the </system> end tag.

    Syntax

    Here's an example of the <results> node within the Retrieve Subscriber Statuses call. (The syntax of the <results> node is the same in all calls in which it is supported.)

    <system>
        <system_name>subscriber</system_name>
        <action>BulkAsyncEnterprise</action>
        <sub_action>SubsStatus_ToFTP</sub_action>
        <search_type></search_type>
        <search_value></search_value>
        <search_value2></search_value2>
        <results>
            <delivery>
                <transport>FTP</transport>
                <location>your FTP address here</location>
                <authentication>
                    <userid>username that can write to your FTP site</userid>
                    <pwd>password associated with this username</pwd>
                </authentication>
            </delivery>
        </results>
    </system>

    Parameters

    XML Tag

    Tag Description

    <location>

    Insert the URL of your FTP site. For example:

    <location>ftp://example.com/subdirectory</location>

    <userid>

    Enter the username of a login that can deposit files to the FTP site.

    <pwd>

    Enter the password associated with the username.

     


    This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:25:48 GMT.

    If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:

     


    Was This Page Helpful?
    Suggestions or Comments:
    Name (optional):
    Email Address (optional):
    Enter 24440 backwards:
       
    Tags: (Edit tags)
    • No tags
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch 2010
    Admin