XML Travel Objects

The following objects are passed as arguments to or results from the Carapace XML to Videotex Translator when mapping a Tour Operator service. Click here to see the descriptions of the travel commands.

The invoke object contains the name of the command and the arguments. If an error occurs in processing, an error object is returned. Certain commands don't have relevant data to return -- in these cases the ok object is returned.

An alphabetical list of XML objects is as follows:

• activity
• collection
• data
• error
• event
• formData
• fieldData
• invoke
• line
• map
• markup
• ok
• page
• service
• session
• status
• viewer

invoke

Used to supply a command request to the XML server.

Attributes

name	mandatory	description
command	yes	name of the command

Content

At most one XML object.

ok

Returns a simple textual response to the client.

Attributes

none

Content

character data

error

Returns a simple textual response to the client.

Attributes

name	mandatory	description
class	yes	integer class of the error
code	yes	differentiates errors within the same class
file	no	name of the file where the error originated
line	no	line within the file where the error originated

Content

character data which describes the error

collection

A collection of a single type of XML objects.

Attributes

name	mandatory	description
type	yes	type of the contained XML objects

Content

sequence of XML objects of the identified type

status

Holds the status of the Videotex session.

Attributes

name	mandatory	description
session	yes	state of the session
serviceId	no	identifier for the connected service
page	no	name of the current Videotex page
activity	no	name of the activity within the service as chosen by the user

Content

empty

page

Describes a Videotex page -- may include the raw content of the page within the contained line objects.

Attributes

name	mandatory	description
name	yes	name of the current Videotex page -- may be unknown
cursorRow	no	integer row where the cursor is currently positioned
cursorColumn	no	integer column where the cursor is currently positioned
file	no	name of file holding the page

Content

sequence of line objects

line

Holds the content of a line on the Videotex screen.

Attributes

name	mandatory	description
no	yes	line number on the screen -- line zero is the initial line

Content

character data holding the line of data

data

Holds data to send to the Videotex host.

Attributes

name	mandatory	description
type	no	defines whether the data is to be sent raw -- i.e. exactly as supplied -- or is to have an end-of-field character appended before sending to the host Values: raw, field The default type is field.

Content

character data to send

markup

Holds marked-up data sent between client and server.

Attributes

name	mandatory	description
language	yes	the language of the data e.g. HTML
data	yes	the data to send

Content

none

event

Defines an event for which the server must wait.

Attributes

name	mandatory	description
type	yes	the type of event required Values: cursorOn, newPage
timeout	yes	maximum time to wait (in milliseconds)

Content

none

session

Holds information about the current Videotex session.

Attributes

name	mandatory	description
user	no	name of the user for logging on
password	no	user's logon password
reference	no	reference supplied by the user at logon
prompts	no	request for prompts to be received from the Videotex service Values: N, Y
serviceId	no	three letter identifier for the service to choose
serviceName	no	descriptive name for the service
serviceMap	no	map for mapping the chosen service
serviceChoiceMap	no	map for mapping the page which selects the service
pageTimeout	no	timeout to wait for a new page to be received
logonTimeout	no	timeout to wait for the system to validate a logon

Content

none

viewer

Defines the Videotex viewer to be attached to each Videotex session -- this is a debugging aid rather than for use in a production system.

Attributes

name	mandatory	description
browser	yes	progId of the browser to be created using COM e.g. InternetExplorer.Application
url	yes	URL of the web page to navigate to which holds the Videotex emulator
emulator	yes	name of the emulator object within the web page
attach	yes	request to attach the browser to the current session
detach	yes	request to detach the browser from the current session

Content

none

communications

Definition of the communications stack for connection to a service.

Attributes

name	mandatory	description
modules	yes	comma-separated list of communication module names for the stack e.g. Util,Telnet,Tcp

Content

sequence of attribute objects representing the attributes to push onto a communications stack

map

Defines a map for an individual Videotex service.

Attributes

name	mandatory	description
code	yes	three-letter code which identifies a Videotex service
name	yes	name of the map to use for this service

Content

none

formData

Holds the values to be entered for fields on a Videotex form.

Attributes

name	mandatory	description
page	no	name of the current Videotex page
timeout	no	time to wait (milliseconds) for the subsequent page to be received from the Videotex host

Content

sequence of fieldData objects

fieldData

Value for a field on a Videotex form.

Attributes

name	mandatory	description
name	yes	name of the field on the current page
value	yes	value for the field

Content

none

service

Information about a Videotex service.

Attributes

name	mandatory	description
code	yes	unique code identifying the service
name	no	name of the service
description	no	textual description

Content

none

activity

An activity available on the Videotex service.

Attributes

name	mandatory	description
name	yes	name of the activity
description	no	textual description

Content

none

Contents

Current topic: videotex

Related topics: Carapace Hub