Entering content frame

Background documentation Functions for InfoObjects and Planning Books Locate the document in its SAP Library structure

Refer to the following table to find the macro function of your choice. The functions are listed in alphabetical order.

Function

Explanation

ACT_COLUMN

ACT_COLUMN returns the number of the column that is currently being processed.

ACT_IOBJNM_VALUE()

ACT_IOBJNM_VALUE( 'IOBJNM'; <GRID=2'> ) returns the value of the InfoObject that is currently being planned. ‘GRID=2’ is an optional parameter. If you specify this parameter, the value of the specified InfoObject in the second grid at the time of the calculation is returned. For example, the result of ACT_IOBJNM_VALUE( 'SALORG') might be 'north'.

ACT_LEVEL or ACT_LEVEL()

ACT_LEVEL returns the level of the object you are planning. ‘GRID=2’ is an optional parameter. If you specify this parameter, the level of the planning object in the second grid is returned. For example, the result of ACT_LEVEL ( 'GRID=2' ) is 2, if the planning object at the time of the calculation is the result of the second drilldown in grid 2.

ACT_LOCATION or ACT_LOCATION()

ACT_LOCATION returns the name of the location that is currently being planned where the InfoObject for the location is 9ALOCNO. For example, the result of ACT_LOCATION might be DC-BERLIN. ‘GRID=2’ is an optional parameter. If you specify this parameter, the name of the location being calculated in the second grid is returned.

ACT_LOCATION _PRODUCTS or ACT_LOCATION _PRODUCTS()

ACT_LOCATION_PRODUCTS provides all the product-location combinations that are in the current selection. ‘GRID=2’ is an optional parameter. If you specify this parameter, the system returns the location products in the selection in the second grid.

ACT_PLOB

ACT_PLOB returns the internal number of the planning object for which the macro is currently being processed. The internal number of a planning object is often needed in other macro functions.

ACT_PLOB_GRID2

ACT_PLOB_GRID2 returns the internal number of the planning object in grid 2 for which the macro is currently being processed. The internal number of a planning object is often needed in other macro functions.

ACT_PRODUCT or ACT_PRODUCT()

ACT_PRODUCT returns the name of the product that is currently being calculated where the InfoObject for the product is 9AMATNR. For example, the result of ACT_PRODUCT might be “4711“. ‘GRID=2’ is an optional parameter. If you specify this parameter, the name of the product being calculated in the second grid is returned.

ACT_RESOURCE or ACT_RESOURCE()

ACT_RESOURCE returns the name of the resource that is currently being planned where the InfoObject name of the resource is 9ARNAME. For example, the result of ACT_RESOURCE might be RES-20_1000_001. ‘GRID=2’ is an optional parameter. If you specify this parameter, the name of the resource being calculated in the second grid is returned.

ACT_USER

ACT_USER returns the user name of the current planner.

ACT_VERSION or ACT_VERSION()

ACT_VERSION returns the version that is currently being planned where the InfoObject name of the version is 9AVERSION. 'GRID=2' is an optional argument. If you specify this argument, the version being planned in the second grid is returned.
For example, the result of ACT_VERSION( 'GRID=2' ) might be 001.

AGG_LEVEL()

Syntax

AGG_LEVEL('characteristic' [; EXCLUDE_IMP] [GRID=2] )

Characteristic = Technical name of the characteristic that is to be analyzed

EXCLUDE_IMP: If you set this optional indicator ('X'), implicitly strong characteristics are not taken into account in the analysis.

GRID=2: If you set this optional parameter, the analysis is applied to the planning object of the second grid.

Description

The AGG_LEVEL() function analyzes whether the planning object being currently processed is detailed or aggregated with regards to the characteristic characteristic. If detailed, the return value is ‘0’; if aggregated, the value is ‘1’.

The return value of the AGG_LEVEL() function is complementary to the return value of the DET_LEVEL() function.

ALERT_BDATE()

ALERT_BDATE( ALERT ) returns the start date of the earliest valid alert/status of the alert/status type specified by ALERT for the current selection. The argument of this function is an alert/status element. For more information about macro elements, see the Application Help for Demand Planning.

ALERT_EDATE()

ALERT_EDATE( ALERT ) returns the finish date of the latest valid alert/status of the alert/status type specified by ALERT for the current selection. The argument of this function is an alert/status element.

ALERT_EXIST()

ALERT_EXIST( ALERT ) returns the number of alerts/statuses that exist for alert/status type ALERT for the current selection. The argument of this function is an alert/status element.

ALERT_PROFILE_THRESH()

ALERT_PROFILE_THRESH( ‘profile’ ; ‘alert type’ ; ‘alert priority’ ; <’alert object type’> ; <’application’>) returns the threshold value for a particular alert type and priority (information, warning, error) in an alert profile.

ALLOC()

ALLOC( n ; m ; X1 ; ... ; Xn + m + 1 ; Y1 ; ... ; Yn + m + 1 ) returns the open allocation quantity that is available for satisfying sales orders, where n is the number of allocation periods before the current period, m is the number of allocation periods after the current period, Xi is the allocation quantity for period i ( i = 1 ... n + m + 1 ), and Yi is the incoming orders quantity for period i. The arguments can be numbers that you enter in Operator/function dialog boxes as well as rows, columns, cells, or areas from the planning table or auxiliary table.

ALLOC_MISQTY()

ALLOC_MISQTY( n ; m ; X1 ; ... ; Xn + m + 1 ; Y1 ; ... ; Yn + m + 1 ) returns the amount by which the customer has already exhausted their allocation, where n is the number of allocation periods before the current period, m is the number of allocation periods after the current period, Xi is the allocation quantity for period i ( i = 1 ... n + m + 1 ), and Yi is the incoming orders quantity for period i. The arguments can be numbers that you enter in Operator/function dialog boxes as well as rows, columns, cells, or areas from the planning table or auxiliary table.

BUCKET_BDATE()

BUCKET_BDATE( X1 ; ... ; Xn ) returns the earliest start date of the periods given by the cell(s), row(s), and/or column(s) (not areas) X1 through Xn of the planning table or the auxiliary table. This date is expressed in whole numbers with reference to the date 01.01.0001. In the attributes of the argument elements, you must specify Period data as the data source.

BUCKET_DATE_IN()

BUCKET_DATE_IN( X ; Y1 ; ... ; Yn ) returns 1 if date X falls within the periods given by the cell(s), row(s), and/or column(s) (not areas) Y1 through Yn. Otherwise, 0 is returned. The date X (for example, the function TODAY or DATE()) is expressed in whole numbers with reference to the date 01.01.0001. The argument can be either a number that you enter in an Operator/function dialog box, or one of the macro elements cell, row, or column from the planning table or the auxiliary table. In the attributes of the argument elements Y1 through Yn, you must specify Period data as the data source.

BUCKET_DAYS()

BUCKET_DAYS( X1 ; ... ; Xn ) returns the number of Gregorian calendar days of the periods given by the cell(s), row(s), and/or column(s) (not areas) X1 through Xn. In the attributes of the argument elements, you must specify Period data as the data source.

BUCKET_DESCRIPTION()

BUCKET_DESCRIPTION( X ) returns for the specified column X the text that appears in the column of that period in the planning table.

BUCKET_EDATE()

BUCKET_EDATE( X1 ; ... ; Xn ) returns the latest finish date of the periods given by the cell(s), row(s) and/or column(s) (not areas) X1 through Xn. This date is expressed in whole numbers with reference to the date 01.01.0001. In the attributes of the argument elements, you must specify Period data as the data source.

BUCKET_WDAYS()

BUCKET_WDAYS( <calendar> ; X1 ; ... ; Xn) returns the number of workdays in the periods given by the cell(s), row(s), and/or column(s) (not areas) X1 through Xn. In the attributes of the argument elements, you must specify Period data as the data source. The specification of a calendar as the first argument is optional. If you do not specify a calendar, the system reads the calendar given by the time stream in the storage buckets profile. If no time stream is defined, the system uses calendar days.

CALC_ERROR

CALC_ERROR returns the value X if an error has occurred during execution of the macro.

CALENDAR()

CALENDAR( 'location' ; 'calendar type' ; <version> ) returns the calendar of the specified type that is used by the specified location in the specified version. The specification of a version as the third argument is optional. CALENDAR( ACT_LOCATION ; 'PP' ) would return the production planning calendar of the location you are currently planning.

CALENDAR_WDAYS()

CALENDAR_WDAYS( ‘calendar’ ; from date ; <to date> ) returns the number of workdays between the from-date and the to-date in the calendar specified.

CBF_DISPLAY_TO_INT()

CBF_DISPLAY_TO_INT( row 1 ; …row n ) writes the displayed values in a CBF planning book into the internal memory.

CBF

CBP_SET_INDICATOR()

CBP_SET_INDICATOR ('mode') switches the display of the CBP progress indicator on or off. The argument is either 'ON' or 'OFF'. The default value is 'ON'.

CBP_SET_ROUNDING()

CBP_SET_ROUNDING ('mode') switches rounding on or off for CBP. The argument is either 'ON' or 'OFF'. The default value is 'ON'.

COLLABORATION()

COLLABORATION ( NAME ) returns a value of 1 if you are currently planning collaboration NAME; otherwise, 0. You enter the name NAME of the collaboration as an argument in an Operator/function dialog box.

DELTA_SUM()

DELTA_SUM( key figure, drilldown level) runs the DELTA_SUM function for the specified key figure at the specified drilldown level. For more information, see SAP Note 610517. This macro function can only be used at detail level.

DET_LEVEL()

Syntax

DET_LEVEL('characteristic' [; EXCLUDE_IMP] [GRID=2] )

Characteristic = Technical name of the characteristic that is to be analyzed

EXCLUDE_IMP: If you set this optional indicator ('X'), implicitly strong characteristics are not taken into account in the analysis.

GRID=2: If you set this optional parameter, the analysis is applied to the planning object of the second grid.

Description

The DET_LEVEL() function analyzes whether the planning object being currently processed is detailed or aggregated with regards to the characteristic characteristic. If detailed, the return value is ‘1’; if aggregated, the value is ‘0’.

Examples

Example 1:

You have selected the products P1 and P2 (characteristic 9AMATNR). DET_LEVEL( '9AMATNR' ) will provide the return value '0' for this planning object because you are at aggregated level with regards to the characteristic 9AMATNR.

Example 2:

The products P1 and P2 are only in location L1 (characteristic 9ALOCNO) due to the characteristics combinations maintained (in DP) or location products (in SNP). You have selected the products P1 and P2 (characteristic 9AMATNR). DET_LEVEL( '9ALOCNO' ) will provide the return value '1' for this planning object because you are at detailed level with regards to the characteristic 9ALOCNO. The 9ALOCNO characteristic is implicitly strong in this case (namely location L1) due to the selection of products P1 and P2 and it is used in the analysis. DET_LEVEL( '9ALOCNO' ; 'X' ) will deliver the return value '0' for this planning object because implicitly strong characteristics are not used for the analysis. A drilldown to the characteristic ‘location’ would characterize it explicitly.

DRILL_DOWN()

DRILL_DOWN( 'characteristic’ , <'internal'>, <’CBF’> ) carries out a drilldown using the specified characteristic (technical name). The display is as for Details (all) in the planning table. If you set the optional argument 'internal,' the display is not changed. This option improves performance if you intend to drill-up in the same macro subsequently.

Set the ‘CBF’ argument if you are working in a CBF planning book and the characteristic is a CBF characteristic. If you want to drill down on a non-CBF characteristic, do not set this argument.

DRILL_IOBJNM()

DRILL_IOBJNM( drill-down level ) returns the technical name of the characteristic that was drilled down on at a particular drill-down level. The drill-down level can be a number 1, 2, and so on or ACT_LEVEL as the current level.

This function is only available if you have drilled down in the grid using the header or by using the DRILL-DOWN macro function.

DRILL_UP()

DRILL_UP( 'characteristic’ , <'internal'>, <’CBF’> carries out a drill-up using the specified characteristic (technical name). If you set the optional argument 'internal,' the display is not changed. This option improves performance if you intend to drill-up in the same macro subsequently.

Set the ‘CBF’ argument if you are working in a CBF planning book and the characteristic is a CBF characteristic. If you want to drill up on a non-CBF characteristic, do not set this argument.

The same rules for drill-down and drill-up apply as in interactive planning.

FIX_CALC()

FIX_CALC( X1; X2: <input check> ) performs fixing calculation with X1 as the row containing the key figure with the value to be fixed and X2 the key figure for the fixed values. If the input check indicator is set (for instance X), the system tries to correct any inconsistencies that may occur due to changes being made on the detail level. For example, a key figure has, at aggregate level, the value 100 and at detail level it has three values (50, 30, and 20). You then change the last value to 40; the system reduces the amounts of the remaining levels so that the total is still 100. Macros that use this function should not be used at detail level. 

FORCONS_LOGIC()

Syntax

FORCONS_LOGIC( product ; location )

Product: Product ID

Location : Customer location ID

These arguments can be entered using other operators/functions such as ACT_PRODUCT, ACT_LOCATION or as literals in single inverted commas.

Description

FORCONS_LOGIC returns the value 1 if the following conditions are fulfilled:

In the customer location, the standard consumption logic has been chosen.

The location product has been assigned a requirements strategy for which the assignment mode is Assign customer requirements to planning with assembly, for example, in the standard requirements strategy 20 – Planning with Final Assembly.

Otherwise, the function returns the value 0.

This function is intended for use with the VMI scenario.

FORECAST_CONSUMPTION()

Syntax

FORECAST_CONSUMPTION( product ; location )

Product: Product ID

Location : Customer location ID

These arguments can be entered using other operators/functions such as ACT_PRODUCT, ACT_LOCATION or as literals in single inverted commas.

Description

FORECAST_CONSUMPTION executes consumption of the VMI forecast by customer requirements for the given customer location and product.

FORECAST_PROFILE_SET()

FORECAST_PROFILE_SET('profile'; 'profile type'; 'version';< key figure 'IOBJNM'> ) sets the forecast profile 'profile' for the  forecasting type 'profile type' (S - univariate, M - MLR, C - composite) and the version 'version'. An optional entry is the key figure for which the profile is valid, for example, 9AFCST for the standard forecast key figure.

IOBJNM_VALUE()

IOBJNM_VALUE( 'IOBJNM' ; 'VALUE' ) determines whether the current selection contains only data for the specified characteristic value VALUE of the InfoObject IOBJNM. If yes, the system returns the value 1; otherwise, 0. Enter the arguments in a dialog box of the Operator/function element. Use this function to find out, for example, if the current selection contains data for product VALUE.

INTERNAL_RESOURCE_UNIT()

INTERNAL_RESOURCE_UNIT( 'resource' ; 'version' ) returns the unit of measure in which a resource is saved in liveCache.

INVENTORY_COST()

INVENTORY_COST( 'product' ; 'location' ;  <'version'> ) returns the inventory cost of the specified product at a specified location in the specified version. The third argument for the version is optional. INVENTORY_COST( ACT_PRODUCT ; ACT_LOCATION ) returns the inventory cost of the currently planned product in the currently planned location.

ITERATION_COUNTER

ITERATION_COUNTER returns the number of iterations that have been carried out in the current step.

KEYFS_PLOB()

KEYFS_PLOB(X) returns the internal number of planning object in row X. In the attributes of the argument row, the value in the Data field must be Row attributes. You can use this function as an argument in other macro functions.

KEYFS_VERSION()

KEYFS_VERSION( X ) returns the version of the key figure values in row X. In the attributes of the argument row, the value in the Data field must be Row attributes.

LAYOUTVAR_VALUE()

Syntax

LAYOUTVAR_VALUE( 'my_Variable' )

my_Variable = Name of variables

Description

LAYOUTVAR_VALUE () returns the value of the numeric variables my_Variable. You must assign this value to the variables first with the function LAYOUTVARIABLE_SET ().

LAYOUTVARIABLE()

Syntax

LAYOUTVARIABLE( 'my_Variable' )

my_Variable = Name of variables

Description

LAYOUTVARIABLE () returns the character string of the alphanumeric variables my_Variable. You must assign this character string to the variables first with the function LAYOUTVARIABLE_SET ().

LAYOUTVARIABLE_SET()

Syntax

LAYOUTVARIABLE_SET( 'my_Variable' ; value)

my_Variable = Name of variables

Value = numeric value

'Value' = alphanumeric character string

Description

LAYOUTVARIABLE_SET() assigns the numeric value or the alphanumeric character string 'value' to the variable my_Variable . If you want to assign an alphanumeric character string, you set the argument in single inverted commas, that is, 'value'. If you want to assign a numeric value, you use the argument without single inverted commas. You can access the variable my_Variable with the functions LAYOUTVAR_VALUE () and LAYOUTVARIABLE () in other macros of the same planning book. The content of the variables is deleted when new data is loaded into interactive planning. The declaration of the type of variables (numeric or alphanumeric) takes place automatically when setting the variables with LAYOUTVARIABLE_SET ().

LOC()

LOC( 'FIELD_NAME' ; <'location'> ;  <'version'> ) returns the content of a numeric field in the location master record of the specified location. The arguments for the location and version are optional. If you do not specify an argument for the location, the system uses the currently planned location. However, it is better for performance reasons to use the ACT_LOCATION function. For example, LOC( 'DURAT' ; ACT_LOCATION ) returns the maximum duration during continuous move of the current location.

LOC_C()

LOC_C( 'FIELD_NAME' ; <'location'> ;  <'version'> ) returns the content of a character field in the location master record of the specified location. The arguments for the location and version are optional. If you do not specify an argument for the location, the system uses the currently planned location. However, it is better for performance reasons to use the ACT_LOCATION function. For example, LOC_C( 'PARTNER' ; ACT_LOCATION ) returns the partner for the current location.

LOC_EXTRA()

LOG_EXTRA( n ; <'location'> ;  <'version'> ) gets the value of an extra field in the location master record for the specified location in the specified version, where n represents the number of the extra field. For example, LOC_EXTRA( 1 ; ACT_LOCATION ) gets the value in extra field 1 for the currently planned location. The arguments for the location and version are optional. If you do not specify an argument for the location, the system uses the currently planned location. However, it is better for performance reasons to use the ACT_LOCATION function. Use this function for numeric fields.

LOC_EXTRA_C()

LOG_EXTRA_C( n ; <'location'> ;  <'version'> ) gets the value of an extra character field in the location master record for the specified location in the specified version, where n represents the number of the extra field. For example, LOC_EXTRA_C( 1 ; ACT_LOCATION ) gets the value in extra field 1 for the currently planned location, if this field is of type character. The arguments for location and version are optional. If you do not specify an argument for the location, the system uses the currently planned location. However, it is better for performance reasons to use the ACT_LOCATION function.

LOC_EXTRA_SET()

LOG_EXTRA_SET( n ;  'field_value' ; <'location'> ;  '<version>' ) sets the value of an extra field in the location master record for the specified location in the specified version, where n represents the number of the extra field and 'field_value' represents the character or numerical value you want to give the field. Enter a numerical value without single inverted commas. The arguments for location and version are optional. If you do not specify an argument for the location, the system uses the currently planned location. However, it is better for performance reasons to use the ACT_LOCATION function.

LOC_SET()

LOC_SET( ‘field name’ ; 'field_value' ; <'location'> ;  '<version>' ) sets the value of the specified field in the location master record for the specified location in the specified version. The arguments for location and version are optional. If you do not specify an argument for the location, the system uses the currently planned location. However, it is better for performance reasons to use the ACT_LOCATION function.

LOCATION_TYPE()

LOCATION_TYPE ( 'location' ) returns the location type of the location in the argument, for example ACT_LOCATION.

MAT()

MAT( 'FIELD_NAME' ; <'product'> ;  <'version'>  ) returns the content of a numerical field in the product master record of the specified product. MAT( 'BRGEW' ; ACT_PRODUCT ) returns the gross weight of the current product. The arguments for product and version are optional. If you do not specify an argument for the product, the system uses the currently planned product. However, it is better for performance reasons to use the ACT_LOCATION function.

MAT_C()

MAT_C( 'FIELD_NAME' ; <'product'> ;  <'version'> ) returns the content of a character field in the product master record of the specified product. The arguments for product and version are optional. If you do not specify an argument for the product, the system uses the currently planned product. However, it is better for performance reasons to use the function ACT_PRODUCT. For example, MAT_C( 'KOSCH' ; ACT_PRODUCT ) returns the product allocation procedure for the current product.

MAT_EXTRA()

MAT_EXTRA( n ; <'product'> ;  <'version'> ) gets the value of an extra field in the product master record for the specified product in the specified version, where n represents the number of the extra field. The arguments for product and version are optional. If you do not specify an argument for the product, the system uses the currently planned product. However, it is better for performance reasons to use the function ACT_PRODUCT. For example, MAT_EXTRA( 1 ; ACT_PRODUCT ) gets the value in extra field 1 for the currently planned product.

MAT_EXTRA_C()

MAT_EXTRA_C( n ; <'product'> ;  <'version'> ) gets the value of an extra character field in the product master record for the specified product in the specified version, where n represents the number of the extra character field. The arguments for product and version are optional. If you do not specify an argument for the product, the system uses the currently planned product. However, it is better for performance reasons to use the function ACT_PRODUCT. For example, MAT_EXTRA( 1 ; ACT_PRODUCT ) gets the value in extra character field 1 for the currently planned product.

MAT_EXTRA_SET()

MAT_EXTRA_SET( n ;  'field_value' ; <'product'> ;  '<version>' ) sets the value of an extra field in the product master record for the specified product in the specified version, where n represents the number of the extra field and 'field_value' represents the character or numerical value you want to give the field. Enter a numerical value without single inverted commas. The arguments for product and version are optional. If you do not specify an argument for the product, the system uses the currently planned product. However, it is better for performance reasons to use the function ACT_PRODUCT.

MAT_SET()

MAT_SET ( ‘field name’ ;  field_value' ; <'product'> ;  '<version>' ) sets the value of the specified field in the product master record for the specified product in the specified version. The arguments for product and version are optional. If you do not specify an argument for the product, the system uses the currently planned product. However, it is better for performance reasons to use the function ACT_PRODUCT.

MATLOC()

MATLOC( 'FIELD_NAME' ; <'product'> ;  <'location'> ; <'version'> ) returns the content of a numerical field in the location/product master record of the specified product and location. The arguments for product, location, and version are optional. If you do not specify an argument for the product and/or location, the system uses the current product/location. However, it is better for performance reasons to use the functions ACT_LOCATION and ACT_PRODUCT. For example, MATLOC( 'BSTMA' ; ACT_PRODUCT ;  ACT_LOCATION ) returns the maximum lot size for this location product.

MATLOC_C()

MATLOC_C( 'FIELD_NAME' ; <'product'> ;  <'location'> ; <'version'> ) returns the content of a character field in the location/product master record of the specified product and location. The arguments for product, location, and version are optional. If you do not specify an argument for the product and/or location, the system uses the current product/location. However, it is better for performance reasons to use the functions ACT_LOCATION and ACT_PRODUCT. For example, MATLOC( 'BESKZ' ; ACT_PRODUCT ; ACT_LOCATION ) returns the procurement type for this location product.

MATLOC_EXTRA()

MATLOC_EXTRA( n ; <'product'> ;  <'location'> ; <'version'> ) gets the value of an extra field in the product/location master record for the specified product and location in the specified version, where n represents the number of the extra field. The arguments for product, location, and version are optional. If you do not specify an argument for the product and/or location, the system uses the current product/location. However, it is better for performance reasons to use the functions ACT_LOCATION and ACT_PRODUCT. For example, MATLOC_EXTRA( 1 ; ACT_PRODUCT ; ACT_LOCATION ) gets the value in extra field 1 for the currently planned location product. Use this function for numeric fields.

MATLOC_EXTRA_C()

MATLOC_EXTRA( n ; <'product'> ;  <'location'> ; <'version'> ) gets the value of an extra character field in the product/location master record for the specified product and location in the specified version, where n represents the number of the extra character field. The arguments for product, location, and version are optional. If you do not specify an argument for the product and/or location, the system uses the current product/location. However, it is better for performance reasons to use the functions ACT_LOCATION and ACT_PRODUCT. For example, MATLOC_EXTRA( 1 ; ACT_PRODUCT ; ACT_LOCATION ) gets the value in extra character field 1 for the currently planned location product.

MATLOC_EXTRA_SET()

MATLOC_EXTRA_SET( n ;  'field_value' ; <'product'> ;  <'location'> ; '<version>' ) sets the value of an extra field in the location product master record for the specified product and location in the specified version, where n represents the number of the extra field and 'field_value' represents the character or numerical value you want to give the field. Enter a numerical value without single inverted commas. The arguments for product, location, and version are optional. If you do not specify an argument for the product and/or location, the system uses the current product/location. However, it is better for performance reasons to use the functions ACT_LOCATION and ACT_PRODUCT.

MATLOC_SET()

MATLOC_SET(( ‘field name’ ; ;  'field_value' ; <'product'> ;  <'location'> ; '<version>' ) sets the value of the specified field in the location product master record for the specified product and location in the specified version. The arguments for product, location, and version are optional. If you do not specify an argument for the product and/or location, the system uses the current product/location. However, it is better for performance reasons to use the functions ACT_LOCATION and ACT_PRODUCT.

PARTNER()

PARTNER( NAME ) returns the value 1 if planning is currently being done by partner NAME; otherwise, 0. You enter the name NAME of the partner as an argument in an Operator/function dialog box. Use this function in Collaborative Planning.

PLOBS_FOR_LEVEL()

PLOBS_FOR_LEVEL( X ) returns the number of planning objects on the specified level where X represents the planning level. For example, PLOBS_FOR_LEVEL( 1 ) returns the number of products in the product group selection if you have first selected a product group and then drilled down to product level.

PRODUCT_LIFE()

PRODUCT_LIFE( X ; <'product'> ) returns the value 1 if data is selected for exactly one product and if the specified date X comes after the phase-in time span and before the phase-out time span of the product. Otherwise, 0 is returned. For example, PRODUCT_LIFE ( DATE ( 20010220 ) ) returns the value 1 if the product is in its growth or maturity phrase on February 20, 2001. The argument can be either a number that you enter in an Operator/function dialog box, or one of the macro elements cell, row, or column from the planning table or the auxiliary table. The argument for product is optional.

PRODUCT_PHIN_END or PRODUCT_PHIN_END()

PRODUCT_PHIN_END( <'GRID=2'> ;  <'product'> ) returns the end date of the specified product's launch phase as maintained for the phase-in profile in the product master record. The arguments for grid 2 and product are optional. If you do not specify a product, the system returns the end date of the phase-in time span of the currently planned product. However, for performance reasons, we recommend that you use the function ACT_PRODUCT to represent the current product.

PRODUCT_PHIN_START or PRODUCT_PHIN_START()

PRODUCT_PHIN_START( <'GRID=2'> ;  <'product'> ) returns the start date of the specified product's launch phase as maintained for the phase-in profile in the product master record. The arguments for grid 2 and product are optional. If you do not specify a product, the system returns the start date of the phase-in time span of the currently planned product. However, for performance reasons, we recommend that you use the function ACT_PRODUCT to represent the current product.

PRODUCT_PHOUT_END or PRODUCT_PHOUT_END()

PRODUCT_PHOUT_END( <'GRID=2'> ;  <'product'> ) returns the end date of the specified product's decline phase as maintained for the phase-out profile in the product master record. The arguments for grid 2 and product are optional. If you do not specify a product, the system returns the end date of the phase-out time span of the currently planned product. However, for performance reasons, we recommend that you use the function ACT_PRODUCT to represent the current product.

PRODUCT_PHOUT_START or PRODUCT_PHOUT_START()

PRODUCT_PHOUT_START( <'GRID=2'> ;  <'product'> ) returns the start date of the specified product's decline phase as maintained for the phase-out profile in the product master record. The arguments for grid 2 and product are optional. If you do not specify a product, the system returns the start date of the phase-out time span of the currently planned product. However, for performance reasons, we recommend that you use the function ACT_PRODUCT to represent the current product.

RESOURCE_COST()

RESOURCE_COST( 'resource' ;  'resource variant' ; DATE ) returns the cost of the specified resource for the specified capacity variant on the specified date.

RESOURCE_EDIT()

RESOURCE_EDIT( 'resource' ; 'version' ) returns the value ' X ' if the resource can be edited in the specified version, ' ' if it cannot.

RESOURCE_OVERLOAD()

RESOURCE_OVERLOAD( 'resource' ;  'version' ) returns the resource overload for the specified resource in the specified version. For example, RESOURCE_OVERLOAD ( ACT_RESOURCE ; ACT_VERSION ) might return 10%.

RESOURCE_RESTYPE()

RESOURCE_RESTYPE( 'resource' ;  'version' ) returns the resource type of the specified resource in the specified version. For example, RESOURCE_RESTYPE( ACT_RESOURCE ;  ACT_VERSION ) returns resource type 'P', 'T', 'S,' or 'H' (production, transportation, storage or handling) for the current resource in the current version.

RESOURCE_UNDERLOAD()

RESOURCE_UNDERLOAD( 'resource' ;  'version' ) returns the resource underload for the specified resource in the specified version. For example, RESOURCE_UNDERLOAD ( ACT_RESOURCE ; ACT_VERSION ) might return 10%.

RESOURCE_UNIT()

RESOURCE_UNIT ( 'resource' ; 'version' ) returns the unit for the resource that is contained in the resource master record in the specified version.

RESOURCE_VARIANT()

RESOURCE_VARIANT( 'version' ;  'resource_variant' ; 'from_date' ;  'to_date' ) returns the available capacity for the specified resource variant in the specified time span.

SUM_CALC()

SUM_CALC( key figure ) calculates the sum of all detail levels of the specified key figure.

STDV_DEMAND_GET()

Syntax

STDV_DEMAND_GET([key figure])

Key figure = Enter the name of the combined key figure here (that is, the result key figure).

Description

This function combines the values of one or more forecast key figures to form a single key figure, the combined key figure. The prerequisite for this function is that you have maintained the Structure linkmaster data for demand combination.

STDV_WRITE_ALERTS()

Syntax

STDV_WRITE_ALERTS()

Description

This function generates data base alerts for Structure linkdemand combination, which the Alert Monitor displays. You must call the function STDV_DEMAND_GET() in the same macro before the alerts can be generated.

TIMESHIFT_BACKWARDS()

       

       

       

       

       

       

       

TIMESHIFT_BACKWARDS( X1 ; ... ; Xn ; Y1 ; ... ; Yn ) shifts the values of time series X1 through Xn backward in time by the number of periods given in time series Y1 through Yn. For example:

The time series look like this:
 X  10   20   30   40   50
Y     1    2    1    3    1.
The result looks like this:
      30   40   30    -    50    -

The value 10 is shifted back one period in time, the value 20 is shifted back two periods in time, and so on.

TIMESHIFT_FORWARDS()

       

       

       

        

       

       

       

TIMESHIFT_FORWARDS(  X1 ; ... ; Xn ; Y1 ; ... ; Yn ) shifts the values of time series X1 through Xn forward in time by the number of periods given in time series Y1 through Yn. Example: The time series look like this:
X    10   20   30   40   50
Y     1    3    1    2    1.

The result looks like this:     
           10     -    30   20   90
The value 10 is shifted forward one period in time, the value 20 is shifted forward three periods in time, and so on.

 

TS_GET()

TS_GET( 'TS_TYPE' ; 'key_value_1' ; 'key_value_2' ; 'key_value_3' ;  <value_from> ; <value_to> ) reads the values of a database time series where 'TS_TYPE' defines the time series type, the second, third and fourth arguments represent the values from the three possible key fields of the time series, and the fifth and sixth arguments (which are optional) define the value range that you want to read.

The mandatory fields have the following types:

TSTYPE = CHAR 20
key_value1 = CHAR 60
key_value2 = CHAR 60
key_value3 = CHAR 60

Example: A time series with ID 'I'', 'A'; 'B'; 'C' is

Item      1    2    3    4    5    6    7    8    9
Value    10   10   20   30   50   50   60   90   120.

TSGET ( ''I'', 'A' ; 'B' ; 'C' ; 2 ; 9 ) returns
10   20   30   50   50   60   90   120

Use an area as the macro result element.

TS_SET()

TS_SET( 'TS_TYPE' ; 'key_value_1' ; 'key_value_2' ; 'key_value_3' ;  from_value ; Y1 ; ... ; Yn ) writes values to a database time series where 'TS_TYPE' defines the time series type, the second, third and fourth arguments represent the values from the three possible key fields of the time series. These fields are defined for TS_GET(). The fifth argument specifies at which bucket the system should start to write the data (for example, 5 = start at bucket 5). The value of this argument must be a whole number ³ 1. Y1 through Yn are the values to be written. These values can be numbers or other functions that define these values.

VALUE_CONTAINED()

VALUE_CONTAINED( value ; range ) returns the value 1 if the value is contained in the specified range.

VEC_LAYOUTVARIABLE()

Syntax

VEC_LAYOUTVARIABLE( 'my_vector' [; from_index [; to_index ] ] )

my_vector = Name of vector

from_index = Index that specifies the start of the interval to be read

to_index = Index that specifies the end of the interval to be read

Description

The contents of the vector my_vector is assigned to a results area (tableau element area). Optionally, you can specify an index from_index so that the contents of the vector my_vector are assigned as of the index from_index. If you have specified an index from_index, you can also specify the index to_index so that the contents of the vector are only assigned to the results area up to the index to_index.

VEC_LAYOUTVARIABLE_SET()

Syntax

VEC_LAYOUTVARIABLE_SET ( ‘my_vector’ ; table_element )

my_vector = Name of vector variable

table_element = Row, column, cell, or area

Description

VEC_LAYOUTVARIABLE_SET() assigns the numerical values in table_element to the vector variable my_vector.

VEC_LAYOUTVARIABLE_APP()

Syntax

VEC_LAYOUTVARIABLE_APP ( ‘my_vector’ ; table_element )

my_vector = Name of vector variable

table_element = Row, column, cell, or area

Description

VEC_LAYOUTVARIABLE_APP() assigns the values in table_element to the vector variable my_vector.

W_AVG_CALC()

W_AVG_CALC( key figure with values ; key figure with weighting factors ) calculates the weighted average of the first key figure using the weighting factors given in the second key figure.

 

 

 

 

 

 

Leaving content frame