- Problems launching the publisher
- Possible causes of publishing problems
- Firewall settings - How to tell if the web services are available?
- How to change the web service settings?
- Where to find the configuration files
- What happens if some of the on-line data is missing?
- How to report issues?
- What happens if the map service is running slowly?
Problems launching the publisher
If the publisher will not start (from the GUI or command line), then check that you don't have another window with the publisher running in it. Only one instance of the publisher may run at any one time.
You must also ensure that you have the required version of the Java Jun time installed (e.g. Version 6.2 for publisher 2.4_2)
Possible causes of publishing problems
Documents may fail to publish for several different reasons:
- The XML of the TransXChange document is invalid, causing a failure of the initial document validation step.
- The XML of the TransXChange document is of a version level not supported by the publisher.
- There are problems accessing on-line web services. (This Applies to Enhanced Publisher .2a_1 and later only).
- Your environment requires the use of proxy settings to access external web services. These must be configured - see later below.
- A web service is not available for a requested function. (For example the NaPTAN stop services are required to publish route maps).
- There is an error in the web service configuration settings of the publisher.
- Not all the required data can be fetched leading to incomplete output.
- The publisher Java environment is not configured with enough memory. See out of memory errors.
- There is a bug in the publisher. See reporting issues below.
Errors are written to a log file, and displayed in the output window. The log file can be found in the logs directory.
Common Publisher Error Messages & Remedies
|Invalid request. Cannot find input document: ...||No such TransXChange input document.||Correct the name or location of the TransXChange input document and try again.|
|Invalid request. Cannot find output directory: ...||The output directory specified does not exist.||Create the out directory (e.g. using Windows Explorer) and try again.|
|The process cannot access the file because it is being used by another process.||An output document already exists with the same name and is in use.||Close PDF document (from Adobe Acrobat) and try again.|
|Version not supported||The version of the schema is not supported by this version of the publisher||Use a version of the publisher that does support version level, or update the document to the next level.|
|Only the timetable section can be published in HTML format.||Invalid combination of publisher options.||Change selection values - specify None for all sections except the timetable, and try again.|
|Error while parsing document.||Invalid XML input document - does not conform to TransXChange XML schema.||Correct errors reported and resubmit. You might find it convenient to use an XML validation tool to find and correct errors more efficiently. See the Technical FAQ.|
|Options not available.||NaPTAN web service not available.||This may be due to problems in on-line access or to the availability of the web service. See below.|
Firewall Settings & How to tell if the web services are available?
The Route Map options of the enhanced publisher require the use of a broadband internet connection and the availability of two separate on-line web services to fetch stop and map data. If you have a firwall that restricts access to certain sites then you need to ensure that it is configured to permit requests to the necesary domains.
- NaPTAN Stop service If you have specified that stop data should be retrieved from the NaPTAN web service and the stop data service is completely unavailable, you cannot print a route map. In this case the publisher will fail early with the error message "Could not get NaPTAN stop data response from web service".
- Check that you have internet access.If necessary explicitly configure your firewall to access http://www.dft.gov.uk/journeyweb/
- Check that the web service settings are correct.
- Check the availability of the NaPTAN stop web service using a standard web browser. The following URL should return a web page
- Map image service: If you have specified map data should be retrieved from the map web service and the map service is completely unavailable, you cannot print a route map with a map image background. If this case the publisher will again fail early with the error message "Got response code x from: y"
- Check that you have internet access.If necessary explicitly configure your firewall to alllow any request beginning with http://dev.virtualearth.net
- Check the availability of the map web service using a standard web browser.
- Publisher v2_4_1 and later Bing:
- Clicking on the following link should return a result an xml document.
- Bing service test on virtual earth : http://dev.virtualearth.net/REST/V1/Imagery/Metadata/Road/
- Bing Tile Test : click here to see a map
- It may be that the map service is exceptionally busy and is timing out in which case try again later.
How to change the web service settings
1. Web service Configuration files
Some properties of the web services are configurable in the TransXchange
Publisher application. There are separate configuration files for each web
service. The web services are located in the
config subdirectory of the publisher folders and are:
- Stop data:
- Map tiles:
- Publisher v2_4.0 and earlier : DEPRECATED
- Publisher v2_4_1 and later :
- Publisher v2_4.0 and earlier : DEPRECATED
These files allow you to change the URL of the web service and also the number of retries attempted and the timeout period of the connection. The settings should not be changed unadvisedly.
If you need to access external services via a secure proxy, then it is possible to configure the proxy access.
To get the publisher to use a named proxy host, add the following lines to the
TransXChangePublisher.l4j.ini file in the root of the publisher directory, specifying the appropriate proxy
Setting Explicit proxy settings with
The user must be authorised to the proxy. This may be done explicitly using the
ntCredentials file (see below) . However you do not need to need to configure the
ntCredentials file if the application is run under a Windows session where the logged on user has access to the internet via the specified proxy. As the application is run under a Windows session then the application process assumes the identity of that user.
If you need to configure individual process access settings, then it is possible to do so using the following file:
Within this file are four values:
userName- The user name. This should not include the domain to authenticate with. For example: "user" is correct whereas "DOMAIN\\user" is not.
password- The password.
host- The host the authentication request is originating from. The computer name for the client machine.
domain- The domain within which to authenticate.
Location of configuration files
The TransXChange publisher has six configuration files, all located in the
../config subdirectory of the publisher folders.
application.properties; application settings
ntCredentials.properties; proxy settings
log4j.properties; log4j files properties : Memory and heap settings
multimap.properties; web service settings (Deprecated): URL and timeout values for Publisher v2.4_0 and earlier
bing.properties; web service settings : URL and timeout values for Publisher v2.4_1 and later
naptan.properties; naptan web service
The configuration files can be moved to a different place if this is more convenient. Their location
should be specified with the system property in the
TransXChangePublisher.l4j.ini file located in the root of the publisher directory:
What happens if there isn't enough memory?
The publisher is a portable application that runs on the Java Virtual Machine (VM). A Java VM can be configured to run in a certain amount of memory. If this is exceeded an "out of memory" error will occur. By default the Java VM memory limit is set to a sensible default appropriate for most timetables. However, for large TransXChange documents you may need to increase this allocation. You can do this simply by editing the configuration settings - see out of memory errors.
What happens if some of the on-line data is missing?
The publisher will typically use the web services to fetch a number of different items of data (i.e. stops and map tiles). This means there may be modes of partial failure if the publisher is able to fetch some but not all of the required data:
- Stop Data: If the NaPTAN web service cannot resolve all the stop data because the stops are not yet in the central NaPTAN database, the publisher will continue to produce output: it will draw on the map any stops for which it has location information, and mark in the route map stop index table any stops that it cannot plot. In this case the NaPTAN web service will also return a warning message which appears as a warning in the result pane of teh publisher GUI.
- To resolve missing stop coordinates you must either arrange to get the NaPTAN definition submitted - see www.dft.gov.uk/naptan/, or include a full definition of the stop in the TransXChange document to be published using the StopPoint or AnnotatedStopRef tags.
- Map data If the publisher is able to retrieve the metadata about map tiles, but not all the map image themselves, the publisher will draw the map, filling in the background for just the areas for which it has received images. This may result in some blank sections of map in the resulting document. The publisher will produce the warning "Did not successfully retrieve x out of y map tile images."
- This may occur either if the map service is busy or there is insufficient bandwidth to download the tiles fast enough, so that the publisher times out. A longer time out period may be set using the configuration settings.
What happens if the map service is running slowly?
The publisher uses the map web services to fetch map tiles if route map options are selected. If the map service is running very slowly this can cause timeouts and exceptions.
- The values for timeouts on requests and the number of retries to attempt can be increased in the the
How to report publisher issues
If you think the problem is due to a bug in the publisher you can report it to TransXChange support . When reporting bugs please always include the following.
- The TransXChange XML document causing the publishing error.
- Any options you are using to publish the document, such as route map, etc
- The publisher version number. (See the About option on the Publisher Desktop GUI.
- All log files from the publisher's logs directory.
- Any contents of the GUI output console, or any output from the command line.
- Any related information that may help.
Please check against the Technical FAQ and the known issues for the version of the publisher you are using before submitting a report. There may already be a workaround.
Page last updated: 2013/04/22