Creating a BLS Integration

To create an integration:

1. Obtain a free API Registration Key on the BLS website.
   • Go to https://data.bls.gov/registrationEngine/ > add registration details > Submit Registration
     

2. The API Registration Key will be sent to the email tied to registration details.

3. Go to Setup > Zone Advanced Billing Setup > Preferences > add the API Registration Key to the BLS Registration Key Field > Save.
   

BLS Series ID Setup

The BLS website offers information on a range of labor and economic reports, including employment rates, productivity and price indexes. Each of these reports (Series) are tied to a Series ID.

After integration setup, locate the BLS Series and Series ID:

1. Visit the BLS website to review data and its associated Series ID:
   https://www.bls.gov/help/hlpforma.htm
2. Create a ZAB Bureau of Labor Statistics Series.  Go to Setup > Zone Advanced Billing Setup > Bureau of Labor Statistics Series > click New ZAB Bureau of Labor Statistics Series
   
3. Add the Series ID to the BLS Series ID field
   
4. Specify if the Series data is Net, Is Percent or both (select all that apply) > Save.
5. Note: The BLS website will determine if the Series is Net, Percentage or both.
6. Save
7. Once saved, additional fields on the Series record will auto-populate with Series details (Survey Name, Series Title, etc.).
8. ZoneBilling will fetch data associated with the Series ID from the BLS for the past ten years, which will populate under the Results subtab.
   

Using BLS results in ZAB Processes

Create a Saved Search from BLS Results to use across a variety of ZoneBilling processes. Searches can be leveraged in ZoneBilling functions such as Rate Policy Adjustments and Renewals.

Example: Using BLS results in Adjustment Rate Policies

1. Create a Saved Search from BLS Results.
2. At a minimum, the Search must supply the record internal ID, a Date, and numeric value (i.e. Value) to the ZAB Rate Policy Search Map.
   
3. Specify key data points from the Saved Search that should be mapped to the Rate Policy Rule
   
4. Add the Rate Policy Search Map to the Value Provided By Search Field.
   
   • In this example, the Rate will increase by the Amount supplied by the search.
5. Add the Rate Policy Rule to the Rate Policy.
   
6. Add the Rate Policy to the Subscription Item under the Adjustments tab.
   
7. The Adjustment percentage uplift (supplied by search) is applied to the Subscription Rate.