Methods of Class CL_ISU_EDM_SETTLPROCESS
Methods of Class CL_ISU_EDM_SETTLPROCESS
CHECK_ALL_PARAMETERS
You use this method to check parameter determination for the settlement document and to locate inconsistencies in the profile allocation. The parameters that were allocated successfully and the parameters that could not be determined are returned as tables together with the possible error messages. The calling application decides whether or not an error is critical. Grids and customer groups that are to be taken into account during parameter determination should be transferred.
|
Parameter |
Type |
Description |
|
X_SETTLDOC |
Importing |
Settlement document number. |
|
XT_GRID_ID XT_REFPROFILE |
Importing |
Grids and customer groups to be taken into account during parameter determination. |
|
YT_PROFILE |
Exporting |
Successfully allocated profiles. |
|
YT_VALUE |
Exporting |
Not currently used. |
|
YT_MISSING_PROFILE |
Exporting |
Missing profile parameters. |
|
YT_MISSING_VALUE |
Exporting |
Not currently used. |
|
YT_ERROR |
Exporting |
Error messages from parameter determination. |
|
YT_SETTLUNIT |
Exporting |
Settlement units taken into account in the settlement document. |
|
YT_TEMPLATE |
Exporting |
Sample profiles for the result profiles or the interim results in the settlement procedure. |
|
Y_CRITICAL_ERROR_FOUND |
Exporting |
This is set if a result parameter is missing or if no sample profile could be determined for a result profile or interim result. Errors such as this always result in the termination of the settlement run. |
|
XY_OBJ |
Changing |
Internal reference to the settlement procedure used. You can use this to call instance methods. If the reference is transferred when you call the instance, no new instance is generated. |
CHECK_ALL_PROFROLES
This method checks whether roles have been specified for the selection of profiles (of interval customers) and usage factors (of non-interval customers) and for sending settlement results (also see SELECT_PROFROLE).
|
Parameter |
Type |
Description |
|
X_SETTLDOC |
Importing |
Settlement document number. |
|
YT_ERROR |
Exporting |
Error messages if roles are not specified. |
|
XY_OBJ |
Changing |
Internal reference to the settlement procedure used. You can use this to call instance methods. If the reference is transferred when you call the instance, no new instance is generated. |
CHECK_COMPATIBILITY
This method checks whether the specified profiles have the same profile type, profile value category, interval length and measurement unit.
|
Parameter |
Type |
Description |
|
X_TARGET_PROFILE |
Importing |
Target profile for saving settlement results. |
|
X_TEMPLATE_PROFILE |
Importing |
Sample profile used to generate settlement results. |
|
X_PARNAME |
Importing |
The name of the settlement parameter is used in an error message if the specified profiles are not compatible. |
CONVERT_TO_LOCAL_TIMEZONE
This method converts the time stamp to the local time zone.
|
Parameter |
Type |
Description |
|
X_FROM |
Importing |
Time stamp in specified time zone. |
|
X_TIMEZONE |
Importing |
Time zone of the time stamp that is to be converted. |
|
Y_LOCAL_FROM |
Exporting |
Time stamp in sy-zonlo |
GET_SERVPROF_TEXT
Provides the service provider long text that can be used for issuing messages.
|
Parameter |
Type |
Description |
|
X_SERVICE_PROV |
Importing |
Service provider |
|
Y_SERVICE_PROV_TEXT |
Exporting |
Long text for service provider (in sy-langu) or service provider ID if no long text is available. |
GET_SETTLPARTXT
This method provides the long text for the settlement parameter.
|
Parameter |
Type |
Description |
|
X_PARNAME |
Importing |
Settlement parameter name. |
|
Y_SETTLPARTXT |
Exporting |
Long text for the settlement parameter (in sy-langu), or the parameter name if no long text is available. |
POD_OF_GRID
This method provides the point of delivery of the supply grid.
|
Parameter |
Type |
Description |
|
X_GRID_ID |
Importing |
Grid |
|
Y_INT_UI |
Exporting |
Internal point of delivery key |
POD_OF_SERVPROV
This method provides all of the service provider’s points of delivery that are valid for the entire specified period. You must create the service provider as a business partner with contract account, contract and installation. Because a business partner can have several installations, several points of delivery can be determined.
|
Parameter |
Type |
Description |
|
X_SERVICE_PROV |
Importing |
Service provider |
|
X_FROM X_TO X_TIMEZONE |
Importing |
Validity period of point of delivery. |
|
YT_INT_UI |
Exporting |
Table containing internal keys for the point of delivery. |
GET_DEPENDENT_GRIDS
This method provides the specified grids with all higher-level grids.
|
Parameter |
Type |
Description |
|
XT_GRID_ID |
Importing |
Grids, to which points of delivery relevant to settlement are allocated (also see GET_GRIDS). |
|
YT_EGRID |
Exporting |
All grids, including the higher-level grids. The higher-level grids do not have to contain points of delivery (that are relevant to settlement). |
GET_PROFILES_TO_SEND
This method provides profiles that are allocated, with the roles defined for the settlement procedure (to send), to the service provider’s points of delivery in the specified period.
|
Parameter |
Type |
Description |
|
X_SERVICE_PROV |
Importing |
Service provider that receives settlement results. |
|
X_FROM X_TO X_TIMEZONE |
Importing |
Validity period of allocations. |
|
YT_PROFILE |
Exporting |
Profiles are allocated to the service provider with the defined roles. |
GET_TEMPLATE_PROFILE
This method provides the sample profile for the specified settlement parameter.
The profile parameters calculated in the settlement procedure have the same header data as the corresponding sample profile. To save settlement results persistently in an EDM profile, the allocated target profile and the sample profile must be compatible (also see CHECK COMPATIBILITY).
|
Parameter |
Type |
Description |
|
X_PARNAME |
Importing |
Settlement parameter name. |
|
Y_PROFHEAD |
Exporting |
Structure with header data of the sample profile. |
|
Y_PROFILE |
Exporting |
Number of EDM profile to be used as the sample profile. |
IS_SETTLPROCESS_INPUT
Provides X (co_selected), if the parameter is an input parameter in the settlement procedure.
|
Parameter |
Type |
Description |
|
X_PARNAME |
Importing |
Settlement parameter name. |
|
Y_IS_INPUT |
Returning |
Parameter is an input parameter. |
IS_SETTLPROCESS_OUTPUT
Provides X (co_selected), if the parameter is an output parameter in the settlement procedure.
|
Parameter |
Type |
Description |
|
X_PARNAME |
Importing |
Settlement parameter name. |
|
Y_IS_OUTPUT |
Returning |
Parameter is an output parameter. |
IS_SETTLPROCESS_PARAMETER
Provides X (co_selected) if parameters are used as input parameters, results or interim results in the settlement procedure.
|
Parameter |
Type |
Description |
|
X_PARNAME |
Importing |
Settlement parameter name. |
|
Y_IS_PARAMETER |
Returning |
Parameter is defined for the settlement procedure. |
USED_INTSIZEID
This method provides the interval lengths of the result profiles.
|
Parameter |
Type |
Description |
|
X_INTSIZEID |
Returning |
Interval length ID |
USED_VERSION_REASON
This method provides the reason for generating a profile version.
|
Parameter |
Type |
Description |
|
Y_VERSREASON |
Returning |
Reason used for creating a profile verison. |
SELECT_PROFROLE
This method provides roles for the selection of the profiles (of the interval customers) and the usage factors (of non-interval customers) and for sending settlement results.
|
Parameter |
Type |
Description |
|
X_SETTLPROCESS |
Importing |
Settlement procedure for which the role definition is to be selected. |
|
YT_EEDMSETTLPROCRI |
Exporting |
Roles for the selection of usage factors (of non-interval customers). |
|
YT_EEDMSETTLPROCRR |
Exporting |
Roles for the selection of profiles (of interval customers). |
|
YT_EEDMSETTLPROCRS |
Exporting |
Roles for the selection of the settlement results to be sent. |