How to set up your Spectrum Data Exchange URL and ID

Follow this process to ensure that Ryvit can access your Spectrum Database.

There are 3 distinct parts to this process:

  1. Operator Maintenance
  2. Data Exchange
  3. Data Exchange URL

 

All 3 parts will need to be completed. Once complete, please provide the following to your Ryvit representative:

  • Authorization ID created in Part 2
  • The URL and Port Number from Part 3

    Part 1: Operator Maintenance

    1. Create a New Operator in Spectrum, by navigating to System Administration > Security > Operator Maintenance

      Navigate to Operator Maintenance
    2. In Operator Maintenance, click [New]

      Create a New Operator
    3. Input the required data to create a new operator, and select the company codes you wish to sync from the Companies tab

      • Operator = RYV
      • Logon ID = Ryvit
      • Password = choose a secure password, do not share with Ryvit. (Make note of this, as you will need it for Part 2, Step 3.)
      • Name = Ryvit
      • Email = ryvit@ryvit.com

        Screen Shot 2021-02-24 at 4.48.08 PM



    4. On the Companies tab, click [New] to add the companies you want the integration to sync to the operator profile.

      Screen Shot 2021-02-24 at 4.51.32 PM

    5. Click [OK] to save the record.

    Part 2: Data Exchange

    1. Navigate to System Administration > Installation > Data Exchange

      Screen Shot 2021-02-25 at 8.50.29 AM
    2. Click [New] 

      Screen Shot 2021-02-25 at 8.51.57 AM
    3. Create an Authorization ID

      In this form, you are creating an authorization ID that functions as an API key or password to Spectrum’s web services. Ryvit recommends completing the form as follows.

      • Authorization ID = “ryv” + 8 random characters to make the authorization id secure. Provide the Authorization ID that is created to Ryvit (Please provide to Ryvit.)
      • Company = Select all of the required companies
      • Status = Active
      • Spectrum Operator Code = Input the PW that you created for the RYV Operator that you created in Part 1, Step 3.
      • Click [Build] and then follow the appropriate instructions for the integration that this setup pertains to (i.e. if you're setting this up for Agora, then select Agora <> Spectrum and follow those instructions).



      Screen Shot 2021-02-25 at 8.55.39 AM

     

    BEFORE YOU PROCEED TO Part 3: Data Exchange URL, click on the integration that you're setting this up for. DO NOT follow instructions for an integration that you're not working on. 

    If you do not see the integration that you're working on, please email support@ryvit.com for clarification.

    Part 3: Data Exchange URL


    1. Navigate to System Administration > Utilities > Data Exchange Download

      Screen Shot 2021-02-25 at 9.20.53 AM
    2. Provide the URL and Port number to Ryvit

      Screen Shot 2021-02-25 at 9.22.00 AM

    This concludes the Spectrum Data Exchange URL and ID setup process. If you have any questions, please do not hesitate to reach out to support@ryvit.com.

    As always, thanks for trusting our team and our tech to help you automate data flow throughout your tech stack.