Symitar — Partner connection
The Symitar — Partner connection holds everything the connector needs to reach the SymXchange™ services of your Symitar® core processing platform. One connection serves every operation that targets the same SymXchange instance. Create one connection per Symitar instance and per environment, and reuse it across your processes.
The connection authenticates with SymXchange administrative credentials: a password, sent together with a device type and a device number. The connector sends these values with every request and keeps no session between calls.
The connector uses two SymXchange services from a single URL. The Account service answers member, share, loan and transaction reads. The File Management service downloads and deletes PowerOn® letter files. You enter only the Account service URL; the connector derives the File Management address from it by replacing the trailing /account with /filemanagement.
Before you begin
Collect the following before you create the connection:
- The SymXchange Account service URL for the SymXchange release your credit union runs, for example
https://hostname:port/SymXchange/2022.01/account. Your Symitar administrator provides it. - The administrative credentials password, and a device type and device number that SymXchange has authorized for the calls your processes make:
getAccountSelectFieldsfor member data,searchShareTransactionPagedSelectFieldsandsearchLoanTransactionPagedSelectFieldsfor transaction history, anddownloadLetterFileanddeleteLetterFileif you read PowerOn letter files. SymXchange refuses a call the device is not authorized for. - Network access from the runtime (basic runtime, runtime cluster or runtime cloud) that will run the connector to the SymXchange host and port, over HTTPS. The connector waits up to 30 seconds to open a connection and up to 120 seconds for a response.
- A Customer ID and a License Key from Solutions Metrix.
Connection tab
Complete the following fields on the Connection tab. Every field is required.
| Field | Required | Description |
|---|---|---|
| SymXchange URL | Yes | The full URL of the SymXchange Account service endpoint, including the release and the /account path, for example https://hostname:port/SymXchange/2022.01/account. The URL must start with http:// or https://. The field is pre-filled with this example pattern, which is not a working address: replace it with your own endpoint. |
| Password | Yes | The password of the SymXchange administrative credentials. The Boomi Enterprise Platform stores the value encrypted, and the connector never writes it to the process logs or to error messages. |
| SymXchange Device Type | Yes | The SymXchange device type identifier the credentials are issued for. The field is pre-filled with CLIENTSYSTEM. Keep it only if your Symitar administrator confirms it. |
| SymXchange Device Number | Yes | The SymXchange device number issued for that device type, as an integer. The field is pre-filled with 20000. Replace it with the number your Symitar administrator issued. |
| Customer ID | Yes | The customer identifier issued to you by Solutions Metrix. It is included in the license request and is validated against the license key. |
| License Key | Yes | The license issued to you by Solutions Metrix, as a single-line value. The value is stored encrypted by the Boomi Enterprise Platform. Without a valid license the connector refuses to execute. To obtain one, send Solutions Metrix the Customer ID you configured here together with the Boomi Account ID of the account the runtime belongs to (Settings > Account Information in the Boomi platform). Browsing and Test Connection work without a license, so the process can be built while the license is issued. |
Test connection
You can test your connection settings before you use or save the connection in a process. Click Test Connection, select the runtime that will execute the connector, and click Next. The test runs on that runtime, so it also proves that the runtime can reach the SymXchange host.
The test first checks that the SymXchange URL, Password, SymXchange Device Type and SymXchange Device Number are filled in and that the URL is a valid http or https address. It then sends one getAccountSelectFields request for an account number that cannot exist. SymXchange answers that request only after it has accepted the password and the device, so an answer saying the account does not exist is the expected result, and the test reports success.
When a value is missing, the test names the field. When the call fails, the message says whether the host could not be reached, the endpoint answered with an HTTP error, or SymXchange rejected the credentials, and what to check. The password and the license key are masked in every message the test produces.
The test does not validate the license key. You can therefore configure and verify the connection before the license is issued. An invalid or missing license is reported when a process is executed, not when the connection is tested.
Environment extensions
All four SymXchange values differ between Symitar instances, and the connector ships none of them. Whoever installs the process must supply them for each environment. Override these connection fields with environment extensions: SymXchange URL, Password, SymXchange Device Type and SymXchange Device Number. Keep the Customer ID and License Key aligned with the license you were issued for the Boomi account that runs the environment.
If a process fails at run time with a message that starts with Connection 'url' is blank, the process ran with an empty SymXchange URL: the environment extension values were not applied to the deployed process. Set the extension values and redeploy the process.
Troubleshooting
The table lists what the Test Connection dialog and failed executions report, and what to do about it.
| Message | Cause and resolution |
|---|---|
<field> is required, followed by an example value. | One of SymXchange URL, Password, SymXchange Device Type or SymXchange Device Number is empty. Fill in the named field. |
SymXchange URL must be an http or https URL, or SymXchange URL <url> is not a valid URL | The URL has another scheme or cannot be parsed. Enter the full Account service endpoint, starting with https://. |
Cannot reach SymXchange at <url> | The request did not reach SymXchange. Check the SymXchange URL, DNS resolution, the TLS certificate, and any firewall or proxy between the runtime and the SymXchange host. The message ends with the underlying error the runtime reported. |
SymXchange at <url> rejected the credentials | SymXchange answered with a fault about the credentials or the device. Check the Password, SymXchange Device Type and SymXchange Device Number, and confirm with your Symitar administrator that the device is authorized for getAccountSelectFields. The message quotes the SymXchange fault text. |
SymXchange at <url> answered the probe request with a SOAP fault | The endpoint is reachable, but the fault does not say why the request failed. Check the same three values as above and the device authorization. The message quotes the fault. |
| … rejected the request with HTTP 401 | The endpoint is reachable but the request was not authenticated. Check the Password, and whether the endpoint sits behind a gateway that expects credentials of its own. |
| … rejected the request with HTTP 403 | The credentials type and device are not authorized for the operation. Check the SymXchange Device Type and SymXchange Device Number with your Symitar administrator. |
SymXchange returned HTTP 404 for <url> | The host is reachable but has no service at that path. Correct the SymXchange URL; it must be the Account service endpoint ending in /account. |
| … answered, but not with a SOAP response, or … answered the probe request with an empty body | The URL points at something other than the SymXchange Account service, or a proxy or login page intercepted the request. Correct the SymXchange URL. |
| A process fails with a message that starts with SM-LICENSE. | The License Key is missing, does not match the Customer ID or the Boomi Account ID, or has expired. The message names the reason. The connection test does not check the license, so a connection can test successfully and still fail at execution. Request a license as described for the License Key field above. |
| A process fails with Connection 'url' is blank. | Environment extension values were not applied to the deployed process. Set the extension values and redeploy. |
Related documentation
- Symitar — Partner Connector (overview)
- Symitar — Partner Connector operation
Symitar® and PowerOn® are registered trademarks, and SymXchange™ is a trademark, of Jack Henry & Associates, Inc.®
