WebSphere Message Brokers
File: cpeo_appspecific_ok
Writer: Karen Cameron

Concept topic

This build: July 31, 2007 21:40:21

Application-specific information

Business objects can contain business data or meta data that is specific to PeopleSoft Enterprise applications. Application-specific information included in a business object is used to determine the way the adapter processes a business object.

The following table describes application-specific parameters and their usage.

Parameter Usage
ObjectName This is the name of the corresponding object in the PeopleSoft application; in other words, the component interface name as defined in PeopleTools. Set this only for the top-level business object.
InsAtOldestEffDtPos When this is set to true and an incorrect index (negative number) is returned by the PeopleTools API, getEffectiveItemNum(), the adapter inserts the row at the highest index, which has the oldest effective date. If you set this parameter, do not set InsAtCurrentEffDtPos.
InstAtCurrentEffDtPos When this is set to true and an incorrect index (negative number) is returned by the PeopleTools API, getEffectiveItemNum(), the adapter inserts the row at the highest index (zero), which has the current effective date. If you set this parameter, do not set InsAtOldestEffDtPos.
GetCurrentItem Set this parameter to true only for effective-dated components (when you want only current effective-dated items need to be retrieved.)
PeopleSoft component interfaces include collections and fields. A collection is essentially a group of more field and collection properties. For each field property, there are two getter and setter methods generated as part of the API. The method names are:
  • get<Property Name>()
  • set<Property Name>()
where <Property Name> is the name of the property. A collection class is generated for each collection property and a get<Collection Name> is also generated in the parent’s class. The following diagram describes the relationship.
So that a business object reflects the structure illustrated in the diagram, each attribute that corresponds to a field property on a component interface is considered a simple attribute. The following table shows the attribute application-specific parameters that you can set for each simple attribute.
Attribute application-specific parameter Description
Getter Getter method for that attribute.
Setter Setter method for that attribute.
PrimaryKey GetKey/CreateKey attribute in the component interface or a key in the child collection.
FindKey FindKey attribute in the component interface.
EffectiveDate EffectiveDate attribute in the component interface.
EffectiveSequence EffectiveSequence attribute in the component interface.
KeepRelations This is set to affect the processing of child objects when the adapter performs an update operation. If this parameter is enabled and the adapter finds a missing child object of a parent during the operation, the child object will not be deleted and the relationship between the objects is preserved.
UID This is used to determine whether the adapter will set values for key attributes within the business object or not. When this is set as true, the adapter does not set values for these keys but allows PeopleCode to automatically generate values for the keys.
DateFormat Used to specify the valid format for date and datetime fields in PeopleSoft.
SoftDeleteValue Set the value for this parameter with the value that will be used to update the corresponding value in the component interface when a top-level delete operation occurs. For example, if the property 'status' has its SoftDeleteValue set to inactive in the business object, set this value so that the same property in the component interface will be similarly updated by a top-level delete operation.
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:40:21

cpeo_appspecific_ok This topic's URL is: