Designing and developing business objects
Business objects
Business objects in the WebSphere business integration system
Business object definitions
Business object instances
Business object structure
Flat business objects
Hierarchical business objects
Overview of the development process
Setting up the development environment
Stages of business object development
Business object design
Determining business object structure
Representing one entity
Representing multiple entities
Design considerations for multiple entities
Designing application-specific business objects
Contents of application-specific business object definitions
Designing for an existing connector or data handler
Designing generic business objects (InterChange Server only)
Generic business object design standards
Designing for event isolation
Attributes in a generic business object
Evaluating existing generic business objects
Determining mapping requirements for business objects (InterChange Server only)
Using Business Object Designer
Working with projects
If Business Object Designer is running without System Manager
If Business Object Designer is running from System Manager
Starting Business Object Designer
Opening a business object definition from Business Object Designer
Opening a business object definition from a project
Opening a definition from a file
Preventing duplicate definition names
Working with business object definitions
Opening a business object definition and its contained child
Business Object Designer functionality
File menu
Edit menu
View menu
Tools menu
Window menu
Developing business object definitions
Creating a business object definition
Creating a flat business object definition manually
Creating a hierarchical business object definition manually
Deleting a business object definition
Deleting a definition using Business Object Designer
Deleting a definition using System Manager
Using an Object Discovery Agent to create a business object definition
Before using an ODA
Using the sample ODA
Entering values and saving a profile
Setting up logging and tracing
Moving through the source-node hierarchy
Providing additional information
Using multiple ODAs simultaneously
Developing an Object Discovery Agent
Developing an Object Discovery Agent
Running an ODA
Selecting the ODA
Obtaining ODA configuration properties
Selecting and confirming source data
Generating content
Saving content
Overview of the ODA development process
Tools for ODA development
ODA development process
Extending the ODA base class
Starting the ODA
Obtaining configuration properties
Initializing ODA metadata
Initializing the ODA start
Determining the ODA generated content
Choosing the ODA content type
Choosing the ODA content protocol
Generating business object definitions as content
Generating source nodes
Generating business object definitions
Providing access to generated business object definitions
Generating binary files as content
Using files
Generating files
Providing access to generated files
Working with agent properties
Defining the agent property
Defining the property value
Setting conditions on the property value
Shutting down the ODA
Handling trace and error messages
Indicating a log destination
Sending a message to the trace file
Message files
Handling exceptions
What is an ODK exception?
Exceptions from the ODK API library
Adding an Object Discovery Agent to the business integration system
Naming the ODA
Compiling the ODA
Starting up a new ODA
Preparing the ODA runtime directory
Creating startup scripts
ODK class reference
Overview of the ODK API
Classes and interfaces
AgentMetaData class
Member variables
agentVersion
searchableNodes
searchPatternDesc
supportedContent
Methods
AgentMetaData()
toXml()
AgentProperty class
Property-type constants
Member variables
allDefaultValues
allDependencies
allValidValues
allValues
cardinality
description
isHidden
isMultiple
isReadOnly
isRequired
propName
type
Methods
AgentProperty()
copy()
BusObjAttr class
Attribute constants
Methods
BusObjAttr()
getAppText()
getAttrType()
getAttrTypeName()
getBOVersion()
getCardinality()
getComments()
getDefault()
getMaxLength()
getName()
getRelationType()
isForeignKey()
isKey()
isRequiredKey()
isRequiredServerBound()
isSimpleType()
setAppText()
setAttrType()
setBOVersion()
setCardinality()
setComments()
setDefault()
setIsForeignKey()
setIsKey()
setIsRequiredKey()
setMaxLength()
setName()
setRelationType()
BusObjAttrType interface
Attribute-type constants
Static member variable
BusObjDef class
BusObjDef()
addDefaultVerbs()
getAppInfo()
getAttrCount()
getAttribute()
getAttributeIndex()
getAttributeList()
getName()
getVerb()
getVerbCount()
getVerbList()
getVersion()
insertAttribute()
insertVerb()
removeAttribute()
removeVerb()
setAppInfo()
setAttributeList()
setVerbList()
BusObjVerb class
BusObjVerb()
clone()
getAppInfo()
getName()
setAppInfo()
setName()
CompleteCondition class
Operator constants
Member variables
allDependentConditions
allInputConditions
Methods
CompleteCondition()
copy()
ContentMetaData class
Member variables
contentType
count
length
Methods
ContentMetaData()
badContent()
contentNotReady()
contentUnavailable()
ContentType class
Member variables
BinaryFile
BusinessObject
Methods
ContentType()
equals()
from_int()
toString()
value()
xmlObject()
DependentCondition class
Member variables
isDynamic
operatorType
propertyName
specificValue
typeOfSpecificValue
Methods
DependentCondition()
copy()
IGeneratesBinFiles interface
generateBinFiles()
getBinFile()
getContentProtocol()
IGeneratesBoDefs interface
generateBoDefs()
getBoDefs()
getContentProtocol()
getTreeNodes()
InputCondition class
Member variables
isDynamic
operatorType
specificValue
typeOfSpecificValue
Methods
InputCondition()
copy()
ODKAgentBase2 class
getAgentProperties()
getMetaData()
getVersion()
init()
terminate()
Deprecated Methods
ODKConstant interface
String-value constants
User-response-dialog constants
Cardinality constants
Trace-level constants
Message-type constants
Node-nature constants
Content-protocol constants
Content-index constant
ODKException class
Methods
ODKException()
getMsg()
Exception subclasses
ODKUtility class
contentComplete()
getAgentProperty()
getAllAgentProperties()
getAllBOSpecificProperties()
getBOSpecificProperty()
getBOSpecificProps()
getClientFile()
getMsg()
getODKUtility()
sendMsg()
sendStatusMsg()
trace()
Deprecated Methods
TreeNode class
Member variables
description
isExpandable
isGeneratable
name
nodes
polymorphicNature
Method
TreeNode()
Appendixes
Index
