Unsubscribe Data File Name Conventions
All unsubscribe data files transferred to Oracle Utilities must follow a standard naming convention. File name components enclosed in angle brackets (<>) must be populated. File name components enclosed in square brackets ([]) are optional and can be included or left out. Any components without brackets must be part of the file name and should not be changed.
Email Unsubscribe File:
opwr_<utility>_res_<specification version number>_email-address-event-v1_<tier>_<yyyyMMddHHmmss>.csv
IVR (Voice) Unsubscribe File:
opwr_<utility>_res_<specification version number>_ivr-address-event-v1_<tier>_<yyyyMMddHHmmss>.csv
SMS (Text) Unsubscribe File:
opwr_<utility>_res_<specification version number>_sms-address-event-v1_<tier>_<yyyyMMddHHmmss>.csv
This naming convention is made up of the following components:
- Prefix: The opwr prefix, which is the standard abbreviation for Oracle Utilities Opower.
- Utility Identifier: A three- or four-character code that identifies the utility sending the file. Your Delivery Team will work with you to choose the utility code early in the implementation process. The code needs to be a unique identifier for the utility in the Oracle Utilities Opower system. For example, “The Great Energy Company” might have an identifier of gec.
- Population Token: An abbreviation that indicates whether the data is applicable to residential (res) or non-residential (nonres) customer populations. For the non-residential category, there are additional segmentations available to designate Small and Medium Business populations (nonres-smb) or Large Commercial Industrial populations (nonres-lci). Consult your Service Delivery Manager to determine which is the most appropriate population token if you need to use additional segmentations.
- Specification Version Number: A three-digit version number of the data transfer specification. Each digit must be separated by a hyphen (-) and not a period or an underscore.
- Data Type: The filename must include the phrase <channel>-address-event-v1 to indicate the type of data included and the specification version used to generate and interpret the file. For example, if the channel is email, the phrase would be email-address-event-v1.
- Tier: The deployment environment to which this data corresponds. Can be stage for pre-production or prod for live production.
- Date/Time: The date that the file was generated, in the format yyyyMMddHHmmss.
- File Extension: All files must be formatted in CSV form. All files should be gzipped and should end with .gz, or be zipped and end with .zip. If you choose to PGP encrypt your files, then the .pgp extension should be used. In the case of PGP encryption, compression is not required since the encryption process includes file compression. Files can be up to one gigabyte compressed, or up to four gigabytes uncompressed.
File Name Examples
Suppose the specification version number of the document is v1-0-0 and your utility is named "The Great Energy Company.” An example of your utility’s file name would be as follows:
opwr_gec_res_v1-0-0_email-address-event-v1_prod_20210316131415.csv
Suppose your utility is using PGP-encrypted files. An example of your utility’s file name would be as follows:
opwr_gec_res_v1-0-0_email-address-event-v1_prod_20210316131415.pgp
Additional Notes
The filename must not exceed 183 characters and must not contain a period (.) unless the period comes right before the file extension. The Oracle Utilities Opower file reception system considers the first period in the file name to be the beginning of a file extension. For example, the following file name is invalid and cannot be processed:
opwr.gec.res.v1.0.0.email-address-event-v1_prod_20210316131415.gz.