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:

• SOAP
• WSDL
• WS-I Basic Profile

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.

• SymXchange Interface Changes
  Changes appear in the SymXchange interface for Episys Release 2021.01.
• SymXchange Installation and Configuration
  This section describes configuring your system and installing SymXchange. Symitar recommends that you complete the tasks in this procedure in order.
• SymXchange in System Web Console
  This section describes the information on creating and administering SymXchange instances in the System Web Console. Symitar recommends that you complete the tasks in this procedure in order.
• SymXchange API Version
  Symitar creates a new API version every release and supports the latest four versions.
• SymXchange Memory Configuration
  This section provides information related to SymXchange’s memory need. You can reference this information to evaluate the memory needs of a credit union’s SymXchange deployment.
• Verification for SymXchange
  This section lists the credentials that are valid for verifying SymXchange.
• SymXchange Error Codes
  A SymXchange response message may include various error codes.
• SymXchange WSDLs and Episys Records
  You can choose a SymXchange Web Services Description Language (WSDL) that corresponds to a specific Episys record.
• Parameter Service Mappings
  The operations in the SymXchange Parameter service point to various parameters and settings in Episys Quest.
• SymXchange and SymConnect Parameter Comparison
  This table compares parameter names in SymXchange and SymConnect. In most cases, the names are the same. If there is a discrepancy, it is noted in the Notes column.
• SymXchange and SymConnect Service Comparison
  This table compares service names in SymXchange and SymConnect. In most cases, the names are the same. If there is a discrepancy, it is noted in the Notes column.
• SymXchange Best Practices
  There are recommended approaches to take for various actions within SymXchange.
• SymXchange Transaction Examples
  This section details 14 common specification transaction examples.
• SymXchange Troubleshooting FAQ
  There are some common issues related to SymXchange. These issues can typically be resolved with simple solutions.

Parent topic: SymXchange Developer’s Guide