SymXchange v2
Provides integration with SymXchange SOAP services through structured JSON requests and service-specific templates. Use this Node on a Local Runtime to call Account, FindBy, PowerOn and Transactions operations.
Revision History
0.0.1.5 - Provides service-based templates, compact and full schema views, metadata caching and administrative credential injection.
Connection
| Property | Type | Description |
|---|---|---|
ServiceUrl |
String | HTTPS service root, for example https://host/SymXchange/2022.01. The selected service path is appended automatically. |
Service |
Enum | Account, FindBy, PowerOn or Transactions. Defaults to Account; determines templates and execution endpoint. |
Password |
Masked | Administrative password injected into requests. |
BindingName |
String | Optional exact SOAP 1.1 binding name when the WSDL exposes multiple bindings. |
TimeoutSeconds |
Integer | Maximum duration of metadata retrieval and the provider call. Defaults to 300. |
Metadata Cache Seconds |
Integer | Compiled WSDL lifetime, from 0 to 3600 seconds. Defaults to 300; 0 reloads metadata on every call. |
Include Diagnostics |
Boolean | Hidden; defaults to false. When enabled and supported by the Runtime logger, logs timings and SOAP bodies with credentials redacted. Account data can remain in the bodies. |
Template Max Depth |
Integer | Compact template depth from 1 to 20. Defaults to 3. Full Schema templates bypass this limit. |
Metadata |
String | Hidden service-specific templates populated by Acquire Metadata. |
Setup Notes
- Configure a Local Runtime that can reach the service and its WSDL/schema imports.
- Set the HTTPS service root, service and administrative password. Use a separate Connection for each service.
- Configure normal certificate trust on the Local Runtime for private provider certificates.
- Select
Acquire Metadata, save the Connection, then select a Compact or Full Schema operation template. - Map the provider request fields and configured device information. For a write operation, explicitly set
Actionto the exact operation name; write templates leave it empty.
Methods
Call
Calls one operation and returns the parsed provider response. Administrative credentials are taken from the Connection.
| Parameter | Type | Description |
|---|---|---|
Connection |
Connection | SymXchange service Connection. |
Action |
String | Exact operation name from the selected template. |
Request |
Object | Provider fields without an outer Request wrapper or SOAP envelope. Connection credentials replace supplied Credentials. |
| Return | Type | Description |
|---|---|---|
Response |
Object | SOAP operation wrapper converted to JSON, without added Flowgear mutation metadata. |
Usage Notes
- JSON objects represent XML elements, arrays represent repeated elements, and
@Namerepresents an XML attribute. The full provider schema validates field names and ordering before the operation is posted. - A response can be accessed through a path such as
Response.findByActiveCardResponse.SingleResponse.AccountNumber; use the selected operation's template for its actual structure. - HTTP errors, SOAP faults and invalid responses fail the awaited call. Exceptions do not include raw provider fault bodies that could expose credentials.
- The Node performs one operation per invocation. Select the provider's paging operation and supply its documented controls when pagination is needed.
- Reacquire metadata after changing
ServiceUrl,ServiceorBindingName, or after provider schema changes. Connections without saved metadata can discover templates live; invalid nonempty metadata must be reacquired. - Compact and Full Schema entries invoke the same operation. Changing template depth does not change request validation or require metadata reacquisition. Refresh the selected template to apply the new view.
- When upgrading from a Node-level
Serviceinput, move the selection to the Connection and reselect templates. Legacy XML inputs must be remapped as JSON.
Known Issues
- Only SOAP 1.1 document/literal SymXchange wrappers are supported. Private certificates must be trusted by the Local Runtime; there is no certificate-validation bypass.
See also
- SymXchange Proxy for raw XML requests and explicit HTTP status handling.