Search

Module: Editor

Version: 5.1.0 +

Category: Data

 

Description

Allows you to log information in Vision about (and/or activated by) a certain event in your application.

Parameters

Identifier:

The identifier for which the Message is applicable.

Message:

The message that has be logged in the Vision database.

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>

The Result element of the response is empty; the answer only consists of a ResultCode. 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
  • 11010 - AccountDoesNotExist - This account does not exst.
  • 11011 - AccountNotRelatedToApp - Account exists, but is not related to this Application
  • 11012 - AccountIsNotUnique - Multiple accounts with this name exist in relation to this App

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.

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.actuit.nl/futurama/vision/service/header/1.0" xmlns:ns1="http://www.actuit.nl/futurama/vision/service/request/1.0">
	<soapenv:header>
		<ns:futurama path="\\servername\path\futurama" version="1.0"/>
		<ns:document path="\\servername\path\data.xml" version="1.0">
			<ns:subdocument/>
		</ns:document>
	</soapenv:header>
	<soapenv:body>
		<request method="LogMessage" version="1.0" module="Data" xmlns="http://www.actuit.nl/futurama/vision/service/request/1.0">
			<parameter name="Identifier" value="User123" type="System.String"/>
			<parameter name="Message" value="YourMessage" type="System.String"/>
		</request>
	</soapenv:body>
</soapenv:envelope>

Within the Header element you find an element 'Document' and an element 'Futurama'. For these elements you have to fill in the path of the Document and the Futurama respectively you also configured in the Apps and Futuramas tab of the Vision Management Site. Within the Request element you find the parameters for this VisionReference. By changing the values of these parameters you can execute different webservice calls.

Usage of WriteMessage

When you want to integrate the logging of information in your application, adding the WriteMessage Vision Reference to your application does not suffice. You should also trigger the WriteMessage webreference to be executed. An option to do so, is to create a change value object that stores the result data of the WriteMessage request (Most logical and almost only option: the ResultCode) to a UserVariable.

Monitoring the logged information

In the Vision Management Site you can see an overview of the messages that are logged, in a certain period.
The messages are grouped by name. This enables you to log your information in the way you want, for instance:
- To log the number of users of an application, you should log the same message for each user.
- To log whích users are using your application, you should include a unique identifying text in your message.

Related Topics

- Activity overview: Using the Management Site to get an overview of the logged events with WriteMessage

Feedback

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

Updated: 2018-07-23