Zuora Central sandbox migration - Self service setup

This issue documents the steps required to migrate your local instance to use Zuora Central sandbox 2 environment.

🛠 Please find details on access, setup steps in the section below.

🐛 If you encounter any problem during setup, please create a new comment on this issue (unless it relates to an existing thread). Also checkout the Troubleshooting section for common errors.

Access

The Zuora Central Sandbox 2 can be accessed via the Okta tile Zuora Dev Sandbox :

Screenshot_2024-03-04_at_11.02.54_AM

If you already had an account on apisandbox as of February 8, 2024, you will automatically be added to the Okta group and the tile should show up.

Please contact @brianmwong or #enterprise-apps if you are an existing user and have trouble accessing the environment.

If you are a new user, please submit an Access Request for 'Standard User' access and assign it to the IT Enterprise Applications team (#enterprise-apps) for provisioning. Add the labels EA-AccessRequests, BT Finance Systems, BT-Priority::1, FinSys::Service Desk to the issue.

Setup

CustomersDot

  1. Pull the latest version of CustomersDot
  2. Find the private 1Password link associated with your email in this sheet. Access the vault using the OTP sent to your email Please contact #s_fulfillment_engineering and someone with Admin access can create OAuth credentilas for your user.
  3. Update your environment file .env with the values from the 1Password vault:
    1. ZUORA_CLIENT_ID
    2. ZUORA_CLIENT_SECRET
    3. ZUORA_INTEGRATION_API_USER_IDS
  4. Please ignore below if you use default urls for CustomersDot (http://localhost:5000) and GDK (http://localhost:3000).
    1. If you had a custom payment method set up in Developer sandbox, the same has been pre-created with your configs in the new environment. Please check your vault for the respective payment method ID
    2. If your vault does not include the payment method configs, please check Step (4) and (5) in this README link to create new ones.

ZSim

  1. Pull the latest version of ZSim
  2. Replace the following values in .env file with the ones from your 1Password vault:
    1. ZUORA_CLIENT_ID
    2. ZUORA_CLIENT_SECRET
    3. ZUORA_USER_ID (value corresponds to ZUORA_INTEGRATION_API_USER_IDS in 1Password vault)
  3. The values for ZUORA_CALLBACK_USERNAME and ZUORA_CALLBACK_PASSWORD env variables are the same as the previous setting in Dev sandbox. They can also be retrieved from 1Password (Subscription portal vault -> [Zuora] Central Sandbox 2)

Post-setup steps

  1. Ensure secrets.yml file in CustomersDot does not have any overrides set for any zuora_ related configs
  2. Update local product catalog cache by executing IronBank::LocalRecords.export on rails console
  3. Restart CustomersDot, GDK, ZSim and start with creating a new user account!
  4. Rebase open MRs on CustomersDot with latest main

🔖 Please note existing Zuora accounts and subscriptions from apisandbox / developer sandbox will not be migrated, and thus CustomersDot and Gitlab.com user accounts in your local instance will not work.

Troubleshooting

  1. In the spreadsheet, if your email is marked as Pending activation, please sign in to Zuora Central Sandbox 2 (10000719) on Okta and send a message to @aish.sub or s_fulfillment_engineering and someone with admin access can create OAuth for you. This can happen because either your user account did not exist in Zuora Production, or the account was unconfirmed.
Edited by Aishwarya Subramanian