Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

xSuite Archive Helix

The connection parameters for a query against xSuite Archive Helix correspond to those of the output system "xSuiteArchiveHelix."

Key

Description

Provider*

Value xSuiteArchiveHelix

Url*

Base address (HTTPS) of the xSuite Archive web service

When specifying the base address, include the port number but not the sub-paths.

ProxyAddress

ProxyUser

ProxyPassword

Proxy server settings for connecting to the xSuite Archive web service (optional)

KeycloakUrl*

KeycloakUrlBasePath

KeycloakRealm*

KeycloakClientId*

KeycloakClientSecret*

Parameters for the Keycloak service to generate the token for authentication against the xSuite Helix Cloud

If the KeycloakUrlBasePath parameter is specified by name in the connection string, it will have the default value auth. If the parameter is to have an empty value, include the parameter in the string without a value or with empty quotation marks ("") after the equals sign.

TraceRequests

Boolean value determining whether, when trace logging is active, the contents of the HTTP requests and HTTP responses to/from the archive server are logged (property Logging.Level: "Trace")

Default value: TRUE

The structure of the query command is based on that of query commands in SQL-SELECT syntax:

SELECT {fieldname 1}@{document type} [AS {alias 1}], …, {fieldname n}@{document type} [AS {alias n}]
FROM {archive index}
[WHERE {filter expression}]
[ORDERBY {fieldname 1}@{document type} [ASC|DESC], …, ORDERBY {fieldname n}@{document type} [ASC|DESC]]

If the fields are to be returned under a different display name, you can assign the fields an alias. You have the option of formulating the search filter in the syntax of an ElasticSearch query string (e.g., ?company@vendors:xSuiteGroup).

In this section: