Provides integration with Sage X3 Classic SOAP publications using HTTP Basic authentication. Use metadata Methods to inspect publication contracts, read business objects, and submit structured creation, update, deletion or subprogram requests.
0.0.0.19 - Provides publication metadata, tenant-specific templates, bounded queries and structured mutations.
| Property |
Type |
Description |
Base URL |
String |
Tenant origin, for example https://x3.example.com. |
Username |
String |
Administration endpoint login mapped to the Sage X3 user. |
Password |
Masked |
HTTP Basic authentication password. |
Pool Alias |
String |
Classic SOAP pool alias. |
Language Code |
String |
Response language code. Defaults to ENG. |
Pool ID |
String |
Optional pool process ID; normally leave empty for pool distribution. |
Validation Public Name |
String |
Publication used for the Connection test, for example BPC. |
Metadata Public Names |
String |
Exact publication names to acquire, one per line. |
Acquired Metadata |
String |
Hidden schemas and bounded business-data samples used by templates. |
- Configure a Classic SOAP pool and publications in an environment that permits HTTP Basic authentication.
- Enter the tenant origin, pool alias, credentials and a valid
Validation Public Name, then test the Connection.
- Enter additional publication names in
Metadata Public Names, one per line, and select Acquire Metadata. The validation publication is included automatically.
- Reopen the template selector and choose the exact publication. Default templates include
BPC, SOHALL, SDHALL and SIHALL.
- Replace illustrative category, site, transaction, customer, product, tax, country and currency values with valid tenant values before writing.
Describes a published object or subprogram.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
| Return |
Type |
Description |
Response |
Object |
Structured publication description from getDescription. |
Retrieves the publication data schema.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
| Return |
Type |
Description |
Response |
Object |
The Schema field contains the full data XML schema text. |
Lists readable publication field metadata.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
| Return |
Type |
Description |
Response |
Array |
Rows describing group, field, type, mode, dimensions, length, description and available examples. |
Builds an illustrative Create payload without writing Sage X3 data.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
| Return |
Type |
Description |
Response |
Array |
One nested publication-shaped object for mapping to Create Items after validating its values. |
Queries a publication left list in one bounded request.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
ObjectKeys |
Array |
Optional field/value pairs used as left-list filters. |
| Return |
Type |
Description |
Response |
Array |
Up to 10 provider records; this is not a complete paged export. |
Queries a publication left list using one filter.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
Key |
String |
Published left-list field name, for example BPCNUM. |
Value |
String |
Exact filter value. |
| Return |
Type |
Description |
Response |
Array |
Up to 10 matching provider records. |
Reads one object by its published key.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
ObjectKeys |
Array |
Field/value pairs identifying the object. |
| Return |
Type |
Description |
Response |
Object |
Complete provider-shaped object without mutation metadata. |
Creates objects using save.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
Items |
Array |
Structured publication objects to create. |
| Return |
Type |
Description |
Response |
Array |
Provider results under Result, plus Status, Messages, TechnicalInfos, and Flowgear.IsSuccess, Flowgear.StatusMessage and Flowgear.Request. |
Updates objects using modify.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
Items |
Array |
Each item contains ObjectKeys and Object. |
| Return |
Type |
Description |
Response |
Array |
Provider results under Result, plus Status, Messages, TechnicalInfos, and Flowgear.IsSuccess, Flowgear.StatusMessage and Flowgear.Request. |
Deletes explicitly identified objects.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
Items |
Array |
Each item contains ObjectKeys for the object to delete. |
| Return |
Type |
Description |
Response |
Array |
Provider results under Result, plus Status, Messages, TechnicalInfos, and Flowgear.IsSuccess, Flowgear.StatusMessage and Flowgear.Request. |
Runs a published subprogram for each input.
| Parameter |
Type |
Description |
Connection |
Connection |
Sage X3 Connection profile. |
PublicName |
String |
Exact published Sage X3 object or subprogram name. |
Items |
Array |
Structured subprogram input objects. |
| Return |
Type |
Description |
Response |
Array |
Provider results under Result, plus Status, Messages, TechnicalInfos, and Flowgear.IsSuccess, Flowgear.StatusMessage and Flowgear.Request. |
- Requests use structured objects and arrays. Do not supply raw SOAP fragments. Dates use Sage's compact
YYYYMMDD representation.
- Acquisition reads publication schemas and may sample one query row and one complete object. Only acquire metadata for data the Connection user is permitted to inspect. The cache can contain business values, but does not store credentials.
- Templates use cached metadata without querying the tenant every time the picker opens. Reacquire after publication changes.
- The first streamed operation is performed during invocation; subsequent mutation items are handled lazily. Check mutation result metadata before dependent work.
- Keep large numeric-looking business identifiers as strings to preserve exact digits. Ordinary quantities and flags remain numeric.
- Query Methods return business data without mutation status fields. Provider failures surface as errors.
- Query and QueryByKey return at most 10 rows from one request. No continuation token, total or automatic paging is provided; do not use these Methods as an unrestricted full export.
- Publication names cannot be discovered automatically from the generic WSDL. Supply exact names when acquiring metadata.
- Sage X3 Online OAuth authentication is not implemented by this Basic-authentication connector.
- Advanced actionObject, actionObjectKeys, insertLines and deleteLines operations are not exposed. Publication rules can also prohibit deletion of a record created successfully through another Method.