SAP CFX_API_COLLABORATION_CREATE Function Module for Create Collaboration









CFX_API_COLLABORATION_CREATE is a standard cfx api collaboration create SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Create Collaboration processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for cfx api collaboration create FM, simply by entering the name CFX_API_COLLABORATION_CREATE into the relevant SAP transaction such as SE37 or SE38.

Function Group: CFX_API_COLLABORATION
Program Name: SAPLCFX_API_COLLABORATION
Main Program: SAPLCFX_API_COLLABORATION
Appliation area:
Release date: 04-Feb-2005
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function CFX_API_COLLABORATION_CREATE pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'CFX_API_COLLABORATION_CREATE'"Create Collaboration
EXPORTING
* I_TEMPLATE_ID = "ID of Template Collaboration
I_NAME = "Collaboration Name
* I_DESCRIPTION = "Description of Collaboration
* I_IS_SYNDICATE = CFXA0_SC_FALSE "Syndicate
* I_DEADLINE = "Due Date and Time as UTC Time Stamp in Short Form (YYYYMMDDhhmmss)
* I_SCENARIO = 'collaboration' "'Collaboration' or 'Competition'
* I_IS_TEMPLATE = CFXA0_SC_FALSE "Template? 'yes' = yes or 'no' = no

IMPORTING
ES_FAULT = "Error According to SOAP
E_FAULTSTRING = "Short Error Text for User
E_COLLABORATION_ID = "ID of Created Collaboration
E_PUBLIC_AREA_ID = "ID of Created Work Area
E_ROOT_FOLDER_ID = "ID of Created Folder
.



IMPORTING Parameters details for CFX_API_COLLABORATION_CREATE

I_TEMPLATE_ID - ID of Template Collaboration

Data type: SYSUUID_C
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_NAME - Collaboration Name

Data type: STRING
Optional: No
Call by Reference: No ( called with pass by value option)

I_DESCRIPTION - Description of Collaboration

Data type: STRING
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_IS_SYNDICATE - Syndicate

Data type: CFX_API_T_BOOL
Default: CFXA0_SC_FALSE
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_DEADLINE - Due Date and Time as UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

Data type: TZNTSTMPS
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_SCENARIO - 'Collaboration' or 'Competition'

Data type: CFX_T_SCENARIO
Default: 'collaboration'
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_IS_TEMPLATE - Template? 'yes' = yes or 'no' = no

Data type: CFX_API_T_BOOL
Default: CFXA0_SC_FALSE
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for CFX_API_COLLABORATION_CREATE

ES_FAULT - Error According to SOAP

Data type: CFX_API_TS_FAULT
Optional: No
Call by Reference: No ( called with pass by value option)

E_FAULTSTRING - Short Error Text for User

Data type: CFX_API_T_FAULTSTRING
Optional: No
Call by Reference: No ( called with pass by value option)

E_COLLABORATION_ID - ID of Created Collaboration

Data type: SYSUUID_C
Optional: No
Call by Reference: No ( called with pass by value option)

E_PUBLIC_AREA_ID - ID of Created Work Area

Data type: SYSUUID_C
Optional: No
Call by Reference: No ( called with pass by value option)

E_ROOT_FOLDER_ID - ID of Created Folder

Data type: SYSUUID_C
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for CFX_API_COLLABORATION_CREATE Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_es_fault  TYPE CFX_API_TS_FAULT, "   
lv_i_template_id  TYPE SYSUUID_C, "   
lv_i_name  TYPE STRING, "   
lv_e_faultstring  TYPE CFX_API_T_FAULTSTRING, "   
lv_i_description  TYPE STRING, "   
lv_e_collaboration_id  TYPE SYSUUID_C, "   
lv_i_is_syndicate  TYPE CFX_API_T_BOOL, "   CFXA0_SC_FALSE
lv_e_public_area_id  TYPE SYSUUID_C, "   
lv_i_deadline  TYPE TZNTSTMPS, "   
lv_e_root_folder_id  TYPE SYSUUID_C, "   
lv_i_scenario  TYPE CFX_T_SCENARIO, "   'collaboration'
lv_i_is_template  TYPE CFX_API_T_BOOL. "   CFXA0_SC_FALSE

  CALL FUNCTION 'CFX_API_COLLABORATION_CREATE'  "Create Collaboration
    EXPORTING
         I_TEMPLATE_ID = lv_i_template_id
         I_NAME = lv_i_name
         I_DESCRIPTION = lv_i_description
         I_IS_SYNDICATE = lv_i_is_syndicate
         I_DEADLINE = lv_i_deadline
         I_SCENARIO = lv_i_scenario
         I_IS_TEMPLATE = lv_i_is_template
    IMPORTING
         ES_FAULT = lv_es_fault
         E_FAULTSTRING = lv_e_faultstring
         E_COLLABORATION_ID = lv_e_collaboration_id
         E_PUBLIC_AREA_ID = lv_e_public_area_id
         E_ROOT_FOLDER_ID = lv_e_root_folder_id
. " CFX_API_COLLABORATION_CREATE




ABAP code using 7.40 inline data declarations to call FM CFX_API_COLLABORATION_CREATE

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

 
 
 
 
 
 
DATA(ld_i_is_syndicate) = CFXA0_SC_FALSE.
 
 
 
 
DATA(ld_i_scenario) = 'collaboration'.
 
DATA(ld_i_is_template) = CFXA0_SC_FALSE.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!