Application-specific information, WebSphere Adapter for JD Edwards EnterpriseOne

IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > JD Edwards EnterpriseOne > Reference > Business object information
Application-specific information

Application-specific information (ASI) is metadata that specifies adapter-dependent information about how to process business objects for the adapter for JD Edwards EnterpriseOne.

When the external service wizard generates a business object, it automatically generates a business object definition, which is saved as an XSD (XML Schema Definition) file. The business object definition contains the application-specific information for that business object. If you want to change the generated ASI, you can modify the metadata values either from the Properties tab in the Business Integration perspective of IBM Integration Designer or by using the business object editor.
The adapter for JD Edwards EnterpriseOne uses application-specific information (ASI) to create queries for Create, Retrieve, Update, and Delete operations. ASI is generated by the external service wizard at three levels: the business-object level, the property level, and the operation level.

Application-specific information at the business-object-level

Application-specific information (ASI) at the business-object level is typically used to specify the name of the corresponding database table and to provide information necessary to perform a physical or logical delete operation. The following table describes the ASI at the business-object level.

Application-specific information at the business-object level
Application-specific information Description
Name Name of operation
BSFN List of business functions associated with the operation
AlwaysReturnResponse
Used to designate if the adapter returns a response business object for every request.
If the value is set to true, the adapter always returns a response business object.
If the value is set to false, an exception is generated after a JDE business function is executed. This exception is generated against the user's component.
The default value is false.

If : For runtime exceptions, for example, if the adapter cannot establish a connection with the JD Edwards EnterpriseOne server, the exception is still generated against the user's component.

Application-specific information at the property level

Application-specific information (ASI) at the property level is typically used to specify the metadata for a property. ASI at the property level represents either child objects or an array of child objects. The following table describes the ASI of a complex property (a child) or a structure or table property (an array of child objects).
Application-specific information at the property level
Application-specific information Description Possible values
Name The business function parameter name as represented in JD Edwards EnterpriseOne BSFNName
Type The type of the business function parameter as it exists in JD Edwards EnterpriseOne BSFN
IOType The type of the business function parameter as it exists in JD Edwards EnterpriseOne

IN: the parameter is mapped from the business object to the business function.
OUT: the parameter is mapped from the business function to the business object.
INOUT: the parameter is mapped both ways.
DEFAULT: the parameter is mapped using the default JD Edwards EnterpriseOne value. For adapter purposes, it is processed as INOUT.

RequiredType Identifies if the parameter is required

YES: the parameter is required.
NO: the parameter is not required.
DEFAULT: the parameter is using the JD Edwards EnterpriseOne value. For adapter purposes, it is processed as NO.

Length The maximum possible length for the parameter value None
Reference
The xpath of the business object property used to obtain the value of this attribute. The xpath expression starts at the business function level
BusinessFunctionContainer
	BusinessFunction1
		Prop1
	BusinessFunction2
		Prop2
If BusinessFunction2/Prop2 property needs to be set with the value of BusinessFunction1/Prop1, the value of Reference for BusinessFunction2/Prop2 needs to be set to BusinessFunction1/Prop1.
Application-specific information at the operation level

Application-specific information (ASI) at the operation level is used by the adapter to perform operations, such as to retrieve or update information in the JD Edwards EnterpriseOne server. The following table describes the ASI at the operation level.

Application-specific information at the operation level
Application-specific information Description Value
Name The name of the business object operation

Create
Retrieve
Update
Delete
RetrieveAll

BSFN.Name The name of the business functions to process

Name
RollbackOnWarnings

BSFN.RollbackOnWarnings Indicates if the adapter needs to rollback the current transaction when the business function returns with warnings False (default setting)
RunOnError
Used to designate if the adapter should continue to process the sequential JDE business functions when a business function encounters an error while executing the business function.
If the value is set to Yes, the adapter will continue to process the subsequent business functions, even if the business function fails. The error message is stored to the attribute, BSFNExecutionErrors.
If the value is set to false, the adapter will stop the execution process and a rollback operation is performed.

If : If the ASI RunOnError is set to True for all business functions, the rollback operation is not performed. An error message for each business function that has failed is stored in the attribute BSFNExecutionErrors, against each business function in the response business object.
False (default setting)

Business object information

Related concepts:

Business objects

Related tasks:

Generate business functions using external service discovery
Generate XML Lists using external service discovery

Related reference:

Supported operations
Naming conventions

Application-specific information	Description
Name	Name of operation
BSFN	List of business functions associated with the operation
AlwaysReturnResponse	Used to designate if the adapter returns a response business object for every request. If the value is set to true, the adapter always returns a response business object. If the value is set to false, an exception is generated after a JDE business function is executed. This exception is generated against the user's component. The default value is false. If : For runtime exceptions, for example, if the adapter cannot establish a connection with the JD Edwards EnterpriseOne server, the exception is still generated against the user's component.

Application-specific information	Description	Possible values
Name	The business function parameter name as represented in JD Edwards EnterpriseOne	BSFNName
Type	The type of the business function parameter as it exists in JD Edwards EnterpriseOne	BSFN
IOType	The type of the business function parameter as it exists in JD Edwards EnterpriseOne	IN: the parameter is mapped from the business object to the business function. OUT: the parameter is mapped from the business function to the business object. INOUT: the parameter is mapped both ways. DEFAULT: the parameter is mapped using the default JD Edwards EnterpriseOne value. For adapter purposes, it is processed as INOUT.
RequiredType	Identifies if the parameter is required	YES: the parameter is required. NO: the parameter is not required. DEFAULT: the parameter is using the JD Edwards EnterpriseOne value. For adapter purposes, it is processed as NO.
Length	The maximum possible length for the parameter value	None
Reference	The xpath of the business object property used to obtain the value of this attribute. The xpath expression starts at the business function level	BusinessFunctionContainer BusinessFunction1 Prop1 BusinessFunction2 Prop2 If BusinessFunction2/Prop2 property needs to be set with the value of BusinessFunction1/Prop1, the value of Reference for BusinessFunction2/Prop2 needs to be set to BusinessFunction1/Prop1.

Application-specific information	Description	Value
Name	The name of the business object operation	Create Retrieve Update Delete RetrieveAll
BSFN.Name	The name of the business functions to process	Name RollbackOnWarnings
BSFN.RollbackOnWarnings	Indicates if the adapter needs to rollback the current transaction when the business function returns with warnings	False (default setting)
RunOnError	Used to designate if the adapter should continue to process the sequential JDE business functions when a business function encounters an error while executing the business function. If the value is set to Yes, the adapter will continue to process the subsequent business functions, even if the business function fails. The error message is stored to the attribute, BSFNExecutionErrors. If the value is set to false, the adapter will stop the execution process and a rollback operation is performed. If : If the ASI RunOnError is set to True for all business functions, the rollback operation is not performed. An error message for each business function that has failed is stored in the attribute BSFNExecutionErrors, against each business function in the response business object.	False (default setting)