Fonction SAP BAPI_CMS_CAG_CREATE - Create a Collateral agreement

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
ADMIN_DATA BAPICMS_STR_CAG_ORG_UNIT_CRT u 66 Organization unit data
AGREEMENT_ID_IN BAPICMS_STR_CAG_ID-CAGMTID C 40 X Collateral Agreement ID
AGREEMENT_TYPE_IN BAPICMS_STR_CAG_TYP-CAGMT_TYPE C 6 Collateral Agreement Type
ASSIGMENT_PLEDGE_DATA BAPICMS_STR_CAG_ASMT_PLD_CRT u 17 X Assignment - Pledge data
BASIC_DATA BAPICMS_STR_CAG_BASIC_CRT u 299 X Collateral agreement basic data
GENERATE_RECEIVABLE_LINKS BAPICMS_STR_FLG_GEN_AUTO_LINKS-GEN_AUTO_LINKS C 1 X Indicates that CAG_RBL links to be generated automatically
GUARANTEE_DATA BAPICMS_STR_CAG_GUAR_CRT u 76 X Guarantee data
LAND_CHARGE_DATA BAPICMS_STR_CAG_LCHG_CRT u 177 X Land charge data
OVERRIDE_DEFAULTS BAPICMS_STR_CAG_SPECIFIC_CRT u 1 X Override CAG default values with user-entered values
PROCESSEXTENSION BAPI_CMS_STR_CENTRAL-PROCESSEXTENSION C 1 X Indicator
TESTRUN BAPI_CMS_STR_CENTRAL-TESTRUN C 1 X CMS BAPI: Common Parameters
TRANSFER_DATA BAPICMS_STR_CAG_TRAN_CRT u 6 X Transfer data

Paramètre Reférence Type Long. Description
AGREEMENT_ID BAPICMS_STR_CAG_ID-CAGMTID C 40 Collateral Agreement ID
AGREEMENT_TYPE BAPICMS_STR_CAG_TYP-CAGMT_TYPE C 6 Collateral Agreement Type

Paramètre Reférence Long. Facultatif Description
BUSINESS_PARTNERS BAPICMS_STR_CAG_BP_CRT 54 X Business partners linked to Collateral agreement
CHARGES BAPICMS_STR_CAG_CHG_CRT 200 X Charges on Collateral agreement
COSTS BAPICMS_STR_CAG_EXP_CRT 40 X Expenditure incurred on collateral agreements
DOCUMENTS BAPICMS_STR_CAG_DOC_CRT 100 X Documents linked to collateral agreement
EXTENSIONIN BAPIPAREX 990 X Ref. structure for BAPI parameter ExtensionIn/ExtensionOut
EXTENSIONOUT BAPIPAREX 990 X Ref. structure for BAPI parameter ExtensionIn/ExtensionOut
NOTES BAPICMS_STR_CAG_NOTES_CRT 162 X Collateral agreement notes
PARTNER_TERMINATION_DATA BAPICMS_STR_CAG_BP_TRM_CRT 92 X BuPa termination details
PORTIONS BAPICMS_STR_CAG_POR_CRT 114 X Collateral agreement portions
PORTION_BUSINESS_PARTNERS BAPICMS_STR_CAG_POR_BP_CRT 50 X Business partners linked to Agreement-Portions
RECEIVABLE_LINKS BAPICMS_STR_CAG_RBL_CRT 146 X Collateral agreement receivable links
RELATIONS_FROM BAPICMS_STR_CAG_REL_POR_CRT 80 X Relationship: Contributions From Agreement Portions
RELATIONS_TO BAPICMS_STR_CAG_POR_REL_CRT 80 X Relationship: Contributions of Portions to Agreements
RETURN BAPIRET2 548 X Return Parameter
RULES BAPICMS_STR_CAG_RULES_CRT 158 X Rules associated to Collateral agreement
SPECIAL_ARRANGEMENTS BAPICMS_STR_CAG_SA_CRT 214 X Special arrangements on collateral agreements
SYSTEM_STATUS BAPICMS_STR_CAG_SYS_STAT_CRT 5 X System status
USER_STATUS BAPICMS_STR_USR_STAT 5 X User status

Functionality
Use this method to create a collateral agreement for all collateralagreement types.
You can use the import parameters to provide information for thecollateral agreement. You use tables to enter your data for thecollateral agreement including data for the specific business of thecollateral agreement categories, business partners, documents, notes andcalculated values.
This method returns :

  • Semantic key of the collateral agreement (ID) and the collateral
  • agreement type
    • A table of return codes
    • Description
      This parameter passes the unique semantic identifier assigned to thenewly created collateral agreement.

      Description
      This parameter passes the collateral agreement type for which the newcollateral agreement is created.

      Description
      This parameter must be implemented to create a new collateral agreement.You must aleast pass the values for administration organizational unitand bank area to create a new collateral agreement.

      Description
      This parameter implements the key field of the collateral agreement.
      See the documentation for the key field for more information about thisparameter.

      Default
      You can define the default settings for collateral agreementidentifications in the Customizing for Number Ranges in the IMG underCollateral Management -> Collateral Agreement -> Maintain NumberRanges.

      Description
      This parameter is mandatory to create a new collateral agreement.
      You can define collateral agreement types and other essential attributes(including certain default values) in the IMG activityDefine Collateral Agreement Types.

      Description
      Implement this parameter to create a collateral agreement of categoryAssignment - Pledge. The following values are set as defaultsand can be changed :

      • Agreement disclosed - No

      • Additional receivable - No

      • Note : At any time, you can only maintain collateral agreement ofone collateral agreement category. For example, if you are maintainingthe data for a Guarantee, then you cannot maintain the data for aLand Charge or a Transfer.

        Description
        The parameter controls the scope of data to be read for the basicdetails of a collateral agreement. The following fields are mandatory:

        • Nominal value and assessment amount

        • Guarantee rate (for a guarantee)

        • Flag Global

        • Collateral agreement validity dates

        • Collateral agreement date (signing date) is entered

        • Note : The system also performs plausibility checks to validatethe data entered for the collateral agreement.

          Description
          Check this flag to allow automatic generation of the collateralagreement - receivable assignments based on the rules. However, if thisflag is not checked, then the collateral agreement - receivableassignments are created using the details maintained for the assignment.

          Default
          Automatic collateral agreement - receivable assignments can be generatedif the flag Global is checked. You can check this flag in the IMGactivity Define Collateral Agreement Typesor in the individual collateral agreement.
          For detailed information on the Flag Global , see the relevantdata element documentation in the ABAP Dictionary.

          Description
          Implement this parameter to create a collateral agreement of categoryGuarantee. The following restrictions exist on guarantees :

          • You can set the indicator for either Fixed liability or Default
          • liability and not for both.
            • If you set the indicator for Default liability, then you must enter
            • percentage value for the default liability.
              • Lending rate of a guarante is mandatory.

              • Note : You can maintian collateral agreements of one collateralagreement category at one time. For example, if you are maintaining theGuarantee data, then you cannot maintain the Land Charge data
                , Transfer data or Assignment - Pledge data.

                Description
                Implement this parameter to create a new collateral agreement ofcategory Real Estate Lien. The following values are set asdefaults :
                Collective land charge - No
                Charge Certifiate - Does not exist
                Enforcement type - None
                Enforcement title - Not Relevant
                Note : You can maintian collateral agreements of one collateralagreement category at one time. For example, if you are maintaining theGuarantee data, then you cannot maintain the data for LandCharge or a Transfer.

                Description
                This parameter allows you to ignore the default settings maintained inthe Customizing of collateral agreement types. If you check this flag,you can ignore the default settings for the field Global anddetermine your own settings.
                For more information, see the relevant data element documentation forthe field Global .

                Description
                Use this parameter to specify specify whether the details specified bythe Customers in a Business Add-In of this method, must be retrieved.
                You will find information on the meaning of the parameter in thedocumentation for the data element Execute Extension(s)(BAdI).

                Value range
                X = Yes: In general the planned customer extensions should be executed.

                Description
                If this parameter is set, the method will only be executed in the testrun. All checks are then carried out, without an entry being made in thedatabase.
                This is used for write BAPIs to check the entries for the objectinstance in the database before actually creating the instance. Theobject instance is not actually created, merely simulated, and the datais not written to the database (updated).

                Value range
                ' ' (no value)
                No value means that the database is updated. This is the default settingand corresponds to the expectations of the calling program.
                'X'
                This value means that the BAPI is called in simulation mode and that nodata is written to the database.

                Description
                Implement this parameter to create a collateral agreement of categoryTransfer. The following values are set as default :

                • CMS_DTE_FLG_CAG_LEASING_TN - Is not part of a leasing transaction

                • CMS_DTE_FLG_CAG_AR_FRM_SLE - Not assigned

                • Note : At any time, you can only maintain collateral agreement ofone collateral agreement category. For example, if you are maintainingdata for a Guarantee, then you cannot maintain the data for aLand Charge or a Transfer.

                  Description
                  This table contains the values for the business partners assigned to thecollateral agreements. The mandatory values are the business partneridentification and the business partner function.
                  The business partner details are transfered only if you have checked theflag FLAG_BUPA while determing the scope of the import parameters.

                  Description
                  This parameter contains the values for the charges that are maintainedbetween the assets anda collateral agreements. The following values aremandatory :

                  • Sequence and ranking order

                  • Asset part amount or percentage

                  • Note : For Real estate lien, the Register number isthe sequence number of the charge maintained in the land register.
                    The details of the charges are transfered only if you have checked theflag FLAG_CHARGES while determining the scope of the import parameters.

                    Description
                    This table contains the cost values maintained for the collateralagreements. If costs are entered, then cost type is mandatory.

                    Description
                    This paramter contains the details of the document attached to thecollateral agreements. The document reference identification and thedocument type are mandatory values.
                    The details of the documents are transfered only if you have checked theflag FLAG_DOCUMENT while determining the scope of the import parameters.

                    Description
                    You can use this parameter to transfer user-specific enhancments to aBAPI. The customer has to complete the EXTENSION structure and thesystem automatically continues processing it. If you have not definedany user-specific fields, then you can transfer a blank EXTENSIONINstructure.

                    Default

                    Further information
                    You can find more information in the BAPI programming guide in thechapter for enhancements to BAPIs.

                    Description
                    You can use this parameter to transfer user-specific enhancments to aBAPI. The customer has to complete the EXTENSION structure and thesystem automatically continues processing it. If you have not definedany user-specific fields, then you can transfer a blank EXTENSIONINstructure.

                    Default

                    Further information
                    You can find more information in the BAPI programming guide in thechapter for enhancements to BAPIs.

                    Description
                    This table contains the details of the notes created for the collateralagreements. These details are transfered only if you have checked theflag FLAG_NOTES while determining the scope for the import parameters.

                    Description
                    This parameter contains the termination details that are maintained forthe business partners assigned to the collateral agreements.
                    The termination details are transfered only if you have checked the flagFLAG_PARTNER_TERMINATION while determining the scope for the importparameters.

                    Description
                    This parameter contains the transfered details of the collateralagreement portions. The following values are mandatory :

                    • Collateral agreement portion validity dates

                    • Portion amount or percentage

                    • Note : The collateral agreement portion value percentage is setto 100%. You must delete this value to enter the collateral agreementportion amount.
                      The following internal checks are made on the input data :
                      • Collateral agreement portion amount cannot be greater than the
                      • collateral agreement amount
                        • Collateral agreement portion percentage cannot be greater than 100%

                        • The details of the collateral agreement portions are transfered only ifyou have checked the flag FLAG_PORTIONS while determining the scope ofthe import parameters.

                          Description
                          This parameter contains the values for the business partners assignedto the collateral agreement portions. The business partneridentification and the partner function are the mandatory values.
                          The business partner details are transfered only if you have checked theflag FLAG_BUPA while determining the scope of the import parameters.

                          Description
                          This parameter contains the values that are transfered for thecollateral agreement - receivable assignments. The following values aremandatory :

                          • Receivable identifications (the receivable semantic key is a combination
                          • of the receivable identification number and credit systemidentification)
                            • Name of the credit system

                            • Priority and ranking class

                            • Receivable amount or percentage

                            • Receivable component type (the default is set to component type
                            • Principal )
                              • Receivable reference percentage or amount if assigning middle portions
                              • of a receivable
                                • Collateral agreement validity dates

                                • The details of the collateral agreement - receivable assignments aretransfered only if you have checked the flag FLAG_AGREEMENT_RECEIVABLEwhile determining the scope of the import parameters.

                                  Description
                                  This parameter contains the values for the backed-up relationshipsdefined for the collateral agreements.
                                  These relationship details are transfered only if you have checked theflag FLAG_AGREEMENT_RELATIONS while determining the scope of the importparameters.

                                  Description
                                  This parameter contains the values for the back-up and collateral poolagreement relationships defined from the collateral agreements.
                                  The details of the relationships are transfered only if you have checkedthe flag FLAG_AGREEMENT_RELATIONS while determining the scope of theimport parameters.

                                  Description
                                  This table contains the return messages (including the error messagesfor plausibility checks ) from the method call.

                                  Description
                                  This parameter contains the details of the rules that are transfered.These rules are used to determine the automatic assignments toreceivables.
                                  The details of the rules are transfered only if you have checked theflag FLAG_RULES while determining the scope of the import parameters.

                                  Description
                                  This parameter contains the values for special arrangements created onthe collateral agreements. The following values are mandatory :

                                  • Special arrangement type and ID

                                  • Special arrangement validity dates

                                  • Nominal value and assessment amount (along with currency)

                                  • Bank key

                                  • Note : You must define the Customizing settings for specialarrangement types and special arrangement sets in the ImplementationGuide. For further information, see the relevant data elementdocumentation.
                                    The details of the special arrangements are transfered only if you havechecked the flag FLAG_SPECIAL_ARRANGEMENTS while determining the scopeof the import parameters.

                                    Description
                                    This parameter contains the details of the internal status of thecollateral agreement. These are:

                                    • Collateral agreement GUID (internal technical key)

                                    • System status

                                    • Name of the system status

                                    • The details of the system status are transfered only if you have checkedthe flag FLAG_SYSTEM_STATUS when determining the scope of the importparameters.

                                      Value range
                                      The following system statuses are possible for collateral agreements :

                                      • Created

                                      • Active

                                      • Inactive

                                      • Legally active

                                      • Calculation relevant

                                      • Note : Only the following combinations of system statuses areallowed:
                                        Created + Calculation relevant
                                        Active + Calculation relevant
                                        Inactive + Calculation relevant
                                        Legally active + Calculation relevant
                                        If you want to set the system status to Calculation relevant,then in the Implementation Guide (IMG) Customizing, you must explicityset the status to a combination of a system status with calculationrelevant.
                                        Note : Internal plausibility checks are defined to validate theinput data before a system status is set for a collateral agreement.

                                        Default
                                        By default, all new collateral agreements assume the status Created
                                        .