Defining Service Operation Properties for a Message Service

As part of developing a message service, you must define operation properties for each operation in the message service.

Operation Properties appear in the Properties section of the Service Interface page when an operation is selected in the service interface diagram.

Properties for the General tab are always available for a service operation.

Properties for the Operation Context and Wire Format tabs are specific to the messaging type of the message service endpoint. These operation properties are available only if an endpoint has been added to the service.

To edit the properties of an operation:

  1. Add a service operation to a message service.

  2. In the Message Service Editor, click the Service Interface tab.

    The Message Service Interface page appears.

  3. In the Service Interface diagram, click to select the operation box.

  4. In the Properties section or Property Panels view, edit the following information:

    General

    PropertyDescription
    NameRename the operation.
    DescriptionProvide an internal description, such as an explanation of this operation.
    Input Message NameField is automatically populated with a default value and used when generating the WSDL for a service. Careful consideration should occur before editing this field to alter the name in WSDL. Modifying the Message Name can be useful in some very specific use-cases, such as in Business Process to reuse the same internal WSDL message for more than one operation; this can be an optimization to prevent the copying of messages unnecessarily.
    Output Message NameField is automatically populated with a default value and used when generating the WSDL for a service. Careful consideration should occur before editing this field to alter the name in WSDL. Modifying the Message Name can be useful in some very specific use-cases, such as in Business Process to reuse the same internal WSDL message for more than one operation; this can be an optimization to prevent the copying of messages unnecessarily.
    VisibleIdentifies whether the service operation is visible or not visible. Only service operations that are defined to be visible can be exposed when the service is made publicly accessible.
    Custom PropertiesAdd and remove custom properties as needed.

    Operation Context: Email

    PropertyDescription
    AttachmentsDefines attachment files for the email message. Click ... to open the Edit Attachments dialog. Click Add to browse to locate an attachment. Select an attachment and click Remove to remove an attachment. When edits are complete, click OK.
    BccIdentifies email addresses for blind carbon copy recipients
    ccIdentifies email addresses for carbon copy recipients
    Content DescriptionDescribes the email content. The value is added in the "Content-Description" header field for the message.
    • If the value is null, any existing "Content-Description" fields are removed.

    • If the value contains non US-ASCII characters, the message is encoded using the platform's default character set.

    • If the description contains only US-ASCII characters, no encoding occurs and the message is processed as-is.

    Content DispositionIdentifies the disposition of the email content. The value is added in the "Content-Disposition" header field of the message.
    • If the value is null, any existing "Content-Disposition" fields are removed.

    • If the value is "inline", the entity is displayed immediately to the user.

    • If the value is "attachment", the user must take additional action to view the entity.

    Content IdThe value is added in the "Content-ID" header field of the message. Identifies the URL scheme that permits the HTML to refer to the images or other data included in the message.
    • If the value is null, any existing "Content-ID" fields are removed.

    Content LanguageThe value is added in the "Content-Language" header of the MIME part. Identifies the language of the message. Several languages may be identified in a comma-separated list.
    Content MD5The value is added in the "Content-MD5" header field of the message. Generated only by an originating user agent, this field is used to verify that the retrieved and decoded data are the same data that were originally sent.
    Content Transfer EncodingDefines the encoding used for the message content. Select one of the transfer encoding options from the drop-list. The default is 7BIT.
    Content TypeIdentifies the media type of the data in the body of the message. Select one of the content types from the drop list. The default is text/plain.
    FromIdentifies the email address of the sender.
    Reply ToIdentifies the email address to which replies to the email are sent.
    SubjectAlpha-numeric field editable by the sender.
    ToIdentifies the email addresses for the email recipients.

    Operation Context: JMS

    PropertyDescription
    Content TypeIdentifies the message type associated with the message.
    Content FormatSpecify the format of the message. Choose from the following:
    • XML

    • CUSTOM_WIRE_FORMAT

    Correlated ResponseSet to True or False, identifies whether the message is expected to have a correlated response.
    JMS Correlation IDIdentifies the JMS provider-assigned correlation id for the message; correlation ids are used to link response messages with request messages.
    JMS Delivery ModeSets the delivery mode for the message. Choose between JMS_DELIVERY_MODE_PERSISTENT or JMS_DELIVERY_MODE_NONPERSISTENT
    JMS DestinationIdentifies the destination to which the message is sent.
    JMS ExpirationIdentifies the time the message should expire. If set to zero (0), the message does not expire. When the expiration time is reached, providers should discard the message.
    JMS Message IDIdentifies the identification value for the message; every message has a unique message ID.
    JMS PriorityIdentifies the priority value for the message. Priority is a numeric value, from 0 to 9, where 0 is lowest priority.
    JMS Redeliveredset to True or False, identifies whether the message is being redelivered.
    JMS Reply ToIdentifies the queue destination where a reply to the current message is to be sent. If this field is null, no reply is expected.
    JMS TimestampIdentifies the time the message was handed off to a provider to be sent.

    Wire Format

    PropertyDescription
    Custom Wire FormatSelect if a custom wire format is to be associated with the operation. See Message Designer Overview.
    XMLSelect if the operation will use an XML schema.
    EncodingIdentifies the encoding associated with the XML schema.
  5. Save the service. Select File|Save from the main menu bar.

Next: Defining Service Operation Parameters for a Message Service

Send your feedback on this help topic to Sybase Tech Pubs: pubs@sybase.com