If errors occur during OData request processing, no details of the errors are
returned to the client for security
purposes. Instead, depending on the type of error, a reply is generated with a
corresponding HTTP error code. If the error occurs within the Intrexx business
logic, the Portal Server log
will contain detailed error messages in some circumstances. However, if the
error occurs right from the start of request processing, it is only possible
to embed the detailed error report in the reply to the client, so that the
error can be analyzed.
To do this, the "log4j" configuration on the Intrexx portal server must be
changed in such a way that it uses the "DEBUG" logging level instead of
"INFO" for the OData Producer module.
To do this, open the "log4j.properties" file in the
portal directory \internal\cfg\
in a text editor. Look for the "OData producer" line in the file, and in the
following line, change the value of "INFO" to "DEBUG" . After saving the
file, restart the portal server to enable the higher level of detail in
the error messages.
1.1.2. OData consumer
If errors occur during an OData request, Intrexx attempts to detect the
error messages from within the reply from the service and to display them
in the browser. This is not possible in all cases. For a more detailed
error analysis it can therefore be advantageous to activate OData request
tracing in the Intrexx portal server.
1.2. Request tracing and error logging
When request tracing is enabled, both the OData requests and responses are
written in detail to the Intrexx portal log file. For requests, an entry
consists of the HTTP action, the URL, the query options, the request headers,
and the XML body. Replies output the HTTP header and the response XML body.
Activate tracing as follows:
You can also activate detailed logging for the OData Provider, which writes all OData replies to a log file. To do so, open portal directory \internal\cfg\portal.wcf and add the following line to the "Java Additional Parameters" section:
Replace <INTREXX_HOME> and <PORTAL> with the specific values for your portal environment, then save the file and restart the portal server. Afterwards, the OData requests will be logged along with their contents. You can apply other settings in regard to logging in the "logging.properties" file.
1.3. Unsupported OData functions
Although Intrexx provides support for all significant functions in version 2.0
of the OData specification, it can occur that a service does not support
certain functions. In this case, it will either cause an error, or a request
will not return the expected result. Since the OData specification provides a
relatively large scope for the services to be implemented in regard to feature
support, if a feature proves to be unsupported, the only way to get around it
is to adjust the Intrexx application to only use functions supported by the
Some examples of these cases are filter definitions, page navigation
(Pagination), or sorting. By using the corresponding
problematic OData features can be deactivated. If certain filter definitions
are not supported, the filter must be adjusted or simplified in Intrexx accordingly.
1.4. SSL connections
For SSL connections between the Intrexx portal server and an OData service,
the Certificate Authority that provided the service certificate must be
added to the certificate store of the Intrexx portal server.
Self-signed certificates are an exception to this, which are not provided
by a recognized Certificate Authority. In order to enable SSL connections
to services with self-signed certificates, the check on the certificate
chain must be deactivated. This is possible at the service level
via a system property.
To do so, open the "portal.cfg" file in the
portal directory /internal/cfg/
with a text editor and add a new <systemProperty>
entry to the <environment> section:
<systemProperty name = "de.uplanet.lucy.server.odata.consumer.ssl.allowSelfSignedCerts.<SERVICE_GUID>;" value="true"/>
The "<SERVICE_GUID>" placeholder must be replaced with the OData service
GUID. You can find this GUID in the
service configuration file in the
portal directory internal/cfg/odata.
After saving the "portal.cfg" file, the Intrexx portal server must be restarted
for the changes to take effect.
1.5. Closing Intrexx OData sessions
Intrexx sessions that were opened via the OData Provider will be closed either
by an automatic timeout or upon request by the
client. In the case of timeouts, a
distinction is made between anonymous and authenticated sessions. By default,
a timeout of 60 seconds is used for anonymous sessions. For authenticated
sessions, the session is automatically closed after 10 minutes without activity.
Both timeout values can be changed via a system property. To change the
default values, open the file "portal.cfg" in a text editor, navigate to the
<environment> section, and add two new <systemProperty> entries:
Please note that the values for the session timeout must be
specified in milliseconds. The changes will be applied after the
The second way to close a session is to use a logout request from the OData
client. This is done by having the client send a request to the server where the
URL ends with the "$logout" path. The session ID, specified in the HTTP header
as a cookie, is used to identify and automatically close the Intrexx session.
2.1. OData specification
A description of the OData protocol as well as the OData specification
can be found
2.2. OData tools
The following tools have proved themselves helpful in creating
applications and analyzing problems:
This Firefox plugin can be used to run and analyze OData requests
within the browser. This is particularly useful for error analysis.
If errors occur, enable Request Tracing, copy the OData HTTP request
from the Intrexx portal.log and run it in the REST client, in order
to adjust the service to avoid unsupported functions.
Microsoft Visual Studio 2010
The Visual Studio 2010 development environment from Microsoft lets custom OData services based on existing databases to be generated and provided over the Microsoft Internet Information Server with little effort.
For technical reasons, it is not currently possible to run the portal server
and OData services on the same TCP port. For this reason, another port must be
selected for Intrexx OData services than the default HTTP port 80 (or 443 for
SSL connections), if the portal needs to be available on that port. However,
a reverse proxy can be used to run the portal server as well as OData services
on the same port. This method uses a forward-facing web server that receives
user requests and uses a set of rules to forward the requests to the
corresponding back-end system. Various free and commercial reverse proxy
solutions are available. The following section describes a sample
implementation using the free Nginx web server. The example assumes that both
Nginx and the Intrexx portal server are running on the same physical server,
and that the portal is available on port 8080 and the OData services are
available on port 9090.
You can download the current version of Nginx from
extracting the downloaded file, the configuration file "nginx.conf" is located
in the child folder "/conf". Replace the file with the following sample
configuration (you can find a copy of the file in the Intrexx
installation directory \adapter\odata\nginx).
Adjust the configuration file for your system/network environment as needed
and save the file. Afterwards, start the Nginx server via "nginx.exe" in the
main program directory. Test the availability of the Intrexx portal and of the
OData services on the unified address with port 80.
Now you should make sure that any embedded URLs in OData documents (such as
links to related data records) receive the correct endpoint URL. Normally, the
name and port of the OData server is used for the URLs. However, when using a
reverse proxy, this differs from the endpoint URL. For this reason, a dynamic
mechanism is required that uses the correct URL for OData addresses at runtime.
To achieve this, the reverse proxy server sends its host name and port to the
back-end system using special request headers (X-Forwarded-*). The back-end
system can read the header and use it to create the relevant URL for the
clients. To activate this mechanism, use the Host parameter in the
OData server configuration.
Enter either "[X-Forwarded]" here to detect the host based on the request
headers, or enter the host name and port of the reverse proxy directly in the
format "hostname:port" (which will override the header values).