Search

 

Module: Editor

Version: 5.2.0 +

Category: General

 

Description

Futurama offers several VisionReferences. These VisionReferences are used to connect (using a webservice) between a Futurama application and Vision. These VisionReferences can only give a succesful response in the situation the connection is well defined. To test this connection the 'TestConnection' webservice can be used.   

Parameters

No parameters.

Response

Format

<response xmlns="http://www.actuit.nl/futurama/vision/service/response/1.0">
	<resultcode code="00000" success="true">
		<description>Success</description>
	</resultcode>
	<result></result>
</response>

Within the Result element you find the result of your VisionReference webservice call. Use soapUI to get a quick overview of the responses (see the paragraph 'Example soapUI message').

Return codes

The following return codes can be encountered:

  • 00000 - GeneralSuccess: The operation completed successfully
  • 01999 - GeneralFailError: The operation caused an error

Example soapUI message

In the preceding paragraph the parameters of the VisionReference are listed. The values of these parameters are used by Futurama to compose an XML-message. With soapUI it is possible to see the responses depending on the values of the parameters. Below you find an example of an XML-message. This example can be used in your soapUI project to test the connection with Vision and to see the response for a certain combination of parameters.

<s:envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
	<s:header>
		<futurama path="\\servername\path\futurama" version="5.2.0.2" xmlns="http://www.actuit.nl/futurama/vision/service/header/1.0"/>
		<document path="\\servername\path\data.xml" version="not defined" xmlns="http://www.actuit.nl/futurama/vision/service/header/1.0"/>
	</s:header>
	<s:body>
		<request method="Ping" version="1.0" module="General" xmlns="http://www.actuit.nl/futurama/vision/service/request/1.0"/>
	</s:body>
</s:envelope>

Within the Header element you find an element 'Document' and an element 'Futurama'. The Futurama path is the path to your Futurama installation that is used to test the connection with Vision (for example the Futurama Editor). The document path is the path to the Futurama document where the TestConnection VisionReference is defined.

Feedback

If you have any questions about this subject or if you want to provide us feedback please send us an e-mail.

Updated: 2014-12-23