Business Object Method Arguments (ttadv7113m000)

Use this session to define the arguments that are required for the methods of a business object.

Each method requires arguments. Per method, you can generate a list of all possible arguments. If the method for which you generate arguments is a Specific method, you can modify the argument properties. If the method is a Standard method, you cannot modify the properties of the arguments, but only delete the generated arguments you do not require.

Note

This session is used for the arguments of both public methods and protected methods:

  • For protected methods, the arguments are protected attributes of the business object, that are displayed in the session directly. For example: businessPartnerCode, address and affiliatedSite.
  • For public methods, the arguments displayed are always the standard arguments Request, Response, and Result. The attributes, which are the actual arguments, are specified in the XML Schema file that is the content of the Response argument.
XML Schema Files

If you generate a public method or save a public method you created manually, XML Schema Files are generated for the arguments (Request, Response and Result) of that method. These files actually store the arguments. Through the Generate XML Schema command in the appropriate menu, you can fill these empty XML Schema files with the business object's public attributes . After generation, you must edit these files manually, because not everything can be generated automatically.

An empty XML Schema file has the following structure:

<xs:element name="Request">
  <xs:complexType/>
</xs:element>

Refer to the following Help topic for more information: To edit XML Schema Files (BOR).

Prerequisites

The following entities must already exist:

  • A business object method.
  • Attributes for the business object or the component.

 

Business Object

The name of the business object.

Business Object Code

The code of the business object, which consists of the package code, the module code, and the business object code that is defined in the Business Object field of the Business Objects (ttadv7500m000) session.

Business Object

The description of the business object.

VRC

The version of the package for which the business object is defined.

VRC

The release of the package for which the business object is defined.

VRC

The customer of the package for which the business object is defined.

VRC

The description of the VRC.

Component

The name of the component to which the method belongs.

Method

The name of the method.

Note

You can only modify argument properties for Specific methods. For Standard methods you can only delete the generated arguments that you do not require. Whether a method is a standard method or a specific method, is defined in the Protected Methods (ttadv7112m100) session for protected methods, and in the Public Methods (ttadv7112m000) session for public methods.

Argument

The argument of the method.

Note

For protected methods, the arguments, are protected attributes of the business object, that are displayed in the session directly. For example: businessPartnerCode, address and affiliatedSite.

For public methods, the arguments displayed are always the standard arguments Request, Response, and Result. The attributes, which are the actual arguments, are specified in the XML Schema file that is the content of the Response argument.

Input/Output

Indicates whether the argument is used for input or output.

Note
  • Attributes that are defined as Read-only or Identifier in the Protected Attributes (ttadv7104m000) session are not allowed as input arguments.

  • Input and output are here related to the operation of the argument. An argument accepts input or delivers output. Therefore, input and output do not indicate the function of the argument in the method, which is quite the reverse. An argument that delivers output, can be input for the method, and an argument that accepts input can be used for the output of the method.

    Some examples, based on the protected methods of the Address business object:

    • The Create method and the Change method use all protected attributes as input arguments.
    • The Delete method uses the addressCode attribute as input argument, and has no other arguments.
    • The Read method uses the addressCode attribute as input argument. The remaining protected attributes are used as output arguments.
Mandatory Input

If this check box is selected, the client is obliged to deliver input for this argument.

Argument XML Tree

This check box indicates whether an XML Schema file exists for the argument.

This field is only displayed if the argument belongs to a public method.

XML Schema File

The package code of the XMLSchema file.

This field is only displayed if the argument belongs to a public method.

XML Schema File

The module code of the XMLSchema file.

This field is only displayed if the argument belongs to a public method.

XML Schema File

The name of the XML Schema file.

This field is only displayed if the argument belongs to a public method.

XML Schema File

The description of the XML Schema File.

This field is only displayed if the argument belongs to a public method.

 

Additional Files

Click to zoom to the Additional Files (ttadv2570m000) session, where you can view and maintain the XML schema files of all arguments of all public methods of all business objects.

Edit / View XML Schema File...

Click to edit or view the XML Schema file that is linked to the selected argument. The file will be opened with the application that is used on your system to open files with a .xsd extension.

Generate Arguments ...

Click to generate a list of all possible input/output arguments for a protected method. The generated arguments are based on the protected attributes of the business object or component. This function is especially useful for the standard protected methods Create, Change, and Read.

Note

  • This command is only available for protected methods.
  • When you start this function, you must specify whether you want to generate input arguments or output arguments. For more information, refer to the help on the Input/Output field.
  • You must also specify how existing arguments must be handled. The following options exist:
    • Delete all before generating: all arguments are deleted before new ones are generated.
    • Do not change existing arguments: only new arguments are generated.
    • Update/generate all arguments all existing arguments are deleted, and all arguments are generated anew.
    • Update only existing arguments: all existing arguments are regenerated. No new arguments are generated.
Generate XML Schema

Click to generate an XML Schema file for the selected argument.

Note

  • This command is only available for public methods.
  • By default, when you generate a method or save a method you created manually, XML Schema Files are generated for the arguments of that method. These files actually store the arguments, but they must yet be filled by the current function.
  • If an XML Schema file that is not empty already exists, you are prompted whether you want to proceed.
  • An empty XML Schema file has only the following content:
<xs:element name="Request">
  <xs:complexType/>
</xs:element>

Note

  • It is required to edit the generated XML Schema file manually, because not everything can be generated automatically. Refer to the following Help topic for more information: To edit XML Schema Files (BOR).