Contents of the generated definition

The business object definition that PeopleSoftODA generates contains:

This section describes:

Business-object-level properties

PeopleSoftODA generates the following information at the business-object level:

At the business-object level, application-specific information format consists of four parameters separated by a colon (:) delimiter. The format is:

cIName=ComponentInterface:EFFDT=[true|false]:setInteractiveMode=[true|false]:GetHistoryItems=[true|false]
 

Table 18 describes these parameters.

Table 18. AppSpecificInfo at the business-object level
AppSpecificInfo Parameter Description
ComponentInterface Specifies the name of the Component Interface defined in the PeopleSoft application
setInteractiveMode Determines when the connector sends changes to the Application Server
GetHistoryItems Determines how much data the connector retrieves
EFFDT Specifies whether the business object (or child business object) uses an Effective Date
EFFDTSEQ When EFFDTSQ=true the effective dated rows are inserted based upon the date as well as the sequence number. This is only true when the effective date attribute is included in the business object definition. If the effective date sequence attribute is not set in the business object, only the effective date is used.

Important:
PeopleSoftODA uses the name of the Component Interface from which it has generated the definition to specify a value for the ComponentInterface property. It does not provide values for the other properties. You must modify the business object definition to provide values for the remaining properties. For information on these properties, see "Application-specific information at the business object level". For information on modifying a business object definition, see the Business Object Development Guide.

Attribute properties

This section describes the properties that PeopleSoftODA generates for each attribute. For more information about the attributes, see "Business object attribute properties".

Name property

PeopleSoftODA derives the attribute's name from a property in the corresponding Component Interface.

Data type property

When setting the type of an attribute, PeopleSoftODA converts the data type of a property into a corresponding business object data type as shown in Table 19:

Table 19. Correspondence of data types
PeopleSoft Business object Length
String

String

Length specified in the data type

Boolean

Boolean


Collection

Object


Float

Float


Number

Integer


Note:
If a property's data type is not one of those shown in Table 19, PeopleSoftODA skips the property and displays a message stating that the property cannot be processed.

Cardinality property

PeopleSoftODA sets the cardinality of all simple attributes to 1. It sets the cardinality of all attributes that represent an array of child business objects to n.

MaxLength property

PeopleSoftODA provides the default length of 255 characters for strings; for all other data types, it uses the standard maximum length for the corresponding business object data type.

IsKey property

If a property is a CreateKey in a Component Interface, PeopleSoftODA sets this property to true. If a property is a GetKey in a Component Interface, PeopleSoftODA sets this property to false, and sets the attribute's AppSpecificInfo parameter to GetKey=true.

IsForeignKey property

PeopleSoftODA sets this property to false. You can change the setting in Business Object Designer.

IsRequired property

Because PeopleSoftODA generates some keys internally, it always sets this property to false. You can change the setting in Business Object Designer.

AppSpecificInfo property

Attribute application-specific information is a set of five name-value parameters that are separated from one another by a colon (:) delimiter. A vertical bar (|) separates the members of a set of options. The format is:

get=getFieldName:set=setFieldName:UID=[true|false]:GetKey=[true|false]:KeepRelationship=[true|false]
 

PeopleSoftODA generates only those properties that are relevant to an attribute, as described in Table 20. If it generates more than one parameter, it separates parameters with a colon.

Table 20. Attribute AppSpecificInfo generated by PeopleSoftODA
AppSpecificInfo parameter Description
GetKey=true PeopleSoftODA generates this parameter only for attributes that correspond to a Component Interface property defined as a GetKey. The connector uses the value of such an attribute to retrieve Component Interface instances.
get=getPropertyName For PropertyName, PeopleSoftODA substitutes the name of the Component Interface property associated with the attribute. It generates this parameter for every simple attribute that corresponds to a Component Interface property. The connector uses this method to retrieve values for the attribute.
get=getCollectionName For CollectionName, PeopleSoftODA substitutes the name of the Component Interface Collection associated with the attribute. It generates this parameter for every attribute that represents an array of child business objects corresponding to a Component Interface Collection. The connector uses this method to retrieve the Collection.
set=setPropertyName For PropertyName, PeopleSoftODA substitutes the name of the Component Interface property associated with the attribute. It generates this parameter for every simple attribute that corresponds to a Component Interface property. The connector uses the method to update values for the attribute.

Note:
You can set additional AppSpecificInfo parameters in Business Object Designer. For information about these parameters, see "Application-specific information at the attribute level". For more information on modifying definitions, see the Business Object Development Guide. For an example of using the parameters described in Table 20, see "Sample business object definition file".

Verbs

Note:
PeopleSoftODA generates the verbs specified in the BO Properties window (as illustrated in Figure 16).

Copyright IBM Corp. 1997, 2003