blob: 440ffedca86f4890da04714b7606b9d7f4808535 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta name="copyright" content="Copyright (c) 2000, 2008 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/. Contributors: IBM Corporation - initial API and implementation" />
<meta name="DC.rights.owner" content="(C) Copyright 2000, 2008" />
<meta content="public" name="security" />
<meta content="index,follow" name="Robots" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta content="task" name="DC.Type" />
<meta name="DC.Title" content="Adding a message" />
<meta name="abstract" content="Messages represent an abstract definition of the data being transmitted. A message consists of logical parts, each of which is associated with a definition within some type system. WSDL messages are top level objects that can be referenced by an operation's input, output and fault elements (within a port type)." />
<meta name="description" content="Messages represent an abstract definition of the data being transmitted. A message consists of logical parts, each of which is associated with a definition within some type system. WSDL messages are top level objects that can be referenced by an operation's input, output and fault elements (within a port type)." />
<meta content="Web services, adding WSDL messages, WSDL files, messages" name="DC.subject" />
<meta content="Web services, adding WSDL messages, WSDL files, messages" name="keywords" />
<meta content="XHTML" name="DC.Format" />
<meta content="addingamessage" name="DC.Identifier" />
<meta content="en-us" name="DC.Language" />
<link href="../../org.eclipse.wst.doc.user/common.css" type="text/css" rel="stylesheet" />
<title>Adding a message</title>
</head>
<body id="addingamessage"><a name="addingamessage"><!-- --></a>
<h1 class="topictitle1">Adding a message</h1>
<div><p>Messages represent an abstract definition of the data being transmitted.
A message consists of logical parts, each of which is associated with a definition
within some type system. WSDL messages are top level objects that can be referenced
by an operation's input, output and fault elements (within a port type).</p>
<div class="p" />
<div class="section"><p>You can create a message using the Outline view by right-clicking
the <strong>Messages</strong> folder and clicking <strong>Add Message</strong>.</p>
<p>To create
a new message for your input, output, or fault element, complete the following
steps:</p>
</div>
<ol>
<li class="stepexpand"><span>In the Design view, right-click your input, output, or fault element
and click <strong>Set Message &gt; New Message.</strong></span></li>
<li class="stepexpand"><span>Type the name of the message in the <span class="uicontrol">General</span> pane
of the Properties view.</span> This name should be a unique amongst all
messages defined within the enclosing WSDL document.</li>
<li class="stepexpand"><span>The new message will appear in the Design view within the port
type.</span></li>
</ol>
<div class="section"><p> <strong>Note</strong>: Messages are referenced within a port type (specifically
by an operation's input, output and fault objects). The input, output and
fault objects within a binding do not reference messages. Hence you cannot
create a new message by right clicking on a input, output, or fault within
a binding (these are also known as binding input, binding output and binding
faults).</p>
<div class="tip"><span class="tiptitle">Tip:</span> You can also create a new message for your input,
output, or fault element using the Outline view. Under the <strong>Port Types</strong> folder,
right-click your element and click <strong>Set Message &gt; Add Message</strong>. Your
message will appear in the Outline view under the <strong>Messages</strong> folder.</div>
</div>
</div>
<div class="nested1" xml:lang="en-us" id="reusingamessage"><a name="reusingamessage"><!-- --></a>
<h2 class="topictitle2">Reusing a message</h2>
<div>
<div class="p">To reuse a message for your input, output, or fault element, complete
the following steps:</div>
<ol>
<li class="stepexpand"><span>In the Design view, right-click your input, output, or fault element
and click <strong>Set Message &gt; Existing Message.</strong></span></li>
<li class="stepexpand"><span>In the <strong>Name</strong> field, type a search string to filter the list
or leave the field blank to view all</span></li>
<li class="stepexpand"><span>You can change the scope of the list by selecting one of the following
options:</span> <ul>
<li><strong>Workspace</strong>: lists the messages available in your workspace.</li>
<li><strong>Enclosing Project</strong>: lists the messages available in the project
that contains your file.</li>
<li><strong>Current Resource</strong>: lists the messages available in your current
file.</li>
<li><strong>Working Sets</strong>: lists the messages available in a specified set of
files. To specify a working set, click <strong>Choose</strong>. You can select files
from an existing working set or create a new working set. Once you have selected
the files, click <strong>OK</strong>.</li>
</ul>
</li>
<li class="stepexpand"><span>The existing messages will be listed. Select one and click <strong>OK</strong>.</span>
</li>
</ol>
<div class="section" />
</div>
</div>
<div class="nested1" xml:lang="en-us" id="importingamessage"><a name="importingamessage"><!-- --></a>
<h2 class="topictitle2">Importing a message</h2>
<div>
<div class="p">If you want to import an existing message for your input, output,
or fault element, follow these steps:</div>
<ol>
<li class="stepexpand"><span>In the Design view, right-click your input, output, or fault element
and click <strong>Set Message &gt; Existing Message.</strong></span></li>
<li class="stepexpand"><span>In the <strong>Name</strong> field, type a search string to filter the list
or leave the field blank to view all.</span></li>
<li class="stepexpand"><span>You can import a message by selecting one of the following options:</span>
<ul>
<li><strong>Workspace</strong>: lists the messages available in your workspace.</li>
<li><strong>Enclosing Project</strong>: lists the messages available in the project
that contains your file.</li>
<li><strong>Working Sets</strong>: lists the messages available in a specified set of
files. To specify a working set, click <strong>Choose</strong>. You can select files
from an existing working set or create a new working set. Once you have selected
the files, click <strong>OK</strong>.</li>
</ul>
</li>
<li class="stepexpand"><span>The messages will be listed. Select one and click <strong>OK</strong>.</span>
</li>
</ol>
<div class="section">You can now add parts to your message. Parts are a flexible mechanism
for describing the logical abstract content of a message. For more information,
see <a href="taddpart.html">Adding a part to a message</a>.</div>
</div>
<div>
<div class="linklist"><strong>Related concepts</strong><br />
<div><a href="../concepts/cwsdled.html" title="The WSDL editor allows you to easily and graphically create, modify, view, and validate WSDL files.">Editing WSDL files with the WSDL Editor</a></div></div>
<div class="linklist"><strong>Related tasks</strong><br />
<div><a href="tcrtwsdl.html" title="You can create a new, empty WSDL file, then edit it using the WSDL editor.">Creating a new WSDL file</a></div>
<div><a href="tedtwsdl.html" title="Once you have created a WSDL file, you can edit it in the WSDL editor. You can also import WSDL files you have created into the workbench and edit them in the WSDL editor.">Editing WSDL files</a></div></div>
</div>
</div>
</body>
</html>