Overview

Skill Level: Any

Prerequisites

After initiating a data job, you can monitor the status of the job using this operation. This step is optional in thejob process.

If a data job completes with errors, you can view detailed results in the Results file (.res) and Error file (.err) which you can find in the Download folder of the FTP account.

Step-by-step

  1. Syntax of the request and response SOAP for GetJobStatus

    Operation  <GetJobStatus>   
    Elements  JOB_ID  Identifies the Watson Campaign Automation Background Job created and scheduled as a result of another API call. 
    Example¬† <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
    xmlns:rep=”SilverpopApi:EngageService.Reporting”>
    <soapenv:Header>
    <ses:sessionHeader>
    <ses:sessionid>16FE7B75445E6C704707025B1B7BBEE5</ses:sessionid>
    </ses:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <rep:GetJobStatus>
    <rep:JOB_ID>503539</rep:JOB_ID>
    </rep:GetJobStatus>
    </soapenv:Body>
    </soapenv:Envelope> 
     
    Response <RESULT>   
    Elements  SUCCESS  TRUE if successful. 
      JOB_ID  Identifies the Watson Campaign Automation Background Job created and scheduled as a result of the API
    call. Will match the JOB_ID passed in the request. 
      JOB_STATUS 

    Identifies the current job status at the time of the API call. Valid values are:

    WAITING
    RUNNING
    CANCELED
    ERROR
    COMPLETE 

      JOB_DESCRIPTION  Description of the job being processed. 
      PARAMETERS  Parameter list that contains <Parameter> elements with name/value pairs. (See each response example in the tables below for more detail.) 
    Example¬† <envelope:Envelope xmlns=”SilverpopApi:EngageService.Reporting”
    xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body>
    <RESULT>
    <SUCCESS>TRUE</SUCCESS>
    <JOB_ID>503539</JOB_ID>
    <JOB_STATUS>WAITING</JOB_STATUS>
    <JOB_DESCRIPTION>Export results for mailing, Sonoa Scheduled
    Mailing2</JOB_DESCRIPTION>
    <PARAMETERS>
    <PARAMETER>
    <NAME>REPORT_ID_ARRAY</NAME>
    <VALUE>55907260</VALUE>
    </PARAMETER>
    <PARAMETER>
    <NAME>MAILING_ID_ARRAY</NAME>
    <VALUE>1905584</VALUE>
    </PARAMETER>
    <PARAMETER>
    <NAME>MAILING_NAME</NAME>
    <VALUE/>
    </PARAMETER>
    <PARAMETER>
    <NAME>EXPORT_FILE_NAME</NAME>
    <VALUE>1905584_55907260_20090717100314__track.zip</VALUE>
    </PARAMETER>
    <PARAMETER>
    <NAME>STATUS_FILE</NAME>
    <VALUE>1905584_55907260_20090717100314__track.status</VALUE>
    </PARAMETER>
    </PARAMETERS>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
     
  2. Parameters when a Database Import Job is Waiting/Running

    There are various job types that you can execute in Watson Campaign Automation and monitor using the GetJobStatus operation. The response data will differ between types of jobs and the current status. For example, if the current status of a Database Import job is WAITING, the response element will contain different elements and values from the same call with a status of ERROR.

    The following tables describe the different Parameters returned from GetJobStatus depending on the current state of the job and the API called to create the job.

    PARAMETERS List of parameters beginning with <PARAMETER> element and containing name/value pairs with details on the status of the export database job.   
    Name/Value Pairs  NOT_ALLOWED  Number of rows not allowed.
      LIST_ID  ID of database. Blank until Watson Campaign Automation creates the database. Once created, this will have a value throughout processing and when the job is complete. 
      SQL_ADDED  Number of rows added to the database. During processing, this number will
    increment in steps of 10,000 until the job is complete. 
      DUPLICATES Number of duplicate rows detected. 
      TOTAL_ROWS  Number of rows in database. During processing, this value will change as the
    initial source file parses and it reads all rows in the file. 
      LIST_NAME  Name of database. 
      BAD_ADDRESSES  Number of email addresses in incorrect format. 
      SQL_UPDATED  Number of rows updated. 
      TOTAL_VALID  Number of rows that were valid in the database. Increments as the source file
    processes. 
      BAD_RECORDS  Number of rows that were not valid. 

    Parameters when Database Import Job is Complete

    PARAMETERS  List of parameters beginning with <PARAMETER> element and containing name/value pairs with details on the status of the job.   
    Name/Value Pairs NOT_ALLOWED  Number of rows not allowed. 
      LIST_ID  ID of database. This will be blank until Watson Campaign Automation creates the database. Once the
    database is created, this will have a value throughout processing and when the job is complete. 
      SQL_ADDED  Number of rows added to the database. During processing, this number will increment in steps of 10,000 until the job is complete. 
      DUPLICATES  Number of duplicate rows detected.
      TOTAL_ROWS  Number of rows in database. During processing, this value will change as the
    initial source file is parsed until it reads all rows in the file. 
      LIST_NAME  Name of database. 
      BAD_ADDRESSES  Number of email addresses in incorrect format. 
      SQL_UPDATED  Number of rows updated. 
      BAD_RECORDS  Number of rows that were valid in the source file. This will increment as the
    source file is processed. 
      TOTAL_VALID  Number of rows that were not valid. 
  3. Parameters when Database Export Job is Waiting/Running

    PARAMETERS  List of parameters beginning with <PARAMETER> element and containing name/value pairs with details on the status of the job.   
    Name/Value Pairs  NUM_PROCESSED  Number of rows processed. This will increment during processing of the job.
      LIST_ID  ID for exported database or query.
      LIST_NAME  Name of exported database or query.

    Parameters when Database Export Job is Complete

    PARAMETERS  List of parameters beginning with <PARAMETER> element and containing name/value pairs with details on the status of the job.   
    Name/Value Pairs  NUM_PROCESSED  Number of rows processed. Value is the number of rows. 
      LIST_ID  ID for the database processed. 
      LIST_NAME The name of the database being processed. 

    Parameters when Tracking Metric Export Job is Waiting/Running

    PARAMETERS  Element containing <PARAMETER> elements with Name/Value pairs.   
    Name/Value Pairs  MAILING_ID_LIST  The IDs of the mailings for which the request is processing. 
      MAILING_NAME  The name of the Mailing being processed. 
      EXPORT_FILE_NAME  The name of the file containing the export data (stored in FTP > Download
    directory). 
      STATUS_FILE  The name of the status file. (stored in FTP > Download directory). 
      REPORT_ID_LIST  The IDs of the reports being accessed. 
  4. Parameters when Tracking Metric Export Job is Complete

    PARAMETERS  Element containing <PARAMETER> elements with Name/Value pairs.   
    Name/Value Pairs  MAILING_ID_LIST  The IDs of the mailings for which the request is processing. 
      MAILING_NAME  The name of the Mailing being processed. 
      EXPORT_FILE_NAME  The name of the file containing the export data (stored in FTP > Download
    directory). 
      STATUS_FILE  The name of the status file. (stored in FTP > Download directory). 
      REPORT_ID_LIST  The IDs of the reports being accessed. 

    Delete a Data Job

    DeleteJob

    After verifying the successful completion of a data job, the user can remove the job from Watson Campaign Automation by using the DeleteJobStatus operation.

    Operation  <DeleteJob>   
    Elements  JOB_ID  Identifies the Background Job to remove from Watson Campaign Automation. 
    Example¬† <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:rep=”SilverpopApi:EngageService.Reporting”>
    <soapenv:Header>
    <ses:sessionHeader xmlns:ses=”SilverpopApi:EngageService.SessionHeader”>
    <ses:sessionid>16FE7B75445E6C704707025B1B7BBEE5</ses:sessionid>
    </ses:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <rep:DeleteJob>
    <rep:JOB_ID>503539</rep:JOB_ID>
    </rep:DeleteJob>
    </soapenv:Body>
    </soapenv:Envelope> 
     
    Response  <RESULT>   
    Elements  SUCCESS  True if successful. 
    Example¬† ¬†<envelope:Envelope xmlns=”SilverpopApi:EngageService.Reporting”
    xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body>
    <RESULT>
    <SUCCESS>TRUE</SUCCESS>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope>
     

Join The Discussion

Your email address will not be published. Required fields are marked *