com.day.cq.analytics.sitecatalyst

Interface SAINTService

public interface SAINTService

Is a wrapper around SitecatalystHttpClient for SAINT API related calls.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	commitImportJob(Configuration configuration, int jobId) Commits the SAINT import for processing.
int	createExportJob(Configuration configuration, int filterOption, String rowStartDate, String rowEndDate, String beginRange, String endRange, String email, String encoding, int relationId, String[] reportSuites, String emptyColumnName, String matchColumnName, String matchColumnValue, boolean selectAllRows, int selectNumRows) Creates a SAINT export job.
int	createImportJob(Configuration configuration, String description, String email, String[] header, int relationId, boolean checkDivisions, boolean exportResults, boolean overwrite, String... reportSuites) Deprecated.
int	createImportJob(Configuration configuration, String description, String email, String[] header, String classificationView, boolean checkDivisions, boolean exportResults, boolean overwrite, String... reportSuites) Creates a SAINT Import Job.
JSONArray	exportGetFileSegment(Configuration configuration, int fileId, int segmentId) Retrieves a page of data, known as a file segment, from a completed Saint job.
JSONArray	getCompatabilityMetrics(Configuration configuration, String[] reportSuites) Returns a list of compatible metrics for specific reportSuites.
JSONArray	getFilters(Configuration configuration, int relationId, String[] reportSuites) Returns a list of filters for the specified reportSuites.
JSONObject	getJobStatus(Configuration configuration, int jobId) Checks for the status of a SAINT job.
boolean	populateImportJob(Configuration configuration, int jobId, int page, Collection<String[]> rows) Appends row data to a previously created import job.

Method Detail

getJobStatus

JSONObject getJobStatus(Configuration configuration,
                      int jobId)
                        throws SitecatalystException

Checks for the status of a SAINT job.

Parameters:

configuration - Web service support configuration

jobId - SAINT job identifier

Returns:

A JSONObject containing the job information. The object is of the following structure:

{
Id: (int),
Type: (string: "Job"|"File"),
Viewable_pages: (int),
Status: (string: "Waiting For User Data"|"In Progress"|"Completed"|"Completed--With Errors")
}


Throws:

SitecatalystException

getCompatabilityMetrics

JSONArray getCompatabilityMetrics(Configuration configuration,
                                String[] reportSuites)
                                  throws SitecatalystException

Returns a list of compatible metrics for specific reportSuites.

Parameters:

configuration - Web service support configuration

reportSuites - Array of report suite identifiers

Returns:

A JSONArray of JSONObjects containing the classified metrics. The objects are of the following structure:

{
relation_id: (int),
relation_name: (string),
report_suite: (string),
site_title: (string),
compatability_hash: (string)
}

Throws:

SitecatalystException

getFilters

JSONArray getFilters(Configuration configuration,
                   int relationId,
                   String[] reportSuites)
                     throws SitecatalystException

Returns a list of filters for the specified reportSuites.

Parameters:

configuration - Web service support configuration

relationId -

reportSuites - Array of report suite identifiers

Returns:

A JSONArray of JSONObjects containing the information about valid data filters for an export job. The objects are of the following structure:

{
date_received_dates: [{date: (string)},...]
columns: [{num: (int), name: (string)},...]
}

Throws:

SitecatalystException

createExportJob

int createExportJob(Configuration configuration,
                  int filterOption,
                  String rowStartDate,
                  String rowEndDate,
                  String beginRange,
                  String endRange,
                  String email,
                  String encoding,
                  int relationId,
                  String[] reportSuites,
                  String emptyColumnName,
                  String matchColumnName,
                  String matchColumnValue,
                  boolean selectAllRows,
                  int selectNumRows)
                    throws SitecatalystException

Creates a SAINT export job. Before calling this API, use #getFilters(Configuration, String) to obtain valid column numbers and names, and filter dates. After creating an export job, use getJobStatus(Configuration, int) to determine when the export data is ready for download. Note: Export data files can be very large. Use #exportGetFileSegment(Configuration) to download the file in pieces (segments).

Parameters:

configuration - Web service support configuration

filterOption - The filter option to use for the SAINT export. Supported values include:

• 0: Return all Campaigns (No filter)
• 1: (Default) Return active campaigns
• 2: Return campaigns with the specified begin and end date.

rowStartDate - The start date for including rows in the export. Include this parameter when filterOption = 1. Specify the date using the following format: Mmm YYYY, where:

• Mmm: A three-character month code. For example, January=Jan, February=Feb, and so on.
• YYYY: The 4-digit year.

For example, September, 2008 is Sep 2008.

rowEndDate - The end date for including rows in the export. Include this parameter when filterOption = 1. Use the same date range format described for the rowStartDate parameter.

beginRange - The campaign start date. Include this parameter when filterOption = 2. Specify the date range using the following format: <start_date>-<end_date>. Provide the date in the following format: YYYMMDD, where:

• YYY + 1900 equals the year (For example, 2008 is 108).
• MM equals the month number minus 1 (January = 00, February = 01, and so on).
• DD equals the 2 digit day. For example, May 22, 2008 is 1080422.

endRange - The campaign end date. Include this parameter when filterOption = 2. Use the same date range format described for the beginRange parameter.

email - E-Mail address to receive job notifications.

encoding - The language encoding to use with the export file. For example, UTF-8.

relationId - Relation identifier of classification the import should be done for.

reportSuites - (Optional) The list of report suites on which SAINT exports data.

emptyColumnName - (Optional) The column name that SAINT checks for empty data cells. If the cell is not empty, SAINT excludes it from the export.

matchColumnName - (Optional) The column name that SAINT checks for cell values that match the value specified in the matchColumnValue parameter. If the cell value matches the value, SAINT excludes it from the export.

matchColumnValue - (Optional) The value that SAINT uses to exclude a data row from the export. Include this parameter when using matchColumnName.

selectAllRows - (Optional) Specifies whether to include all data rows in the export (up to the 50,000 row limit). (Default) Include all rows in the export.

selectNumRows - (Optional) Limits the number of data rows in the export file to the specified value. The default limit is 50,000. Include this parameter when selectAllRows is true.

Returns:

Export job identifier

Throws:

SitecatalystException

exportGetFileSegment

JSONArray exportGetFileSegment(Configuration configuration,
                             int fileId,
                             int segmentId)
                               throws SitecatalystException

Retrieves a page of data, known as a file segment, from a completed Saint job.

Parameters:

configuration - Web service support configuration

fileId - The ID of the export file you want to view. You can get this value from {getJobStatus(Configuration, int)

segmentId - The number of the data page you want to view from the SAINT export job. The viewable_pages value in { getJobStatus(Configuration, int) indicates the number of data pages in the job. Valid values for segment_id are between 1 and the value of viewable_pages.

Returns:

A JSONArray of JSONObjects containing the information and data for the specified SAINT data segment. The objects are of the following structure:

{
warnings: [(string),...]
header: [(string),...]
data: [[(string)],...]
}

Throws:

SitecatalystException

createImportJob

@Deprecated
int createImportJob(Configuration configuration,
                             String description,
                             String email,
                             String[] header,
                             int relationId,
                             boolean checkDivisions,
                             boolean exportResults,
                             boolean overwrite,
                             String... reportSuites)
                    throws SitecatalystException

Deprecated.

Creates a SAINT Import Job. To successfully submit a SAINT Import, call SAINTService#createImportJob(String, String, String[], boolean, boolean, boolean, String...) to specify the parameters for the Import job and the header columns to be classified. After submitting the job, you can iteratively populate row data by calling SAINTService#populateImportJob(String, int, Collection). After sending all data, call SAINTService#commitImportJob(int) to finalize the Import job and submit it to the SAINT processing queue.

Parameters:

configuration - Web service support configuration

description - Description of the import job.

email - E-Mail address to receive job notifications.

header - Array of column values for classification.

relationId - Relation identifier of classification the import should be done for.

checkDivisions - Specifies whether to check report suites for compatible divisions.

exportResults - Specifies whether to automatically perform an export when the import job finishes processing.

overwrite - Specifies whether to overwrite data when conflicts occur.

reportSuites - (Optional) List of report suites to receive the import job.

Returns:

Import job identifier

Throws:

SitecatalystException

createImportJob

int createImportJob(Configuration configuration,
                  String description,
                  String email,
                  String[] header,
                  String classificationView,
                  boolean checkDivisions,
                  boolean exportResults,
                  boolean overwrite,
                  String... reportSuites)
                    throws SitecatalystException

Creates a SAINT Import Job. To successfully submit a SAINT Import, call SAINTService#createImportJob(String, String, String[], boolean, boolean, boolean, String...) to specify the parameters for the Import job and the header columns to be classified. After submitting the job, you can iteratively populate row data by calling SAINTService#populateImportJob(String, int, Collection). After sending all data, call SAINTService#commitImportJob(int) to finalize the Import job and submit it to the SAINT processing queue.

Parameters:

configuration - Web service support configuration

description - Description of the import job.

email - E-Mail address to receive job notifications.

header - Array of column values for classification.

classificationView - The report for which you want to perform a SAINT import

checkDivisions - Specifies whether to check report suites for compatible divisions.

exportResults - Specifies whether to automatically perform an export when the import job finishes processing.

overwrite - Specifies whether to overwrite data when conflicts occur.

reportSuites - (Optional) List of report suites to receive the import job.

Returns:

Import job identifier

Throws:

SitecatalystException

populateImportJob

boolean populateImportJob(Configuration configuration,
                        int jobId,
                        int page,
                        Collection<String[]> rows)
                          throws SitecatalystException

Appends row data to a previously created import job. Data can be separated into pages, but the pages must be sent sequentially (either ascending or descending) to avoid errors when SAINT processes the job.

Note: Individual SAINT job pages cannot exceed 25,000 rows.

Parameters:

configuration - Web service support configuration

jobId - SAINT job identifier to append row data

page - Page number that identifies the sequential position in the SAINT import job. For example, if you submit a spreadsheet with 1000 values, divided into 4 pages, page 1 includes values 1 - 250, page 2 includes values 251 - 500, and so on.

rows - Collection of row data that matches the column heading

Returns:

true if population was successful, false otherwise.

Throws:

SitecatalystException

commitImportJob

boolean commitImportJob(Configuration configuration,
                      int jobId)
                        throws SitecatalystException

Commits the SAINT import for processing.

Parameters:

configuration - Web service support configuration

jobId - SAINT import job identifier

Returns:

true if job has been processed successfully, false

Throws:

SitecatalystException