SymXchange Interface

SymXchange is an API that leverages web services that provides third-party vendors, credit unions, and JHA products the ability to access the Episys database. With SymXchange, you can use third-party vendor applications to perform transactions, inquiries, file maintenance, and run PowerOn specfiles on member accounts.

Similar to SymConnect, this interface can support multiple configurations, client-specific parameters, common parameters, and transactions.

SymXchange uses XML and Web Services Description Language (WSDL) files with SOAP (Simple Object Access Protocol) specifications to implement web services over client- and third-party-system networks. Programming knowledge may be necessary to understand the SymXchange interface.

To learn more about SOAP, WSDL, and XML, visit these internet sites:

You can locate the links to the WSDL files for each SymXchange instance at the SymXchange Endpoint Directory URL (http://hostname:port/SymXchange), where you need to enter your hostname and port number in the URL. This directory page displays the endpoints name and the available operations.

The SymXchange feature comprises multiple service endpoints including CRUD (Create, Read, Update, Delete), transactions, PowerOn specfiles, file management, user management, and several other web service operations.

Not all functionality available in Episys Quest is available using SymXchange. Specifically, SymXchange can interact directly with the Episys database but cannot use workflow functionality that is built into Episys Quest, such as Card Wizard and Collection Queue.

Prerequisites

Before you begin setting up SymXchange, you will need the following:

  • Mutual Non-Disclosure Agreement (MNDA) for credit unions and third-party vendors.

    Please contact NHS SymConnect to request the necessary paperwork.

  • An active Discovery Service and Parameter Server.

    Discovery Service needs to be running before Parameter Server is started.

  • Access to symop.

  • Known Episys host server name or host IP address.

  • Minimum of 2GB RAM per SymXchange instance.

  • System Web Console admin credentials.

  • Knowledge of vi Editor.

  • Understanding of the SymXchange interface workflow.

SymXchange Feature in System Web Console

The System Web Console is a web application that provides an easy-to-use interface between symop and Symitar features, including SymXchange, Active Directory®, SFTP or FTPS Key Management, and Replication Services. You can create and manage SymXchange instances in the System Web Console. See the System Web Console Application for more details.

Parent topic: SymXchange Developer’s Guide