SAP ABAP IMG Activity /IPRO/RUN_RULE (Run Rules)
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/RUN_RULE Run Rules  
Transaction Code /IPRO/67000059   (empty) 
Created on 20050204    
Customizing Attributes /IPRO/RUN_RULE   Rule Rules 
Customizing Activity /IPRO/RUN_RULE   Run rules 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name /IPRO/RUN_RULE    

Use

Implement this Business Add-In to determine whether a rule linked to an element should run depending on the element's inclusion status.

The Business Add-In consists of the method described below, which can be used to determine whether a rule linked to an element will run based on the element's inclusion status and the document attributes.

RUN_RULE

The following import parameters are provided:

  • IO_DOCUMENT
    Reference to the interface /IPRO/IF_DOCUMENT, which contains methods that enable you to retrieve all elements, variables and attributes of a document instance. The LOOKUP method of this interface enables you to find document attributes such as CONTENT and DOCUMENT SELECTION.
  • IS_ELMNT_ID
    Standard Element ID
  • IV_STATUS
    Inclusion status of the element. All possible values for this field are listed below:
    • 'OR'
      Optionally included via rule
    • 'OC'
      Optionally included via configuration
    • 'MR'
      Mandatory inclusion via rule
    • 'MC'
      Mandatory inclusion via configuration
      'RE' -
      Excluded by rule
    • 'US'
      Evaluate rule to determine inclusion status
    • 'RR'
      Recommended inclusion via rule
    • 'UI'
      User included
    • 'UE'
      User excluded

The return parameter RV_RUN_RULE is provided: Boolean value used to determine whether the rule for the given element should run.

Standard settings

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

Additional Information

For more information, 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 3   Nonrequired 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/RUN_RULE 0 HLB0009110 Cross-Application Components 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20050209 
SAP Release Created in 200