SAP ABAP IMG Activity /IPRO/OUTPUT (Generic Output Interface)
Hierarchy
☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-GTF-DOB (Application Component) Document Builder
     ⤷ /IPRO/PROGS (Package) programs
IMG Activity
ID /IPRO/OUTPUT Generic Output Interface  
Transaction Code /IPRO/67000022   (empty) 
Created on 20040603    
Customizing Attributes /IPRO/OUTPUT   Generic Output Interface 
Customizing Activity /IPRO/OUTPUT   Output interface 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name /IPRO/OUTPUT    

Use

Implement this Business Add-In to generate output based on the output type. In general, output is always generated from data contained in the current SAP Document Builder document. Output types are defined in the corresponding table (/IPRO/TOUTDEF).

You maintain output types in the IMG under Basic Functions > Define Output Definition. This table is the filter table for this Business Add-In.

To implement this Business Add-In, implement the interface /IPRO/IF_EX_OUTPUT, which consists of the method described below:

GENERATE

  • FLT_VAL
    Filter value.
  • PIR_DOCUMENT
    Reference to /IF_DOCUMENT object that contains response data.

The following export parameters must be provided by your coding:

  • PRS_OUTPUT
    This is a structure of type /IPRO/S_OUTPUT. This structure contains the text format, the text encoding, the raw string that contains the actual text of the generated responses report and the text mime type of the text.

Requirements

To create output, the BAdI implementation must be supplied with a reference to a valid SAP Document Builder document.

Standard settings

Call the GENERATE method - passing in a valid reference to the current SAP Document Builder document.

Recommendation

Before starting on the implementation process, do the following:

  • Decide what type of output (HTML, XML, etc.) you need and how/where it will be displayed or otherwise processed.
  • Make sure the output type has an associated filter value in the /IPRO/TOUTDEF table - see the Maintain Output Definition step in the IMG.
  • Check the responses report (/IPRO/RESP_REP) and the reviewer's checklist report (/IPRO/REV_CHECK) implementations of the /IPRO/OUTPUT Badi as examples to follow in building the new implementation.

Activities

After calling up the IMG activity, a dialog box appears, in which you can enter a name for the implementation.

If you have already made other implementations for this BAdI, another dialog box appears, in which the existing implementations are displayed. In this case, choose Create, and proceed as follows:

1. In the dialog box, enter a name for the BAdI implementation in the Implementation field, and choose Create.

The screen for creating BAdI implementations is now displayed.

2. Enter a short text for the implementation in the Short text for implementation field.

3. From the tab index, choose Interface.

The Name of implemented class field is already filled on the tab page, as a class name was automatically assigned to the implementation when you named it.

4. Save your entries, and assign the implementation to a development class.

5. Place the cursor on the method, and double-click to enter method processing.

6. Enter the coding for the implementation between the statements method <Interface name> ~ <Name of method> and endmethod.

7. Save and implement your coding. Return to the Edit Implementation screen.

8. Save the entries on the Edit Implementation screen.

Note: You can also create an implementation, and then activate it at a later time. In such a case, end the processing stage at this point.

9. Choose Activate.

The coding you stored in the methods will be run when the application program is executed.

Example

An example of an implementation of this Business Add-In is the responses report. The implementation of this BAdI is in /IPRO/RESP_REP. The implementing class is /IPRO/CL_IM_RESP_REP. This implementation of the /IPRO/OUTPUT BAdI accesses response data in the current SAP Document Builder document and prepares an HTML report. The associated output type for the responses report output is type 1 - this is also the filter value (defined in the /IPRO/TOUTDEF table) used to access this implementation.

Additional Hints

For more information on using Business Add-Ins, see the SAP Library under Basis Components -> ABAP Workbench (BC-DWB) -> Changing the SAP Standard (BC) -> Business Add-Ins.

Business Attributes
ASAP Roadmap ID 257   Create User Exits 
Mandatory / Optional 2   Optional activity 
Critical / Non-Critical 2   Non-critical 
Country-Dependency A   Valid for all countries 
Assigned Application Components
Documentation Object Class Documentation Object Name Current line number Application Component Application Component Name
SIMG /IPRO/OUTPUT 0 HLB0009110 Cross-Application Components 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20040727 
SAP Release Created in 100