Batch Automation User Guide
The purpose of this user guide is to describe how to get started with the Batch Automation Services and is intended to provide an understanding of the required components for scheduling Phone Number Verification Scrub Job and Phone Number Verification Monitoring Jobs.
Prerequisites
Batch Automation is one of the core infrastructure services in the Syniverse Developer Community. The following configurations and items need to be in place to start using Batch Automation:
- Create Company Environment in Syniverse Developer Community
- Subscribe for Batch Automation
- Subscribe for an OPTIONAL Service Offering for Media Storage Service (if doing batch look-ups or monitoring)
- Subscribe for an OPTIONAL Service Offering for Event Manager (if interested in receiving notifications regarding batch job status, example job started and job complete)
- Application created in Syniverse Developer Community
- Application resources have API Batch Automation turned ON
- Based on the application defined in Syniverse Developer Community, you must request provisioning of the Phone Number Verification Scrub Job - Contact Syniverse
- Syniverse provides a unique customer specific job ID required to submit any batch jobs for execution.
Related Services
Batch Automation is used as a key component for Batch Phone Verification and Phone Verification Monitoring. The following related services can be used in conjunction with batch automation:
- Syniverse Developer Community
- Event Manager Service
- Media Storage Service
- Phone Verification Service
Quick Start Overview
Please review how to get started with Syniverse API Batch Automation service through the related User Guide in Phone Number Verification.
Key Concepts
The following concepts are central to understanding the Batch Automation
service:
- Input and Output File Formats: ABA jobs accept text files (ex: txt, csv, dat) however, compressed input is in gzip format only. File format details can be retrieved using the Layout Resource.
- Uploading Input Files: Input files can be uploaded via the Content Resource in the Media Storage Service. Visit the Media Storage Service overview and resources pages for further details
- Supported Jobs: A list of available jobs can be queried using the Job Resource. Jobs are predefined to simplify setup. The job defines the input and output file layouts, as well as the Syniverse services and APIs to be used to process the input data
- Schedule Jobs: Batch jobs are scheduled using the Schedule Resource. When scheduling a batch job, the input file ID and job ID need to be specified. A list of available job IDs can be returned using the Job Resource.
- Job Status Notifications: The customer can be notified when a job is complete as well as receive other event notifications during batch processing. To receive notifications, the customer needs to create a subscription for the ABA-Messages Topic in the Event Manager Service. This is created once and will be performed for all subsequent batch jobs
- Job Execution, Status, and Results: Scheduled jobs are executed by the Batch Automation service on behalf of the customer. The customer can query the status of a job using the Execution Resource. The query will also return statistics for the job execution. Upon completion of a job, the Execution Resource can also be queried to obtain the final job execution details as well as the URL to download the output files
- Downloading Output Files: Output files, including separate files of the results and errors, can be downloaded from Media Storage Service using the URL provided by the Execution Resource.
User Guide
When submitting a schedule, the following settings can
be modified to match your requirements:
Phone Number Verification Scrub Job:
| Field Name | Description or Value |
|---|---|
| jobId | Customer specific identifier for the phone verification scrub job (provided by Syniverse upon provisioning completion) |
| name | Customer specified name associated with the scheduling of the job |
| inputFileId | Unique file identifier provided by Media Storage Service upon successful upload of the input file |
| fileRetentionDays | Value that determines the number of days that files are retained in the system before purging. Max value is 90 and the default value is 30 days. |
| scheduleRetentionDays | Value that determines the number of days that a schedule is retained in the system before purging. |
| outputFileNamingExpression |
This pattern is used to generate the output file name within Media Storage Service. It can be a combination of literal characters and reserved substitution tags. These tags will be replaced with appropriate data when the file is uploaded to Media Storage Service. Supported substitution tags are: [Date] [Time] Examples: "MyOutputFile-[Date].txt" will resolve to "MyOutputFile-20160927.txt" "MyOutputFile[Date][Time].csv" will resolve to "MyOutputFile20160927140299.csv" "MyOutputFile.out" will resolve to "MyOutputFile.out" |
| outputFileFolder | Name of the folder where the output files are stored. |
| outputFileTag | Customer designated tags associated with the output files generated for logical grouping. |
| jobRuntimeContext | Not applicable for the Phone Number Verification Scrub job. |
Phone Number Verification (Create Subscription) for Monitoring:
| Field Name | Description or Value |
|---|---|
| jobId | NIS-Monitor-v2 |
| name | Name associated with the scheduled job |
| inputFileId | File identifier provided by Media Storage Service |
| fileRetentionDays | Value that determines the number of days that files are retained in the system before purging. Max value is 90 and the default value is 30 days. |
| scheduleRetentionDays | Value that determines the number of days that a schedule is retained in the system before purging. |
| outputFileNamingExpression |
This pattern is used to generate the output file name within Media Storage Service. It can be a combination of literal characters and reserved substitution tags. These tags will be replaced with appropriate data when the file is uploaded to Media Storage Service. Supported substitution tags are: [Date] [Time] Examples: "MyOutputFile-[Date].txt" will resolve to "MyOutputFile-20160927.txt" "MyOutputFile[Date][Time].csv" will resolve to "MyOutputFile20160927140299.csv" "MyOutputFile.out" will resolve to "MyOutputFile.out" |
| outputFileFolder | Name of the folder where the output files are stored. |
| outputFileTag | Customer designated tags associated with the output files generated for logical grouping. |
| jobRuntimeContext | Contains two fields: subscribeevents and subscriberdestinationid listed below: |
| subscribeevents | If set to “all”, subscription is created for
all events associated with mobile number. Note: You have an option to provide a comma separated event type list if not interested in all events associated with the mobile number. |
| subscriberdestinationid | Destination ID configured in Event Manager service to receive notifications about number updates. |
Phone Number Verification (Unsubscribe) for Monitoring:
| Field Name | Description or Value |
|---|---|
| jobId | NIS-Unsubscribe-v1 |
| name | Name associated with the scheduled job |
| inputFileId | File identifier provided by Media Storage Service |
| fileRetentionDays | Value that determines the number of days that files are retained in the system before purging. Max value is 90 and the default value is 30 days. |
| scheduleRetentionDays | Value that determines the number of days that a schedule is retained in the system before purging. |
| outputFileNamingExpression |
This pattern is used
to generate the output file name within Media
Storage Service. It can be
a combination of literal characters and reserved substitution tags.
These tags will be
replaced with appropriate data when the file is uploaded to Media Storage Service.
Supported
substitution tags are: [Date] [Time]
Examples: "MyOutputFile-[Date].txt"
will resolve to "MyOutputFile-20160927.txt"
"MyOutputFile[Date][Time].csv"
will resolve to "MyOutputFile20160927140299.csv"
|
| outputFileFolder | Name of the folder where the output files are stored. |
| outputFileTag | Customer designated tags associated with the output files generated for logical grouping. |
| jobRuntimeContext | Not applicable for the Phone Number Verification Unsubscribe job. |