SymXchange API

Editing a SymXchange Instance – Enhanced

System Web Console > SymXchange Web Services – Enhanced > Editing a SymXchange Instance – Enhanced

You can make changes to an existing SymXchange instance or add required field information to fully provision an instance within System Web Console.

  • Log on to the System Web Console.
  • Click SymXchange > SymXchange Web Services – Enhanced.
  • The SymXchange Instances screen appears.
  • Click the Edit button for the instance you wish to edit.
  • If you are on Tile View, click the Settings tile to edit the instance.
  • The Settings page appears.
  • Edit the fields required to fully provision an instance:
    1. Name
    2. HTTP(s) Port Number
    3. Protocol
    4. At least one device entry
    5. At least one service entry
  • Edit the fields as necessary based on the following conditions:
    • If the Protocol field is set to https, then the Key Configuration Name and Key Alias fields are required.
    • If mutual authorization is on:
      • A client certificate mapping is required.
      • At least one device entry with a client ID for each client mapping should be present.
  • Click Save.

You have successfully edited or fully provisioned your SymXchange instance. The Settings tile now appears in blue on Tile View and the instance appears in symop.

Important: If the ContactEventMgmtService, BatchJobsService, or CheckVerificationService service is selected, then internal key configuration is required. These services will require additional steps in order for the instance to be considered completely provisioned. If the internal key configuration is not completed for these services, the instance cannot be successfully provisioned and will not appear in symop.

Last updated Fri Mar 3 2023