Methods of Class
CL_ISU_EDM_SETTLSTEP
GET_MASS_FACTOR
This method provides the factor for converting units of measurement.
|
Parameter |
Type |
Description |
|
X_SOURCE_MASS |
Importing |
Unit of measurement of source profile. |
|
X_TARGET_MASS |
Importing |
Unit of measurement of target profile. |
|
Y_FACTOR |
Exporting |
Conversion factor |
CONVERT_FROM_UTC
You use this method to convert the time stamp from UTC.
|
Parameter |
Type |
Description |
|
X_UTC_FROM |
Importing |
From-date/From-time in UTC |
|
X_TIMEZONE |
Importing |
Time zone (default sy-zonlo) |
|
Y_FROM |
Exporting |
From-date/From-date |
CONVERT_TO_UTC
You use this method to convert the time stamp to UTC.
|
Parameter |
Type |
Description |
|
X_FROM |
Importing |
From-date/From-time in UTC |
|
X_TIMEZONE |
Importing |
Time zone (default sy-zonlo) |
|
Y_UTC_FROM |
Exporting |
From-date/From-time |
GET_OWN_POINTS_OF_DELIVERY
This method provides settlement-relevant points of delivery of the interval and non-interval customers for the current settlement run. The settlement units processed in the settlement step are used as selection criteria.
|
Parameter |
Type |
Description |
|
X_SELTYPE |
Importing |
Selection type for selecting data (for example, consumption) |
|
X_PROFROLE |
Importing |
If a role is specified for a profile allocation, only those profiles that were allocated with that role are returned. |
|
XT_GRID_ID |
Importing |
If specified, only those points of delivery that have the specified grid allocation are provided. |
|
YT_EEDMSETTLUF |
Exporting |
Point of delivery data of the non-interval customer. |
|
YT_EEDMSETTLIN |
Exporting |
Point of delivery data of the interval customer. |
GET_PROFILE_CONTEXT
For an EDM profile as a settlement parameter, the settlement unit, the grid allocation and the reference profile are returned as context information. The context information is derived from the data in the parameter container. The method can be redefined in derived classes if it is necessary to determine the context differently.
|
Parameter |
Type |
Description |
|
X_PROFILE |
Importing |
Number of the EDM profile |
|
Y_SETTLUNIT |
Exporting |
Settlement Unit |
|
Y_GRID_ID |
Exporting |
Grid |
|
Y_REFPROFILE |
Exporting |
Customer group |
|
Y_PARNAME |
Exporting |
Settlement parameter name. |
CREATE_PROFILE
This method provides a reference to a new temporary profile used for entering results. A table containing profile values (dependent on the interval length for the settlement procedure) is created for the specified period. The header data (profile type, profile value category, measurement unit, and so on) corresponds to the sample profile of the settlement parameter.
|
Parameter |
Type |
Description |
|
X_PARNUMBER |
Importing |
The number of the exporting parameter is required to determine the sample profile. |
|
X_DATE_FROM X_TIME_FROM X_DATE_TO X_TIME_TO X_TIMEZONE |
Importing |
Period for which profile values are to be processed. For performance reasons, you should, if possible, choose UTC (default) as the time zone. |
|
Y_HANDLE |
Exporting |
Reference from profile data (profile values, header data, status). |
|
Y_PROFILE |
Exporting |
New result parameter that was calculated in the settlement step. If necessary, the context information (settlement unit, grid, customer group) must be set in the settlement step. |
GET_INTSIZEID
This method provides the interval lengths for settlement. All profiles that are updated as results of the settlement procedure have the specified interval length. Only those profiles with the same or a higher interval length than that specified here can be processed as input parameters in the settlement procedure.
|
Parameter |
Type |
Description |
|
Y_INTSIZEID |
Returning |
Interval length ID |
GET_PARAMETER_TEXT
This method provides the long text for parameter names or numbers. You can use this information in error messages.
|
Parameter |
Type |
Description |
|
X_PARKIND X_PARNUMBER |
Importing |
Settlement type of the settlement step (importing/exporting/changing) and the parameter number used. |
|
XY_PARNAME |
Changing |
Parameter name |
|
Y_SETTLPARTXT |
Exporting |
Parameter description in the settlement procedure. |
INVALID_PROFILE_VALUES_EXIST
This method returns data to the open profile parameter X (co-selected) if invalid profile values exist within the settlement period.
|
Parameter |
Type |
Description |
|
X_HANDLE
|
Importing |
Settlement type of the settlement step (importing/exporting/changing) and the parameter number used. |
|
X_DOUBTFUL_IS_VALID X_NO_VALUE_GIVEN_IS_VALID |
Importing |
Additional information on which values are valid. Doubtful values are accepted as valid values by default. |
|
Y_RESULT |
Returning |
X if profile values are missing. |
OPEN_PROFILE
This method provides the reference to an existing EDM profile or a temporary profile.
|
Parameter |
Type |
Description |
|
X_PROFILE
|
Importing |
Profile number |
|
X_TMP_PROFILE
|
Importing |
X (co-selected) if the profile to be opened is a temporary profile (settlement interim result). |
|
X_READ_ONLY |
Importing |
The profile is opened as read only by default. |
|
Y_HANDLE |
Exporting |
Reference to profile data. The profile data (profile values, header data, status) is only available after method READ_PROFILE_DATA has been called. |
READ_PROFILE_DATA
This method provides the data of an open EDM profile or a temporary profile for the specified period.
|
Parameter |
Type |
Description |
|
X_HANDLE
|
Importing |
Reference to an open profile. |
|
X_DATE_FROM X_TIME_FROM X_DATE_TO X_TIME_TO X_TIMEZONE |
Importing |
Period for which profiles are to be processed. For performance reasons, you should, if possible, choose UTC (default) as the time zone. |
|
X_REREAD_DATA |
Importing |
Should be set to X (co-selected) if you want data from the database to be re-read when a call is repeated (for a different period for example). |
SEND_PROFILES
This method sends the transferred profiles to a service provider and logs the send status in the settlement document. If errors are identified when the profiles are sent, they are also noted in the settlement document (and cause the processing of the settlement step to terminate at a later point).
|
Parameter |
Type |
Description |
|
X_RECEIVER
|
Importing |
Recipient |
|
XT_PROFILE |
Importing |
Table containing the profiles to be sent. In addition to the profile number and the period, the context information (settlement unit, grid, customer group) should also be transferred if possible. |
|
X_CONTINUE_AFTER_ERROR |
Importing |
By default, the system attempts to send all transferred profiles, even if an error has occurred when sending one of the profiles. |
SET_ALERT
Log global notification
|
Parameter |
Type |
Description |
|
X_MSG
|
Importing |
Alert notification |
|
X_DO_UPTDATE |
Importing |
Means that all cumulated alerts are written immediately. By default, alerts are only written when processing of the settlement step ends. It may make sense to set this parameter for long running processes. |
SET_ERROR
Log a critical error in the settlement document (results are rejected).
|
Parameter |
Type |
Description |
|
X_MSG
|
Importing |
Error message |
|
X_SETTLUNIT X_GRID_ID |
Importing |
Additional context for error message. |
|
X_SET_ALERT |
Importing |
A global alert should be set at the same time as the error message. |
SET_MSG
Write line in application log.
|
Parameter |
Type |
Description |
|
X_MSG
|
Importing |
Message for application log |
|
X_DETAIL_ONLY |
Importing |
This means that, dependent on the Detail_Log parameter, it may be possible to filter out the message when writing the log. |
|
X_TECHNICAL_CONTEXT |
Importing |
This means that the message is marked in the log as technical data. |
GET_REFPROFILES
This method provides the current settlement run with the relevant customer groups. Only those customer groups with points of delivery for the current settlement document are provided.
|
Parameter |
Type |
Description |
|
YT_REFPROFILE
|
Returning |
Table of the customer groups in settlement. |
GET_GRIDS
This method provides the current settlement run with the relevant grids. Only those grids with points of delivery for the current settlement document are provided. In the settlement procedure, the grid selection for the point of delivery must also be active.
To include the higher-level grids, you subsequently have to call method GET_DEPENDENT_GRIDS.
|
Parameter |
Type |
Description |
|
YT_GRIDID
|
Returning |
Grids |
PERFORM_VALUES_ACTION
If standard status handling is not sufficient when determining result profiles, you can use this method to execute other actions on profile values (for example, importing estimated values). If the method is not called, the profile values of the settlement results are valid.
|
Parameter |
Type |
Description |
|
X_HANDLE
|
Importing |
Reference to a temporary profile created using CREATE_PROFILE. |
|
XT_ACTION |
Importing |
Actions to be used on profile values. |
FORECAST_MISSING_VALUES
Missing profile values of an EDM profile are extrapolated depending on the replacement value procedure group.
|
Parameter |
Type |
Description |
|
X_HANDLE
|
Importing |
Reference to an open EDM profile. If READ_PROFILE_DATA has not yet been called, all of the profile values in the settlement period are taken into account. |
|
YT_ERROR |
Exporting |
Contains the error messages that occurred during extrapolation. |
|
Y_REPLACE_SUCCESS |
Exporting |
Shows that the values were extrapolated successfully. |
SAVE_FORECASTED_PROFILE
Saves an EDM profile whose values were extrapolated using method FORECAST_MISSING_VALUES.
|
Parameter |
Type |
Description |
|
X_CREATE_VERSION
|
Importing |
By default, a version is always created for generated data. |
|
X_HANDLE |
Importing |
Reference to an open EDM profile. |