IBM Cognos Web Services

NoticeCast Chapters in IBM Cognos Web Services SDK API Reference

The following updates will be included in the next version of the NoticeCast chapters of the IBM Cognos Web Services SDK API Reference Guide.

Adapter or AdapterList Element

The description of this element should read:

Information about all the server groups for one adapter. For example, the PPWA adapter is associated with PowerPlay server groups.

AgentMessage Element

The description of this element should read:

Specifies a list of messages to use when running a NoticeCast Agent.

Optional.

If specified, the message will be used either in addition to, or in place of, the messages stored in the agent, depending on the ClearMessages setting.

If not specified, the default message stored in the agent is used.

ChooseAgent command, Name Attribute

The description of this attribute should read:

Name of the parent NewsBox.

ChooseAgent Response Element

The description of this element should read:

The response from the ChooseAgent command. Returns a list of agent Items.

IBM Cognos Web Services does not use or process this information, but passes it to the appropriate server.

Item Element

The description of this element should read:

A list of NewsBoxes or NoticeCast Agents returned by a call to a ChooseAgent operation.

Message Element

The description of this element should read:

Specifies a list of messages to use when running a NoticeCast Agent.

Optional.

If specified, the message will be used either in addition to, or in place of, the messages stored in the agent, depending on the ClearMessages setting.

If not specified, the default message stored in the agent is used.

MessageBody Element

The description of this element should read:

Specifies the content of the message.

If specified, the content of MessageBody is used in place of that stored in the NoticeCast Agent, but does not update the NoticeCast data store.

If not specified, the default message stored in the agent is used.

MessageSubject Element

The description of this element should read:

Specifies the subject of the message.

If specified, the content of MessageSubject is used in place of that stored in the NoticeCast Agent, but does not update the NoticeCast datastore.

If not specified, the default subject stored in the agent is used.

Recipient Element

The description of this element should read:

Represents a receiver of a NoticeCast message.

Optional.

If specified, the content of Recipient is used in place of that stored in the NoticeCast Agent (but does not update the NoticeCast datastore).

If not specified, the default recipient(s) stored in the agent is used.

ServerGroup Element

The description of this element should read:

A list of ServerGroup elements with their associated adapters.

Status Element

The description of this element should read:

Result code returned from a RunAgent command.

Value is "Success" indicating that the operation completed correctly, or a fault is returned.

Action Attribute

The description of this element should read:

Indicates what NoticeCast should do with the message.

Required (literal adapter).

Possible values include:

• Add - adds the message to the existing collection of messages stored in the NoticeCast Agent
• Remove - removes the message as specified by the Id attribute
• Update - makes changes to either the message body or subject, or the recipient list, in the message specified by the Id attribute.

Id Attribute

The description of this element should read one of the following, depending on where it is used:

• For the ChooseAgent command, Id refers to the Id of the parent NewsBox.
• For the Open command, Id refers to the NewsItem identifier of the NoticeCast Agent to open. Optional, but one of Name or Id must be specified.
• For the Message and AgentMessage elements, Id is an identifier for the message. Required when the Action attribute has a value of Update or Remove. If not specified, and the Action is Update, then the first message stored in the agent is modified.
• For the Recipient element, Id specifies an identifier for a recipient. Depending on the values specified by the Type attribute, either an Access Manager identifier, or an external email address, is returned.
• For the Item element, Id refers to the NewsItem Id of the NewsBox or NoticeCast Agent.

Message Attribute

The description of this element should read:

Specifies a list of messages to use when running a NoticeCast Agent.

Optional.

If specified, the message will be used either in addition to, or in place of, the messages stored in the agent, depending on the ClearMessages setting.

If not specified, the default message stored in the agent is used.

Name Attribute

The description of this element should read one of the following, depending on where it is used:

• For the Attribute or AttributeList elements, the name attribute is the name of the adapter.
• For the ChooseAgent command, name is the name of the parent NewsBox.
• For the HeaderPair element, name is the name of a parameter you are passing to the BI server through the Web server. For example, if you are passing security logon information, the name might be a username.
• For the Open command, the name attribute is the Full NewsItem path and name of the NoticeCast Agent. The format is //NewsIndex/NewsBoxname/AgentName.
• For the Recipient element, the name attribute is the name of the recipient of the agent email.
• For the ServerGroup element, the name attribute is the name of the server group.

ServerGroup Attribute

The description of this element should read:

The name of a server group.

Type Attribute

The description of this element should read one of the following, depending on where it is used:

• For the Item element, type refers to the type of the item, either NCAgent or NewsBox.
• For the Item element, the type attribute indicates the type of the recipient. Possible values include:
  • AccMan - indicates that the recipient is an IBM Cognos Access Manager user
  • External - indicates that the recipient is not an IBM Cognos Access Manager user, and that an external email address is being used

Value Attribute

The description of this element should read:

The value of a parameter you are passing to the BI server through the Web server. For example, if you are passing security logon information, and the name parameter is username, the value is the applicable username.