SAP BusinessObjects Planning and Consolidation
-
Upload
harikishore66 -
Category
Documents
-
view
550 -
download
11
Transcript of SAP BusinessObjects Planning and Consolidation
SAP BusinessObjects Planning and Consolidation
Planning and Consolidation provides everything you need to meet your bottom-up and top-down financial and operational planning requirements, as well as complete consolidation and reporting through a single application and user interface.
IntegrationThere are two versions of the software: a version for the Microsoft platform and a version for SAP NetWeaver. While this application help focuses on the Microsoft platform version, there may be some notes related to the SAP NetWeaver version. You can ignore these notes.
Certain client components are integrated with Microsoft Office (Word, Powerpoint, and Excel). Other client components are based on Windows or Web technologies.
FeaturesThe SAP Library documentation for the system includes:
Getting Started — Describes the connection wizard and other logon tasks, the interfaces available (Administration, Excel, Word, PowerPoint, and Web), how to set the overall language for the system, and where to find more information, specifically, technical information.
Administration — Provides instructions for administrators about setting up and maintaining Planning and Consolidation applications.
Data Management — Provides instructions about moving data into and out of the system, and about copying and moving data within and across applications.
Business Process Flows — Provides information about using Business Process Flows (BPF). For information about setting up BPFs, see the Administration section.
Reports and Input Schedules — Provides instructions about building, distributing, and publishing reports, and about collecting data and submitting it to the database using input schedules.
Journals — Provides information about creating and posting journal entries to adjust data in the database.
Functions Reference — Provides reference information on using the Planning and Consolidation functions in your reports and input schedules.
More InformationMore Information
Getting Started
You can start Planning and Consolidation from the Windows Start menu.
PrerequisitesTo access the Web or Server Manager interfaces, you have installed the Planning and Consolidation server components. To access the Excel, Word, or PowerPoint interfaces, you have installed the Planning and Consolidation for Office client. To access the Administration interface, you have installed the Planning and Consolidation Administration client.
ActivitiesTo start the program, select SAP BusinessObjects Planning and Consolidation Planning and Consolidation from the Windows Start menu.
More InformationInterface for Office
Interface for Word or PowerPoint
Interface for the Web
Interface for Administration
Interface for Office
The Interface for Office client includes interfaces for Microsoft Excel, Word, and PowerPoint.
These interfaces leverage your familiarity with the Microsoft Office applications of Excel, Word, and PowerPoint, enabling you to collect, analyze, and store financial data and efficiently distribute enterprise performance management reports.
The Interface for Excel is the primary interface you use, complemented by features of the Interface for Word and Interface for PowerPoint.
FeaturesWith Interface for Office, you can perform the following tasks:
Utilize the powerful and flexible formulas and functions within reports and input schedules to retrieve, display, and submit data for a real-time view of the financial position of your organization.
Use predefined report and input schedule templates that you can customize to meet your specific business requirements.
Instantly change the information you see in a report or the entities, accounts, time period, and so on, of input data simply by changing your current view.
Display accurate, live data from the database within Microsoft Excel worksheets, Microsoft Word documents, and Microsoft PowerPoint slides.
Analyze data in reports, perform data entry in input schedules, and distribute information based on user access rights when you are completely offline from the system.
Submit budgets with a wide range of supporting attachments in the form of spreadsheets, documents, and presentations.
Create hypothetical scenarios of future outcomes using powerful modeling functions. Post journal entries to carefully track changes to your data. Schedule and run Data Manager packages for loading, transforming, and manipulating financial
data.
ActivitiesTo start one of the interfaces, select one of them from the launch page, or from another module (such as Interface for the Web or Administration), expand Available Interfaces in the action pane and make your selection.
NOTE
If you see a prompt to update files, select Yes.
More InformationReports and Input Schedules
Interface for Word and PowerPoint
Journals
Data Management for the NetWeaver platform or Data Management for the Microsoft platform
With Planning and Consolidation reporting, you can retrieve requested data from the database into the Excel interface. You can analyze your multidimensional data using the current view, which is available on the action pane. The system provides a variety of report templates to help you design your own reports.
Input schedules allow you to send data directly from your spreadsheet to the databases. Input schedules contain all of the same formatting and functionality as reports. The difference is that reports are used for analysis purposes, and input schedules are used for writing data to the database. Data can be written to base-level members to which you have write access.
More InformationCreating Reports and Input Schedules
Common Report and Input Schedule Features
Dynamic Report and Input Schedule Templates
EvDRE Builder
Drag and Drop Reporting
Live Reporting
Data Submission
Creating Reports and Input Schedules
When you create new reports and input schedules, you choose from the following methods:
Opening a dynamic template that Planning and Consolidation provides. See Dynamic Report and Input Schedule Templates.
Using the EvDRE Builder. See EvDRE Builder. Using the drag and drop interface. See Drag and Drop Reporting. Starting from a blank workbook. See Functions Reference.
ActivitiesSaving Reports Locally
You can save a report locally to the My Reports or My Schedules folder by choosing Save to My Reports folder in the Report State action pane.
Saving Input Schedules Locally
You can save an input schedule locally to the My Schedules folder by choosing Save to My Schedules folder in the Schedule Options action pane.
Saving Reports and Input Schedules as Templates
You can save a report or schedule as a template by selecting eTools Save Template Library . (You must have authorization for this task). After a template is saved, you can make it available for downloading to other users' machines by updating the template version number.
More InformationSee Setting Template Version in Application Set Management.
Dynamic Report and Input Schedule Templates
The system provides several templates within the sample application set, ApShell. You can choose the template you want to use, and then customize it to meet your needs.
FeaturesYou can save reports locally, or save them as a template on the server (if you have administrator rights). If you modify an existing report template or create a custom report, you can save it as a template for
future use. Only administrators with the appropriate rights can save templates on the server. However, you can modify a template and save it locally for your own use. You can edit the template title and description in the language you require.
NOTE
If you make a change to an existing template and save it to the server, you should increment the template version number so that the new template can be downloaded to all client machines that access the server. See Application Set Management.
NOTE
To retrieve information on the Server name, User name, AppSet name and Application name for the current report, you can add the appropriate EvFunction.
The following tables describe the provided templates. Since administrators can save any report as a template, your application set may contain a different set.
Dynamic reports in Planning application
Template name Description
Subtotals by Accounts
This custom report contains Account dimension with subtotals in rows and any dimension across in columns.
Consolidating This custom report contains any dimension in rows and Entity type members across in columns with hierarchy.
Variance This custom report contains any dimension in rows and Categories comparison in columns. It also features Variances calculation (both amount and percentage). With both YTD and Periodic boxes.
Comparative X This custom report contains any dimension in rows and Categories comparison in columns and also retrieves the Last Year same period data. With both YTD and Periodic boxes.
Comparison with 3–year
This custom report contains Year over Year comparisons.
Drill In Place This custom report performs drill in place.
Sort on Values or Sort on Members
This custom report contains data sorting by total value.
Nested Row This custom report allows any two dimensions to be nested in the rows and a third dimension in the column.
Drill Across Dimensions
This custom report allows you to drill from one dimension to another in the rows.
Dynamic schedules in Planning application
Template name
Description
Account-Trend or Entity-Trend
This schedule contains Account type members in Rows and Time periods in columns, using EVDRE based functions.
Entity-Trend This schedule contains Entity type members in Rows and Time periods in columns, using EVDRE based functions.
Consolidating This schedule contains Account type members in Rows and Entity type members in Columns, using EVDRE based functions.
Nested Row This schedule provides the ability to choose the dimensions and members on the Row, Column, and Page. Two Row dimensions can be selected and they will be nested. It uses EVDRE based functions.
Comparative This schedule contains Account type members in Rows and Category type members in columns with a variance column, using EVDRE based functions.
Dynamic reports in Rate application
Template name
Description
Nested Row This custom report allows any two dimensions to be nested in the rows and a third dimension in the column.
Any by Any This custom report contains any dimension in the rows and any dimension in the columns.
Dynamic schedules in Rate application
Template name
Description
Nested Row This schedule provides the ability to choose the dimensions and members on the Row, Column, and Page. Two Row dimensions can be selected and they will be nested.
Any by Any This schedule provides the ability to choose which dimensions are on the Row and Column.
ActivitiesOpen a report templateFrom Interface for Excel, select Reporting & Analysis from the Getting Started action pane. Select Build a report using a template, then select the desired template and choose Open.
Save a report locallyWe recommend that you save all report copies locally, so that you have instant access to the reports you need if you do not have access to the server.
From the report you want to save, select Save to My Reports folder. At the Lock down prompt, select Yes to lock down the current view, or select No if you want the report to continue to show live data. If you select Yes, then select a Park N Go option. For more information, see Park N Go. Enter a name for the report, then choose Save. The default folder is the Report folder on your local drive.
Save a report as a templateTo save a report as a template, from the report you want to save, select eTools > Save Template Library. Enter a name for the report template, then select Save. To make the template available for downloading to the Planning and Consolidation client on user machines, increment the template version number. You
can change the version number in the Admin Console, or from the Set application parameters page in the TemplateVersion field. See for more information.
Edit the template title and descriptionTo edit the title and description of the template in the language you require, open the Description.txt file located in the WebFolders directory. In the Description.txt file, the title and description are grouped by language. Between each group is a blank row. The languages must be enclosed in square brackets. After you modify the file, save it with Unicode encoding and close it.
If the application cannot find the entry in Description.txt for the language in which the application is installed, it displays the template title and description in the first available language in the Description.txt file.
NOTE
Only Administrators can modify the Description.txt file.
Retrieve information on current reportTo retrieve information (Server name, User name, AppSet name, Application name) for the current report, add the appropriate EvFunction. See the EvAPP, EvAST, EvSVR, and EvUSR functions for more information.
Application Set Management
An application set consists of one or more applications. An application set stores all the data from each application. Each application contains the master data that controls the data in the application set. Applications can share one or more dimensions with other applications within the set.
Features
Adding New Application Sets
Administrators create new application sets by copying information from the ApShell application set provided with Planning and Consolidation. See New Application Sets and Application Set Status.
Viewing Application Set Statistics (applicable only to the Microsoft version of the system)
You can view the following application set statistics by selecting Show application set statistics in the Manage Application Sets action pane:
Real time, short term, and long term application storage count
The storage count comes from the row count of each the table in the Microsoft SQL Server Management Studio.
Cube processing status Current application optimization status Dimension processing status
Setting the Application Set Status
The application set status determines when and how users can log on and interact with the data in Interface for Office. See Application Set Status.
Setting the Template Version
If you have made changes to any of the dynamic templates for reports or schedules, you can force an update of template files by changing the template version. Therefore, clients that log on to the application set receive the new templates. You can set the template version by selecting an application set in the Admin Console, choosing Set template version from the Manage Application Sets action pane, incrementing the version number by 1, then choosing Update Template Version.
Refreshing Client-side Dimension Files
You can use the Refresh client-side dimension files option to ensure the properties of your dimension files are current.
Viewing User Activity (Applicable only to the NetWeaver version of the system)
Planning and Consolidation logs user and administrator behavior by recording information about each remote function call made from .NET to ABAP. You can view activity logs from the Manage Application Sets action pane.
Using E-Mail Notifications
Administrators can use the e-mail notification service from the Administration Console and the Getting Started page of Interface for the Web. The e-mail notification service allows administrators to send e-mails to users or teams defined in the system.
The appropriate SMTP parameters must be set up correctly. See Application Set Parameters.
Deleting application sets
You can delete application sets in the Admin Console by selecting the application set name at the top of the tree, selecting one or more application sets in the Delete application sets action pane, then choosing Delete Selected Application Sets.
CAUTION
You can delete an application set when it contains data. You cannot, however, delete a dimension member when there is data associated to that member in an application.
Additional Information (applicable only for the NetWeaver platform)
The following information is important when managing application sets on the NetWeaver platform of the system:
An application set is equivalent to an InfoArea within NetWeaver with nearly all unique objects within this InfoArea.
No objects are shared across application sets, except delivered properties such as scaling, formula, and so on. An InfoArea is like a folder, where in the case of an application set, it is much more delineated.
You can transport application set changes between development and production environments. For more information, see the operations guide on SAP Service Marketplace at http://service.sap.com/instguidesEPM-BPC.
New Application Sets
You add new application sets to the system by copying information from the ApShell application set.
FeaturesYou can copy database records, Content Library data, Live Reports, and journals from the source application set. When using the Microsoft version of Planning and Consolidation, you can also copy business process flows. After the copying is complete, you can begin to modify the default applications, add new ones, and assign users to them.
When you create a new application set, Planning and Consolidation does the following:
Copies the application set WebFolders/data within File Service Creates a copy of all NetWeaver BI objects (in the NetWeaver system only) Copies all transactional and master data from the source application set to the new application set Copies security and Planning and Consolidation metadata
If the system encounters an error when copying an application set, it rolls back to clear the objects created during the failed copy.
You can modify the descriptive text associated with an application set. For example, you might want to change the description if you have made a significant change to the application set, such as adding a new application that performs new functions for your business. You change application set descriptions for a selected application set in the Administration main screen by choosing Application Set Tasks Add a new application set , then entering the new application set description.
ActivitiesYou add a application set by choosing Add a new application set in the Manage Application Sets action pane and entering the required data.
More InformationApShell Sample Application Set
ApShell Sample Application Set
You use the ApShell application set to build your own application sets.
Because it is a shell, it needs to be populated with publications and reports to become a fully functioning application set. ApShell does not contain any data except Time dimension information, and has only a limited amount of master data in the form of dimension members. The dimension master data is limited to default members in most dimensions so the application set works when an administrative task is run.
When you install a new version of Planning and Consolidation, ApShell and its components are overwritten.
CAUTION
You must not modify ApShell.
FeaturesApShell contains the following components needed to build a functioning application set:
Two sample applications — Planning and Rate — that contain most of the functionality you need to start building your own application set (see Planning Sample Application and Rate Sample Application).
If you need to build more complex application sets, for example, for legal reporting, consolidation, or ownership, you can build an application using the components included within ApShell.
A set of dynamic EvDRE-based report and input schedule templates (see Dynamic Report and Input Schedule Templates)
Data Manager packages Blank Content Library and Live reports Required administration setup parameters All required dimensions with the properties needed to create a basic planning and consolidation
application set
More InformationNew Application Sets
Application Set Management
Planning Sample Application
The Planning application is a multi-currency financial application. The Planning application is designed, by default, to accommodate currency translations. This means that the Rate application, which stores the
currency rates, is assigned to it as a supporting application. The combination of the two applications allows for the calculation of currency conversions.
FeaturesThe Planning application within ApShell contains the following dimensions:
P_DataSrc: the source of data, such as manual input or uploaded
Category: (category type) version of your data; secured dimension
P_Activity: (user type) enriches the activity types by adding appropriate members
P_ACCT: (account type) used for a list of planning accounts, account members, and member formula
P_CC: (entity type) holds the cost entities in a cost center planning scenario; should reference the input currency dimension
RptCurrency: (rate type) currency used for reporting
Time: (time type) used for storing time periods
NOTE
Planning is a financial-type application, so a currency-type dimension is required.
Default Application Parameters
The following are the default parameters and values within the sample Planning application:
Web Admin Parameter Default Value
DIMSFORFACTTBLINDEX N/A
JNR_ACCDETAIL_DIM N/A
JRN_BALANCE N/A
JRN_CLOSING_CODE N/A
JRN_DESC_MODE 0
JRN_IS_STAT_APP N/A
JRN_MAXCOUNT N/A
JRN_OPENING_CODE N/A
JRN_POST_OVERWRITE N/A
JRN_REOPEN N/A
JRN_REVSIGN_CODE N/A
JRN_VALIDATION_SP N/A
TOPDOWN N/A
WORKSTATUSVALIDATE N/A
YTDINPUT No
Web Admin Parameter Default Value
YTDInputTimeHir H1
Rate Sample Application
The Rate application contains currency translation rates.
FeaturesThe Rate application within ApShell contains the following dimensions:
R_ACCT: used for a list of planning accounts
R_ENTITY: defines your organizational structure; secured dimension
CATEGORY: version of your data; secured dimension
INPUTCURRENCY: currency used for planning
TIME: used for storing time periods
Default Application Parameters
The following are the default parameters and values within the sample Rate application:
Web Admin Parameter Default Value
CALCULATION 0
COMMENT Off
DIMSFORFACTTBLINDEX (for Microsoft version only) N/A
FXTRANS 0
INTCOBOOKINGS 0
OPENINGBALANCE 0
USELIM 0
WORKSTATUSVALIDATIONS N/A
YTDINPUT No
YTDInputTimeHir (for Microsoft version only) H1
Advanced rules
The ApShell Rate application has standard default advanced rules that calculate, divide, or multiply rates for currency translation, and requires the following:
The currency-type property must have a property named MD. The whole value is either M or D, which stands for Multiply currency and Divide currency. In the ApShell Rate application, the currency-type dimension is namedInputCurrency.
Dynamic Report and Input Schedule Templates
The system provides several templates within the sample application set, ApShell. You can choose the template you want to use, and then customize it to meet your needs.
Features You can save reports locally, or save them as a template on the server (if you have administrator
rights). If you modify an existing report template or create a custom report, you can save it as a template for future use. Only administrators with the appropriate rights can save templates on the server. However, you can modify a template and save it locally for your own use. You can edit the template title and description in the language you require.
NOTE If you make a change to an existing template and save it to the server, you should increment the
template version number so that the new template can be downloaded to all client machines that access the server. See Application Set Management.
NOTE To retrieve information on the Server name, User name, AppSet name and Application name for
the current report, you can add the appropriate EvFunction. The following tables describe the provided templates. Since administrators can save any report
as a template, your application set may contain a different set. Dynamic reports in Planning application
Template name Description
Subtotals by Accounts
This custom report contains Account dimension with subtotals in rows and any dimension across in columns.
Consolidating This custom report contains any dimension in rows and Entity type members across in columns with hierarchy.
Variance This custom report contains any dimension in rows and Categories comparison in columns. It also features Variances calculation (both amount and percentage). With both YTD and Periodic boxes.
Comparative X This custom report contains any dimension in rows and Categories comparison in columns and also retrieves the Last Year same period data. With both YTD and Periodic boxes.
Comparison with 3–year
This custom report contains Year over Year comparisons.
Drill In Place This custom report performs drill in place.
Sort on Values or Sort on Members
This custom report contains data sorting by total value.
Nested Row This custom report allows any two dimensions to be nested in the rows and a third dimension in the column.
Drill Across Dimensions
This custom report allows you to drill from one dimension to another in the rows.
Dynamic schedules in Planning application
Template name
Description
Account-Trend or Entity-Trend
This schedule contains Account type members in Rows and Time periods in columns, using EVDRE based functions.
Entity-Trend This schedule contains Entity type members in Rows and Time periods in columns, using EVDRE based functions.
Consolidating This schedule contains Account type members in Rows and Entity type members in Columns, using EVDRE based functions.
Nested Row This schedule provides the ability to choose the dimensions and members on the Row, Column, and Page. Two Row dimensions can be selected and they will be nested. It uses EVDRE based functions.
Comparative This schedule contains Account type members in Rows and Category type members in columns with a variance column, using EVDRE based functions.
Dynamic reports in Rate application
Template name
Description
Nested Row This custom report allows any two dimensions to be nested in the rows and a third dimension in the column.
Any by Any This custom report contains any dimension in the rows and any dimension in the columns.
Dynamic schedules in Rate application
Template name
Description
Nested Row This schedule provides the ability to choose the dimensions and members on the Row, Column, and Page. Two Row dimensions can be selected and they will be nested.
Any by Any This schedule provides the ability to choose which dimensions are on the Row and Column.
Activities Open a report template From Interface for Excel, select Reporting & Analysis from the Getting Started action pane.
Select Build a report using a template, then select the desired template and choose Open. Save a report locally We recommend that you save all report copies locally, so that you have instant access to the
reports you need if you do not have access to the server. From the report you want to save, select Save to My Reports folder. At the Lock down prompt,
select Yes to lock down the current view, or select No if you want the report to continue to show live data. If you select Yes, then select a Park N Go option. For more information, see Park N Go.
Enter a name for the report, then choose Save. The default folder is the Report folder on your local drive.
Save a report as a template To save a report as a template, from the report you want to save, select eTools > Save Template
Library. Enter a name for the report template, then selectSave. To make the template available for downloading to the Planning and Consolidation client on user machines, increment the template version number. You can change the version number in the Admin Console, or from the Set application parameters page in the TemplateVersion field. See for more information.
Edit the template title and description To edit the title and description of the template in the language you require, open
the Description.txt file located in the WebFolders directory. In theDescription.txt file, the title and description are grouped by language. Between each group is a blank row. The languages must be enclosed in square brackets. After you modify the file, save it with Unicode encoding and close it.
If the application cannot find the entry in Description.txt for the language in which the application is installed, it displays the template title and description in the first available language in the Description.txt file.
NOTE Only Administrators can modify the Description.txt file.
Retrieve information on current report To retrieve information (Server name, User name, AppSet name, Application name) for the
current report, add the appropriate EvFunction. See the EvAPP,EvAST, EvSVR, and EvUSR functions for more information.
Park N Go
You use this function to lock the current view in a report or input schedule, or both the current view and data, or to take the workbook offline.
FeaturesThe data and current view in a report or input schedule is live until you use one of these features from the Park N Go action pane:
You can lock the current view by choosing Set to live data and static current view. Locking the current view allows you to store the file on the server and share it with others who are authorized.
NOTE
The term 'static' indicates that a refresh does not update the current view or the data.
You can lock the current view and data by choosing Set to static data and static current view. You lock the current view and data when you want to protect the data in the report or input schedule from being refreshed.
In addition, you can use this function to take a report or input schedule completely offline and bring it back online. You can make changes to the report or input schedule when you are disconnected from the server, then bring it back online later.
You can take reports and input schedules offline by choosing Set to offline (no connectivity). When you want to send a report or input schedule to remote users, you can take the workbook offline. Remote users can look at published information and enter data in an offline workbook, but do not have authorization to update or view unpublished data. These users do not have access to Interface for Excel. After a workbook has been taken offline, you can bring it back to its live state when you want to work with it in Interface for Excel (as long as there are no significant changes to the format).
NOTE
When you set reports and input schedules to offline, the system changes the Ev functions so that you can open the workbook in native Excel. If you want to set the template to be live and send the data, do not change the format or formulas.
Activities To choose a Park N Go option, choose Park N Go from the Report State action pane, then select
one of the options described above. To restore a locked report or input schedule, choose Park N Go Set to Live to restore data
and live current view.
More InformationWorking Offline
Working Offline
You use this function to work with a report or input schedule in a disconnected state.
PrerequisitesBefore you can work with a workbook offline, the current view and data must be locked using the Park N Go feature. See Park N Go.
FeaturesWhen you work on the offline client, you can perform all your Excel tasks while disconnected from the system server, then bring the workbook back to its live state when you reestablish connectivity.
ActivitiesTo work on a report or input schedule offline, start Interface for Excel. From the Login page, select the Work Offline button. Open the desired report or input schedule, and modify the workbook as desired. When you are finished, save it.
EvAST The EvAST (Application set) function returns the name of the current application set.
SYNTAX1. EvAST()
EXAMPLE
EvAST( ) returns the name of the current application set.
EvAST The EvAST (Application set) function returns the name of the current application set.
SYNTAX1. EvAST()
EXAMPLE
EvAST( ) returns the name of the current application set.
The EvAST (Application set) function returns the name of the current application set.
SYNTAX1. EvAST()
EXAMPLE
EvAST( ) returns the name of the current application set.
The EvAST (Application set) function returns the name of the current application set.
SYNTAX1. EvAST()
EXAMPLE
EvAST( ) returns the name of the current application set.
EvSVR The EvSVR (Interface on the Web Server) function returns the name of the web server to which the user is connected.
SYNTAXEvSVR()
EXAMPLE
The following example returns Http://CorpServ01 if the current server is CorpServ01.EvSVR()
EvUSR The EvUSR (User ID) function returns the name of the user who is logged on to the system.
SYNTAXEvUSR
EXAMPLE
The following example returns JSmith, if Joe Smith is currently logged on to the system.EvUSR()
EvAPP The EvAPP (Application) function returns the current application name.
SYNTAX1. EvAPP()
EXAMPLE
EVAPP() returns Financial Consolidation, if the current view application is Financial Consolidation.
Application Set Management
An application set consists of one or more applications. An application set stores all the data from each application. Each application contains the master data that controls the data in the application set. Applications can share one or more dimensions with other applications within the set.
Features
Adding New Application Sets
Administrators create new application sets by copying information from the ApShell application set provided with Planning and Consolidation. See New Application Sets and Application Set Status.
Viewing Application Set Statistics (applicable only to the Microsoft version of the system)
You can view the following application set statistics by selecting Show application set statistics in the Manage Application Sets action pane:
Real time, short term, and long term application storage count
The storage count comes from the row count of each the table in the Microsoft SQL Server Management Studio.
Cube processing status Current application optimization status Dimension processing status
Setting the Application Set Status
The application set status determines when and how users can log on and interact with the data in Interface for Office. See Application Set Status.
Setting the Template Version
If you have made changes to any of the dynamic templates for reports or schedules, you can force an update of template files by changing the template version. Therefore, clients that log on to the application set receive the new templates. You can set the template version by selecting an application set in the Admin Console, choosing Set template version from the Manage Application Sets action pane, incrementing the version number by 1, then choosing Update Template Version.
Refreshing Client-side Dimension Files
You can use the Refresh client-side dimension files option to ensure the properties of your dimension files are current.
Viewing User Activity (Applicable only to the NetWeaver version of the system)
Planning and Consolidation logs user and administrator behavior by recording information about each remote function call made from .NET to ABAP. You can view activity logs from the Manage Application Sets action pane.
Using E-Mail Notifications
Administrators can use the e-mail notification service from the Administration Console and the Getting Started page of Interface for the Web. The e-mail notification service allows administrators to send e-mails to users or teams defined in the system.
The appropriate SMTP parameters must be set up correctly. See Application Set Parameters.
Deleting application sets
You can delete application sets in the Admin Console by selecting the application set name at the top of the tree, selecting one or more application sets in the Delete application sets action pane, then choosing Delete Selected Application Sets.
CAUTION
You can delete an application set when it contains data. You cannot, however, delete a dimension member when there is data associated to that member in an application.
Additional Information (applicable only for the NetWeaver platform)
The following information is important when managing application sets on the NetWeaver platform of the system:
An application set is equivalent to an InfoArea within NetWeaver with nearly all unique objects within this InfoArea.
No objects are shared across application sets, except delivered properties such as scaling, formula, and so on. An InfoArea is like a folder, where in the case of an application set, it is much more delineated.
You can transport application set changes between development and production environments. For more information, see the operations guide on SAP Service Marketplace athttp://service.sap.com/instguidesEPM-BPC.
Application Set Status
Application sets have a status of either Available or Not available. They have an available status until an administrator takes it offline, or a system function automatically takes it offline. If an application set is not available (or offline), users may be restricted from performing certain data retrieval and export tasks.
FeaturesIf using the Microsoft version of the system:
The following conditions determine who and when users can perform certain tasks when the application set is set to Not available:
Users have Offline Access task security:
When users attempt to log on to Interface for Office, the following prompt is displayed “Application set is unavailable. Do you want to continue?” A response of Yes allows them to log on. A response of No does not.
If RETRIEVE_ON_OFFLINE is set to 1 and users have the OfflineAccess task security assigned to them, the prompt “Application set is unavailable. Do you want to continue?” is displayed when they try to retrieve data. A response of Yes allows them to see data. A response of No does not allow them to see data.
When users do not have Offline Access task security:
When users attempt to log on to Interface for Office, the following prompt is displayed “The application is not available at this time. Contact your administrator.” Users cannot log on.
If the user is logged on when the administrator takes the application set offline and RETRIEVE_ON_OFFLINE is set to 1, the user cannot retrieve data.
NOTE
If RETRIEVE_ON_OFFLINE is set to 0, users cannot retrieve data while the system is offline, regardless of task security.
For information about tasks that open the prompt, see the RETRIEVE_ON_OFFLINE parameter in Application Set Parameters.
If using the NetWeaver version of the system:
When you attempt to log on to an application set that is unavailable, you receive a warning and can open the application set to work offline on parked or locked documents. You can also query the application information, but the data may not be completely accurate.
ActivitiesYou can manually set the status of an application set by doing one of the following:
Set to Not Available — Choose Set application set status Not Available Update Application Set Status .
You can enter informative text to display to users who try to perform a restricted task while the application set is unavailable. We recommend including the current date and time so that users can see that the message is current, and to give an estimated time when they can log back on again.
Set to Available — Choose Set application set status Available Update Application Set Status .
Change the AVAILABLE_FLAG on the Application Set Parameters page to 1 for Available and 2 for Unavailable.
More InformationApplication Set Management
Application Set Parameters
Application Set Parameters
Application set parameters allow you to customize your application sets.
PrerequisitesYou have Appset task security rights to view and change application set parameters.
FeaturesThe following table describes the parameters you can set from the Administration Configuration action pane.
The parameters that require a value include (R) in the Type column. Parameters that do not require a value include (O) in the Type column. If an application set parameter is required, you can leave it blank to accept the default, but if you delete the parameter, the system may not work correctly. If an application set parameter is optional, you can leave it blank or delete it.
Type Key ID Description
(O) for the Microsoft version
(R) for the NetWeaver version
ALLOW_FILE_SIZE The maximum file size the system permits users to upload. A warning message appears if the file size exceeds the parameter value when you upload a file. The default value is 100 MB.
This parameter is used in:
Interface for the Web - when posting documents in Content library menu
Interface for Office - sending data, journal posts, Data Manager imports, e-mail notification attachments
Type Key ID Description
(O) APPROVALSTATUSMAIL Defines whether owners and managers receive an e-mail when there is a change to an assigned work status.
Has the following possible values:
Yes: Send e-mail
No: Do not send e-mail
In the Microsoft version of Planning and Consolidation, the following SMTP application set parameters must be set up as well to use e-mail notifications in the system: SMTPAUTH, SMTPPASSWORD, SMTPPORT, SMTPSERVER, and SMTPUSER.
In the NetWeaver version of the system, the ABAP SMTP service is used for sending e-mails.
(O) APPROVALSTATUSMSG Allows you to define a custom e-mail message that is sent to the owners and managers of a work status when a work status code is changed. The message is applicable to all applications in the application set.
You can customize the message using the following variables:
%USER% — Name of user who changed this status
%STA% — Work status
%OWNER% — Entity owner (Microsoft version only)
%TIME% — Time of change
%REGION% - Lock region (NetWeaver version only) — For example: ENTITY: CG1, TIME: 2009.Q1, DATASRC: DC_1, PROJECT: PRJ_1, PRODUCT: PRO_1
EXAMPLE
You can create a message such as, This is to inform you that %USER% has updated the work status for %REGION% on %TIME%.
The text of the e-mail can be a maximum of 255 characters. There is no need for quotes or brackets around parameters.
(R) AVAILABLEFLAG Controls whether the system is offline or not. Yes means the system is online and available for sending data to the database. You can take the system offline by changing the value to No.
This parameter is used in Interface for Office - Send Data, Journal Posts, DM Imports
Type Key ID Description
(R) AVAILABLEMSG The message that displays to users who try to access an application that is offline (AVAILABLEFLAG = No).
The default value is “Current Appset status is available”
EXAMPLE
The message could be “The system is temporarily unavailable due to scheduled maintenance. Try again later.”
This parameter is used in Interface for Office - Send Data, Journal-post, DM-Import.
(R) AVAILABLEURL
(In NetWeaver version only)
The URL of the warning page that displays when a user attempts to access an application that is offline.
(O) BPFSTEP_COMPLETE_MSG
(In Microsoft version only)
Determines the content of the message that is displayed when a Business Process Flow step is completed.
The default message is:[%BPF_STEP_NAME%] step of [%BPF_NAME%] has been completed by %USER_NAME%.
This parameter is used in Admin console - Manage Business Process Flows.
(O) CLR_COMMENTS_HISTORY
Deletes the comment history except for the last comment entered.
Possible values for this parameter are:
0: This is the default value and saves the history of comments.
1: The historical comments are deleted and only the latest comments remain.
(O) COMMENT_MAX_LENGTH
(In Microsoft version only)
Customizes the length of comments. The default value is 256 and the maximum length is 4,000 characters.
NOTE
If you set a smaller value than current value, the newly entered value does not apply to comment length and the previous value still applies even though the setting is updated successfully in AppSet parameters page. Therefore, the new value should be larger than the previous value.
Type Key ID Description
(O) COMPANY_LOGO
(In Microsoft version only)
Use this parameter to add your corporate logo to the default templates in the interface for Excel. Enter the file name for the logo image that you want to display.
This image must be stored in the Application Set directory, which is "[Server Install]\Data\WebFolders\[Appset]".
EXAMPLEC:\Program Files\SAP BusinessObjects\PC_MS\Data\WebFolders\[Appset]
If the COMPANY_LOGO does not exist or the file name is invalid, the default globe image displays.
Allows the bmp, gif, and jpg image file types.
(O) DEFAULT_EXTENSIONS The system allows the default file type even if you do not set this parameter. The default file extensions are hard-coded internally.
The file extensions the system allows users to upload by default: .XLS, XLT, .DOC, .DOT, .PPT, .POT, .XML, .MHT, .MHTML, .HTM, .HTML, .XLSX, .XLSM, .XLSB, .ZIP, .PDF, .PPTX, .PPTM, .POTX, .POTM, .DOCX, .DOCM, .DOTX, .DOTM, .CDM, .TDM, .PNG, .GIF, .JPG, .CSS, .MRC. See ALLOWEXTENSIONS above.
The user can change the value.
This parameter is used in:
Interface for the Web - When posting documents in the Content library menu
Interface for Office - Send Data, Journal-post, DM-Import
(O) DTSSTATUSCHECK
(In Microsoft version only)
Use this parameter to hide or show the Refresh Status Every checkbox in the Data Manager Status View.
If the checkbox is enabled and large records exist, the performance when refreshing the status degrades. By hiding the checkbox, the refresh is performed whenever a user calls the refresh button manually.
Possible values for this parameter are:
0: Hides the checkbox
1: Show the checkbox
Type Key ID Description
(O) EVDRE_STYLES
(In Microsoft version only)
Use this parameter to specify a report or input template containing the default style sheet. If no style template is specified in the EVDRE builder in the Formatting section, then the default stylesheet is applied from the template specified in this parameter.
This allows users to customize their formatting and save the customization as the default style template. They do not have to manually reapply the template for each new report. Users can overwrite the default formatting for a given report or input template by using existing formatting options.
The priority of formatting for a new EVDRE report or input template is:
If a template is supplied in the Allow Formatting section, it is used.
Otherwise, the style template specified in the EVDRE_STYLES parameter is used.
Otherwise, the default EVDRE colors are used.
By default, this parameter is empty. Style templates that are used for EVDRE formatting can be stored in any folder in the file service. The full file service path must be specified in the parameter, starting with //root/ of the file service, so that one template can be used globally, regardless of the AppSet.
Changes to the style template specified in this parameter do not affect reports and schedules previously created from this template.
(O) EXECUTECUSTOMQUERY
(In Microsoft version only)
Set to Y to query the database using predefined SQL statements stored in the tblCustomQuery table.
Type Key ID Description
(R) FILESFOLDERDELIMITER
(In Microsoft version only)
When you create Web-ready files in Excel, the system creates subfolders based on the native Excel Save as HTML function. Since the naming rule of the subfolder is different for each Microsoft Office language, this parameter allows the system to find the subfolder having the defined delimiter when selecting Web-ready files in Interface for the Web. (Required)
The default value is _:.:-. You must define a value for this parameter if the value is empty, or does not contain the required delimiter for your Microsoft Office version. Separate multiple delimiters with a colon; for example, :,:_.
EXAMPLE
For example, under a folder named 'Report.htm', the system creates the following subfolders:
Chinese: report.file
English: report_files
French: report_fichiers
German: report-Dateien
Italian: report-file
Japanese: report.files
Korean: report.files
The user can define this delimiter depending on their country. Use “:” to separate multiple values.
This parameter is used in Interface for Office - book publishing.
(O) JREPORTZOOM This parameter allows you to set the default zoom magnification value on HTML journal reports.
We recommend that you set the value to 75%.
(O) LANDINGPAGEITEM This parameter allows you to set up a web page as your home page for the Web interface. Once you set this, this page displays for all users of this application set. The page must first exist as a Web page in Interface for the Web. (See Creating a Web Page.)
The default value is 1. or you can enter the number that represents the web page you want to make your home page.
(O) LIMITOFDIFFERENCE
(In Microsoft version only)
The least value for which the system processes logic. If a data value is smaller than this value, they system does not process the logic. For example, when you set 0.001, smaller data values, such as 0.0009, are not processed by logic.
The default value is .00000001, so if the parameter is not set, logic ignores less than 0.00000001.
This parameter is used in Script Logic - Processing of script logic.
Type Key ID Description
(O) LOGLEVEL
(In NetWeaver version only)
Controls the minimum level of ABAP messages to store in the log in terms of severity, which you view by the transaction SLG1.
The default value for this parameter is Info.
The possible values for this parameter are:
Donothing
Info
Warning
Error
Fatal
(O) LOGLEVEL
(In Microsoft version only)
This parameter controls the severity level of messages to store in the log file.
The default value for this parameter is Info.
The possible values for this parameter are:
None
Info
Warning
Error
Fatal
(O) LOPTZ_AVAILABLE This parameter takes the system offline during a minimal optimization of an application.
The default value for this parameter is: 0.
The possible values for this parameter are:
0 – do not change to offline
1 – change to offline
This parameter is used in Admin - Lite optimize.
(O) MAXLRCOLUMNS The maximum number of columns to display in a live report in Interface for the Web. The value includes header and data columns.
The default value is 30.
EXAMPLE
If you specify a value of 5, one heading column and four data columns are displayed.
(O) MAXLRROWS The maximum number of rows to display in a live report in Interface for the Web.
The default value is 50. and the value includes both header and data rows.
EXAMPLE
If you specify a value of 5, one heading row and four data rows are displayed.
Type Key ID Description
(O) MSNIMPASSWORD The password that the system uses to operate Instant Message alerts in Insight.
The default value is blank.
This parameter is used in Insight - Alert.
(O) MSNIMUSER The user name that the system uses to operate Instant Message alerts in Insight.
The default value is blank.
This parameter is used in Insight — Alert.
(O) MULTIBYTE_FORMULA
(In Microsoft version only)
Use this parameter to support dimension formulas with member IDs that contain double-byte characters, such as those in Japanese, Chinese, Korean, and Russian.
The value defines the dimension formula column type as Nvarchar or Varchar.
The default value is blank. Possible values are:
1 – Dimension formula column is nvarchar instead of varchar to support double-byte characters.
N/A or blank or 0 - Dimension formula column is varchar.
This parameter is used in Admin - Process dimension.
(O) RETRIEVE_ON_OFFLINE
(In Microsoft version only)
Use this parameter to restrict data retrieval and export while an application set is unavailable (system offline).
The options are:
0: Does not allow retrieving or exporting data while an application set is unavailable regardless of OfflineAccess task security.
1 (default): Allows retrieving or exporting data while an application set is unavailable (system offline) if the user has OfflineAccess task security.
:
The following tasks are exceptions to rule, and can be executed when the value is 0:
Execute logic (script, business rules) from DM packages
Run Export from fact table package
Run Append into Fact Table package
Add new comments
Save data through DHE (Dynamic Hierarchy Editor)
This parameter is used in all functions that retrieve or export data. For example: Refresh data in Interface for Office and Interface for the Web, Export DM package, Book Publish, and so on.
Type Key ID Description
(O) RUNPKGBYEXE
(In Microsoft version only)
Allows for the use of an .EXE file type wrapper for running a package out of process from COM+.
The options are:
0: Run in process
1 (default): Run out of process
(O) SESSIONTIME Defines the session time (in minutes) for the Who’s Online feature.
The default value is 3000 minutes.
(R) SMTPAUTH
(In Microsoft version only)
The authentication method of the SMTP server.
This setting does not change the method on the SMTP server, but must match the type of authentication enabled on it. Failure to set this appropriately can result in errors from the e-mail server.
The default value is: 1.
Possible values for this parameter are:
0 = Anonymous
1 = Basic
2 = NTLM
This parameter is used in:
Interface for the Web - When posting documents, Work status, Alert
Interface for Office - Offline distributor
(O) SMTPPASSWORD
(In Microsoft version only)
The password for the user name defined as the SMTPUSER.
This parameter is Optional except when SMTPAUTH is “1” (basic), this parameter is Required
The default value is blank.
The user can input
Creating a Web Page
Procedure1. Select Add a New Web Page from the Content Library Options action pane.2. Enter a page name, select a template layout from the list, and select the object type you want to
add.3. Enter a title for the object and the objects pixel height.4. If the object is a web site, the only setting required is the name of the URL. Otherwise, choose the
desired options for your chosen object type.5. Continue adding more objects to the page, or select one of the options:
Modify the object — You can make additional changes to the page. Set Team Access to the page — You can determine the teams or users who can access a
page. Select the teams and/or users to which to grant access. To view the finished web page, choose Save.
Preview the output — Display the page. Save and view the output — Save and display the page.
ResultOnce the page is open, you can add and view comments, modify the contents of the page, or delete the page.
EvDRE Builder
This function allows you to quickly create a report by selecting the dimensions you want in the columns and rows, as well as a few more report details.
FeaturesA default report contains one expansion on the columns using the Time dimension, one expansion on the rows using the Account dimension, and the MemberSet Dep.
You can use the following options for modifying the default report:
Screen Element
Description
Available dimensions
Lists the dimensions that are available in the active application. You can select one or more dimensions and place them on the In columns and In rows fields using the arrow icons.
In columns Lists the dimensions that are placed in the column axis of the report. Use the up and down arrows to change the nesting order.
In rows Lists the dimensions that are placed in the row axis of the report. Use the up and down arrows to change the nesting order.
Spread across worksheets
Lists the dimension that has its members enumerated across the worksheets. See Expansion Across Sheets.
Member selection
Displays the memberset for the dimensions.
See Edit Membersets in Drag and Drop Reporting.
Enable Expand Range
Select to generate an Expand range parameter.
See Expand Range Parameter.
Enable Options Range
Select to generate an Options range.
An Option Range is a range of cells in which you can define your EvDRE options. Alternatively, you can enumerate the options in a comma-delimited list in the Options field.
See EvDRE Options for the Microsoft version or EvDRE Options for the SAP NetWeaver version.
Enable Formatting Range
Select to generate a Formatting range. If not selected, you can still define a format range, but you must do it manually.
If selected, you can keep the default format (the standard report colors or the style template defined by the administrator in the EvDRE_STYLES application set parameter), or import the style from a predefined workbook (either local or server-based).
See Style Imports and Format Ranges.
Screen Element
Description
Enable Sorting Parameter
Select to generate a Sorting parameter.
You can have the system automatically insert a break total into the worksheet, and choose to display the values in descending order.
See EvDRE Sorting Range.
More InformationStyle Imports
Expansion Across Sheets
When creating an EvDRE report using the EvDRE Builder, you can choose to expand a member set across sheets.
Features The expansion replicates the sheet defining the expansion in several sheets (one sheet per
expanded member), generating a book of reports for the desired set of members.
The generated sheets are named after the member being expanded in the sheet.
The page key defining the page member of the sheet dimension also contains the hard coded ID of the current member.
Each of the resulting tabs contains a replica of the starting EVDRE function, where the chosen dimension's member specified in the PAGEKEY is the (hard-coded) member ID associated with the current sheet.
The starting sheet defining the expansion is the first sheet of the expanded set. The starting sheet also has the chosen dimension's ID hard-coded in the page key, even if it initially contained a reference to the current view (by the use of EvCVW, for example).
The member set defining the sheet expansion cannot be specified as relative to the content of the page key (because it becomes hard-coded).
Otherwise, the workbook is not reusable for further expansions on different current views (of the dimension expanded in the sheets).
The member set of the sheet expansion can be either self-defined or you can relate it to what is defined in the current view bar by pointing to another cell in the sheet.
When you perform an expansion across sheets, the following restrictions apply:
There must be only one EvDRE function in the sheet defining the expansion
You can expand only one dimension across sheets (no nested sheet expansions)
The BeforeRange and the AfterRange parameters for the sheet expansion are ignored
The system ignores the Insert parameter for the sheet expansion.
ActivitiesTo expand a memberset across sheets, use the EvDRE Builder to create a report. From the Spread across worksheets field, select the desired dimension.
ExampleThe following is the result of a 3D expansion performed on Entity SalesEurope:
App: FINANCE
ACCOUNT NetIncome Net Income
CATEGORY ACTUAL Actual from GL
DATASRC Input Input
ENTITY SALESEUROPE
Sales Europe
INTCO Non_InterCo Non-Inter-company
MEASURES PERIODIC Periodic
RPTCURRENCY EUR EURO
TIME 2008.Q1 2008.Q1
2008.Q1 2008.JAN 2008.FEB 2008.MAR
2008.Q1 2008.JAN 2008.FEB 2008.MAR
NETINCOME Net income 743,805,521.18 249,706,192.55
257,354,085.87
236,745,242.75
PRETAXINCOME
Pretax Income 831,842,995.34 277,819,708.17
285,889,304.22
268,133,982.95
TAXES Taxes 88,037,474.18 28,113,515.63 28,535,218.36 31,388,740.20
Drag and Drop Reporting
Drag and drop reporting provides an alternative method for creating reports. You use the action pane to design the report structures and contents. The resulting report is based on EvDRE, so after you create the report you can modify it using the drag and drop reporting interface or the EvDRE control panel.
NOTE
We recommend that you use EvDRE Builder to use more advanced features, such as the following:
Options and Format ranges
Advanced sorting options
Expand by sheet function
Multiple EvDRE tables per sheet
By default, drag and drop reporting does not support these features.
FeaturesYou can use the following screen elements to design your report:
Screen element Description
Start Designing Select this screen element to choose the desired dimensions, members, and other options for the columns and rows.
Dimensions list in Design Options action pane
Drag any available dimension name to either the column or row area. The system nests the dimension if one already exists on the column or row.
Include description Select this element to include the dimension description in the grid.
Edit MemberSets Choose the dimension for which you want to define members, then select options from the following list:
Add Member Lists
To define the members for the dimension, use Member Lookup.
Add Member Selection Rules
Choose from the following expansion options:
SELF: only the selected members
ALL: the selected members and dependents
BAS: base level of only selected members
DEP: only dependents of the selected members
BASEMEMBERS: all base members for the dimension
MEMBERS: all dimension members
NOEXPAND: only the selected members with no expansion options
Clear MemberSet
Clears the members and starts over.
Set Options Allows you to apply special formatting options to this data grid. For more information, see one of the following:
For the Microsoft version, see EvDRE Options.
For the SAP NetWeaver version, see EvDRE Options
ActivitiesTo create a report using drag and drop, follow these steps:
1. Select Reporting & Analysis from the Getting Started action pane in Interface for Excel.
2. Select Build a report using drag & drop.
3. Drag the Data Grid object to a cell in the top-left corner of an EvDRE data grid, then use the screen elements listed above to define the report.
4. Click the check box until you return to the Report State action pane, then select Save to My Reports folder.
To remove a dimension, choose Edit report using drag and drop - Start designing in the action pane. Then, select the dimension cell and drag it out of the key range.
More InformationEditing Reports and Input Schedules
EvDRE
EvDRE Builder
Member Lookup
EvDRE Options
You can define any of the following options in the key range parameter to customize your EvDRE data.
FeaturesYou can use the following methods for entering EvDRE options:
You can enter the appropriate keywords in the Options cell of the KeyRange.
The Options cell (which can also be named OptionRange), may contain an EvRNG function pointing to a range of cells listing valid options. This range is the default, if you select the Allow options box in EvDRE Builder. The first column in the range must contain a valid option keyword. The second column activates the corresponding option with a Y value, or with a numeric value.
A list of options is below with a description of each; the keywords are NOT case sensitive.
Option Description
ApplyColumnAbove Applies the colors and formulas in the Before/AfterRange to the column.
AutofitCol Automatically adjusts the size of the columns containing the EvDRE ranges to fit the content after refreshing data.
Bottom n Shows only the specified number (n) of the lowest values in the entire data range.
DumpDataCache The content of the data cache is written in the log file EvDre_log.txt.
ExpandOnly Disables the refresh action and performs only an expansion, when requested. The system does not retrieve data from the database.
GroupExpansion When you expand a report using the Groups dimension, which is used to identify consolidation sequences.
HideColKeys and HideRowKeys Hides the corresponding key ranges.
NoRefresh Prevents the system from refreshing data from the database
NoSend Prevents the system from sending data to the database.
PctInput Enforces a different percentage of input data to trigger SQL queries (default is 20%)
QueryEngine Manual (or blank for Automatic)
QueryType NEXJ,TUPLE (or blank for Automatic)
QueryViewName Use a user-defined view for querying SQL data
Option Description
ShowComments Add an Excel comment in any DataRange cell with a formula, if the value retrieved from the database differs from the one displayed by the formula.
ShowNullAsZero All empty cells in the data range are filled with zeros.
SortCol Sorts a given column.
SQLOnly Forces the query engine to only issue SQL queries
SumParent Inserts new rows with subtotals.
SuppressDataRow andSuppressDataCol
Performs a suppression on the defined data range directly in Excel.
SuppressNodata Prevent the suppression of zero values. Only missing (no data) values are suppressed. Otherwise, both zeros and missing data are suppressed.
Top n Shows only the specified number (n) of highest values in the entire data range.
ActivitiesTo define options, follow these steps:
1. Open an EvDRE report or input schedule.
2. In the Options cell of the Key range parameter table, enter the desired options.
When you enter more than one, use a comma as the delimiter. For example, you can enter SumParent, AutoFitCol, NoSend.
3. Choose the Expand All button and save the report or input schedule.
NOTE
The first column in the range must contain a valid option keyword. The second column activates the corresponding option with a Yes value, or with a numeric value, where appropriate.
EvDRE Options
You can define any of the following options in the key range parameter to customize your EvDRE data.
FeaturesYou can use the following methods for entering EvDRE options:
You can enter the appropriate keywords in the Options cell of the KeyRange.
The Options cell (which can also be named OptionRange), may contain an EvRNG function pointing to a range of cells listing valid options. This range is the default, if you select the Allow options box in EvDRE Builder. The first column in the range must contain a valid option keyword. The second column activates the corresponding option with a Y value, or with a numeric value.
A list of options is below with a description of each; the keywords are NOT case sensitive.
Option Description
AutofitCol Automatically adjusts the size of the columns containing the EvDRE ranges to fit the content after refreshing data.
Bottom Shows only the specified number (n) of the lowest values in the entire data range.
DumpDataCache The content of the data cache is written in the log file EvDre_log.txt.
ExpandOnly Disables the refresh action and performs only an expansion, when requested. The system does not retrieve data from the database.
HideColKeys and HideRowKeys Hides the corresponding key ranges.
NoRefresh Prevents the system from refreshing data from the database
NoSend Prevents the system from sending data to the database.
ShowComments Add an Excel comment in any DataRange cell with a formula, if the value retrieved from the database differs from the one displayed by the formula.
ShowNullAsZero All empty cells in the data range are filled with zeros.
SortCol Sorts a given column.
SumParent Inserts new rows with subtotals.
SuppressDataRow andSuppressDataCol
Performs a suppression on the defined data range directly in Excel.
SuppressNodata Prevent the suppression of zero values. Only missing (no data) values are suppressed. Otherwise, both zeros and missing data are suppressed.
Top Shows only the specified number (n) of highest values in the entire data range.
ActivitiesTo define options, follow these steps:
1. Open an EvDRE report or input schedule.
2. In the Options cell of the Key range parameter table, enter the desired option(s).
When you enter more than one, use a comma as the delimiter. For example, you can enter SumParent, AutoFitCol, NoSend.
3. Choose the Expand All button and save the report or input schedule.
NOTE
The first column in the range must contain a valid option keyword. The second column activates the corresponding option with a Yes value, or with a numeric value, where appropriate.
Editing Reports and Input Schedules
ProcedureTo make changes to an existing report or input schedule, take the following steps:
1. Select Reporting & Analysis (to edit a report) or Data Input (to edit an input schedule) from the Getting Started – Interface for Excel action pane.
2. To edit a report stored on the server, choose Open an existing report (schedule) or for a local report, choose Open an existing report (schedule) from My Reports (Schedules) folder.
3. Select the name of the report or input schedule from the dialog box, then choose Open.4. Select Edit report using drag & drop from the Report Tasks section of the action pane.5. If there are multiple EvDRE grids on the report, select Search from the Drag & Drop Options action
pane, and double-click the sheet or address for the EvDRE report you want to modify, then choose the Check pushbutton.
6. To modify the report or input schedule, select Start designing in the Drag & Drop Options action pane. See Drag and Drop Reporting.
EvDRE
You use the EvDRE (Data Range Exchange) function to generate Planning and Consolidation reports and input schedules.
FeaturesThe flexible EvDRE function provides the following features:
You can use EvDRE to create large reports or input schedules with optimal performance.
By accepting cell ranges as parameters, EvDRE workbooks are faster to download and upload because there are no send or retrieve functions in the data cells.
EvDRE is bidirectional; it can both send and retrieve data. It combines and extends the functionality of other Planning and Consolidation functions such asEvGET and EvSND. EvDRE is faster than these functions because it does not evaluate each cell.
You can use EvDRE to build static workbooks (without expansions) as well as dynamic workbooks (with expansions), or workbooks where some dimensions are defined using static members while others dynamically expand.
You can define one or more expansions on the rows, columns, or both simultaneously. Workbook options determine how EvDRE sends data. If the workbook option Type is set to Report,
you cannot send data; if the option is set to Input Schedule, the template can retrieve and send data. See Workbook Options.
For the Microsoft version only, you can create a new style template from an active EvDRE workbook. The following commands are available from the eToolsmenu:
Open EvDRE default Styles. You select this menu option to open the default style template. You can edit it, and then use Save EvDRE Default Stylesto save it.
Save EvDRE default Styles. You select this menu option to save the current formatting as a style template.
After defining the template, you can go to Application Set Parameters to define it as the default template for all users creating EvDRE workbooks. After a default template is defined there, changes saved to that template are automatically applied to newly created EvDRE workbooks (that is, there is no need to reset the application set parameter). Changes to a style template do not
affect workbooks previously created from the same template. You can define one default style template for each application set. For more information, see Application Set Parameters.
ActivitiesTo create an EvDRE report, use EvDRE Builder or the Drag and Drop Reporting feature.
Workbook Options
You use this function to set behavior options in an active report or input schedule.
FeaturesThe system determines default workbook option settings depending on whether a report or input schedule is active. You can change any of the following options:
Option Description
Type Options are Report and Input Schedule.
The refresh options provide default selections to optimize the workbook performance. After setting the type, you can further customize the refresh options to suit your needs.
Refresh and expansion
When you refresh a workbook, the system goes to the server and returns data values for the cells whose retrieval formulas are affected.
When you expand a workbook, the expansion functions dynamically expand dimensional data.
All refresh and expansion options for both reports and input schedules are enabled by default except for Refresh by sheet.
Refresh workbook on worksheet update: The system automatically performs a refresh when a change is made to an affected data cell.
Refresh after data send: The system automatically performs a refresh after data is sent to the database. If not selected, you can perform a manual refresh by selecting eTools Refresh .
Expand on workbook open: The system automatically expands the expansion functions when the workbook opens. If you do not select it, you can perform a manual expansion by selecting eTools Expand All .
Expand on CurrentView change: The system automatically expands the expansion functions when the current view is changed. (SeeDynamic Expansion.)
If not selected, you can perform a manual expansion by selecting eTools Expand All .
Refresh by sheet: When you tab from one worksheet to another in an EvDRE report, select this option to refresh each worksheet individually. Unopened worksheets are not refreshed.
Allow users to change options
If you select this, users, who are not administrators, can set workbook options on a workbook. If you leave it blank, only administrators can change these options. By default, this check box is selected.
Option Description
Drill-down This option controls member expansion behavior in the active spreadsheet. You can use Expand by Overwriting Rows or Expand by Inserting Rows. When you select Expand by Overwriting Rows, the expanded members display in the rows below the expanded member, clearing existing members. When you select Expand by Inserting Rows, any rows below the expanded member shift down, and new rows are inserted to accommodate the newly displayed members.
Set maximum expansion
For performance purposes, there is a maximum number of rows and columns to return when the row or column in the report or input schedule dynamically expands.
For Microsoft Excel, the maximum number of rows is 65,535 and the maximum number of columns is 255. However, for a file format of Excel 12 (Excel 2007) html, xml workbook or template, the maximum number of rows is 1,048,575 and the maximum number of columns is 16,383.
Override current view settings
When you open a Planning and Consolidation report or input schedule in Interface for Office or Interface for the Web, the data changes based on your current view. If you want an active workbook to always open to specific members, you can override one or more of the current view members.
To override current view settings, enter some data in two columns (for member names and values) of an empty cell on the workbook. Enter the names and values of the members you want to hard code. Select eTools Workbook Options , then select the two-column range of cells that represents the current view settings, and then choose Add. Choose the Remove button to remove the range.
NOTE
The Override applies only to non EvDRE templates. It points to the control panel to control non-specified EvGET/EvGTSdefinitions. If you define a row/column, you can override only the dimensions for the page keys because the EvGET refers specifically to the row/column member ID.
Save the session CV with the workbook
This option allows you to save the active current view with the workbook when you have multiple reports open for which you want to see different current views. Rather than use the active session current view for all three reports, you select, then save the desired current view with each workbook. When you switch between the reports, a unique current view is used for each.
Set worksheet password
You can set a Planning and Consolidation password on the workbook. A Planning and Consolidation password is required when the report or input schedule is distributed or collected using the Offline Distribution Wizard.
The password is different from native Excel's workbook password. If you use the Excel password to secure a workbook, Planning and Consolidation expansions may not work properly. To set the password, select eTools Workbook Options from the Excel interface.
Lock status The Workbook Options dialog shows whether the current workbook is locked or unlocked. You can lock the report or input schedule using thePark N Go feature.
Read options for comment
This field is used for cell-based comments. If an EvCOM function returns a specific comment value, you can have it displayed as text in the cell or in a Microsoft Excel comment dialog box.
ActivitiesTo set workbook options, open the workbook for which you want to set the options and choose Set workbook options from the action pane.
More InformationExpansion Functions
VBA Workbook Options
Dynamic Expansion
You use this function to dynamically change the members displayed in a report, based on any number of criteria.
Dynamic expansion utilizes Planning and Consolidation functions. The expansion functions are: EvEXP EvNXP
FeaturesDynamic expansion has the following features:
The system detects when a new dimension member is added to the application. When you use expansion formulas in your reports and input schedules, the new member is automatically displayed when you select a dynamic expansion formula that calls for the member (provided you have updated your dimensions from the server; for more information, see Client Options).
You can set dynamic expansion to automatically expand each time the current view is changed in a report or input schedule.
ActivitiesTo set dynamic expansion, open the report or input schedule for which you want to enable automatic dynamic expansion and from the action pane choose Set workbook options Expand on CurrentView change .
ExampleWith dynamic expansion you can do much of your analysis in one report. By just changing the current view of the expansion member you can yield a new set of data. For example, say you have a report with Accounts in the rows. The expansion in this report is based on the AccountType property of the current Account member. The current account is Revenue, which is an income account; therefore, the system returns all accounts with theAccountType INC in the report body. If you change the current account member to Salaries, which is an Expense account, the members displayed in the report body change to expense account.
More InformationExpansion Functions
Client Options
Client options are available for maintenance purposes.
FeaturesYou can perform the following tasks for client maintenance:
Reset the Current View Bar
You can reset the current view bar so that for each dimension, the top hierarchical level member displays, which also clears the list of recently accessed members. You reset the current view bar within Interface for Excel by choosing eTools Client Options Clear current view bar .
Clear Local Application Information
You can clear the files associated with an application from your client. After you perform this procedure, the next time you log on to this Interface for Excel application, you are prompted to complete the Connection Wizard, which allows you to select a server and any authorized application sets. You can clear the files associated with an application from your client by choosing within Interface for Excel eTools Client Options Clear Local Application Information .
Refresh Dimensions
When you log on to an application set whose structure has changed (there are changes to dimensions and templates stored on the server), the system automatically updates your client information. You can also initiate this procedure manually, which you should do only when instructed by your administrator. You can refresh the dimension information on your client with the dimension and member information saved on the server by choosing within Interface for Excel eTools Refresh dimension members .
Refreshing Templates
You can update the wizard templates on your client with the templates saved on the server by choosing within Interface for Excel eTools Client Options Refresh Dynamic Templates .
Set Local Folder for Clients
You can set a user-defined working folder on each client machine by choosing within Interface for Excel eTools Client Options Set local folder for Planning and Consolidation . The default working folder is the My Documents folder of a user.
Member Lookup
You can set options that control behavior on the Member Lookup dialog box (see Member Lookup).
Member Lookup
You use this function to select specific members to use in reports, input schedules, journals, member security definitions, and data management packages.
In addition, from Interface for Excel, you can use it to copy and paste member lists into spreadsheets.
FeaturesYou can use the following features when using Member Lookup, some of which are available only when performing certain tasks within the system:
Feature Description
Select members
You can select members at any time to display in your report or input schedule. You can select only the dimensions and members to which you have access.
To select a member, do one of the following:
Highlight that member and click OK.
Right-click the member and choose an option:
Select sibling members of the current member
Select all children of the current member
Unselect sibling members of the current member
Unselect all children of the current member
Populate all children of the current member
If a section is disabled, all members in the dimension are selected, and all members are returned to the report or input schedule upon clicking OK.
You can select the checkbox next to one or more members to copy them to the active spreadsheet.
Feature Description
Filter members You can filter the member list based on member properties as well as hierarchy.
You select a property, an operator, and a value, then click Refresh to apply your changes to the current list.
You can specify a filter on one or more properties. If you define a filter, the members can only be displayed in Table data view (not hierarchical).
When filtering by properties, the following options are available:
= Equal
< > Not equal
LIKE — A pattern match that supports using an asterisk ( * ) before or after the value
BT — A range between a low and high value
If you set selections with the same property, the logic operator between each selection is OR. If you set selections with different properties, the logic operator between each selection is AND.
For example, when you set the following selections:Attr1 = 1
Attr1 bt 3 to 7
Attr2 <> 10
The filter is ((Attr1 = 1 or (Attr1 >=3 and Attr1 <=7)) and Attr2 <> 10).
The logic operator for hierarchy selections is OR.
For example:2006.JAN SELF
2005.TOTAL BAS
The filter is (SELF(2006.JAN) or BAS(2005.TOTAL)).
The logic operator between Hierarchy selections and Attribute selections is AND.
For example:Attr1 = 1
Attr1 bt 3 to 7
Attr2 <> 10
2006.JAN SELF
y2005.TOTAL BAS
The filter is ((Attr1 = 1 or (Attr1 >=3 and Attr1 <=7)) and Attr2 <> 10) or (SELF(2006.JAN) or BAS(2005.TOTAL)).
You can filter by hierarchy in Data Manager. The following information applies:
You can use the following filter options:
SELF — the value itself
DEP — direct children of the value
BAS — all the base members of the value’s children
ALL — all the children of the value
You can save and modify filters using Maintain Filter. You can use the saved filters when selecting members for Data Manager packages.
You can choose whether to return the members or filter to Data Manager by choosing Return By.
Feature Description
View member properties or attributes
You can view the property values and attributes of a selected member. Members that are available for use when creating and modifying reports or input schedules are enabled. Properties that are for information purposes only are disabled.
You can view a member's properties by opening the Member Lookup, then doing one of the following:
Right-click the desired member, then select Member properties.
Click the Show selected member properties link.
After reviewing the list, click OK to close the Properties dialog box.
Set Member Lookup options
You can set options that control behavior on the Member Lookup dialog box.
To access the Member Lookup Options dialog box, open the Member Lookup, then select the Options button.
In the Double-click Options section, select the checkbox if you want to select the member and return to the worksheet by double-clicking a member. This option closes the Member Lookup and returns to the active report or input schedule. If unselected, a double-click expands or collapses the member when double-clicked. This option keeps the Member Lookup open.
The Select All Children Behavior section determines how members are selected when you use the Copy option to copy one or more members and paste them into your spreadsheet. See Copy and Paste Member Lists, below.
Do one of the following:
Select Select direct children only to only copy the members directly below the selected member.
Select Select all descendents to copy all descendents of the selected member.
Copy and Paste Member Lists
You can copy members from Member Lookup and paste them into a spreadsheet. You can use this feature to create journal entries, reports, or input schedules.
You can copy and paste a member list by doing the following:
1. Open the report, input schedule, or journal template from the Excel interface. Open Member Lookup for the applicable dimension.
2. Select a member or choose Select sibling members for the selected member.
3. Select the rows and columns in which to place the members. Choose the Copy Members button, then in the Copy Members dialog box, select in rows to place the members in the rows, or select in columns to place the members on the columns.
4. Select the first cell in which you want to place the members. Select Edit Paste to paste the members.
Feature Description
Select Members from Dynamic Hierarchy
You can select members from Dynamic Hierarchy if Dynamic Hierarchy is available. The Dynamic Hierarchy option is available only for the entity type and group type dimensions, or the currency type dimension if the group Members are included in the currency type dimension, in a consolidation application, and a dynamic hierarchy is built and stored in the ownership application.
You can select only the dimensions and members to which you have access. With the Dynamic Hierarchy option, the Entity and Group (or Currency) dimension hierarchies are dynamically displayed according to the consolidation hierarchy that was built for the time and category member selected in the current view.
To select a member from Dynamic Hierarchy, do one of the following:
Select a group member from the dynamic hierarchy if the group (or currency) dimension member selector is open, or select an entity member from the dynamic hierarchy if the entity dimension member selector is launched.
Highlight that member and click OK.
Right-click the member and choose an option:
Select sibling members of the current member
Select all children of the current member
Unselect sibling members of the current member
Unselect all children of the current member
Populate all children of the current member
If a section is disabled, all members in the dimension are selected, and all members are returned to the report or input schedule upon clicking OK.
If a dimension does not have a dynamic hierarchy, the dynamic hierarchy option is unavailable. You can select the checkbox next to one or more members to copy them to the active spreadsheet.
The Dynamic Hierarchy option is available only in the Excel client, specifically in the action pane, EVDRE report, EVCVW function, and in the embedded Excel object in the Office client. Its availability also depends on ownership transaction data.
ActivitiesTo access the Member Lookup, do one of the following:
Choose a dimension member from the Session Information section of the action pane, select the down arrow next to a dimension, then select more.
From the eTools menu, select Select Members, then select the dimension whose members you want to view.
Right-click any cell in a workbook and select Select Members, then select the dimension whose members you want to view.
Run Data Manager packages for which you need to select members.
When selecting members, be aware that using the operator Between functions as expected for all types of dimensions except for Time. Between is a string comparison, and therefore does not take into account the concept of time. For example, if you want to select all members under 2005.TOTAL and 2006.TOTAL, setting up ID BT 2005.TOTAL to 2006.TOTAL would be incorrect because the string 2005.Q1 does not fall between 2005.TOTAL and2006.TOTAL. 2005.Q1 would not be selected.
More InformationReports and Input Schedules
Data Management for the NetWeaver platform or Data Management for the Microsoft platform
Journals
Reports and Input Schedules
Reports
With Planning and Consolidation reporting, you can retrieve requested data from the database into an Excel interface. You can analyze your multidimensional data using the current view, which is available on the action pane. The system provides a variety of report templates to which you can add common formulas to design your own reports.
Input Schedules
Input schedules allow you to send data directly from your spreadsheet to the databases. Input schedules contain all of the same formatting and functionality as reports. The difference is that reports are used for analysis purposes, and input schedules are used for writing data to the database. Data can be written to base-level members to which you have write access.
In addition to the common features of reports and input schedules, here are some unique features of input schedules:
Modeling Options
You can use the provided modeling options (spread, trend, and weight). See Data Modeling.
Submitting Data
If you have the proper authority, you can send data to the database. There are several submission options available. See Data Submission.
Upon sending data to the database, if the work status or data submission validation is enabled by your administrator, the system checks to make sure there are no work status locks or validity issues, respectively, on the member intersections. A validity check includes making sure that the members are valid, the periodicity is correct, and the member type is correct (for example, the member is not a calculated member). A concurrency check is always performed by the system for data submissions. See Data Submission.
Changing the Work Status Code
After submitting data, you can change the work status code to enforce data locks on authorized data points. See Work Status.
Distribution and Collection
You can use the distribution feature to distribute a set of input schedules to users, then use the collection feature to get the input schedules back. See Distribute and Collect Offline Data.
Using Special Formatting
If you want to apply special formatting to read-only cells, cells that are ready for input, or changed cells, you can use the FormatRange option in EvDRE. For example, for calculated cells, you can set the USE formatting option to LOCK (then lock those cells through native Excel), to prevent the user from changing calculated cells. See Format Ranges.
More InformationCreating Reports and Input Schedules
Common Report and Input Schedule Features
Dynamic Report and Input Schedule Templates
EvDRE Builder
Drag and Drop Reporting
Live Reporting
Data Submission
Common Report and Input Schedule Features
There are several common features available in both reports and input schedules.
FeaturesThe following table describes some of the basic tasks you can perform in reports and input schedules:
Task Description
Set workbook options
You can set behavior options on an active report or input schedule in the Workbook Options dialog box.
See Workbook Options.
Change the current view
The current view represents the dimension members displayed. You can change any variable members in the current view. See Current View.
Drill down on members
The drill-down function allows you to drill down on member data within dimensions. See Drill Down.
Refresh You can refresh your reports and input schedules to retrieve current data from the database. See Refresh Report Data.
Worksheet dimension lock options
You can set dimension locks on a schedule. The locked dimension members display in the action pane as not editable. See Dimension Locks.
Park and Go You can lock and unlock the current view, or both the current view and data, in an input schedule. See Park N Go.
Insert functions You can insert functions to build formulas. See Functions Reference.
NOTE
When you use a template that removes schedules, you can insert functions only into EvDRE reports.
Add and view comments
You can add or view text comments in your schedule. See Comments.
Insert Dashboard
Allows you to embed an Xcelsius SWF file into an Excel workbook. The Xcelsius document is based on the current view. If you change the current view, the Xcelsius document is updated. If you embed an Xcelsius document in any other way through an Excel function, it is not based on the current view.
Toggle Edit Mode
Allows you to resize an Xcelsius SWF file frame once it has been inserted into an Excel workbook.
Special formatting
If you want to apply special formatting to read-only cells, cells that are ready for input, or changed cells, you can use the FormatRange option in EvDRE. For example, for calculated cells, you can set theUSE formatting option to LOCK (then lock those cells through native Excel), to prevent the user from changing calculated cells. See Format Ranges.
ActivitiesCreate a report or input schedule by using an existing template, report, or schedule, or by using an empty workbook. You can open a template from the template library, or create a new EvDRE report or schedule. For more information, see EvDRE Builder, Dynamic Report and Input Schedule Templates, or Drag and Drop Reporting.
Workbook Options
You use this function to set behavior options in an active report or input schedule.
FeaturesThe system determines default workbook option settings depending on whether a report or input schedule is active. You can change any of the following options:
Option Description
Type Options are Report and Input Schedule.
The refresh options provide default selections to optimize the workbook performance. After setting the type, you can further customize the refresh options to suit your needs.
Refresh and expansion
When you refresh a workbook, the system goes to the server and returns data values for the cells whose retrieval formulas are affected.
When you expand a workbook, the expansion functions dynamically expand dimensional data.
All refresh and expansion options for both reports and input schedules are enabled by default except for Refresh by sheet.
Refresh workbook on worksheet update: The system automatically performs a refresh when a change is made to an affected data cell.
Refresh after data send: The system automatically performs a refresh after data is sent to the database. If not selected, you can perform a manual refresh by selecting eTools Refresh .
Expand on workbook open: The system automatically expands the expansion functions when the workbook opens. If you do not select it, you can perform a manual expansion by selecting eTools Expand All .
Expand on CurrentView change: The system automatically expands the expansion functions when the current view is changed. (See Dynamic Expansion.)
If not selected, you can perform a manual expansion by selecting eTools Expand All .
Refresh by sheet: When you tab from one worksheet to another in an EvDRE report, select this option to refresh each worksheet individually. Unopened worksheets are not refreshed.
Allow users to change options
If you select this, users, who are not administrators, can set workbook options on a workbook. If you leave it blank, only administrators can change these options. By default, this check box is selected.
Option Description
Drill-down This option controls member expansion behavior in the active spreadsheet. You can use Expand by Overwriting Rows or Expand by Inserting Rows. When you select Expand by Overwriting Rows, the expanded members display in the rows below the expanded member, clearing existing members. When you select Expand by Inserting Rows, any rows below the expanded member shift down, and new rows are inserted to accommodate the newly displayed members.
Set maximum expansion
For performance purposes, there is a maximum number of rows and columns to return when the row or column in the report or input schedule dynamically expands.
For Microsoft Excel, the maximum number of rows is 65,535 and the maximum number of columns is 255. However, for a file format of Excel 12 (Excel 2007) html, xml workbook or template, the maximum number of rows is 1,048,575 and the maximum number of columns is 16,383.
Override current view settings
When you open a Planning and Consolidation report or input schedule in Interface for Office or Interface for the Web, the data changes based on your current view. If you want an active workbook to always open to specific members, you can override one or more of the current view members.
To override current view settings, enter some data in two columns (for member names and values) of an empty cell on the workbook. Enter the names and values of the members you want to hard code. Select eTools Workbook Options , then select the two-column range of cells that represents the current view settings, and then choose Add. Choose the Remove button to remove the range.
NOTE
The Override applies only to non EvDRE templates. It points to the control panel to control non-specified EvGET/EvGTS definitions. If you define a row/column, you can override only the dimensions for the page keys because the EvGET refers specifically to the row/column member ID.
Save the session CV with the workbook
This option allows you to save the active current view with the workbook when you have multiple reports open for which you want to see different current views. Rather than use the active session current view for all three reports, you select, then save the desired current view with each workbook. When you switch between the reports, a unique current view is used for each.
Set worksheet password
You can set a Planning and Consolidation password on the workbook. A Planning and Consolidation password is required when the report or input schedule is distributed or collected using the Offline Distribution Wizard.
The password is different from native Excel's workbook password. If you use the Excel password to secure a workbook, Planning and Consolidation expansions may not work properly. To set the password, select eTools Workbook Options from the Excel interface.
Lock status The Workbook Options dialog shows whether the current workbook is locked or unlocked. You can lock the report or input schedule using the Park N Go feature.
Read options for comment
This field is used for cell-based comments. If an EvCOM function returns a specific comment value, you can have it displayed as text in the cell or in a Microsoft Excel comment dialog box.
ActivitiesTo set workbook options, open the workbook for which you want to set the options and choose Set workbook options from the action pane.
More InformationExpansion Functions
VBA Workbook Options
EvCOM The EvCOM function references another cell and sends its value, a textual comment, to the database when specified.
SYNTAXEvCOM(CommentRange,AppName,Member1,Member2,and so on)
CommentRange — The cell reference of the input cell.
Insert AppName
Insert Member1–N
EXAMPLE
The following example sends the text value in cell D16 to the database.EvCOM(D16,Finance,Salaries,Budget,Jan2008)
Expansion Functions
Functions that allow dynamic expansion of dimensional data in reports and input schedules.
FeaturesWhen you use expansion functions in reports and input schedules, you can use the following features:
You can dynamically expand dimensional data based on criteria defined in the expansion formula In the expansion formula, you can specify whether to expand the report by row, column, or both;
and on which member to base the expansion criteria.
NOTE
The expansion copies the first row if there is no column expansion; it copies the first column if there no row expansion; and it copies the upper left cell of the data range if there is both first row and column expansion.
When you choose a cell that contains an expansion formula, the system restructures the report to include the new members, while maintaining its original design.
VBA Workbook Options You can use several Visual Basic for Applications (VBA) variables in the Microsoft
Excel Name object to define workbook options.
Prerequisites To apply these variables to the workbook, you should be familiar with VBA programming.
Features The following table shows the available variables:
Variable Description Example values
EV__EXPOPTIONS__ The drill down options control the member expansion behavior in the active spreadsheet.
0: (Expand by Overwriting Rows) - The expanded members display in the rows below the expanded member, clearing existing members as needed.
1: (Expand by Inserting Rows) - Any rows below the expanded member shift down, and new rows are inserted to accommodate the newly-displayed members.
1
EV__LASTREFTIME__ Displays the time of the last refresh (EVRTI function)
2008–07–15 10:38:24
EV__LOCKEDCVW__(appname)
Locks the current view in the specified application.
NetIncome,ACTUAL,Input, Sales, Non_InterCo,LC, 2008.TOTAL, PERIODIC,
EV__LOCKSTATUS__ Specifies the Park N Go status.
1: Live data and static current view
2: Static data and static current view
4: Offline workbook
1
EV__MAXEXPCOLS__ Specifies the maximum number of columns for expansion.
100
EV__MAXEXPROWS__ Specifies the maximum number of rows for expansion.
1000
EV__MEMORYCVW__ Specifies whether or not the system memorizes the current view in the workbook.
0: Do not memorize
1: Memorize
1
EV__WBEVMODE__ Specifies the workbook mode:
0: Report
1: Input schedule
1
Variable Description Example values
EV__WBREFOPTIONS__ Specifies refresh and expand options:
1: Recalculate workbook on worksheet update
2: Recalculate workbook on worksheet open
4: Recalculate on CurrentView change
8: Refresh after data send
16: Expand on workbook open
32: Expand on CurrentView change
134217728: Allow users to change options
41
EV__WBVERSION_ An internal flag. 0
Current View
The Planning and Consolidation current view feature transforms static spreadsheets into dynamic, reusable reports and input schedules. The current view represents the following:
The dimensions that are included in the current application. The members that are used in the current display of a live report (or the saved members in an
offline report).
FeaturesYou can dynamically select members to change the current view in a live report by selecting new members from the current view. Any cell in a report or input schedule that contains the EvCVW function is dependent on the current view. If you change the current view, the data displayed changes to reflect the new current view settings.
You can set a workbook to refresh automatically upon selecting a member from the current view, or you can allow a manual refresh. For more information, see Workbook Options.
If current view values are in conflict, the higher the rank, the higher the precedence. See Current View Precedence.
ActivitiesTo change the current view, make sure the action pane is maximized. From the action pane, maximize the current view list in the Session Information section. Specify the desired member. If you are prompted to refresh the report or input schedule, choose Yes.
NOTE
If you choose to refresh data, the system goes to the server and returns new data values, and you lose any previous input.
Current View Precedence
You can define which current view has precedence by a combination of the settings described in the following table.
FeaturesThe full key (current view) of a cell is controlled by EvDRE overlaying onto each cell the definitions of a current view as defined by any combination of the following settings:
Rank Description
1 The system current view, as defined by the current view bar.
2 The workbook current view, as defined in the workbook options.
NOTE
The Park N Go feature does not override the current view.
3 The page current view, as defined in the PageKeyRange.
4 The column current view, as defined in the ColumnKeyRange.
5 The row current view, as defined in the RowKeyRange.
6 The cell current view, as defined in the CellKeyRange.
If these definitions are in conflict, the system takes precedence from the lowest to the highest. For example, the cell key, if it exists, takes precedence over the row key, the row key takes precedence over the column key, and the column key takes precedence over the page key.
More InformationCurrent View
Current View
The Planning and Consolidation current view feature transforms static spreadsheets into dynamic, reusable reports and input schedules. The current view represents the following:
The dimensions that are included in the current application. The members that are used in the current display of a live report (or the saved members in an
offline report).
FeaturesYou can dynamically select members to change the current view in a live report by selecting new members from the current view. Any cell in a report or input schedule that contains the EvCVW function is dependent on the current view. If you change the current view, the data displayed changes to reflect the new current view settings.
You can set a workbook to refresh automatically upon selecting a member from the current view, or you can allow a manual refresh. For more information, seeWorkbook Options.
If current view values are in conflict, the higher the rank, the higher the precedence. See Current View Precedence.
ActivitiesTo change the current view, make sure the action pane is maximized. From the action pane, maximize the current view list in the Session Information section. Specify the desired member. If you are prompted to refresh the report or input schedule, choose Yes.
NOTE
If you choose to refresh data, the system goes to the server and returns new data values, and you lose any previous input.
Drill Down
You use this function to drill down on member data within dimensions. You can drill down on members in a worksheet, or you can drill down on charts and graphs.
Prerequisites To drill down on members in a worksheet:
Expansion is enabled in the workbook. A hierarchy-based dimension is included either in the rows or columns.
To perform graphical drill down: The source report has a hierarchy-based dimension in the rows and/or columns. The chart is on its own worksheet, and the worksheet appears immediately after the
worksheet with the source data on it.
FeaturesYou can do the following:
You can drill down on members in a workbook. Upon selecting an expansion member, the spreadsheet automatically displays the immediate dependents of that member.
You can create graphical drill downs. You can drill down on charts and graphs to make your charts and graphs dynamic.
Activities To drill down on members in a workbook, select the member you want to drill down on and double-
click the member ID or the description. You can use the action pane to both drill down and drill back up.
More InformationDynamic Expansion
Refresh Report Data
You use this function to refresh your report data to get current data into your report from the database.
FeaturesYou refresh your report data when you change members using the current view, and when your report contains dynamic expansions. You set up automatic refresh settings in workbook options. See Workbook Options.
If the report contains EvSND functions, you are prompted to send updated data.
You can refresh data in the following ways:
Refresh Option Description
Retrieve active cell Refreshes data in the active cell.
Retrieve active worksheet
Refreshes data in the active worksheet.
Retrieve active workbook
Refreshes data in the active workbook.
Retrieve supporting documents
This option opens the Content Library, where you can retrieve a supporting document. See Content Library.
Retrieve and refresh dimension members
Fetches the latest dimension information from the database.
Set automatic refresh This option automatically refreshes the report when you change the current view settings in the Workbook Options dialog box. See Workbook Options.
ActivitiesTo refresh data in a report, open the report for which you want to refresh data and choose Retrieve data from the action pane. Select one or more of the available options.
More InformationCreating Reports and Input Schedules
Dynamic Expansion
Content Library
The Content Library is a repository for storing files that you want to share. Valid file types include Microsoft Word, Excel, and PowerPoint, HTML, text (such as an e-mail), web pages and images, but the list of file types can be customized by your system administrator.
IntegrationTo use this feature, select Content Library in Interface for Web or go to http://<server_name>/OSoft/Contents/WebContentsList.aspx.
FeaturesYou can use the Content Library features to post, share, retrieve, and manage the display of documents.
Documents that have an application context are associated with a current view. For example, a Microsoft Word document might be associated with a particular report. If you want to view a report and anything that is associated with that report, you can view a particular current view. Relevant reports and documents are displayed.
Activities You can post documents that reside on a hard drive or network folder. Posted files display in a list
and are filtered by a user’s current view, a user’s view rights to information, and any manual filters set.
You can delete items that you posted to the Content Library list. Select one or more items and click Delete Selected Items from the Content Library Options action pane.
When you post a document to the Content Library using the Content Library Options action pane, you can describe the document, set access to the document, and determine whether you want to send a notification e-mail about the posting.
You can view one item by choosing its title. You can view multiple items from the Content Library list in tabs, which allows you to flip through the tabs to easily view each file. You select items you want to view and click Open selected items in tabs.
To sort the list, click Sort this list from the Content Library Options action pane or by click a column heading.
You can categorize, sort, and filter documents in the Content Library list by the following elements: Document type and subtype Application context Access rights Date
You can filter the items in the Content Library list to see a subset of the files by clicking Filter this list from the Content Library Options action pane.
You can assign a document type and subtype to aid sorting and filtering. System administrators define document types. Subtypes are defined by a user when the document is posted.
You can create pages in the Content Library for displaying content and also set access to those pages. See Creating a Web Page.
To open multiple Content Library items in separate tabs, select two or more items and choose Open selected items in tabs.
Creating a Web Page
Procedure1. Select Add a New Web Page from the Content Library Options action pane.2. Enter a page name, select a template layout from the list, and select the object type you want to
add.3. Enter a title for the object and the objects pixel height.4. If the object is a web site, the only setting required is the name of the URL. Otherwise, choose the
desired options for your chosen object type.5. Continue adding more objects to the page, or select one of the options:
Modify the object — You can make additional changes to the page. Set Team Access to the page — You can determine the teams or users who can access a
page. Select the teams and/or users to which to grant access. To view the finished web page, choose Save.
Preview the output — Display the page. Save and view the output — Save and display the page.
ResultOnce the page is open, you can add and view comments, modify the contents of the page, or delete the page.
Dimension Locks
You can set dimension locks on the worksheets of a report or input schedule so end users cannot change those dimension members in the current view displayed in the action pane. The locked dimension's members display in the action pane as not editable.
NOTE
In the Microsoft version of the product, the current view of a business process flow overrides the dimension locks in a worksheet. For more information, see Business Process Flows and Defining Actions.
FeaturesYou lock dimensions on a worksheet by selecting the application and dimension members for which you want to prevent entry. You select the Worksheet Dimension Lock Options menu item from the Report State action pane, then select the desired application, and then the dimensions.
NOTE
You cannot lock a dimension if it is defined as secure for a specific application.
You can unlock a dimension member by selecting the check box next to the dimension name to remove the check.
Business Process Flows
Business process flows guide users through a prepackaged set of application tasks. Business process flows comprise steps that must be completed sequentially, and steps can have substeps. Substeps do not need to be completed sequentially and may not be required at every iteration of the process flow. Depending on a user's role in the organization, steps the person performs can involve completing actions, such as data entry, or reviewing an already completed step.
NOTE
A business process flow can only be defined for end-user tasks, and not for administrative tasks.
FeaturesYou can use these business process flow features:
Personal To Do List
The To Do List displays required steps and optional substeps assigned to you, or completed steps that you must review, based on region. Therefore, they are called step regions. The To Do List displays the name and current status of each step region for which you are responsible.
Steps can have the following statuses:
Status Description
Action Required Waiting for completion as a new step.
Review Required Action has been taken and the step is waiting for review.
Completed The step has passed completion criteria.
Rejected The step has failed to pass completion criteria.
Waiting for Proper Work Status
The step is waiting for its work status to be updated.
Pending The step is waiting for a reopened step to be completed.
Reopen The step is waiting for completion as a reopened step.
Status Description
Waiting for Reopen
The step is waiting to be reopened by a reviewer.
If it is a Review Required step, a user cannot reopen the step – it can only be reopened by a reviewer. When a user requests a reviewer to reopen a step, it has the status of Waiting for Reopen.
Unavailable The step is not available; no action can be undertaken.
Owners and Reviewers
The owner of a step is the person responsible for completing the step. A reviewer is a person who must verify the activity taken for a step. Owners and reviewers can be an individual user or a team of users. Two or more users can select the same step region concurrently, as multiple users may be involved in the completion of a step region.
Reopen and Reset
Authorized users can reopen a previously completed step, and reset a specific instance or a set of business process flow instances. (Administrators can reset a set or all instances.)
For a step to be reopened, it must have the following criteria:
The step has the attribute Allow Re-Open defined in the Administration console. The status of the step is Completed. Only one previous step can be reopened at a time, but the steps can be reopened one by one in
sequence. The Reopen function is available only for the step prior to the current one. Therefore, the last step
of a process cannot be reopened after that step is completed. Users cannot reopen a step directly if the step has the attribute Enable Reviewers set. They can,
however, send an e-mail request to a reviewer using an action pane link. A user has the ReopenBPFStep task security assignment. A designated reviewer does not need to
have the ReopenBPFStep task security to reopen a step.
A user can only reset a currently open business process flow region by choosing Reset this Instance on the action pane.
Step Completion
When completing a step or substep, the action pane displays context-sensitive options to assist you with completing tasks.
Completion of steps is audited by the system and appears in audit reporting.
When a step is completed, all reviewers nominated for the step receive an e-mail if Send e-mail to reviewers on completion is set.
Locked Dimension Precedence
A business process flow current view takes precedence over any dimension locks in the opened worksheet, but any locked dimensions not specified in the business process flow current view remain locked in the opened worksheet.
EXAMPLE
The business process flow region uses Entity, Category, and Time, and the Entity and Category dimensions are locked in the workbook. The Entity and Category members are taken from the business process flow, and the Time member is taken from the worksheet.
For more information, see Defining Actions and Dimension Locks.
Reports
You can create reports on business process flows. See Reporting on Business Process Flows.
ActivitiesYou access your Personal To Do List and business process flow reports using the links in the action pane that displays when you enter the Web interface. You perform the following business process flow activities:
Click a step in the Personal To Do List to launch the appropriate Planning and Consolidation function. This allows you to complete the step or launches the next substep.
To indicate you have completed a step, click Completed in the To Do List. This modifies the status of the step.
To refresh your To Do List, click Refresh. This allows you to see the activity of other users who share ownership of a step.
To reset a currently open business process flow instance, click Reset this BPF instance in the action pane of the To Do List.
To reset a currently open instance, you must have the Reset task profile.
To reopen a previously completed step, click Reopen this step in the action pane of the To Do List.
To reopen a previously completed step, you must have the Reopen step task profile, the step must previously have been set by an administrator as Allow Reopen, and the status of the step must be Completed. If the step has a status of Review enabled, only the reviewer can open it.
Defining Actions
An action is a specific task a user performs when completing a step of a business process flow. You can assign actions to steps that do not have substeps, substeps themselves, and steps that require custom review by a participant.
NOTE
Since the BPF current view takes precedence over any dimension locks in a workbook, we recommend that the BPF actions do not reference workbooks that have locked dimensions. This prevents confusion about which dimension and member combination is being used.
Another reason for this is that the BPF current view is applied only on the active sheet. If the person performing the action opens another sheet in the same workbook, the BPF current view is not transferred, and any dimensions locked in the worksheet apply. Therefore, if you want to apply a BPF current view to nonactivated sheets (that is, not the initially opened sheet), do not reference a workbook with locked dimensions.
If you want to use the same current view across the workbook (and not the BPF current view), you can use the 'Override current view settings' option in the Workbook Options dialog box (see Workbook Options). The workbook current view settings impact the entire workbook's current view, but do not prevent users from manually changing their current view.
Note that any locked dimensions not specified in the BPF current view are still locked in the opened worksheet. For example, if the BPF region uses Entity, Category, and Time, and the Entity and Category dimensions are locked in the workbook, the Entity and Category members are taken from the BPF, and the Time member is taken from the worksheet.
EXAMPLE
An action can be any user-authorized task, for example, opening a schedule or publishing a report.
Procedure1. From Define Actions, choose a step or substep.
2. The name of the step or substep appears as the default action name. Add additional names or modify the name to be displayed if desired. The first action in the list is the one that displays when the user selects the action.
3. Associate a BPC interface and task with the action, entering valid parameters for the specified interface or task.
4. Associate an application with the action and specify the source of the values for each dimension.5. Save the action, then define actions for additional steps and substeps as required.6. Finish the BPF by reviewing the BPF and enabling it for use (see Finishing BPFs).
Finishing BPFs
In this final screen, you can review the new business flow, and release the BPF now, or hold it for use at a later date.
Once the BPF is released, users can create instances of its use.
Procedure1. From Finish, review the information you entered when setting up the BPF, defining steps and
substeps, and defining actions.2. Make the BPF immediately available to users, or reserve it for future use.3. Save the BPF, then close the business process flow assistant.
Reporting on Business Process Flows
You can generate reports on Business Process Flows (BPFs). Reports can be viewed online and printed. Microsoft reports can be exported to Microsoft Excel.
FeaturesThe following types of reports are available for business users. When generating a report, you choose the name of the business process flow and criteria for the report. Criteria include the start and end date and time frame for the BPF, the associated data region, and the orientation of the report.
Standard BPF reports give you information about data regions, grouped by step. Step BPF reports give you information about steps, grouped by data region.
ActivitiesTo generate a report for a business process flow, choose Launch Planning and Consolidation System Reports from the Getting Started Options action pane in the Interface for the Web. Choose BPF Report from the action pane and select a standard report or a step report. After specifying a start date, end date, orientation, and data region, choose OK to generate the report in a new browser window.
Defining Actions
An action is a specific task a user performs when completing a step of a business process flow. You can assign actions to steps that do not have substeps, substeps themselves, and steps that require custom review by a participant.
NOTE
Since the BPF current view takes precedence over any dimension locks in a workbook, we recommend that the BPF actions do not reference workbooks that have locked dimensions. This prevents confusion about which dimension and member combination is being used.
Another reason for this is that the BPF current view is applied only on the active sheet. If the person performing the action opens another sheet in the same workbook, the BPF current view is not transferred,
and any dimensions locked in the worksheet apply. Therefore, if you want to apply a BPF current view to nonactivated sheets (that is, not the initially opened sheet), do not reference a workbook with locked dimensions.
If you want to use the same current view across the workbook (and not the BPF current view), you can use the 'Override current view settings' option in the Workbook Options dialog box (see Workbook Options). The workbook current view settings impact the entire workbook's current view, but do not prevent users from manually changing their current view.
Note that any locked dimensions not specified in the BPF current view are still locked in the opened worksheet. For example, if the BPF region uses Entity, Category, and Time, and the Entity and Category dimensions are locked in the workbook, the Entity and Category members are taken from the BPF, and the Time member is taken from the worksheet.
EXAMPLE
An action can be any user-authorized task, for example, opening a schedule or publishing a report.
Procedure1. From Define Actions, choose a step or substep.2. The name of the step or substep appears as the default action name. Add additional names or
modify the name to be displayed if desired. The first action in the list is the one that displays when the user selects the action.
3. Associate a BPC interface and task with the action, entering valid parameters for the specified interface or task.
4. Associate an application with the action and specify the source of the values for each dimension.5. Save the action, then define actions for additional steps and substeps as required.6. Finish the BPF by reviewing the BPF and enabling it for use (see Finishing BPFs).
Functions Reference
All Planning and Consolidation reports and input schedules use custom functions to retrieve, send, and display data. These functions are commands that are used with cell references and values in formulas to make a report behave in a certain way, providing power and flexibility to reports and input schedules.
FeaturesYou can insert functions into reports and input schedules to build formulas. You use the formulas to create or modify reports and input schedules.
ActivitiesYou use the Insert function option on the action pane to insert functions.
Comments
Comments provide a vehicle for submitting, storing, and retrieving text commentary associated with Planning and Consolidation data cells. This allows users to annotate data so other users can view supporting information associated with a particular data point.
IntegrationThe Comments function is fully integrated in Interface for Excel, Interface for Word, Interface for PowerPoint, and Interface for the Web. Therefore, you can enter and view comments from within any interface that manages data.
FeaturesYou can use comments in the following ways:
You send/retrieve a comment using the action pane. You can see comments on a series of data such as a specific report or Content Library document
that is not driven by the current view. You can retrieve a comment for a specific cell in Interface for Excel, but not in Interface for the Web
live reports. You can use functions to retrieve comments based on a fully specified or partially qualified current
view. See EvCGP and EvCGT.
Adding Comments
You can add comments using the EvCOM function or through the action pane. The Add comment link is available on any action pane from which the context of the page allows you to enter a comment. In the Microsoft version, you can set the comment length using the COMMENT_MAX_LENGTH parameter. The maximum length is 4,000 characters. For more information, see Application Parameters.
NOTE
If you use EvCOM, you must pass along all the dimension members and application with the text within the formula syntax.
When adding a comment, you may specify the following items:
Item Description
Context Select how to apply the comment:
The published page (Interface for the Web)
This option is available when a published report or input schedule is active. The comment becomes associated with the active report or input schedule.
The active report or schedule cell (Interface for Excel)
This option is available when a live report or schedule is active. The comment is applied to the data region associated with the selected cell.
The selected Planning and Consolidation data (Interface for Word/Powerpoint)
This option is available when you select Insert data object.
The active current view
This option applies the comment to the current view shown in the action pane.
Custom current view
This option allows you to specify a specific current view to which to associate the comment. From the Comment for These CV Values table, select the application. For each dimension, select the check box next to the dimensions for which you want a specific member or all members to apply. Leaving a check box unselected ignores the members for that dimension for this comment. To select a member using the Member Lookup, click a dimension link. See Member Lookup.
Priority Select the desired priority level or No Priority. The reports show comments in order of their priority level.
Keywords
Use keywords to organize and search for comments in the database. This field takes blanks and empty strings.
Viewing Comments
If you have a live report or input schedule open, you can view any comments that are associated with it. You can also view comments associated to the current view of a selected cell within that report or input schedule, or view any comments for a specific current view. To view relevant comments, you must answer some questions so the system can filter the database.
Item Description
Context Select how to apply the comment:
The published page (Interface for the Web)
This option is available when a published report or input schedule is active. The comment becomes associated with the active report or input schedule.
The active report or schedule cell (Interface for Excel)
This option is available when a live report or schedule is active. The comment is applied to the data region associated with the selected cell.
The selected Planning and Consolidation data (Interface for Word/Powerpoint)
This option is available when you select Insert data object.
The active current view
This option applies the comment to the current view shown in the action pane.
Custom current view
This option allows you to specify a specific current view to which to associate the comment. From the Comment for These CV Values table, select the application. For each dimension, select the check box next to the dimensions for which you want a specific member or all members to apply. Leaving a check box unselected ignores the members for that dimension for this comment. To select a member using the Member Lookup, click a dimension link. See Member Lookup.
Comment History
You select the checkbox to show multiple comments for the specified search criteria. Leave the checkbox blank to return only the most recent comment that meets the criteria.
Priority You select one or more priority options to return comments associated with that priority.
Keywords You can enter a keyword (up to 50 characters) to return only comments with a matching keyword.
Comments from what origin
You can select one of the following:
Comments from anyone. This option returns comments entered by all users. Comments from myself. This option returns comments that were entered by you. Comments from another user. This option returns comments entered by a specific
user. Enter a valid user in the User edit box.
Comments by date range
You can select the Search by date range check box to specify a date range for which to return comments. Use the From and To drop-down lists to specify the desired date range.
Clearing Comments
You can delete comments from the comment history, except for the last comment entered, using the CLR_COMMENTS_HISTORY application set parameter. For more information see Application Set Parameters.
You can also delete or remove comments with conditions through the ClearComment package in Data Manager.
Comments Summary Page
When you add a comment or choose your view options, you can display them on the Comments Summary page. If other comments exist for the same data region, those also appear in the summary
page. If associated data regions contain comments, those data regions also appear in the page. If you define view options, all associated comments are displayed.
To change views, you can do one or more of the following:
To change what displays in the Data Region with Comments table, choose the Display Criteria hyperlink at the top of the page. See Viewing Comments, above.
To delete a comment, select the check box next to the comment in the Comments for the selected data region table, then choose Delete selected comments from the action pane. Only the owner of the comment or a user with administrative rights can delete a comment.
Comments Summary Table
Item Description
Comment Displays the entire comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the cell. When you finish modifying the text, choose Update Comment.
Priority Displays the priority for the comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the cell by selecting another option from the drop-down list.
Keyword Displays the keyword associated with the comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the field.
Originator Displays the comment originator’s name. The value in this cell is display only.
Date Displays the date that the comment was saved to the database. If the comment is updated by the originator or an administrator, the updated date appears in this cell. The value in this cell is display only.
Show (drop-down list)
Allows you to specify the comment blocks to display in the table.
ActivitiesAdding Comments
To add a comment, open the report or input schedule and select the cell in which you want to add a comment. From the Report State action pane, select theAdd a new comment link. Specify the requested information, then enter the comment (up to 265 characters).
Viewing Comments
To view a comment, from a live report/input schedule or a selected cell in a report/input schedule, select View comments from the action pane. Specify the requested information to view the Comments Summary page.
More InformationEvCOM
EvCGP The Get Partial Comment function retrieves comments based on a partially-qualified current view. The system ignores any members not specified in the function. The comments returned are those added to the database using each one of the specified members or All.
SYNTAX1. EvCGP(Application Name,Member1,Member2,Membern)
Application Name — The name of the application.
Member1- n — The ID of the member from which to obtain associated comments.
EvCGT The Get Comment function retrieves comments for a fully-specified current view. The system takes any members not specified in the function from the current view. The comments returned are those added to the database using each one of the specified members or [ALL].
SYNTAX1. EvCGT(Application Name,Member1,Member2,Membern)
Application Name — The name of the application.
Member1- n — The ID of the member from which to get associated comments.
Application Parameters
Application parameters control the way certain features behave in an application.
PrerequisitesAdministrators with Administration - Application task security rights can set application parameters.
FeaturesApplication parameters can be different for each application within an application set. If an application parameter is required, you can leave it blank to accept the default. If you delete the parameter, the system may not work correctly. If an application parameter is optional, you can delete it.
The following table describes the parameters you can set within the Administration interface using the Administration Configuration action pane.
The parameters that require a value include (R) in the Type column. Parameters that do not require a value include (O) in the Type column. If an application parameter is required, you can leave it blank to accept the default, but if you delete the parameter, the system may not work correctly. If an application parameter is optional, you can leave it blank or delete it.
Type Key ID Description
(O) BPC_STATISTICS (in NetWeaver version only)
Use this parameter to specify that various modules write detailed runtime statistics to the tables UJ0_STAT_HDRand UJ0_STAT_DTL. You can use this information to monitor system performance.
Valid values are: ON
OFF
Type Key ID Description
(O) CUSTOMFACTBLINDEX(in Microsoft version only)
Use this parameter to define a dimension list to create a custom index in the appropriate database table and accelerate import processing.
Valid values for this parameter are: Category, Time, Entity, Account, and RptCurrency.
Enter a list of dimensions into this parameter, separated by commas.
The default value is blank.
When you use a custom fact table index, we recommend that when you modify the application, you select theReassign SQL Index option.
This parameter is used in Admin - Modify application, Add a new application, Copy an application.
(O) DIMSFORFACTTBLINDEX(in Microsoft version only)
Use this parameter to specify the fields and the field order for the indexes used by the Fact, Fac2 and write-back tables. The Fact and Fac2 tables use a clustered index; the write-back table uses a composite index.
Valid values are: Category
Time
Entity
Account
RptCurrency
Enter a list of dimensions into this parameter, separated by commas.
The default value is:Category, Time, Entity, Account, RptCurrency
If the parameter is blank, the default fields and field order are used.
This parameter is used in Admin - Modify application, Add a new application, Copy an application.
(O) DTSLOGPAGESIZE Use this parameter to set the number of records that display in the Data Manager Status View.
Enter the number of records to display.
The default value is 300.
This parameter is used in Data Manager - Status View.
(O) JRN_ACCDETAIL_DIM Use this parameter to specify a special dimension name used to manage the Opening, Closing, and Reverse Sign codes.
This is used with JRN_CLOSING_CODE, JRN_OPENING_CODE, and JRN_REVSIGN_CODE.
This parameter is used in Interface for Office - Journal.
Type Key ID Description
(O) JRN_BALANCE Use this parameter to control whether it is necessary for Journals to be balanced.
Valid values are:
0 – Journals need not be balanced
1 – Journals need to be balanced
The default value is 0.
This parameter is used in Interface for Office - Journal.
(O) JRN_CLOSING_CODE Use this parameter to specify the member name for the Closing code. This member is part of the dimension name specified by JRN_ACCDETAIL_DIM.
The member name must be set to use this feature.
The default value is blank.
This parameter is used in Interface for Office - Journal.
(O) JRN_DESC_MODE Use this parameter to allow the display of the description in the journal template.
Valid values are:
N – Displays the member ID in the journal template for the application. This provides optimal readability.
Y – Displays the description of member in the journal template
The default value is N.
This parameter is used in Interface for Office - Journal.
(O) JRN_IS_STAT_APP Use this parameter to enable or disable subsequent journal fields, if the application is used for statutory consolidation.
Valid values are:
1 – Enables the subsequent journal fields
0 – Disables the subsequent fields
The default value is 0.
This parameter is used in Interface for Office - Journal.
(O) JRN_MAXCOUNT Use this parameter to specify the maximum number of journal entries returned from a query in the Journal Manager. This is useful if you have a large number of Journal Entries and want to protect a user from launching a long query.
The default value is blank.
This parameter is used in Interface for Office - Journal.
Type Key ID Description
(O) JRN_OPENING_CODE Use this parameter to specify the member name for the Opening code. This member is part of the dimension name specified by JRN_ACCDETAIL_DIM.
The member name must be set to use this feature.
The default value is blank.
This parameter is used in Interface for Office – Journal.
(O) JRN_POST_OVERWRITE
Use this parameter to specify whether the system keeps the same Journal ID when saving journals that were previously set to Posted status, but changed to Unposted status.
Valid values are:
Y – Preserves the Journal ID when the unposted journal is saved
N – Creates a new ID when the unposted journal is saved
The default value is N.
This parameter is used in Interface for Office – Journal.
(O) JRN_REOPEN Use this parameter to define the default for reopening journals.
Valid values are:
N – Does not allow reopening of journals
Y – Allows the reopening of journals
The default value is N.
This parameter is used in Interface for Office – Journal.
(O) JRN_REOPEN_PROPERTY
Use this parameter to specify the property name in the account dimension that is used to further filter the journals to reopen.
A valid value is a property in the account type dimension.
The default value is GROUP.
If this parameter is not set, the GROUP property must exist in the account type dimension. Alternatively, to use a property other than GROUP, change the value of the ACCOUNT_PROPERTY column in the Journal Translation template. This value can be any property in the account type dimension, or *.
For more details, see SAP Note 1384731.
(O) JRN_REVSIGN_CODE Use this parameter to specify the member name that is used to reverse the sign during posting and unposting. This member is part of the dimension name specified by JRN_ACCDETAIL_DIM.
The member name must be set to use this feature.
The default value is blank.
This parameter is used in Interface for Office – Journal.
Type Key ID Description
(O) JRN_VALIDATION_SP Use this parameter to specify the SQL stored procedure name to be executed before posting or unposting data. This stored procedure performs custom validation on the entire RecordSet to be posted or unposted and returns go/no-go to the posting engine.
The default value is blank.
This parameter is used in Interface for Office – Journal.
(O) LOCKREPORT (in Microsoft version only)
Use this parameter to specify a report name to launch when submission validation for a data region is not 0. The template must be located in the folder<drive>\webfolders\<appset>\<application>\eExcel\Input Schedules\Wizard\.
A sample validation template provided with ApShell is located in<drive>\webfolders\ApShell\Planning\Excel\Input Schedules\Wizard\Validate.xlt.
The default value is blank.
This parameter is used in Interface for Office – Validate submission.
(R) ORG_ACCOUNTLIST Use this parameter to specify what account dimension members of the ownership application represent the legal consolidation method, and the ownership percentage for the subsidiary company in the dynamic hierarchy.
The account dimension members must exist in the ownership type application.
The METHOD member for the consolidation method must be defined in the parameter. If you define any member other than METHOD, the legal consolidation fails due to the consolidation business rule referring to a reserved word.
For the ownership percentage, you can define one or one more account dimension members according to your business needs. At least one member must be defined for the ownership percentage.
This parameter is required if the application is an ownership type, and if performing legal consolidation that refers to the ownership application.
The default value is METHOD,POWN,PCON.
You can enter account dimension members from the ownership type application separated by a comma (,) delimiter.
This parameter is used in Admin - Dynamic Hierarchy Editor.
Type Key ID Description
(R) ORG_ACCOUNTOWN Use this parameter to specify the relationship of the parent and subsidiary companies in the dynamic hierarchy.
The default value is PGROUP. If the parameter is not defined, Dynamic Hierarchy Editor does not work.
During processing of the legal consolidation business rule, the rule refers to the parameter value as well. If the parameter is not defined, the rule finds the account dimension member named GROUP or PGROUP during processing.
This parameter is required for ownership type applications that are used to perform legal consolidations.
You can enter account dimension members of ownership type application.
This parameter is used in Admin - Dynamic Hierarchy Editor.
(R) ORG_INTCO Use this parameter to specify a member ID from the INTCO dimension in the Ownership application.
The default value is I_NONE.
This parameter is used in Admin - Dynamic Hierarchy Editor.
(R) ORG_PARENTPROPERTY
Use this parameter to specify the property name of the group dimension for dynamic hierarchy statutory applications when defining fixed hierarchies. The value must match the value in the ParentProperty for entities in the statutory applications that support ownership application.
This parameter is required for ownership type applications that are used to perform legal consolidations.
The default value is PARENT_GROUP.
This parameter is used in Admin - Dynamic Hierarchy Editor, Business Rules.
(O) SEC_CACHE_EXPIRE (in Microsoft version only)
Use this parameter to set the expiration time, in hours, for the secured profile cache. This specifies how long member access security profiles are cached. This limits the amount of memory required for the cache. If a user does not retrieve data during the specified time period, the cache memory is released on the application server.
A valid value is a positive integer larger than 0.
The default value is 24.
If you change this parameter, you must reset IIS on the application server.
Type Key ID Description
(O) SEND_SGTABLE_COUNT(in Microsoft version only)
Use this parameter to specify the count of the sgData[Application] table that is used by the data sending process. It is to be scalable for sending data, and it process sending data parallel as the number of the table.
Use this parameter so that the system can split the sgData[Application] table when it sends large amounts of data.
Valid values are positive integers larger than 0.
The default value is 2.
After you add or modify this parameter, modify the application in the Administration console.
(O) SIGNED_DATA_FORMAT
Use this parameter to specify the decimal precision and scale of the signeddata column of the tablestblFact, tblFac2 and tblFactWB in an application.
The default value is 25,10 (25 for precision and 10 for scale).
This parameter is used in Admin – Add a new application, Modify application, and Copy an application.
(R) TOPDOWN (in Microsoft version only)
Use this parameter to define how to handle the approval of work status.
Valid values are:
Yes – Top down approval of work status. Work status is approved regardless of whether sub-work status is approved
No – Bottom up approval of work status. Work status can be approved only if all sub-work statuses are approved.
The default value is No.
When you change the value of this parameter, existing work status information is removed.
This parameter is required if work status setting is enabled in the Administration console.
(O) VALIDATE_MBR_LOGIC
Use this parameter to specify that the system validates members when processing logic. The performance of processing logic decreases due to this validation.
Valid values are:
1 – The system filters records that would otherwise post to a parent member to a member that no longer exists or a member calculated dimension formula
0 – The system bypasses this validation
The default value is 0.
This parameter is used in Script Logic – posting data during running script logic.
Type Key ID Description
(O) WORKSTATUSVALIDATE(in Microsoft version only)
Use this parameter to specify that the system checks the value of a cell for which a user tries to change the work status. If 0, it passes the validation; if not, it is rejected.
Valid values are:
Yes – Necessary to check validate
No – Not necessary to check
The default value is No.
(O) YTDINPUT Use this parameter to specify whether data is entered in year-to-date (YTD) format.
Valid values are:
Yes – YTD format
No – Periodic format
The default value is No.
This parameter is used in Admin - Application process.
(R) if application type is YTD input type
YTDINPUTTIMEHIR (in Microsoft version only)
Use this parameter to specify the time dimension hierarchy that is used by a YTD storage application.
The default value is H1.
(O) YTD_NECJ_RETRIEVE Use this parameter to specify the query type to improve the performance of data retrieval when retrieving YTD measures on Periodic applications or the opposite.
This parameter is useful in the following circumstances:
YTD / QTD measures data is retrieved on periodic application or Periodic / QTD measures data is retrieved on YTD application.
The retrieval range is huge, but the portion of the data existing cells is small.
ColKeyRange or RowKeyRange has more than two dimensions.
The retrieval range has no members with a dimension formula.
Valid values are:
1 – To use the NonEmptyCrossJoin query
0 – Not to use the NonEmptyCrossJoin query
The default value is 0.
This parameter is used in Retrieve data functions EVDRE, EVGET, EVGTS, EVSND, EVINP.
ActivitiesTo update the value of a parameter, start the Administration interface, and from the action pane, select Set Application parameters. Modify the parameters, as desired, and then click Update.
To add a new parameter (you can add any 'optional' parameter if it does not already display), add a new row, enter the parameter name, then enter the desired value.
Application Set Parameters
Application set parameters allow you to customize your application sets.
PrerequisitesYou have Appset task security rights to view and change application set parameters.
FeaturesThe following table describes the parameters you can set from the Administration Configuration action pane.
The parameters that require a value include (R) in the Type column. Parameters that do not require a value include (O) in the Type column. If an application set parameter is required, you can leave it blank to accept the default, but if you delete the parameter, the system may not work correctly. If an application set parameter is optional, you can leave it blank or delete it.
Type Key ID Description
(O) for the Microsoft version
(R) for the NetWeaver version
ALLOW_FILE_SIZE The maximum file size the system permits users to upload. A warning message appears if the file size exceeds the parameter value when you upload a file. The default value is 100 MB.
This parameter is used in:
Interface for the Web - when posting documents in Content library menu
Interface for Office - sending data, journal posts, Data Manager imports, e-mail notification attachments
(O) APPROVALSTATUSMAIL Defines whether owners and managers receive an e-mail when there is a change to an assigned work status.
Has the following possible values:
Yes: Send e-mail
No: Do not send e-mail
In the Microsoft version of Planning and Consolidation, the following SMTP application set parameters must be set up as well to use e-mail notifications in the system: SMTPAUTH, SMTPPASSWORD, SMTPPORT, SMTPSERVER, and SMTPUSER.
In the NetWeaver version of the system, the ABAP SMTP service is used for sending e-mails.
Type Key ID Description
(O) APPROVALSTATUSMSG Allows you to define a custom e-mail message that is sent to the owners and managers of a work status when a work status code is changed. The message is applicable to all applications in the application set.
You can customize the message using the following variables:
%USER% — Name of user who changed this status
%STA% — Work status
%OWNER% — Entity owner (Microsoft version only)
%TIME% — Time of change
%REGION% - Lock region (NetWeaver version only) — For example: ENTITY: CG1, TIME: 2009.Q1, DATASRC: DC_1, PROJECT: PRJ_1, PRODUCT: PRO_1
EXAMPLE
You can create a message such as, This is to inform you that %USER% has updated the work status for %REGION% on %TIME%.
The text of the e-mail can be a maximum of 255 characters. There is no need for quotes or brackets around parameters.
(R) AVAILABLEFLAG Controls whether the system is offline or not. Yes means the system is online and available for sending data to the database. You can take the system offline by changing the value to No.
This parameter is used in Interface for Office - Send Data, Journal Posts, DM Imports
(R) AVAILABLEMSG The message that displays to users who try to access an application that is offline (AVAILABLEFLAG = No).
The default value is “Current Appset status is available”
EXAMPLE
The message could be “The system is temporarily unavailable due to scheduled maintenance. Try again later.”
This parameter is used in Interface for Office - Send Data, Journal-post, DM-Import.
(R) AVAILABLEURL
(In NetWeaver version only)
The URL of the warning page that displays when a user attempts to access an application that is offline.
(O) BPFSTEP_COMPLETE_MSG
(In Microsoft version only)
Determines the content of the message that is displayed when a Business Process Flow step is completed.
The default message is:[%BPF_STEP_NAME%] step of [%BPF_NAME%] has been completed by %USER_NAME%.
This parameter is used in Admin console - Manage Business Process Flows.
Type Key ID Description
(O) CLR_COMMENTS_HISTORY
Deletes the comment history except for the last comment entered.
Possible values for this parameter are:
0: This is the default value and saves the history of comments.
1: The historical comments are deleted and only the latest comments remain.
(O) COMMENT_MAX_LENGTH
(In Microsoft version only)
Customizes the length of comments. The default value is 256 and the maximum length is 4,000 characters.
NOTE
If you set a smaller value than current value, the newly entered value does not apply to comment length and the previous value still applies even though the setting is updated successfully in AppSet parameters page. Therefore, the new value should be larger than the previous value.
(O) COMPANY_LOGO
(In Microsoft version only)
Use this parameter to add your corporate logo to the default templates in the interface for Excel. Enter the file name for the logo image that you want to display.
This image must be stored in the Application Set directory, which is "[Server Install]\Data\WebFolders\[Appset]".
EXAMPLEC:\Program Files\SAP BusinessObjects\PC_MS\Data\WebFolders\[Appset]
If the COMPANY_LOGO does not exist or the file name is invalid, the default globe image displays.
Allows the bmp, gif, and jpg image file types.
(O) DEFAULT_EXTENSIONS The system allows the default file type even if you do not set this parameter. The default file extensions are hard-coded internally.
The file extensions the system allows users to upload by default: .XLS, XLT, .DOC, .DOT, .PPT, .POT, .XML, .MHT, .MHTML, .HTM, .HTML, .XLSX, .XLSM, .XLSB, .ZIP, .PDF, .PPTX, .PPTM, .POTX, .POTM, .DOCX, .DOCM, .DOTX, .DOTM, .CDM, .TDM, .PNG, .GIF, .JPG, .CSS, .MRC. See ALLOWEXTENSIONS above.
The user can change the value.
This parameter is used in:
Interface for the Web - When posting documents in the Content library menu
Interface for Office - Send Data, Journal-post, DM-Import
Type Key ID Description
(O) DTSSTATUSCHECK
(In Microsoft version only)
Use this parameter to hide or show the Refresh Status Every checkbox in the Data Manager Status View.
If the checkbox is enabled and large records exist, the performance when refreshing the status degrades. By hiding the checkbox, the refresh is performed whenever a user calls the refresh button manually.
Possible values for this parameter are:
0: Hides the checkbox
1: Show the checkbox
(O) EVDRE_STYLES
(In Microsoft version only)
Use this parameter to specify a report or input template containing the default style sheet. If no style template is specified in the EVDRE builder in the Formatting section, then the default stylesheet is applied from the template specified in this parameter.
This allows users to customize their formatting and save the customization as the default style template. They do not have to manually reapply the template for each new report. Users can overwrite the default formatting for a given report or input template by using existing formatting options.
The priority of formatting for a new EVDRE report or input template is:
If a template is supplied in the Allow Formatting section, it is used.
Otherwise, the style template specified in the EVDRE_STYLES parameter is used.
Otherwise, the default EVDRE colors are used.
By default, this parameter is empty. Style templates that are used for EVDRE formatting can be stored in any folder in the file service. The full file service path must be specified in the parameter, starting with //root/ of the file service, so that one template can be used globally, regardless of the AppSet.
Changes to the style template specified in this parameter do not affect reports and schedules previously created from this template.
(O) EXECUTECUSTOMQUERY
(In Microsoft version only)
Set to Y to query the database using predefined SQL statements stored in the tblCustomQuery table.
Type Key ID Description
(R) FILESFOLDERDELIMITER
(In Microsoft version only)
When you create Web-ready files in Excel, the system creates subfolders based on the native Excel Save as HTML function. Since the naming rule of the subfolder is different for each Microsoft Office language, this parameter allows the system to find the subfolder having the defined delimiter when selecting Web-ready files in Interface for the Web. (Required)
The default value is _:.:-. You must define a value for this parameter if the value is empty, or does not contain the required delimiter for your Microsoft Office version. Separate multiple delimiters with a colon; for example, :,:_.
EXAMPLE
For example, under a folder named 'Report.htm', the system creates the following subfolders:
Chinese: report.file
English: report_files
French: report_fichiers
German: report-Dateien
Italian: report-file
Japanese: report.files
Korean: report.files
The user can define this delimiter depending on their country. Use “:” to separate multiple values.
This parameter is used in Interface for Office - book publishing.
(O) JREPORTZOOM This parameter allows you to set the default zoom magnification value on HTML journal reports.
We recommend that you set the value to 75%.
(O) LANDINGPAGEITEM This parameter allows you to set up a web page as your home page for the Web interface. Once you set this, this page displays for all users of this application set. The page must first exist as a Web page in Interface for the Web. (See Creating a Web Page.)
The default value is 1. or you can enter the number that represents the web page you want to make your home page.
(O) LIMITOFDIFFERENCE
(In Microsoft version only)
The least value for which the system processes logic. If a data value is smaller than this value, they system does not process the logic. For example, when you set 0.001, smaller data values, such as 0.0009, are not processed by logic.
The default value is .00000001, so if the parameter is not set, logic ignores less than 0.00000001.
This parameter is used in Script Logic - Processing of script logic.
Type Key ID Description
(O) LOGLEVEL
(In NetWeaver version only)
Controls the minimum level of ABAP messages to store in the log in terms of severity, which you view by the transaction SLG1.
The default value for this parameter is Info.
The possible values for this parameter are:
Donothing
Info
Warning
Error
Fatal
(O) LOGLEVEL
(In Microsoft version only)
This parameter controls the severity level of messages to store in the log file.
The default value for this parameter is Info.
The possible values for this parameter are:
None
Info
Warning
Error
Fatal
(O) LOPTZ_AVAILABLE This parameter takes the system offline during a minimal optimization of an application.
The default value for this parameter is: 0.
The possible values for this parameter are:
0 – do not change to offline
1 – change to offline
This parameter is used in Admin - Lite optimize.
(O) MAXLRCOLUMNS The maximum number of columns to display in a live report in Interface for the Web. The value includes header and data columns.
The default value is 30.
EXAMPLE
If you specify a value of 5, one heading column and four data columns are displayed.
(O) MAXLRROWS The maximum number of rows to display in a live report in Interface for the Web.
The default value is 50. and the value includes both header and data rows.
EXAMPLE
If you specify a value of 5, one heading row and four data rows are displayed.
Type Key ID Description
(O) MSNIMPASSWORD The password that the system uses to operate Instant Message alerts in Insight.
The default value is blank.
This parameter is used in Insight - Alert.
(O) MSNIMUSER The user name that the system uses to operate Instant Message alerts in Insight.
The default value is blank.
This parameter is used in Insight — Alert.
(O) MULTIBYTE_FORMULA
(In Microsoft version only)
Use this parameter to support dimension formulas with member IDs that contain double-byte characters, such as those in Japanese, Chinese, Korean, and Russian.
The value defines the dimension formula column type as Nvarchar or Varchar.
The default value is blank. Possible values are:
1 – Dimension formula column is nvarchar instead of varchar to support double-byte characters.
N/A or blank or 0 - Dimension formula column is varchar.
This parameter is used in Admin - Process dimension.
(O) RETRIEVE_ON_OFFLINE
(In Microsoft version only)
Use this parameter to restrict data retrieval and export while an application set is unavailable (system offline).
The options are:
0: Does not allow retrieving or exporting data while an application set is unavailable regardless ofOfflineAccess task security.
1 (default): Allows retrieving or exporting data while an application set is unavailable (system offline) if the user has OfflineAccess task security.
:
The following tasks are exceptions to rule, and can be executed when the value is 0:
Execute logic (script, business rules) from DM packages
Run Export from fact table package
Run Append into Fact Table package
Add new comments
Save data through DHE (Dynamic Hierarchy Editor)
This parameter is used in all functions that retrieve or export data. For example: Refresh data in Interface for Office and Interface for the Web, Export DM package, Book Publish, and so on.
Type Key ID Description
(O) RUNPKGBYEXE
(In Microsoft version only)
Allows for the use of an .EXE file type wrapper for running a package out of process from COM+.
The options are:
0: Run in process
1 (default): Run out of process
(O) SESSIONTIME Defines the session time (in minutes) for the Who’s Online feature.
The default value is 3000 minutes.
(R) SMTPAUTH
(In Microsoft version only)
The authentication method of the SMTP server.
This setting does not change the method on the SMTP server, but must match the type of authentication enabled on it. Failure to set this appropriately can result in errors from the e-mail server.
The default value is: 1.
Possible values for this parameter are:
0 = Anonymous
1 = Basic
2 = NTLM
This parameter is used in:
Interface for the Web - When posting documents, Work status, Alert
Interface for Office - Offline distributor
(O) SMTPPASSWORD
(In Microsoft version only)
The password for the user name defined as the SMTPUSER.
This parameter is Optional except when SMTPAUTH is “1” (basic), this parameter is Required
The default value is blank.
The user can input the SMTP password.
This parameter is used in:
Interface for the Web - When posting documents, Work status, Alert
Interface for Office - Offline distributor
(R) SMTPPORT
(In Microsoft version only)
Port number for your SMTP e-mail server.
The default is port 25, the default SMTP server port number.
The user can input the port number.
This parameter is used in:
Interface for the Web - When posting documents, Work status, Alert
Interface for Office - Offline distributor
Type Key ID Description
(R) SMTPSERVER
(In Microsoft version only)
The name or TCP/IP address of the SMTP e-mail server the system uses to send e-mail.
The default value is blank.
The user can input the SMTP Server name or TCP/IP address.
This parameter is used in:
Interface for the Web - When posting documents, Work status, Alert
Interface for Office - Offline distributor
(R) SMTPUSER
(In Microsoft version only)
The user name from which e-mail from the system originates.
The default value is blank.
The user can input the User name.
This parameter is used in:
Interface for the Web - When posting documents, Work status, Alert
Interface for Office - Offline distributor
(R) TEMPLATEVERSION Current version number of the dynamic templates in your application set. Whenever you add to or change your input schedule or report dynamic templates, you should increment this version number so that users automatically receive the new templates when they log on to this application set.
You can also reset the template version from the Admin Console.
The default value is the current version number of the dynamic templates in your application set.
The user can input the version, or it changes automatically.
This parameter is used in Interface for Office - Logon, Save dynamic template.
(O) TRACELEVEL Defines the level of tracing to conduct. The default value is Error. The following levels are available:
Donothing
Debug
Path
Info
Warning
Error
(O) TRACEUSER Defines the Planning and Consolidation user for which the system performs remote tracing, in the formDomainName\UserName. This parameter is blank by default, and is populated by an administrator only when conducting tracing activities for a specific client.
Type Key ID Description
(O) UNLIMIT_PRINT_LOG
(In Microsoft version only)
Determines whether all posted records are written in the log file. The default value is NO.
The available options are:
YES – all posted records are written to the log file
NO – all posted records are written to the log file unless there are more than 300,000 records
If there are more than 300,000 records, no records are written but replaced with the message More than 300,000 records. Details are not being logged.
This parameter is used in Script Logic.
(R) UPLOADTEMP Temporary folder used to store Content Library documents.
The default value is: <drive>\FTPServer\OSoftFTP (where <drive> is Folder name that was created at installation.)
The user can input the path and, if the system was installed in a different named folder, the Administrator must change this path according to the path.
This parameter is used in Interface for the Web - Upload document in the Content Library menu.
(O) USE_VARCHAR_FOR_DIM
(In Microsoft version only)
This parameter will be available in a future release.
To set the SQL data type as Nvarchar or Varchar for the dimension tables, you must edit the App column in the tblDefaults table. The default for dimension tables is Nvarchar, which is typically used for double-byte character languages such as Korean, Japanese, Chinese, or Russian.
You might want to change the setting to Varchar if you have space restriction issues in SQL and OLAP, or if you are not storing unicode data.
In the tblDefaults table, you can enter a specific dimension name or leave the KeyID cell blank. If the KeyID is a specific dimension name, it is applied to only the specific dimension; if the KeyID is blank, all dimensions are applied in all dim tables.
EXAMPLE
This is tblDefaults table that manages all of system parameters.
User Id Type App Key ID Value
_GLOBAL
SYSTEM
USE_VARCHAR_FOR_DIM
ACCOUNT
1
ActivitiesTo update the value of a parameter, start the Administration interface, and from the action pane, select Set AppSet parameters. Modify the parameters, as desired, and then click Update.
To add a new parameter (you can add any 'optional' parameter if it is not already displayed), add a new row, enter the parameter name, then enter the desired value.
Format Ranges
You define format ranges that can point either to one cell or to an entire range of cells.
FeaturesFor one cell, EVDRE applies the format of the defined cell to the entire data range.
For a range of cells, EVDRE interprets the content of the cells in the defined range to derive the formatting instructions, then applies them to different areas in the report range.
When you leave the FormatRange cell blank, EvDRE automatically derives the format of the data range from the format of the top left cell of the data range to be expanded.
You can define one or multiple format values:
Define one format value
You can point to one cell for the data cell format, define the format range, then select eTools Expand All .
Define multiple format values
You can define multiple format values when you want to define formatting for different areas of report.
You can specify multiple formatting instructions using multiple rows, each row representing one formatting instruction.
The system executes the EvDRE function in sequence from the first (top row) to the last (bottom row) in the range.
You can define which format should prevail over conflicting formats (for example, the Locked format overwrites the Calc format, which in turn overwrites the Default format).
You can overlay different formatting properties on the same cell. You can also define a different format for different ranges of the sheet.
NOTE
FormatRange supports empty members in both Row and Column MemberSet definitions to allow for more versatile formatting.
Scaling EvDRE Data
You can scale EvDRE data to the thousands using standard Excel options. From an EvDRE workbook, right click on the cell you want to scale. Select Format Cells Number Custom . Select #,##0.00,_);[Red](#,##0.00,), then choose OK. For example, if you enter 1000 in a cell with this formatting applied, Excel shows 1.00.
ActivitiesTo define multiple formats, set up a table in EvDRE with six columns. Each column represents a separate parameter of a formatting instruction. See Multiple Format Ranges.
Data Modeling
You can use this function to input your numbers when creating an input schedule.
FeaturesYou can use the following modeling options:
Spread
The Spread modeling option allows you to take a value and allocate it among selected destination cells. The value can be allocated equally, or it can be weighted by a range of values. For example, you can take the value 100,000 and spread it across a number of columns that represent each month of the year. See Spread Modeling.
Trend
The Trend modeling option takes a value or percentage and grows it by a factor among selected cells. This option places the source value in the first cell of the destination range. Each subsequent cell in the destination increases by the amount or percentage specified. See Trend Modeling.
Weight
The Weighted modeling option lets you allocate a set of values by weighted factors in your spreadsheet. It allows you to take a set of values, grow them if desired, and then allocate the new amount based on the relative weights of the selected cells. The destination range is the same as the weight range. For example, you can weigh 12 months of revenue based on 12 months of cost of sales. See Weighted Modeling.
Spread Modeling
This function allows you to take a value and allocate it among selected destination cells.
FeaturesYou use the following features for spread modeling:
Feature Description
Source Value The total value to be spread.
Destination The cells to which the system writes the results of the spread.
Weights (optional feature)
A range containing weight values to apply to the spread. This range contains the same number of cells as the destination range.
Add to Existing Values (optional feature)
Select this checkbox to take the spread amount to each cell and add it to any existing values already in the destination range. If you leave it blank, the amount spread to each cell overwrites the amounts in the destination cells.
ActivitiesTo spread an amount, open the input schedule and select Spread from the action pane.
Trend Modeling
This function allows you to take a value and grow it by a factor among selected cells.
FeaturesYou can use the following features for trend modeling:
Screen Element
Description
Source Value The initial value from which the trend begins.
Screen Element
Description
Destination Range
A range of cells to which the results of the trend are written.
By Percentage A specified percentage of the previous value (previous cell) in the destination range. To create an increasing trend, use a positive percentage. To create a declining trend, use a negative percentage.
By Value A specified amount over the previous value (previous cell) in the destination range. To create an increasing trend, enter a positive value. To create a declining trend, enter a negative value.
Add to Existing Values
Select this checkbox to take the spread amount to each cell and add it to any existing values already in the destination range. If you leave it blank, the amount spread to each cell overwrites the amounts in the destination cells.
ActivitiesTo use trend modeling, open the input schedule and select Trend from the action pane.
Weighted Modeling
You use this function to take an amount, grow it, and then allocate the new amount based on the relative weights of the selected cells.
FeaturesYou use the following features for weighted modeling.
Sum to Allocate — The initial sum from which the allocation begins. This amount defaults to the sum of the selected cells.
Weighted Destination — A range of cells that contain relative weights, to which the results of the allocation are written.
By Percentage — Increase of the overall sum to allocate by the specified percentage before allocating.
By Value — Increase of the overall sum to allocate by the specified value before allocating.
ActivitiesTo allocate an amount by a weighted factor, open the input schedule and choose Weight from the action pane.
Data Submission
You use this process to submit data to a central database.
FeaturesWhen submitting data, you can do the following:
Send active worksheet or workbook. Sends all changed records on the active worksheet or workbook, respectively.
NOTE
Planning and Consolidation places a limit on the number of digits it can send. Currently, the number of digits that Planning and Consolidation supports when sending data is from -9999999999999.9999999 (smallest: 13 digits on the left of decimal and 7 digits to the right of the decimal) to 99999999999999.9999999 (largest: 14 digits to the left of the decimal and 7 digits to the left of the decimal). A number smaller or larger, respectively, than the valid range is either rejected or regarded as invalid in the system.
Submit supporting documents. This option opens the Content Library where you can post a file with or without application context. See Content Library.
Set work status. See Work Status.
NOTE
If the work status or data submission validation is enabled by your administrator, the system checks to make sure there are no work status locks or validity issues, respectively, on the data region. A validity check includes making sure that the members are valid, the periodicity is correct, and the member type is correct (for example, the member is not a calculated member). A concurrency check, which prevents data from being sent concurrently to the same region, is always performed by the system for data submissions.
ActivitiesFrom an input schedule, select Send Data from the Schedule Options action pane.
Member Lookup
You use this function to select specific members to use in reports, input schedules, journals, member security definitions, and data management packages.
In addition, from Interface for Excel, you can use it to copy and paste member lists into spreadsheets.
FeaturesYou can use the following features when using Member Lookup, some of which are available only when performing certain tasks within the system:
Feature Description
Select members
You can select members at any time to display in your report or input schedule. You can select only the dimensions and members to which you have access.
To select a member, do one of the following:
Highlight that member and click OK.
Right-click the member and choose an option:
Select sibling members of the current member
Select all children of the current member
Unselect sibling members of the current member
Unselect all children of the current member
Populate all children of the current member
If a section is disabled, all members in the dimension are selected, and all members are returned to the report or input schedule upon clicking OK.
You can select the checkbox next to one or more members to copy them to the active spreadsheet.
Feature Description
Filter members You can filter the member list based on member properties as well as hierarchy.
You select a property, an operator, and a value, then click Refresh to apply your changes to the current list.
You can specify a filter on one or more properties. If you define a filter, the members can only be displayed in Table data view (not hierarchical).
When filtering by properties, the following options are available:
= Equal
< > Not equal
LIKE — A pattern match that supports using an asterisk ( * ) before or after the value
BT — A range between a low and high value
If you set selections with the same property, the logic operator between each selection is OR. If you set selections with different properties, the logic operator between each selection is AND.
For example, when you set the following selections:Attr1 = 1
Attr1 bt 3 to 7
Attr2 <> 10
The filter is ((Attr1 = 1 or (Attr1 >=3 and Attr1 <=7)) and Attr2 <> 10).
The logic operator for hierarchy selections is OR.
For example:2006.JAN SELF
2005.TOTAL BAS
The filter is (SELF(2006.JAN) or BAS(2005.TOTAL)).
The logic operator between Hierarchy selections and Attribute selections is AND.
For example:Attr1 = 1
Attr1 bt 3 to 7
Attr2 <> 10
2006.JAN SELF
y2005.TOTAL BAS
The filter is ((Attr1 = 1 or (Attr1 >=3 and Attr1 <=7)) and Attr2 <> 10) or (SELF(2006.JAN) or BAS(2005.TOTAL)).
You can filter by hierarchy in Data Manager. The following information applies:
You can use the following filter options:
SELF — the value itself
DEP — direct children of the value
BAS — all the base members of the value’s children
ALL — all the children of the value
You can save and modify filters using Maintain Filter. You can use the saved filters when selecting members for Data Manager packages.
You can choose whether to return the members or filter to Data Manager by choosing Return By.
Feature Description
View member properties or attributes
You can view the property values and attributes of a selected member. Members that are available for use when creating and modifying reports or input schedules are enabled. Properties that are for information purposes only are disabled.
You can view a member's properties by opening the Member Lookup, then doing one of the following:
Right-click the desired member, then select Member properties.
Click the Show selected member properties link.
After reviewing the list, click OK to close the Properties dialog box.
Set Member Lookup options
You can set options that control behavior on the Member Lookup dialog box.
To access the Member Lookup Options dialog box, open the Member Lookup, then select the Options button.
In the Double-click Options section, select the checkbox if you want to select the member and return to the worksheet by double-clicking a member. This option closes the Member Lookup and returns to the active report or input schedule. If unselected, a double-click expands or collapses the member when double-clicked. This option keeps the Member Lookup open.
The Select All Children Behavior section determines how members are selected when you use the Copy option to copy one or more members and paste them into your spreadsheet. See Copy and Paste Member Lists, below.
Do one of the following:
Select Select direct children only to only copy the members directly below the selected member.
Select Select all descendents to copy all descendents of the selected member.
Copy and Paste Member Lists
You can copy members from Member Lookup and paste them into a spreadsheet. You can use this feature to create journal entries, reports, or input schedules.
You can copy and paste a member list by doing the following:
1. Open the report, input schedule, or journal template from the Excel interface. Open Member Lookup for the applicable dimension.
2. Select a member or choose Select sibling members for the selected member.
3. Select the rows and columns in which to place the members. Choose the Copy Members button, then in the Copy Members dialog box, select in rows to place the members in the rows, or select in columns to place the members on the columns.
4. Select the first cell in which you want to place the members. Select Edit Paste to paste the members.
Feature Description
Select Members from Dynamic Hierarchy
You can select members from Dynamic Hierarchy if Dynamic Hierarchy is available. The Dynamic Hierarchy option is available only for the entity type and group type dimensions, or the currency type dimension if the group Members are included in the currency type dimension, in a consolidation application, and a dynamic hierarchy is built and stored in the ownership application.
You can select only the dimensions and members to which you have access. With the Dynamic Hierarchy option, the Entity and Group (or Currency) dimension hierarchies are dynamically displayed according to the consolidation hierarchy that was built for the time and category member selected in the current view.
To select a member from Dynamic Hierarchy, do one of the following:
Select a group member from the dynamic hierarchy if the group (or currency) dimension member selector is open, or select an entity member from the dynamic hierarchy if the entity dimension member selector is launched.
Highlight that member and click OK.
Right-click the member and choose an option:
Select sibling members of the current member
Select all children of the current member
Unselect sibling members of the current member
Unselect all children of the current member
Populate all children of the current member
If a section is disabled, all members in the dimension are selected, and all members are returned to the report or input schedule upon clicking OK.
If a dimension does not have a dynamic hierarchy, the dynamic hierarchy option is unavailable. You can select the checkbox next to one or more members to copy them to the active spreadsheet.
The Dynamic Hierarchy option is available only in the Excel client, specifically in the action pane, EVDRE report, EVCVW function, and in the embedded Excel object in the Office client. Its availability also depends on ownership transaction data.
ActivitiesTo access the Member Lookup, do one of the following:
Choose a dimension member from the Session Information section of the action pane, select the down arrow next to a dimension, then select more.
From the eTools menu, select Select Members, then select the dimension whose members you want to view.
Right-click any cell in a workbook and select Select Members, then select the dimension whose members you want to view.
Run Data Manager packages for which you need to select members.
When selecting members, be aware that using the operator Between functions as expected for all types of dimensions except for Time. Between is a string comparison, and therefore does not take into account the concept of time. For example, if you want to select all members under 2005.TOTAL and 2006.TOTAL, setting up ID BT 2005.TOTAL to 2006.TOTAL would be incorrect because the string 2005.Q1 does not fall between 2005.TOTALand 2006.TOTAL. 2005.Q1 would not be selected.
More InformationReports and Input Schedules
Data Management for the NetWeaver platform or Data Management for the Microsoft platform
Journals
Data Management
The Data Manager is a Planning and Consolidation module that helps you move data into the Planning and Consolidation system, copy and move data within and across applications, and export data from an application by means of packages. Data Manager packages are based on process chains, which are sequences of processes that are scheduled to wait in the background for an event. Some of these processes trigger a separate event that can, in turn, start other processes.
FeaturesData Transfer from an Application to the File Service
The Data Manager allows you to transfer data files to and from the file service. You can also use the data preview feature to preview data files stored on the file service. This allows you to see the format of your data when deciding how to set up a transformation (see Previewing Data Files).
Run and View the Status of Packages and Package Links
The Data Manager allows you to schedule, run, and view the runtime status of any package and package link (see Running a Package and Viewing the Status of a Package.
View Schedule Status of Packages and Package Links
The Data Manager allows you to view the scheduling status of any package and package link (see Running a Package Link and Viewing the Status of a Package Link).
Manage and Maintain Transformations and Conversions for Data Management Tasks
This includes the management, maintenance, and validation of conversion and transformation files (see Data Conversion Maintenance and Data Transformation Maintenance).
Manage Packages
Package organization in the Data Manager involves adding, modifying, moving, copying, and removing packages and package groups. This also includes assigning them to be available to specific teams of users.
You can use the dynamic script editor to set up scripts to create a user interface for package prompts, for example, to preassign parameters to automate the running of packages. You can modify existing prompts and create new ones.
Packages and process chains that execute data management tasks are categorized as follows:
Data management tasks Export data Import master data from an SAP NetWeaver Business Warehouse InfoObject Write mode examples Import compound SAP NetWeaver Business Warehouse InfoObjects Import hierarchies from an SAP NetWeaver Business Warehouse InfoObject Clear data Copy data Move data Import transaction data from a flat file Import master data from a data file Import master data descriptions from a flat file Import transaction data from an SAP NetWeaver Business Warehouse InfoProvider Retracting master data and transaction data via a BAdI Import and send e-mail package Import using FTP
Financial processes Run allocations Calculate ownership
Currency restatement Intercompany reconciliations Intercompany bookings Intercompany eliminations Legal consolidation Opening balance calculation Account transformations Validations
System administration tasks Application optimization Dimension member processing Validate logic Run activity archiving Run data archiving
Starting the Data Manager
The Data Manager is integrated within the Excel interface. To start the Data Manager, choose the Planning and Consolidation icon on your desktop, then choose Interface for Excel Manage Data .
Previewing Data Files
You can preview the first 200 lines of uploaded data files stored in the data file folder in the File Service. This is useful when creating a transformation file and you want to see a preview of the data presentation.
Procedure1. Choose eData Data Preview .2. Select a site.3. Select a directory and a data file, and choose OK.4. Select a different file and choose Open to preview another file. Choose Cancel when you have
finished previewing the data.
Running a Package
PrerequisitesThe package has been defined (see Package Usage).
Procedure1. In the Manage Data Options action pane, choose Run a package.2. In the Run Package dialog box, perform the following steps:
1. Select a team (optional).2. Select a folder from among the Package Group folders.
NOTE
Administrators see the package group selection screen. Non-administrative users see the list of packages.
3. Click Run.4. Enter data as required.
The information you must enter depends on the definition of the package.
NOTE
After the package is executed or scheduled, you can check its status. If you are using the Microsoft version of Planning and Consoldiation, see Viewing the Status of a Package. If you are using the NetWeaver version, see Viewing the Status of a Package.
Package Usage
Access to packages in the Data Manager is controlled by the task security that an administrator sets.
FeaturesYou can perform the following tasks with packages:
Run or schedule packages (see Running a Package) View schedule package status (see Viewing the Status of a Package Schedule) View package status (see Viewing the Status of a Package) Maintain packages (see Package Maintenance (Organization)) Assign packages to teams (see Assigning Packages to Teams) Test packages (see Testing Packages) Use logic in your packages (see Logic Usage in Packages)
More InformationStandard Packages
Viewing the Status of a Package Schedule
Use this procedure to do the following:
View the status of a package schedule Edit package schedules View a history of when a package was run against a schedule Edit package parameters Delete schedules
PrerequisitesA package is scheduled.
ProcedureChoose eData Packages Schedule Status .
More InformationRunning a Package
Viewing the Status of a Package Schedule
Use this procedure to do the following:
View the status of a package schedule Edit package schedules View a history of when a package was run against a schedule Edit package parameters Delete schedules
PrerequisitesA package is scheduled.
ProcedureChoose eData Packages Schedule Status .
More InformationRunning a Package
You can maintain the packages that are available in the Data Manager. You can perform the following package organization tasks:
Add or edit packages. See Adding and Modifying Packages. Move or copy packages. See Moving or Copying Packages. Remove packages. See Removing Packages.
Adding and Modifying Packages
After creating a package in SQL Server Business Intelligence Development Studio, you must add it to the Data Manager.
You can also take that package and modify it within Data Manager. You can modify packages through SSIS (as described below) or you can modify packages using custom tasks using the MODIFYSCRIPT package variable. TheMODIFYSCRIPT package variable allows you to set up predefined answers to package prompts so that you can automate running packages. See MODIFYSCRIPT Package Variable Task Usage.
PrerequisitesYou have created a package using SQL Server Business Intelligence Development Studio, and you have appropriate task security to add or modify packages. See the Planning and Consolidation Security Guide for more information.
ProcedureTo add a package to Data Manager:
1. Choose eData Organize Package List 2. Select a team and package group and click Add Package.3. Enter data as required. See Package Properties.4. Save your changes.
To modify a package:
1. From the application server, start Microsoft SQL Server Business Intelligence Developer Studio.2. In the context menu of the Microsoft SSIS folder, click Open Package.3. In the target application set and application, choose \\DataManager\PackageFiles\
Examples\.4. Select a sample package.5. In the Select Package dialog box, select the package you want to modify and click OK.6. Open the task to modify and view its properties. See Custom Tasks.
MODIFYSCRIPT Package Variable Task Usage
MODIFYSCRIPT Package Variable is a custom task that can be inserted into any package in the Data Manager to modify the package itself, when executed. When this task runs, it modifies the properties of objects contained in the package (such as tasks and connections), according to some user-defined instructions specified in the task itself. MODIFYSCRIPT provides you with a single interface from which you can specify a modification for any property within the package. You can use this task to automate processes by replacing user-provided information with script-provided information.
NOTE
This section explains how to use MODIFYSCRIPT Package Variables to modify the behavior of packages at runtime. For help on building packages, see Microsoft SQL Server documentation. In the sample packages included with Planning and Consolidation, the MODIFYSCRIPT variable must be defined as Package Variable (and MODIFYSCRIPT must be capitalized in SSIS Variables.) Some knowledge of Microsoft SSISpackages is recommended for working with the MODIFYSCRIPT variable.
Package Properties
The following table describes the fields you must complete when adding or editing packages. If any of these fields are incorrect or left blank, the package generates an error when the package is executed.
Field Description
Package type
FILE or SQL
File If the FILE package type is selected, a file text box is displayed so that you can specify the file that contains the package.
NOTE
You can find example packages in the Examples folder. See Adding Sample Packages to the Data Manager. Choose eData Data Upload to upload package files to the MyFiles or Examplespackage group. See Transferring Files Using OSoftTaskFtp2008.
NOTE
The System Files group is read-only and contains packages that are maintained by SAP. You cannot upload files to this group.
Package name
The name of the package. If the file contains packages, you can view a list of available packages (when you select the file package type).
Group The folder group to which the package is added. You can define a new group here.
Description A description of the package.
Task Type You can control who has access to run the package. If you select Admin Package, only users who are Planning and Consolidation Administrators can run an administrative package. The package can still be saved to a team that contains non-administrative users. A non-administrative user can see the package, but cannot execute it. If you select User Package, users who have been assigned the Execute Data Management task security privilege can execute the task.
Adding Sample Packages to the Data Manager
Procedure1. Choose eData Organize Package List .2. Select or create a package group and click Add Package.3. Enter data as required. See Package Properties.
4. Package Properties 5. 6. The following table describes the fields you must complete when adding or editing packages. If
any of these fields are incorrect or left blank, the package generates an error when the package is executed.
Field Description
Package type
FILE or SQL
File If the FILE package type is selected, a file text box is displayed so that you can specify the file that contains the package.
NOTE
You can find example packages in the Examples folder. See Adding Sample Packages to the Data Manager. Choose eData Data Upload to upload package files to the MyFiles or Examplespackage group. See Transferring Files Using OSoftTaskFtp2008.
NOTE
The System Files group is read-only and contains packages that are maintained by SAP. You cannot upload files to this group.
Package name
The name of the package. If the file contains packages, you can view a list of available packages (when you select the file package type).
Group The folder group to which the package is added. You can define a new group here.
Description A description of the package.
Task Type You can control who has access to run the package. If you select Admin Package, only users who are Planning and Consolidation Administrators can run an administrative package. The package can still be saved to a team that contains non-administrative users. A non-administrative user can see the package, but cannot execute it. If you select User Package, users who have been assigned the Execute Data Management task security privilege can execute the task.
Transferring Files
PrerequisitesThe FTP task (OSoftTaskFtp2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server.2. Select the task and add it to the package. See Adding and Modifying Packages.3. Open the task and enter the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
4. Type the FTP site (tcp/ip address or url of the computer), user name and password to access the FTP site, and the port number (the default is port 21, which is the FTP protocol default).
5. Enter the number of times the task should retry to connect to the FTP site.6. Enter a destination directory.7. On the Files tab, select one or more files to transfer. Choose move to destination and select the
files to be downloaded.
NOTE
You can select from a list of files in a directory. Alternately, choose move all to destination to select all displayed files for download.
8. Click OK.
NOTE
You can use TASK commands in the EvDTSModifyPkg task to automatically complete the information for you.
Registering Custom Tasks
Planning and Consolidation comes with some proprietary tasks. Before you can use them to create custom packages, you must register them in Microsoft SQL Server Business Intelligence Developer Studio.
You can register all Planning and Consolidation tasks at one time, or do them separately.
Procedure
To register multiple tasks
1. Copy the required <task>.dll files from <BPC_home>/BPC/Websrvr/Bin to the Microsoft SQL Server Business Intelligence Developer Studio tasks folder (/Program Files/Microsoft SQL Server/100/DTS/Tasks)
RECOMMENDATION
You must copy the files on the server where you intend to edit the SSIS packages using Visual Studio. In a multiserver environment, we recommend that this is on the application server tier not the database server tier.
The files to copy are some or all of the following: OSoftTaskAdmin2008.dll OSoftTaskAvailable2008.dll OSoftTaskComment2008.dll OSoftTaskConvert2008.dll OSoftTaskDumpLoad2008.dll OSoftTaskFtp2008.dll OSoftTaskLogic2008.dll OSoftTaskMakeDim2008.dll OSoftTaskOwnership2008.dll OSoftTaskSendMail2008.dll OSoftTaskTrigger2008.dll
2. From the server where you want to edit the SSIS packages, choose Start Programs Microsoft SQL server 2008 SQL Server Business Intelligence Development Studio
3. Choose File New Project 4. Select Business Intelligence Projects5. Select Integration Services Project6. Enter the package name, for example, test1 and click OK
7. In SSIS, click Toolbox on the Tool bar to open the Toolbox view8. Right click the Toolbox label and select Choose Item9. In the Choose Toolbox Items view, select the SSIS Control Flow Items tab and then select all the
tasks that you copied in step 110. Click OK
This registers the custom tasks and makes them visible in the toolbox. By default, the custom tasks are added to the Control Flow Items tab.
To make a new tab for the custom tasks, do the following:
Right click the Toolbox label and select Add Tab Enter a suitable title Move all the custom tasks to the new tab using drag and drop
To register a single task
1. In Microsoft SSIS, create or open the package to which you want to add the task.2. Choose Task Register Custom Task .
Task description: Ensure that the task description matches the task name. Location: <BPC_home>/BPC/Websrvr/Bin/[task name].dll
3. Click OK.
Custom Tasks
Planning and Consolidation provides custom Microsoft SSIS tasks that allow you to manage your data and perform unattended administration tasks. You can also create your own custom tasks for use in Planning and Consolidation.
PrerequisitesBefore you can use a custom task in Data Manager, take the following steps:
Register the task. See Registering Custom Tasks.
Add the task to a package. See Adding and Modifying Packages.
FeaturesThe following table describes the custom tasks that are provided in Planning and Consolidation:
Task More Information
DumpLoad This task has a number of data dump and data retrieval functions.
See DumpLoad Task Usage.
Admin This task enables you to run one of a number of eAdmin tasks through Microsoft SSIS.
See Admin Task Usage.
Send Mail This task sends an e-mail message before or after another task has processed.
See Send Mail Task Usage.
Trigger This task allows you to wait for a trigger condition before processing the next task.
See Trigger Task Usage.
System Available
This task allows you to control whether the system is set to available (online) or not available (not online) status.
See System Available Task Usage.
FTP This task allows you to transfer data files from an FTP site to the Planning and Consolidation server.
See FTP Task Usage.
Logic This task is a Microsoft SSIS version of the Planning and Consolidation Logic module that can be used from within the Data Manager module. This allows you to use the full power of the logic module in a batch setting.
See Logic Task Usage.
Convert This task takes an input data and transformation file (which may or may not use conversion files) to create an output file. For example, an input file could be a file exported from a similar product. You can use transformation and conversion files to convert to the Planning and Consolidation format.
Make Dimension
This task creates dimension members using a Microsoft SQL Server table and schedules the processing of dimension members. For example, if a new member ID is added, this process updates the fac2table with the updated list.
DumpLoad Task Usage
This task has a number of data dump and data retrieval functions and can be added to any package.
You can provide information for the necessary fields directly in the Microsoft SQL interface or by script using ModifyScript.
More InformationMODIFYSCRIPT Package Variable (DumpLoad)
MODIFYSCRIPT Package Variable (DumpLoad)
You can use the following dump load task commands in the MODIFYSCRIPT Package Variable task:
TASK(TASKNAME,DESCRIPTION,TASKNAME)
TASK(TASKNAME,APPSET,apshell)
TASK(TASKNAME,APP,finance)
TASK(TASKNAME,USER,tonyd)
TASK(TASKNAME,DATATRANSFERMODE,1)
TASK(TASKNAME,”CHECKLCK”,1)
TASK(TASKNAME,PROCESSMODE, 2)
TASK(TASKNAME,PROCESSCUBE,1)
TASK(TASKNAME,PROCESSCUBE_FAC2,)
TASK(TASKNAME,FILE,C:\...\Webfolders\ApShell\Finance\DataManager\DataFiles\Examples\Import.txt)
TASK(TASKNAME,SQL,)
TASK(TASKNAME,MDX,)
TASK(TASKNAME,MAXMEMBERS,)
TASK(TASKNAME,SELECTION,)
TASK(TASKNAME,CLEARDATA,0)
TASK(TASKNAME,TIMEIDFORMAT,0)
TASK(TASKNAME,SELECTIONFROMTASK,"CATEGORY,TIME,ENTITY")
TASK(TASKNAME,DIMLIST,"CATEGORY,TIME,ACCOUNT,ENTITY,DATASRC,INTCO,RPTCURRENCY")
TASK(TASKNAME,RUNTHELOGIC,0)
TASK(TASKNAME,GETMEASURE,)
TASK(TASKNAME,MACHINENAME,)
TASK(TASKNAME,VALIDATETMPFILE,)
TASK(TASKNAME,DMMCOPY,)
More InformationDATATRANSFERMODE Property
DumpLoad Task Usage
DATATRANSFERMODE Property
When using the Dumpload task (for example, TASK(DumpLoad, DATATRANSFERMODE, 4)), there are special property values for DATATRANSFERMODE. These values are shown in the following table:
Property Value
Description More Information
0 Process the application set Processing the Application
1 Import into SQL
This value is best for importing large data. You can check the work status setting on the data before importing. See Checking Work Status below.
Importing into SQL Server
2 Export from SQL Exporting from Microsoft SQL Server
3 Export from Cube Exporting from a Cube
4 Import into Cube (Fac2)
This value is best for importing small to medium data
Importing into a Cube
5 Clear data from SQL
You can check the work status setting on the data before clearing. See Checking Work Status below.
Clear Data from SQL
6 Import into Cube (WB) Importing into a Cube
9 Import Into Cube Append — Appends the value in the cube without clearing the existing data
Importing into a Cube
10 Export journal data Exporting Journal Data
Property Value
Description More Information
11 Restore journal data Restoring Journal Data
12 Clear journal data Clearing Journal Data
Checking Work Status
When you use the 1 (Import into SQL) and 5 (Clear Data from SQL) property values, you can have the system check the work status settings of the data being cleared from the database.
Use the following rule in the MODIFYSCRIPT package variable for DumpLoad:TASK (Task Name, “CHECKLCK”, 1)
Process Mode
Property Value
Description
1 Full Process. This rebuilds the entire application. Select this option if the application structure has changed.
2 Refresh. Clears data from the application and repopulates it with existing data
4 Fac2 Process. This option processes the short-term data storage (the FAC2 table). The Data Manager imports data to the short-term data storage by default, so there may be no need to process the entire application.
More InformationDumpLoad Task Usage
MODIFYSCRIPT Package Variable (DumpLoad)
Processing the Application
You can process the application in preparation for a task or as part of the maintenance subsequent to a task.
To automate application processing, select the Process application option.
PrerequisitesYou have advanced knowledge of Microsoft SSIS.
The Admin task (OSoftTaskAdmin2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server. See Adding and Modifying Packages.2. Select the task and add it to the package.3. Open the task and choose Process application.4. Enter the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
5. Select an application.6. Select Incremental or Full.7. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
More InformationAccessing Microsoft SSIS
Accessing Microsoft SSIS
ProcedureMicrosoft SSIS is available from the Microsoft SQL Server Business Intelligence Development Studio on the Planning and Consolidation server. It is not available from the Data Manager interface.
1. Open the Microsoft SQL Server Business Intelligence Development Studio on the Planning and Consolidation server.
2. Start a new project and select Integration Services Project.
Open the Microsoft SQL Server group and server.
3. Select the Microsoft SSIS folder.4. Open or create a package and add Planning and Consolidation tasks to the package.
Importing into SQL Server
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server.2. Select the task and add it to the package. See Adding or Modifying Packages.3. Open the task and choose Data Management Import into SQL .4. Fill in the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
5. Enter the path and name of an import file.
NOTE
By default, the import process appends the data in the import file to the data already in the database. To change this behavior, select Clear existing data and select the dimensions to clear.
6. Select the Process Cube option, then select one of the following options: The Full Process option rebuilds the entire application (cube). Select this option if the
application structure is changed. The FAC2 option processes just short-term data storage (the FAC2 table). The Data Manager
imports data to the short-term data storage by default, so there may be no need to process the entire application.
The Refresh Data option clears data from the application and repopulates it with existing data.
7. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Exporting from Microsoft SQL Server
You can export an ASCII text file that contains data from your Planning and Consolidation database.
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server. See Adding or Modifying Packages.2. Select the task and add it to the package.3. Open the task and choose Data Management Export from SQL .4. Fill in the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
5. Enter the path and name of an export file.6. Select Export time in timeID if you want the time members to use the TIMEID rather than time
member names.7. Select a time measure from the Measure list.8. You can enter a selection file that contains either of the following methods for specifying members:
A list of dimensions and members to export An SQL statement that returns the member list needed for export
9. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Exporting from a Cube
You can export an ASCII text file that contains data from your Planning and Consolidation database.
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server.2. Select the task and add it to the package. See Adding and Modifying Packages.3. Open the task and choose Data Management Export from Cube .
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files. See Validating Logic.
4. Enter the application set, application, and the user ID.5. Enter the path and name of an export file.6. Select Export time in timeID if you want the time members to use the TIMEID rather than time
member names.7. Select a time measure from the Measure list.8. You can enter a selection file that contains either of the following methods for specifying members:
A list of dimensions and members to export An SQL statement that returns the member list needed for export
9. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Validating Logic
In the Admin package, you can validate logic using the Validate logic option.
PrerequisitesYou have advanced knowledge of Microsoft SSIS.
The Admin task (OSoftTaskAdmin2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server.2. Select the task and add it to the package. See Adding and Modifying Packages.3. Open the task and choose Validate logic.4. Fill in the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
5. Select the logic file (*.lgf) to be validated.6. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Importing into a Cube
There are three ways to import an ASCII text file directly into a cube:
The Import into Cube (Fac2) option allows you to import data into the Fac2 table. The Import into Cube (WB) imports data into the write-back table. The Import into Cube Append option appends the data in the import file to the data already in the
database.
You must add this task using SQL Server Business Intelligence Development Studio.
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open the package that you want to modify, or create a new package in Microsoft SSIS.2. Select the DumpLoad task and add it to the package.3. Open the task and choose Data Management Import into cube (Fac2), Import into cube (WB),
or Import into Cube Append .4. Enter data as required.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
5. Select the Process Cube option, then select one of the following options: The Full Process option rebuilds the entire application (cube). Select this option if the
application structure is changed. The FAC2 option processes just short-term data storage (the FAC2 table). The Data Manager
imports data to the short-term data storage by default, so there may be no need to process the entire application.
The Refresh Data option clears data from the application and repopulates it with existing data.
6. Select Run default logic if you want the logic contained in default.lgc to be run after importing the data.
7. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Clear Data from SQL
You can clear data from the Microsoft SQL Server database. If the work status for a set of data is locked, the data is not cleared from the database.
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server.2. Select the task and add it to the package. See Adding and Modifying Packages.3. Open the task and choose Data Management Clear data from SQL .4. Fill in the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files. For more information about validating logic, see Logic Task Usage.
5. To limit the clear action to a subset of members, enter a member selection.6. Select Process Cube, then select one of the following options:
The Full Process option rebuilds the entire application (cube). Select this option if the application structure is changed.
The FAC2 option processes just short-term data storage (the FAC2 table). The Data Manager imports data to the short-term data storage by default, so there may be no need to process the entire application.
The Refresh Data option clears data from the application and repopulates it with existing data.
7. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Logic Task Usage
Logic is a Microsoft SSID version of the Planning and Consolidation Logic module that can be used from within the Data Manager module. This allows you to use the full power of the Logic module in a batch setting. The functionality of this package is similar to the functionality of the Logic Debugger in the Admin module. The main difference is that this package is set to affect the data in the database by default, while the Logic Debugger is set to run in simulation mode by default. Logic is especially useful when importing data directly into long term storage (the fact table), which bypasses default formulas by default. See Running a Package.
You can use Logic for the following tasks:
Calculations that can only be executed in batch mode after the appropriate data has been entered into the application database (the cube). This might be applicable in the following scenarios:
You run an elimination procedure after all Intercompany declarations have been entered by all companies.
You encounter a situation in which currency conversion must be re-executed after some exchange rates have been modified.
To maximize performance, it may be better to wait until all data is verified as correct before running logic on it.
NOTE
You can use MODIFYSCRIPT Package Variable tasks to manipulate the values of the Logic task. Alternatively, EvDTSModifyPkg tasks are given in the description of the Logic interface, below. For more information about MODIFYSCRIPT, see MODIFYSCRIPT Package Variable Task Usage.
Exporting Journal Data
You can export journal data from Planning and Consolidation using Export Journal.
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server.2. Select the task and add it to the package. See Adding and Modifying Packages.3. Open the task and choose Journal Management Export .4. Enter the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privilegesto validate logic files. For more information about validating logic, see Validating Logic.
5. Enter the path and name of the file to which the journal data is to be exported.6. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Restoring Journal Data
To restore journal entry data from a text file, choose Restore Journal Data.
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server. See Adding and Modifying Packages.2. Select the task and add it to the package.3. Open the task and choose Data Management Import into SQL .4. Fill in the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
5. Enter the path and name of the file that contains the target journal data.6. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Clearing Journal Data
You can clear journal entry information from a selected data region by choosing Clear Journal Data.
PrerequisitesThe DumpLoad task (OSoftTaskDumpLoad2008.dll) is registered with Microsoft SSIS. See Registering Custom Tasks.
Procedure1. Open a package or create a new package in Microsoft SSIS on the Planning and Consolidation
server.2. Select the task and add it to the package. See Adding and Modifying Packages.3. Open the task and choose Journal Management Clear .4. Fill in the application set, application, and the user ID.
NOTE
The user ID must have Planning and Consolidation administrator privileges to validate logic files.
5. Take one of the following actions: Enter the list of members to clear. Browse to a file that contains a list of members to clear.
6. Click OK.
NOTE
You can use TASK commands in the MODIFYSCRIPT Package Variable task to automatically complete the information for you.
Admin Task Usage
This task enables you to run one of a number of eAdmin tasks through Microsoft SSIS, including the following:
Validate logic Validate security Optimize application Process application Create dimension
You can add this task to your package by registering OSoftTaskAdmin2008.dll, located in the Planning and Consolidation websrvr\bin folder, with the Microsoft SSIS interface. See Registering Custom Tasks.
Send Mail Task Usage
You can use the send mail task to send an e-mail message before or after another task has processed. For example, if a task fails, the send mail task can send a fail message to a Planning and Consolidation user. Or you can send an e-mail after completion of a certain task. You can send mail to any Planning and Consolidation user and the mail can include one or more attachments. You can add this task to your package by registeringOSoftTaskSendMail2008.dll located in the Planning and Consolidation websrvr\bin folder, with the Microsoft SSIS interface. See Registering Custom Tasks.
NOTE
To enable the system to send e-mail, configure the e-mail system parameters in Administration.
Trigger Task Usage
The Trigger task allows you to wait for a trigger condition before processing the next task. Triggers include the existence of a specified file or the setting of a flag in a database. You can set up to three trigger conditions that all have to be met to exit the trigger successfully. You can also set a retry interval if you want this task to wait for a trigger condition. You can add this task to your package by registering OSoftTaskTrigger2008.dll located in the BPC\websrvr\bin folder, with the Microsoft SSIS interface. See Registering Custom Tasks.
System Available Task Usage
The System Available task allows you to control whether the system is set to available (online) or not available (not online) status. You can set the system to a not available status, then run some tasks, and set it back to an available status using this task. You can add this task to your package by
registering OSoftTaskAvailable2008.dll located in the BPC\websrvr\bin folder, with the Microsoft SSIS interface. See Registering Custom Tasks.
FTP Task Usage
You can use the FTP task to transfer data files from an FTP site to the Planning and Consolidation server. You can add this task to your Microsoft SSIS package by registering OSoftTaskFtp2008.dll located in theBPC\websrvr\bin folder, with the Microsoft SSIS interface. See Registering Custom Tasks.
Moving or Copying Packages
Procedure1. Choose eData Organize Package List 2. Select a package and click Copy Package or Move Package.3. Enter data as required.4. Click OK.5. Save your changes.
Removing Packages
You can remove packages if you no longer want them available to be run through the Data Manager.
Procedure1. Choose eData Organize Package List .2. Select a package and click Remove Package.3. Save your changes.
Assigning Packages to Teams
You can assign packages to be available to Planning and Consolidation teams.
Procedure1. Choose eData Manage Team User Package Access .2. Select a team.3. Select the packages to assign to the team.4. Save your changes.
Testing Packages
We recommend that you test all packages before making them available to users. Use the Debug script in the Dynamic Script Editor to verify the properties and values of packages.
Using the debug command you can check to see that all properties are assigned the correct values. The debug command has the following syntax:
Debug(value)
The following table describes the value parameters:
Parameter
Description
ON Enables the debug feature.
APPEND Enables the debug feature and specifies that debug messages are appended to the package log file.
The package log file can be shown in the Detail log window, which you can open from the View Status window.
After you successfully run the debug script, you must comment out or remove the debug script command in the Dynamic Script Editor before running a Planning and Consolidation application. Use the following syntax to comment out the debug script:‘Debug(value)
NOTE
If you do not comment out or remove the debug script command, the package log file lists the properties of a package along with their current values.
Procedure
Simulating the Package Script (debug script)
1. In Excel, from the Data Manager menu, choose Organize Package List..2. Open Dynamic Script Editor by choosing Move Organize Package List . Select a package
and choose Modify Package. Next to the Package File path, choose View Package.3. Choose the Advanced button.4. Set the debug script command in the Dynamic Script Editor, and save the package log script. For
example, the package log script below includes the debug script command DEBUG(ON).5. Choose Data Manager Run Package . In the Local Packages pane, run the package that
you modified.
Example Package Log[EvModifyScript Detail]
------------------------------------------------------------
09-11-2009 18:01:27 - Debug turned ON
TASK(DUMP data, APPSET, PCMS75Mpre)
TASK(CONVERT data, OUTPUTFILE, D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\DataManager\DataFiles\\Export_debug.txt)
INFO(%MEASURENAME%, PERIODIC)
INFO(DATAMGRGLOBALCLIENTMACHINEID, ICND50075752A)
INFO(MODIFYSCRIPT, DEBUG(ON)
<BR>PROMPT(OUTFILE,,"PLEASE ENTER AN OUTPUT FILE",)
<BR>PROMPT(SELECT,,,,[Category],[P_ACCT],[P_Activity],[P_CC],[P_DataSrc],[RptCurrency],[Time])
<BR>PROMPT(TRANSFORMATION,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\DATAMANAGER\TRANSFORMATIONFILES\SYSTEM FILES\EXPORT.XLS,"TRANSFORMATION FILE:",,,EXPORT.XLS)
<BR>PROMPT(COMBOBOX,PERIODIC,"PLEASE SELECT A MEASURE THAT YOU WANT TO EXPORT",1,PERIODIC,Periodic,QTD,YTD)
<BR>INFO(D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\PrivatePublications\Administrator\TempFiles\Temp5v4i_89_.tmp,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\PrivatePublications\Administrator\TempFiles\Tempwgxm_89_.tmp)
<BR>TASK(DUMP DATA,APPSET,PCMS75Mpre)
<BR>TASK(DUMP DATA,APP,PLANNING)
<BR>TASK(DUMP DATA,USER,ICND50075752A\Administrator)
<BR>TASK(DUMP DATA,DATATRANSFERMODE,3)
<BR>TASK(DUMP DATA,MDX,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\PrivatePublications\Administrator\TempFiles\FROM_89_.TMP)
<BR>TASK(DUMP DATA,FILE,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\PrivatePublications\Administrator\TempFiles\Temp5v4i_89_.tmp)
<BR>TASK(DUMP DATA,GETMEASURE,PERIODIC)
<BR>TASK(CONVERT DATA,INPUTFILE,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\PrivatePublications\Administrator\TempFiles\Temp5v4i_89_.tmp)
<BR>TASK(CONVERT DATA,OUTPUTFILE,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\DataManager\DataFiles\\Export_debug.txt)
<BR>TASK(CONVERT DATA,CONVERSIONFILE,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\DATAMANAGER\TRANSFORMATIONFILES\SYSTEM FILES\EXPORT.XLS)
<BR>TASK(CONVERT DATA,STRUSERNAME,ICND50075752A\Administrator)
<BR>TASK(CONVERT DATA,STRAPPSET,PCMS75Mpre)
<BR>TASK(CONVERT DATA,STRAPP,PLANNING)
<BR>TASK(CONVERT DATA,SELECTIONFILE,D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\PrivatePublications\Administrator\TempFiles\FROM_89_.TMP))
Verifying Properties of Packages and Values
The following tables show examples of debug output.
Package Script Description of Command
PROMPT(OUTFILE,,"Please enter an output file",) 'Prompt for selecting output file in the Export package
TASK(CONVERT data,OUTPUTFILE,%FILE%) ‘Prompt for selecting output file in the Export package
Package Properties or Values Description of Command
INFO(%FILE%, D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\DataManager\DataFiles\\Export_debug.txt)
‘OUTPUTFILE instruction is generated reserved (%FILE%) variable/ value for transferring into convert task.
TASK(CONVERT data, OUTPUTFILE, D:\PC_MS\Data\WebFolders\PCMS75Mpre\PLANNING\DataManager\DataFiles\\Export_debug.txt)
‘OUTPUTFILE variable(%FILE%) is transferred into Convert Task.
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Logic Usage in Packages
You can set up Planning and Consolidation logic to work together with your Data Manager packages. Most packages automatically run default logic (contained in logic.lgf) for your application when importing data. You can specify a different set of logic to run or you can specify that logic is not applied.
You can set up a step inside a package that runs logic. The OSoftTaskLogic2008 custom Microsoft SSIS task allows you to set up parameters and run logic file or logic subroutines (see Logic Task Usage).
Standard Packages
You can use the packages provided in the Data Management package group to perform general data management tasks. If a file has an associated transformation file, you can modify the file or assign it directly to the package. See Data Transformations.
Package Name
Description
Clear This package clears the data in the Fact and FAC2 table by importing zero values. The optimize process clears all values from the table. Running this package also clears comments from the comments table. You can use the import.xls transformation file with this package.
NOTE
To run this package, select at least one dimension. If you select [All], the package cannot run.
Copy This package copies data between dimensions within the Planning and Consolidation application. See Copying Application Data.
Default Formulas
This package executes default formulas stored in your Default.LGF file.
Export This package exports data values from the Planning and Consolidation cube (including calculated values) into an ASCII file. You are prompted to enter a name for the export file and for a data selection to export. You can use the export.xls transformation file with this package.
FX Restatement
This package is used for currency translation. A sample logic file, FXTrans.lgf, is provided as an empty file. For more information, seeCurrency Conversions.
Import This package imports one or more ASCII files into the current application. You are prompted for one or more import files and associated conversion files. The signs of the amounts are reversed based on the Account type. You can use the import.xls transformation file with this package.
Move This package lets you move any selection of data within an application. You are prompted for source and destination data selections for all dimensions. The package clears records in the fact table in the destination before it moves records from the source fact table. When the records have been moved to the destination, the package clears the records in the source table.
More InformationRunning and Scheduling Packages
Data Transformations
You define data transformations so that you can map external data to internal Planning and Consolidation data structures.
EXAMPLE
When performing a data import, the source data may not be in the correct format. The dimension names in the source data may not match the dimension names in Planning and Consolidation. In this case, you map the external dimensions to the internal dimensions in the conversion file. The Data Manager import package reads the transformation file (which has a pointer to a conversion file) and correctly maps the data.
PrerequisitesTo perform data transformations, at least two Interface for Excel workbook files must exist. The required files are described in the following table:
File Description
Transformation file
This file allows you to set up the rules for reading data from an external source and put it in the proper form for your system database. Transformation files are Microsoft Excel files that contain one worksheet named Instructions. The Instructions worksheet has the following sections:
*Options
*Mapping
*Conversion
Conversion file This file allows you to map member names from external to internal dimension structures. You can set up multiple sheets in a conversion file so that many transformations can access the same conversion workbook. You can have one conversion file per dimension. See Data Conversion Maintenance.
FeaturesAfter setting up a transformation file and a conversion file, you run packages using these files to define a data transformation. See Running a Package.
NOTE
All dimensions of an application must be mapped in the transformation. If the import file does not have a dimension (such as DATASRC), then you would use *NEWCOL (see below).
Options SectionThe *Options section of the Transformation file contains definitions for various options that you can set for your transformation. The following table contains a list of available options and descriptions for each option:
Option Default
Description
AMOUNTDECIMALPOINT =text character . (period)
This option allows you to specify a nonperiod decimal point for countries that use a different character, such as a comma. The character specified in this option must differ from the character specified for the DELIMITER.
Option Default
Description
CONVERT_INTERNAL = YES | NO NO This option compares input member names with columns in the conversion file.
If NO, the input member names are compared with the external column in conversion file.
If YES, the input member names are compared with the internal column in conversion file.
RECOMMENDATION
Do not change the default setting. This setting is here for the purposes of backward compatibility only. There are no reasons to change this in Planning and Consolidation 7.5 and later versions.
CONVERTAMOUNTWDIM =dimension name <Account>
This option specifies which dimension to look at for value calculations. You must specify a dimension conversion sheet using the Amount *Conversion option. For more information about conversion files, see Data Conversion Maintenance. If there is no formula in the Formula column of the Amount conversion sheet, this parameter has no effect. For example, if the Formula column has the following formula: <value>*1.10, all accounts are increased by 10% during the conversion.
CREDITNEGATIVE = YES |NO YES This option reverses the signs for a given account. If this parameter is set to NO, the option reverses the sign for all amounts referring to an ACCOUNT type (LEQ, INC).
Option Default
Description
DELIMITER = text character| SPACE | TAB , (comma)
This option defines the single character that is the delimiter between columns of the output if the FORMAT option is set to DELIMITED, Use the keywords SPACE or TAB if the columns are delimited by spaces or tabs.
The delimiter character must be unique and must be the delimiter character used in the file. Otherwise, the Data Preview displays incorrectly.
EXPORTFORMAT =CATEGORYBYTIME |MULTIWITHHEADER |MULTIWITHNOHEADER
There is no default. This option must be defined.
This option defines processing associated with an exported file.
Using the CATEGORYBYTIME option generates an output file categorized by time period.
Using the MULTIWITHHEADER option generates an output file with header information.
Using the MULTIWITHNOHEADER option generates the same output file as MultiWithHeader without the header titles
FORMAT = DELIMITED | FIXED | CATEGORYBYTIME
There is no default. This is a required option.
This option defines the format of the data in the input or output file. DELIMITED means that there is a special character between each column of data, defined by theDELIMITER option (above).
FIXED means that the data is in a fixed field format. For this setting, use the FCOL mapping option.
CATEGORYBYTIME means that the data is listed by categories that represent time periods.
Option Default
Description
HEADER = YES | NO YES This option specifies if your data has a header row. If this parameter is set to YES, your input file contains one header row that defines the fields. If you do have a header row, you can refer to a field by name in the MAPPING section.
MAXREJECTCOUNT = empty string | -1 | positive number
empty string
This option specifies the number of rejected records at which to stop processing if you are validating records. A value of -1 implies that the Data Manager should keep processing, no matter how many rejected records exist. The default value is 500, which can be represented by an empty string.
NULLAMOUNTVALUE = text character a space character
This value allows you to assign a valued to null records.
OUTPUTDELIMITER = text character| SPACE | TAB , (comma)
This option defines the single character that is the delimiter between columns of the output if the FORMAT option is set to DELIMITED, Use the keywords SPACE or TAB if the columns are delimited by spaces or tabs.
The delimiter character must be unique and must be the delimiter character used in the file. Otherwise, the Data Preview displays incorrectly.
Option Default
Description
OUTPUTHEADER = text string empty string
This option allows you to create a custom header to export data. It is ignored when the transformation file is used to import data.
You can use {CRLF} to create more than one row for the header. For example: MyCompany Data{CRLF}Category,Time,Account, Entity,Datasrc,Intco,RPTCurrency,Amount.
NOTE
The complete OUTPUTHEADER text string should be in the same cell in the transformation file.
ROUNDAMOUNT = integer There is no default. You must define this option.
This option specifies the amount of decimal places to which values are to be rounded during the transformation. By default, there is no rounding during data transformation. If you use this option, you must enter a parameter. The integer can be zero or any positive integer.
SKIP = integer 0 (zero) This option specifies the number of lines to skip at the top of a data file.
EXAMPLE
Use this option to skip header lines during transformation.
SKIPIF = text string |text string2 empty string
This option causes the transformation to skip a line in the data file if it begins with the specified strings. The strings are separated by |, in the above case. If a record begins with<text string> or <text string2>, the record is skipped. To include all lines in the transformation, set this option to an empty string. If you use this option, you must enter a parameter.
You can skip null database records by setting SKIPIF = NULL.
Option Default
Description
VALIDATERECORDS = No |Yes No This option specifies whether or not to validate records. If this parameter is set to No, the validation does not occur. If this parameter is set to Yes, check the following items before the import:
Validate the mapping.
Ensure that the members exist.
Verify that the record is proper for the Planning and Consolidation application.
When this option is enabled, the following rules apply:
If a member ID is not mapped, the record associated with the ID is rejected during validation and ignored.
If the import file has an extra field that is not mapped, all records are rejected during validation.
VALIDATERECORDS is only relevant for importing files. If you are using Planning and Consolidation for the Microsoft platform, ensure that VALIDATERECORDS is set to Nowhen exporting files.
Mapping SectionThe *Mapping section of the transformation file defines how data is mapped to your system database.
EXAMPLE
For a header row and that defines a column named AccountVal, you can map the Account dimension to the Account field from the data file this way:
Account = AccountVal
The following table details the available mapping functions:
Mapping Function Parameters
Description
*COL(A) A = column index in the data file
This function defines a dimension for a field in the data file when the data file does not have a header row. See the note below about automatic field names when you do have a header row.
EXAMPLEAccount =*COL(2)
*COL(A, B:C) A = column index in the data file
B:C = the start and end positions within the column
This function defines a dimension for a subset of a field in the data file.
EXAMPLEAccount=*COL(3,1:4)
*FCOL(A:B) A:B = the start and end positions within the data row
This option allows you to define the start and end character columns for each field when you are using Fixed format data files, In the example below, the columns 4 through 7 represent the Account dimension.
EXAMPLEAccount=*FCOL(4:7)
*MVAL(A:B)
orDimension =*MVAL(keyfiguretype1|dim_mem1||keyfiguretype2|dim_mem2||keyfiguretype3|dim_mem3)
A:B = the start and end time period columns
This function supports the following types of usage:
Allows you to use multiple time period columns
EXAMPLE
If you have a number of consecutive columns that are based on time periods, you can use this function to include all of them. In the following set of columns, you can use the following command:Time = *MVAL(7:18)
Account,Category,DATASRC,entity,IntCo,RptCURRENCY,JAN,FEB,MAR,APR,MAY,JUN,JUL,AUG,SEP,OCT,NOV,DEC
Using this command requires that you use a time.xls conversion sheet. To see the sample time.xls conversion file, open the existing conversion definition window. If your data does not have a header row, the time periods are named P1, P2, P3,...,PN by default.
Allows you to convert multiple key figures to one key figure according to the following guidelines:
The dimension must be an existing column in the cube.
The dimension members in dim_mem must be the noncalculated members of the dimension.
The keyfiguretype must be the field name of the source data.
You can directly input the dimension members in the dim_mem, or input any existing mapping command in the dim_mem, such as *newcol, *col or *newcol(cash)+*col(1).
EXAMPLE
Source data:
Account, Entity, Data source, LC, GC, TC.
Cash, SalesItaly, Input,
key1, key2, key3
Mapping command:Account=*MKEY(LC|*NEWCOL(Cash_lc)||GC|*COL(1)+*STR(gc)||TC|*NEWCOL(Cash_tc))
Target data:
Account, Entity, Data source, keyfigure
Cash_lc, SalesItaly, Input, key1
Cash_gc, SalesItaly, Input, key2
Cash_tc, SalesItaly, Input, key3
EXAMPLE
Source data:
Account, Entity, Data source, LC, GC, TC.
Cash, SalesItaly, Input, key1, key2, key3
Mapping command:Keyfiguretype=*MKEY(LC|*NEWCOL(LC)||GC|*STR(GC)||TC|*NEWCOL(TC))
Target data:
Account, Entity, Data source, Keyfiguretype, keyfigure
Cash, SalesItaly, Input, LC, key1
Cash, SalesItaly, Input, GC, key2
Cash, SalesItaly, Input, TC, key3
*NEWCOL(A) A = dimension member
This function creates a new field with the given value.
EXAMPLEAccount=*NEWCOL(Revenue)
*Str(string) Not applicable This function adds a text string to the members of a column. This function is useful if you need to map data file fields to fields in your database that have the same names, except that the field names contain extra characters (either before or after the name).
EXAMPLEEntity = *Str(NE) + *COL(1)
*PAD Not applicable This function is used for padding imported fields.
EXAMPLE
To prepend the letter A to a field (such as the member ID) use *PAD(A). If the field contains 123 before the command, the resulting value is A123.
*If (Condition1 then Action1;Condition2 then Action2;Default Action)
Planning and Consolidation takes the following actions, depending on the results of the condition evaluations:
Condition1- If this evaluates toTrue, map using Action1
Condition2- If Condition1 is "False" and Condition2 is "True," map using Action2
Default Action - If both Conditi
This function allows you to test a series of conditions, and to apply a corresponding action if the condition is true.
EXAMPLEProduct=*if (Product+ID+Entity = *str(148552) then *str(MHarn);ID(1:1) = *str(C) then *str(XX) ; *str(YY))
Explanation: This means that if the sum of the product, ID, and entity value are equal to 148552 then change product value to MHarn or
Else IF first value of ID field is equal to C then Change Product value to XX
Else change product value to YY
NOTE
The *STR() function must be used when evaluating numeric constants in an *IF statement.
EXAMPLE
Examine the following series of data sets, mapping function examples, and result sets to gain an understanding of how the *IF function can be used in various scenarios:
Data Set 1:PRODUCT,ID,ENTITY
14,85,52
AB,CD,EF GH,IJ,KL
Mapping Function 1:Product=*IF (product+ID+Entity=*Str(148552) then
on1 and Condition2 are "False", map using this Default Action
Condition1andCondition2can contain multiple items that are added together (using the plus + sign).
*str(MHarn);ID(1:1) = *str(C)
then *str(XX) ; *str(YY))
Result Set 1:PRODUCT,ID,ENTITY
MHarn,85,52
AB,XX,EF
YY,IJ,KL
Data Set 2:Entity, SEntity
U1000000, US01
Z2000A01, CA03
K3430000, JP04
Mapping Function 2:Entity=*IF(*col(1,1:1)=U then SEntity;*col(1,1:1)=Z then *col(1,3:6); *STR(ERR))
Result Set 2:Entity, SEntity
US01, US01
A01, CA03
ERR, JP04
Conversion SectionThe *CONVERSION section of the transformation file defines which conversion sheet to use with which dimensions. Use the following syntax to associate a dimension with a conversion sheet:Dimension Name = [COMPANY]WorkbookName[!SheetName]
NOTE
Items in brackets are optional.
The following table describes the variables.
Variable Description
DimensionName
Either the dimension name to correlate with the conversion file or the keyword Amount. Use the Amount option to specify the conversion file to be used if you specify the ConverAmountWDim option in the*Options section. This allows you to use a formula to scale the input or output values.
Workbookname The name of the conversion file
SheetName This is the name of the worksheet to use within the conversion file. If a name is not specified, the system assumes the sheet name is Conversion.
[COMPANY] If [COMPANY] is defined then the Data Manager tries to obtain the conversion file from the main company Data Manager folder. Otherwise the Data Manager looks in the appropriate Site folder.
Activities To create a new transformation file, select eData New Transformation File. Enter data as
required.
To edit transformation files, select eData Manage Transformation Files, then browse to the desired file. Enter data as required.
To copy a transformation file, open the file you want to copy by selecting Manage Data from the Getting Started - Interface for Excel action pane. Select Maintain transformations Manage existing transformation. Open the desired file and select Copy Transformation File.
To copy dimension files between applications, you create a transformation file to map the dimensions. See Sample Transformation File.
ExampleIn this example, AccountConv.xls is the name of the Account dimension conversion file.
Account = AccountConv.xls
Amount = AccountConv.xls (Use the Amount keyword with the ConvertAmountWDim transformation option.)
Account = AccountConv.xls!newaccount
Account = [COMPANY]AccountConv.xls!newaccount
Data Conversion Maintenance
Conversion files define the mapping by dimensions from external member names to internal member names. You create one conversion file per dimension in a transformation.
Each conversion file can contain one or more sheets for different types of data conversions.
Features*skipIf you want to ignore external data (as listed in the External column), you can place the keyword *skip in the Internal column, as in the following example.
External Internal
ACCPAY *skip
WildcardsYou can use the asterisk (*) and question mark (?) wildcards in the External or Internal columns. An asterisk (*) stands for any character, while a question mark (?) stands for any single character. For example, if you want to reference all members, use the asterisk (*).
You also can use a colon (:) for a specified range:
When Conversion_internal = NO, use a colon in the Internal column or formula column.
When Conversion_internal = YES, use a colon in the External column or formula column.
In the following example, the formula, which uses an asterisk, would increase all of the members by 10 percent:
External Internal Formula
* * Value*1.10
*IF
You can use if statement in a conversion file.
External
Internal
actual *If(%external%=act* then Actual; %external% = bud* then budget; forecast)
If the transformation option Convert_internal = NO, *IF can be used in the Internal column.
If transformation option Convert_internal = YES, *IF can be used in the External column.
FormulaTo write a formula to update SIGNEDDATA, you write this formula with the FORMULA column.
Example 1
Conversion file: RPTCURRENCY.XLS!SHEET1
External Internal
USD *skip
LC RMB
Conversion file: RPTCURRENCY.XLS!SHEET2
External Internal Formula
LC RMB Value*1.10
Apply this conversion rule to dimension RPTCURRENCY.
The first rule is applied to RPTCURRENCY, and the second rule is applied to Signedata. The criteria checks the member value of RPTCURRENCY before and after the conversion.
Before the conversion, the transaction data is the following:DATASRC,CATEGORY,ACCOUNT,ENTITY,TIME,PRODUCT,RPTCURRENCY,AMOUNT
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYPUPPY,USD,-100
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYADULT,LC,-200
The meaning of this rule is the following:
Convert the dimension members of RPTCURRENCY
If the source value is USD, then the system skips this current record since the internal value is *skip.
If the source value is LC, then this value is converted to RMB.
Convert the SIGNEDDATA according to the member value of RPTCURRENCY
If the source value is LC before conversion and is RMB after the conversion, then the signedata of this current record is increased by the formula.
After the conversion, the transaction data is the following:
Submitted:
Transaction data:DATASRC,CATEGORY,ACCOUNT,ENTITY,TIME,PRODUCT,RPTCURRENCY,AMOUNT
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYADULT,RMB,-220
Skipped:
Transaction data:DATASRC,CATEGORY,ACCOUNT,ENTITY,TIME,PRODUCT,RPTCURRENCY,AMOUNT
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYPUPPY,USD,-100
Example 2
Conversion file: RPTCURRENCY.XLS!SHEET1
External Internal Formula
* * Value*1.10
Apply this conversion rule to dimension RPTCURRENCY.
Before the conversion, the transaction data is the following:DATASRC,CATEGORY,ACCOUNT,ENTITY,TIME,PRODUCT,RPTCURRENCY,AMOUNT
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYPUPPY,USD,-100
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYADULT,LC,-200
The meaning of this rule is: For any member of RPTCURRENCY, whatever it is before the conversion (External) and after conversion (Internal), the formula is applied to the signed data for the current data records.
After the conversion, the transaction data is the following:
Transaction data:DATASRC,CATEGORY,ACCOUNT,ENTITY,TIME,PRODUCT,RPTCURRENCY,AMOUNT
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYPUPPY,USD,-110
INPUT,ACTUAL,ExtSales,PETSTORE1,2006.JAN,DOGDRYADULT,LC,-220
Example 3
Conversion file: RPTCURRENCY.XLS!SHEET1
External Internal
1:100 PETSTORE1
C001:C999 PETSTORE2
Apply this conversion rule to dimension ENTITY.
Before the conversion, the transaction data is the following:DATASRC,CATEGORY,ACCOUNT,ENTITY,TIME,PRODUCT,RPTCURRENCY,AMOUNT
INPUT,ACTUAL,ExtSales,23,2006.JAN,DOGDRYPUPPY,USD,-100
INPUT,ACTUAL,ExtSales,C100,2006.JAN,DOGDRYADULT,LC,-200
The meaning of this rule is: For the dimension members of ENTITY, if the source value is in the range of the value in the external column, then the source value is converted to the value in the internal column
After the conversion, the transaction data is the following:
Submitted:
Transaction data:DATASRC,CATEGORY,ACCOUNT,ENTITY,TIME,PRODUCT,RPTCURRENCY,AMOUNT
INPUT,ACTUAL,ExtSales, PETSTORE1,2006.JAN,DOGDRYPUPPY,USD,-100
INPUT,ACTUAL,ExtSales, PETSTORE2,2006.JAN,DOGDRYADULT,LC,-200
Javascript can be used in the data conversion Mandatory: Precede the Javascript code with the following string: js:
You can use Javascript code in IF statements.
EXAMPLE
The following examples illustrate Javascript string manipulation commands: js: %external%.substring(0,2)
This example returns a substring of the string contained in external. js: %external%.length
This example returns the length of the string contained in external. js: %external%.replace("apples", "oranges");
This example returns a string in which a specified substring has been replaced with another substring a specified number of times.
*IF(%external%=act* then Actual; js:%external%.length=4 then budget; forecast)
In this example, if the source data contains the patten of act*, then the source data is converted to Actual. If the length of the source data is 4, then the source data is converted to Budget. Otherwise, the source data is converted to Forecast.
Javascript can be used in the FORMULA column
EXAMPLE
The following item is an example of a Javascript command that can be used in the formula column:
js:Math.round(VALUE*Math.pow(10,2))/Math.pow(10,2);
If the source value is 200.356, the target value is 200.36.
Javascript is used to generate a target value or to do calculations for signed data. This means the following:
When Conversion_internal = NO, Javascript can be used in the Internal column or formula column.
When Conversion_internal = YES, Javascript can be used in the External column or formula column.
ActivitiesYou can perform the following tasks when maintaining data conversions:
Maintaining a Data Conversion Definition
Creating a Data Conversion File
Copying Data Conversion Files
Inserting Conversion Sheets
Validating Conversion Definitions
To maintain conversions, choose Data Maintain conversions.
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Maintaining a Data Conversion Definition
Use this procedure to perform the following tasks with data conversion files:
Copy Detete
Paste Rename
ProcedureChoose eData Maintain conversions Manage definition of existing conversion .
Creating a Data Conversion File
Use this procedure to create a data conversion file.
ProcedureCreate a data conversion file by doing the following steps:
1. Choose eData Maintain conversions .2. Choose Create new conversion.
RECOMMENDATION
Give the conversion file the same name as the dimension for which it is being used.
Copying Data Conversion Files
Use this procedure to copy a data conversion file.
Procedure1. Choose eData Maintain conversions .2. Open or create a new conversion file.3. Choose Copy conversion.
RECOMMENDATION
Give the conversion file the same name as the dimension for which it is being used.
Inserting Conversion Sheets
Use this procedure to insert a conversion sheet.
Procedure1. Choose eData Maintain conversions .2. Open or create a new conversion file.3. Choose Insert conversion sheet.
RECOMMENDATION
Give the conversion sheet the same name as the dimension for which it is being used.
More InformationMaintaining a Data Conversion Definition
Creating a Data Conversion File
Validating Conversion Definitions
Use this procedure to validate an opened conversion file as well as save it.
Procedure1. Choose eData Maintain conversions .2. Open or create a new conversion file.3. Choose Validate conversion definitions or Validate and save conversion definitions.
4. Sample Transformation File 5. 6. When you are copying or importing data between applications and need to map the dimensions
that are different, you can create a transformation file to map the dimensions.7. The following table contains a list of the dimensions in a sample source and target application:
Source Application Target Application
Category
Account
Entity
Time
Rptcurrency
Intco
Datasrc
Cat
Acc
Ent
Tim
Currency
Int
Dat
8. To map the dimensions from the source application to the target application, you can create a transformation file such as the following:
9. *OPTIONS10. FORMAT = DELIMITED11. HEADER = YES12. DELIMITER =13. SKIP = 014. SKIPF =15. CREDITNEGATIVE=NO16. CONVERTAMOUNTWDIM=17. MAXREJECTCOUNT=18. VALIDATERECORDS=YES19. *MAPPING20. cat=category21. Acc=Account22. Ent = Entity23. Tim=time24. Currency=Rptcurrency25. int=intco26. dat=Datasrc27. *CONVERSION
28. More Information29. Data Transformations
Copying Application Data
The Data Manager allows you to define a package to copy the data within a range or scope using the process chain /CPMB/COPY.
NOTE
If the source and destination packages have different dimensionality, you must map the dimensions using a transformation file. See Data Transformations (for the Microsoft platform) and Data Transformation Maintenance (for the NetWeaver platform).
Procedure1. Create a package using the corresponding process chains for copying data (see Package Usage).
2. Run the package.
1. Log onto the Planning and Consolidation Office client.
2. Choose Manage Data Run a package .
3. Choose the package you created in step 1 and choose Run.
4. Select one of the following methods to copy the data:
Choose Merge data values.
Choose Replace and clear data values.
5. To run default logic after the copy process, choose Yes.
6. To check the work status when importing the data, choose Yes.
7. Select the data regions for the source and destination.
8. Choose one of the following options:
Run now
Schedule
Run now & schedule
9. Choose Finish.
NOTE
You can change the default package instructions (see Modifying the Dynamic Script of a Package).
Dynamic script task parametersTask: /CPMB/CLEAR_SOURCE_CUBE
Task Parameter Default Value Description
/CPMB/CLEAR_SOURCE_CUBE CHECKLCK 0 Check work status
1 = YES
0 = NO
/CPMB/CLEAR_SOURCE_CUBE RUNLOGIC 0 INTERNAL
/CPMB/CLEAR_SOURCE_CUBE SELECTION INTERNAL
/CPMB/CLEAR_SOURCE_CUBE SPACKAGE_SIZE 40.000 Package size
/CPMB/CM_CONVERT SELECTION Selection
Task Parameter Default Value Description
/CPMB/CM_CONVERT SPACKAGE_SIZE 40.000 Package size
/CPMB/CM_CONVERT TOSELECTION Selection destination
/CPMB/CLEAR_SOURCE_CUBE CLEARDATA 0 Delete data before writing
0 = NO
1= YES
/CPMB/APPEND_LOAD CHCKLCK 0 Check work status
1 = YES
0 = NO
/CPMB/APPEND_LOAD RUNLOGIC 0 Run logic after process
0 = NO
1 = YES
/CPMB/CLEAR_SOURCE_CUBE CLEARDATA 0 Delete data before writing
0 = NO
1= YES
EXAMPLE
ScriptPROMPT(RADIOBUTTON,%CLEARDATA%,"Select the method for copying the data from the source to destination database",0,{"Merge data values (Copies specified records, leaving all remaining records in the destination intact)","Replace && clear data values(Copies specified records, and clears the data values for any records that mirror each entity/category/time combination defined in the source)"},{"0","1"})
PROMPT(RADIOBUTTON,%RUNLOGIC%,"Select whether to run default logic for stored values after copying",0,{"Yes","No"},{"1","0"})
PROMPT(RADIOBUTTON,%CHECKLCK%,"Select whether to check work status settings when importing data.",1,{"Yes, check for work status settings before importing","No, do not check work status settings"},{"1","0"})
PROMPT(COPYMOVEINPUT,%SELECTION%,%TOSELECTION%,"Select the members to COPY and where to","%DIMS%")
INFO(%TEMPNO1%,%INCREASENO%)
INFO(%ACTNO%,%INCREASENO%)
TASK(/CPMB/CM_CONVERT,OUTPUTNO,%TEMPNO1%)
TASK(/CPMB/CM_CONVERT,ACT_FILE_NO,%ACTNO%)
TASK(/CPMB/CM_CONVERT,SAPPSET,%APPSET%)
TASK(/CPMB/CM_CONVERT,SAPP,%APP%)
TASK(/CPMB/CM_CONVERT,SELECTION,%SELECTION%)
TASK(/CPMB/CM_CONVERT,TOSELECTION,%TOSELECTION%)
TASK(/CPMB/CM_CONVERT,CLEARDATA,%CLEARDATA%)
TASK(/CPMB/CLEAR_SOURCE_CUBE,CHECKLCK,%CHECKLCK%)
TASK(/CPMB/CLEAR_SOURCE_CUBE,SELECTION,%TOSELECTION%)
TASK(/CPMB/APPEND_LOAD,INPUTNO,%TEMPNO1%)
TASK(/CPMB/APPEND_LOAD,ACT_FILE_NO,%ACTNO%)
TASK(/CPMB/APPEND_LOAD,RUNLOGIC,%RUNLOGIC%)
TASK(/CPMB/APPEND_LOAD,CHECKLCK,%CHECKLCK%)
TASK(/CPMB/APPEND_LOAD,CLEARDATA,%CLEARDATA%)
Data
The transaction data in the target selection is cleared to zero first, then all the transaction data in the source selection is written to the target. The transaction data in the source is not affected after the copy.
When set option = Merge, this means CLEARDATA=0:
Example1:
Source selection: Entity=CASH
Target selection: Entity=CASH1
Data in the application before the copy:ACTUAL,CASH,2006.MAY,200
ACTUAL,CASH,2006.JULY,300
ACTUAL,CASH1,2006.MAY,100
ACTUAL,CASH1,2006.JUNE,150
Data in the application after the copy:ACTUAL,CASH,2006.MAY,200
ACTUAL,CASH,2006.JULY,300
ACTUAL,CASH1,2006.MAY,200
ACTUAL,CASH1,2006.JUNE,0
ACTUAL,CASH1,2006.JULY,300
Example 2:
Source selection: Time=2006.MAY, DataSrc = INPUT
Target selection: Time=2006.JULY, DataSrc = INPUT
Data in the application before the copy:INPUT, ACTUAL,CASH, LC, 2006.MAY,200
INPUT, ACTUAL,CASH, USD, 2006.MAY,100
INPUT, ACTUAL,CASH, LC, 2006.JULY,300
INPUT, ACTUAL, CASH, USD, 2006. AUG, 500
NO_IP, ACTUAL,CASH,LC, 2006.JULY,150
MANU, ACTUAL,CASH,LC, 2006.JUNE,250
MANU, ACTUAL,CASH,USD, 2006.AUG, 400
Data in the application after the copy:INPUT, ACTUAL,CASH, LC, 2006.JULY,200
INPUT, ACTUAL,CASH, USD, 2006.JULY,100
INPUT, ACTUAL,CASH, LC, 2006.MAY,200
INPUT, ACTUAL,CASH, USD, 2006.MAY,100
INPUT, ACTUAL, CASH, USD, 2006. AUG, 500
NO_IP, ACTUAL,CASH,LC, 2006.JULY,150
MANU, ACTUAL,CASH,LC, 2006.JUNE,250
MANU, ACTUAL,CASH,USD, 2006.AUG, 400
When set option = Replace and clear, this means CLEARDATA=1:
Example3:
Source selection: Time=2006.MAY, DataSrc = INPUT
Target selection: Time=2006.JULY, DataSrc = INPUT
Data in the application before the copy:INPUT, ACTUAL,CASH, LC, 2006.MAY,200
INPUT, ACTUAL,CASH, USD, 2006.MAY,100
INPUT, ACTUAL,CASH, LC, 2006.JULY,300
INPUT, ACTUAL, CASH, USD, 2006. AUG, 500
NO_IP, ACTUAL,CASH,LC, 2006.JULY,150
MANU, ACTUAL,CASH,LC, 2006.JUNE,250
MANU, ACTUAL,CASH,USD, 2006.AUG, 400
Data in the application after the copy:INPUT, ACTUAL,CASH, LC, 2006.JULY,200
INPUT, ACTUAL,CASH, USD, 2006.JULY,100
INPUT, ACTUAL,CASH, LC, 2006.MAY,200
INPUT, ACTUAL,CASH, USD, 2006.MAY,100
INPUT, ACTUAL, CASH, USD, 2006. AUG, 500
NO_IP, ACTUAL,CASH,LC, 2006.JULY,0
MANU, ACTUAL,CASH,LC, 2006.JUNE,250
MANU, ACTUAL,CASH,USD, 2006.AUG, 400
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Data Transformations
You define data transformations so that you can map external data to internal Planning and Consolidation data structures.
EXAMPLE
When performing a data import, the source data may not be in the correct format. The dimension names in the source data may not match the dimension names in Planning and Consolidation. In this case, you map the external dimensions to the internal dimensions in the conversion file. The Data Manager import package reads the transformation file (which has a pointer to a conversion file) and correctly maps the data.
PrerequisitesTo perform data transformations, at least two Interface for Excel workbook files must exist. The required files are described in the following table:
File Description
Transformation file
This file allows you to set up the rules for reading data from an external source and put it in the proper form for your system database. Transformation files are Microsoft Excel files that contain one worksheet named Instructions. The Instructions worksheet has the following sections:
*Options
*Mapping
*Conversion
Conversion file This file allows you to map member names from external to internal dimension structures. You can set up multiple sheets in a conversion file so that many transformations can access the same conversion workbook. You can have one conversion file per dimension. See Data Conversion Maintenance.
FeaturesAfter setting up a transformation file and a conversion file, you run packages using these files to define a data transformation. See Running a Package.
NOTE
All dimensions of an application must be mapped in the transformation. If the import file does not have a dimension (such as DATASRC), then you would use *NEWCOL (see below).
Options Section
The *Options section of the Transformation file contains definitions for various options that you can set for your transformation. The following table contains a list of available options and descriptions for each option:
Option Default Description
AMOUNTDECIMALPOINT= text character . (period)
This option allows you to specify a nonperiod decimal point for countries that use a different character, such as a comma. The character specified in this option must differ from the character specified for the DELIMITER.
Option Default Description
CONVERT_INTERNAL =YES | NO NO This option compares input member names with columns in the conversion file.
If NO, the input member names are compared with the external column in conversion file.
If YES, the input member names are compared with the internal column in conversion file.
RECOMMENDATION
Do not change the default setting. This setting is here for the purposes of backward compatibility only. There are no reasons to change this in Planning and Consolidation 7.5 and later versions.
CONVERTAMOUNTWDIM= dimension name <Account>
This option specifies which dimension to look at for value calculations. You must specify a dimension conversion sheet using the Amount *Conversion option. For more information about conversion files, see Data Conversion Maintenance. If there is no formula in the Formula column of the Amount conversion sheet, this parameter has no effect. For example, if the Formula column has the following formula: <value>*1.10, all accounts are increased by 10% during the conversion.
CREDITNEGATIVE =YES | NO YES This option reverses the signs for a given account. If this parameter is set to NO, the option reverses the sign for all amounts referring to an ACCOUNT type (LEQ, INC).
Option Default Description
DELIMITER = text character| SPACE |TAB , (comma)
This option defines the single character that is the delimiter between columns of the output if the FORMAT option is set to DELIMITED, Use the keywords SPACE or TAB if the columns are delimited by spaces or tabs.
The delimiter character must be unique and must be the delimiter character used in the file. Otherwise, the Data Preview displays incorrectly.
EXPORTFORMAT =CATEGORYBYTIME |MULTIWITHHEADER |MULTIWITHNOHEADER
There is no default. This option must be defined.
This option defines processing associated with an exported file.
Using the CATEGORYBYTIME option generates an output file categorized by time period.
Using the MULTIWITHHEADER option generates an output file with header information.
Using the MULTIWITHNOHEADER option generates the same output file as MultiWithHeader without the header titles
FORMAT = DELIMITED | FIXED | CATEGORYBYTIME
There is no default. This is a required option.
This option defines the format of the data in the input or output file. DELIMITED means that there is a special character between each column of data, defined by the DELIMITER option (above).
FIXED means that the data is in a fixed field format. For this setting, use the FCOL mapping option.
CATEGORYBYTIME means that the data is listed by categories that represent time periods.
HEADER = YES | NO YES This option specifies if your data has a header row. If this parameter is set to YES, your input file contains one header row that defines the fields. If you do have a header row, you can refer to a field by name in the MAPPINGsection.
Option Default Description
MAXREJECTCOUNT =empty string | -1 |positive number
empty string
This option specifies the number of rejected records at which to stop processing if you are validating records. A value of -1 implies that the Data Manager should keep processing, no matter how many rejected records exist. The default value is 500, which can be represented by an empty string.
NULLAMOUNTVALUE =text character a space character
This value allows you to assign a valued to null records.
OUTPUTDELIMITER =text character|SPACE | TAB , (comma)
This option defines the single character that is the delimiter between columns of the output if the FORMAT option is set to DELIMITED, Use the keywords SPACE or TAB if the columns are delimited by spaces or tabs.
The delimiter character must be unique and must be the delimiter character used in the file. Otherwise, the Data Preview displays incorrectly.
OUTPUTHEADER = text string empty string
This option allows you to create a custom header to export data. It is ignored when the transformation file is used to import data.
You can use {CRLF} to create more than one row for the header. For example: MyCompany Data{CRLF}Category,Time,Account, Entity,Datasrc,Intco,RPTCurrency,Amount.
NOTE
The complete OUTPUTHEADER text string should be in the same cell in the transformation file.
Option Default Description
ROUNDAMOUNT =integer There is no default. You must define this option.
This option specifies the amount of decimal places to which values are to be rounded during the transformation. By default, there is no rounding during data transformation. If you use this option, you must enter a parameter. The integer can be zero or any positive integer.
SKIP = integer 0 (zero) This option specifies the number of lines to skip at the top of a data file.
EXAMPLE
Use this option to skip header lines during transformation.
SKIPIF = text string | text string2 empty string
This option causes the transformation to skip a line in the data file if it begins with the specified strings. The strings are separated by |, in the above case. If a record begins with<text string> or <text string2>, the record is skipped. To include all lines in the transformation, set this option to an empty string. If you use this option, you must enter a parameter.
You can skip null database records by setting SKIPIF = NULL.
Option Default Description
VALIDATERECORDS =No | Yes No This option specifies whether or not to validate records. If this parameter is set to No, the validation does not occur. If this parameter is set to Yes, check the following items before the import:
Validate the mapping.
Ensure that the members exist.
Verify that the record is proper for the Planning and Consolidation application.
When this option is enabled, the following rules apply:
If a member ID is not mapped, the record associated with the ID is rejected during validation and ignored.
If the import file has an extra field that is not mapped, all records are rejected during validation.
VALIDATERECORDS is only relevant for importing files. If you are using Planning and Consolidation for the Microsoft platform, ensure that VALIDATERECORDS is set to No when exporting files.
Mapping Section
The *Mapping section of the transformation file defines how data is mapped to your system database.
EXAMPLE
For a header row and that defines a column named AccountVal, you can map the Account dimension to the Account field from the data file this way:
Account = AccountVal
The following table details the available mapping functions:
Mapping Function Parameters Description
*COL(A) A = column index in the data file
This function defines a dimension for a field in the data file when the data file does not have a header row. See the note below about automatic field names when you do have a header row.
EXAMPLEAccount =*COL(2)
*COL(A, B:C) A = column index in the data file
B:C = the start and end positions within the column
This function defines a dimension for a subset of a field in the data file.
EXAMPLEAccount=*COL(3,1:4)
*FCOL(A:B) A:B = the start and end positions within the data row
This option allows you to define the start and end character columns for each field when you are using Fixed format data files, In the example below, the columns 4 through 7 represent the Account dimension.
EXAMPLEAccount=*FCOL(4:7)
*MVAL(A:B)
orDimension =*MVAL(keyfiguretype1|dim_mem1||keyfiguretype2|dim_mem2||keyfiguretype3|dim_mem3)
A:B = the start and end time period columns
This function supports the following types of usage:
Allows you to use multiple time period columns
EXAMPLE
If you have a number of consecutive columns that are based on time periods, you can use this function to include all of them. In the following set of columns, you can use the following command:Time = *MVAL(7:18)
Account,Category,DATASRC,entity,IntCo,RptCURRENCY,JAN,FEB,MAR,APR,MAY,JUN,JUL,AUG,SEP,OCT,NOV,DEC
Using this command requires that you use a time.xls conversion sheet. To see the sample time.xls conversion file, open the existing conversion definition window. If your data does not have a header row, the time periods are named P1, P2, P3,...,PN by default.
Allows you to convert multiple key figures to one key figure according to the following guidelines:
The dimension must be an existing column in the cube.
The dimension members in dim_mem must be the noncalculated members of the dimension.
The keyfiguretype must be the field name of the source data.
You can directly input the dimension members in the dim_mem, or input any existing mapping command in the dim_mem, such as *newcol, *col or *newcol(cash)+*col(1).
EXAMPLE
Source data:
Account, Entity, Data source, LC, GC, TC.
Cash, SalesItaly, Input,
key1, key2, key3
Mapping command:Account=*MKEY(LC|*NEWCOL(Cash_lc)||GC|*COL(1)+*STR(gc)||TC|*NEWCOL(Cash_tc))
Target data:
Account, Entity, Data source, keyfigure
Cash_lc, SalesItaly, Input, key1
Cash_gc, SalesItaly, Input, key2
Cash_tc, SalesItaly, Input, key3
EXAMPLE
Source data:
Account, Entity, Data source, LC, GC, TC.
Cash, SalesItaly, Input, key1, key2, key3
Mapping command:Keyfiguretype=*MKEY(LC|*NEWCOL(LC)||GC|*STR(GC)||TC|*NEWCOL(TC))
Target data:
Account, Entity, Data source, Keyfiguretype, keyfigure
Cash, SalesItaly, Input, LC, key1
Cash, SalesItaly, Input, GC, key2
Cash, SalesItaly, Input, TC, key3
*NEWCOL(A) A = dimension member
This function creates a new field with the given value.
EXAMPLEAccount=*NEWCOL(Revenue)
*Str(string) Not applicable This function adds a text string to the members of a column. This function is useful if you need to map data file fields to fields in your database that have the same names, except that the field names contain extra characters (either before or after the name).
EXAMPLEEntity = *Str(NE) + *COL(1)
*PAD Not applicable This function is used for padding imported fields.
EXAMPLE
To prepend the letter A to a field (such as the member ID) use *PAD(A). If the field contains 123 before the command, the resulting value is A123.
*If (Condition1 then Action1;Condition2 then Action2;Default Action)
Planning and Consolidation takes the following actions, depending on the results of the condition evaluations:
Condition1- If this evaluates toTrue, map using Action1
Condition2- If Condition1 is "False" and Condition2 is "True," map using Action2
Default Action - If both Conditi
This function allows you to test a series of conditions, and to apply a corresponding action if the condition is true.
EXAMPLEProduct=*if (Product+ID+Entity = *str(148552) then *str(MHarn);ID(1:1) = *str(C) then *str(XX) ; *str(YY))
Explanation: This means that if the sum of the product, ID, and entity value are equal to 148552 then change product value to MHarn or
Else IF first value of ID field is equal to C then Change Product value to XX
Else change product value to YY
NOTE
The *STR() function must be used when evaluating numeric constants in an *IF statement.
EXAMPLE
Examine the following series of data sets, mapping function examples, and result sets to gain an understanding of how the *IF function can be used in various scenarios:
Data Set 1:PRODUCT,ID,ENTITY
14,85,52
AB,CD,EF GH,IJ,KL
Mapping Function 1:Product=*IF (product+ID+Entity=*Str(148552) then
on1 and Condition2 are "False", map using this Default Action
Condition1andCondition2can contain multiple items that are added together (using the plus + sign).
*str(MHarn);ID(1:1) = *str(C)
then *str(XX) ; *str(YY))
Result Set 1:PRODUCT,ID,ENTITY
MHarn,85,52
AB,XX,EF
YY,IJ,KL
Data Set 2:Entity, SEntity
U1000000, US01
Z2000A01, CA03
K3430000, JP04
Mapping Function 2:Entity=*IF(*col(1,1:1)=U then SEntity;*col(1,1:1)=Z then *col(1,3:6); *STR(ERR))
Result Set 2:Entity, SEntity
US01, US01
A01, CA03
ERR, JP04
Conversion Section
The *CONVERSION section of the transformation file defines which conversion sheet to use with which dimensions. Use the following syntax to associate a dimension with a conversion sheet:Dimension Name = [COMPANY]WorkbookName[!SheetName]
NOTE
Items in brackets are optional.
The following table describes the variables.
Variable Description
DimensionName
Either the dimension name to correlate with the conversion file or the keyword Amount. Use the Amount option to specify the conversion file to be used if you specify the ConverAmountWDim option in the *Options section. This allows you to use a formula to scale the input or output values.
Workbookname The name of the conversion file
SheetName This is the name of the worksheet to use within the conversion file. If a name is not specified, the system assumes the sheet name isConversion.
[COMPANY] If [COMPANY] is defined then the Data Manager tries to obtain the conversion file from the main company Data Manager folder. Otherwise the Data Manager looks in the appropriate Site folder.
Activities To create a new transformation file, select eData New Transformation File. Enter data as
required.
To edit transformation files, select eData Manage Transformation Files, then browse to the desired file. Enter data as required.
To copy a transformation file, open the file you want to copy by selecting Manage Data from the Getting Started - Interface for Excel action pane. Select Maintain transformations Manage existing transformation. Open the desired file and select Copy Transformation File.
To copy dimension files between applications, you create a transformation file to map the dimensions. See Sample Transformation File.
ExampleIn this example, AccountConv.xls is the name of the Account dimension conversion file.
Account = AccountConv.xls
Amount = AccountConv.xls (Use the Amount keyword with the ConvertAmountWDim transformation option.)
Account = AccountConv.xls!newaccount
Account = [COMPANY]AccountConv.xls!newaccount
Data Transformation Maintenance
You define data transformations so you can map external data to internal Planning and Consolidation data structures.
PrerequisitesTo perform data transformations, at least two Interface for Excel workbook files must exist. The required files are described in the following table:
File Description
Transformation file
This file allows you to set up the rules for reading data from an external source and put it in the proper form for your system database. Transformation files are Microsoft Excel files that contain one worksheet named Instructions. The Instructions worksheet has the following sections:
*Options
*Mapping
*Conversion
Conversion file This file allows you to map member names from external to internal dimension structures. You can set up multiple sheets in a conversion file so that many transformations can access the same conversion workbook. You can have one conversion file per dimension (see Data Conversion Maintenance).
FeaturesThe following details the transformation and conversion file rights that are granted:
With the Execute task of DM security, a user can read, write, and select the transformation and conversion file in Company.
With the GeneralAdmin task of DM security, a user can read and write the transformation and conversion file in Company and Team.
With the PrimaryAdmin task of DM security, a user can read and write the transformation and conversion file in Company.
With the TeamLeaderAdmin task of DM security, a user can read and write the transformation and conversion file in Team.
After setting up a transformation file and a conversion file, you run packages using these files to define a data transformation (see Running a Package).
NOTE
All dimensions of an application must be mapped in the transformation. If the import file does not have a dimension (such as DATASRC), then you would use *NEWCOL (see below).
Options Section
The *Options section of the Transformation file contains definitions for various options that you can set for your transformation. The following table contains a list of available options and descriptions for each option:
Option Default Description
AMOUNTDECIMALPOINT=text character . (period)
This option allows you to specify a nonperiod decimal point for countries that use a different character, such as a comma. The character specified in this option must differ from the character specified for the DELIMITER. You can use this option in the following two ways:
AMOUNTDECIMALPOINT = Any single character
For example, a period (.) or a comma (,). The decimal point is either a period or a comma and there is no thousands separator.
AMOUNTDECIMALPOINT = Any two characters.
The first character functions as the decimal point and the second functions as the thousands separator. There should be no space, tab, or any other character between the two characters.
The default setting is that the decimal point of the signed data is a period and there are no thousand separators. For example, 10000.12.
Option Default Description
CONVERTAMOUNTWDIM=dimension name <Account>
This option specifies which dimension to look at for value calculations. You must specify a dimension conversion sheet using the Amount in *Conversion option. For more information about conversion files, see Data Conversion Maintenance. If there is no formula in the Formula column of the Amount conversion sheet, this parameter has no effect at all. For example, in a case where the Formula column has the following formula: <value>*1.10, all accounts are increased by 10% during the conversion.
CONVERT_INTERNAL = YES | NO NO This option compares input member names with columns in the conversion file.
If NO, the input member names are compared with the external column in conversion file.
If YES, the input member names are compared with the internal column in conversion file.
RECOMMENDATION
Do not change the default setting. This setting is here for the purposes of backward compatibility only. There are no reasons to change this in Planning and Consolidation 7.0 and later versions.
CREDITNEGATIVE = YES | NO YES This option reverses the signs for a given account. If this parameter is set to NO, the option reverses the sign for all amounts referring to an ACCOUNT type (LEQ,INC).
Option Default Description
DELIMITER = text_character|SPACE | TAB , (comma)
This option defines the single character that is the delimiter between columns if the FORMAT option is set to DELIMITED. Use the keywords SPACE or TAB if the columns are delimited by spaces or tabs.
ENDROUTINE <empty>
This option specifies the filter value to call an End routine used in a BAdI.
FORMAT = DELIMITED | FIXED There is no default. This is a required option.
This option defines the format of the data in the input or output file. DELIMITED means that there is a special character between each column of data, defined by the DELIMITER option. Delimited format includes multiperiod and variant. FIXED means that the data is in a fixed field format. For this setting, use the FCOL mapping option.
NOTE
CATEGORYBYTIME is out of scope for Planning and Consolidation 7.5
Set FORMAT = DELIMITED for Variant format, which is still supported.
Variant allows the user to define the name and position of the dimensions using multiple lines beginning with an asterisk (*).*CATEGORY=ACTUAL
*TIME=2007.JAN
*ENTITY, ACCOUNT, AMOUNT
STORE1, EXTSALES, 1203
STORE2, EXTSALES, 1203
The variable format allows
Option Default Description
the user to define the name and position of the dimensions using multiple lines beginning with an asterisk (*). These lines (as many as needed) represent a header section.
Besides a simple, one line header, the data file can also contain a variant header. The header can have several lines, each line starting with an asterisk (*). The following are examples of variant headers:
The following example illustrates how you can use the variable format syntax, using a three line header section:*CATEGORY, TIME
*ENTITY, ACCOUNT, PRODUCT,
*AMOUNT
ACTUAL, 1999.JAN, UK, Sales, Sedan, 1203
ACTUAL, 1999.JAN, UK, Sales, Coupe, 2345
While the above example is simple, some extra features of the variable format demonstrate its potential as a more useful tool.
Repetitive field values can be moved into the header section. For example, the above file could also be read in the following format, where the value of the category (ACTUAL) and time (1999.Jan) are set in the header section and removed from the value rows.
*<DIMENSION>=<VALUE> specify the value of the dimension. This has the same effect as the *NEWCOL command in the mapping section. The lines
Option Default Description
starting with ‘ is the comment line that is skipped during process.*CATEGORY = ACTUAL
*TIME = 1999.JAN
*ENTITY, ACCOUNT, PRODUCT,
*AMOUNT
UK, Sales, Sedan, 1203
UK, Sales, Coupe, 2345
If one of the predefined values changes in the body of the file, a redefinition of the current member can be inserted anywhere in the file and as many times as desired, like in this example:
If the *<Dimension> =<value> header occurs in the middle of data file, all the records following this header are affected, but the records before the header are not.*CATEGORY, TIME
*ENTITY = UK
*ACCOUNT, PRODUCT, AMOUNT
ACTUAL, 1999.JAN, Sales, Sedan, 1234
ACTUAL, 1999.JAN, Sales, Coupe, 2345
*ENTITY = FR
ACTUAL, 1999.JAN, Sales, Sedan, 986
ACTUAL, 1999.JAN, Sales, Coupe, 945
The results of Example 3 are:ACTUAL, 1999.JAN, UK, Sales, Sedan, 1234
ACTUAL, 1999.JAN, UK, Sales, Coupe, 2345
ACTUAL, 1999.JAN, FR, Sales, Sedan, 986
ACTUAL, 1999.JAN, FR,
Option Default Description
Sales, Coupe, 945
A set of members of one or more dimension can span across multiple columns (typically, 12 months of budget values). The following example of a header section accepts 12 value records:
*<Dimension> =<value1>,<value2> has the similar effect of an *MVAL command in the mapping section. This type of header occurs only in the beginning of the data file, not in the middle.*CATEGORY=ACTUAL
*TIME=1999.JAN, 1999.FEB, 1999.MAR,1999.APR
*ENTITY, ACCOUNT, PRODUCT
*AMOUNT UK, SALES, SEDAN, 100, 200, 300, 400
The variable format allows you to specify which dimensions are in the page (CATEGORY=ACTUAL), which dimensions are in column (TIME=1999.Jan, 1999.Feb, and so on), and which dimensions are in row (ENTITY,ACCOUNT,PRODUCT,PERIODIC).
Irrespective of the format of the source file, the output file is always in the fixed format described for the input file. For example, the first line contains the delimited list of all dimension names with their corresponding positions for the data fields. All subsequent lines define one data cell per line.
The variable format file containing the 4 periods shown above generates the
Option Default Description
following output (if conversion of the members' labels is excluded):CATEGORY, TIME, ENTITY, ACCOUNT, PRODUCT, AMOUNT
ACTUAL, 1999.JAN, UK, SALES, SEDAN, 100
ACTUAL, 1999.FEB, UK, SALES, SEDAN, 200
ACTUAL, 1999.MAR, UK, SALES, SEDAN, 300
ACTUAL, 1999.APR, UK, SALES, SEDAN, 400
FORMULA = LIB.LGF|LIB1.LGF <empty>
This option sets the K2 functions referenced by the master data member’s formula attribute. This option is only used for importing master data. It is illegal when running other packages.
The libraries are syslib. The *syslib prefix is not needed here. Different libraries are separated by |.
NOTE
This is used for loading master data as is (new in Planning and Consolidation 7.0).
EXAMPLEDAVY_KP1_DEV7A2_Q_Mdxlib_1.LGF| DAVY_KP1_DEV7A2_Q_Mdxlib_2.LGF
HEADER= YES | NO YES This option specifies if your data has a header row. If this parameter is set to YES, then your input file contains one header row that defines the fields. If you do have a header row, you can refer to a field by name in the MAPPING section.
Option Default Description
MAXREJECTCOUNT=empty_string |-1 | positive number
empty_string
This option specifies the number of rejected records at which to stop processing if you are validating records. A value of -1 implies that the Data Manager should keep processing, no matter how many rejected records exist. The default value is 500, which can be represented by an empty string.
OUTPUTDELIMITER= , (comma)
This is the same as DELIMITER, but defines the delimiter when using a transformation to export data. This option works only when exporting data.
OUTPUTFORMAT= NORMAL Normal It specifies the format of the data in the output file. Currently, only Normal format is supported.
OUTPUTHEADER= <empty>
It allows you to use a custom header to export data. This option only works when exporting data. You can use {CRLF} to create more than one row for the header.CATEGORY, TIME {CRLF} Entity, ACCOUTN, PRODUCT {CRLF} PERIODIC
The exported file is shown in below.
The above example should be placed all in the same one cell in the transformation file.*CATEGORY, TIME
*ENTITY, ACCOUNT, PRODUCT
*PERIODIC
ACTUAL, 1999.JAN, UK, SALES, SEDAN, 1234
ACTUAL, 1999.JAN, UK, SALES, COUPE, 2345
Option Default Description
ROUNDAMOUNT=integer There is no default. You must define this option.
This option specifies the amount of decimal places to which values are to be rounded during the transformation. By default, there is no rounding during data transformation. If you use this option, you must enter a parameter. The integer can be zero or any positive integer.
Option Default Description
SELECTION = <Dimension1_techname>,<Dimension1_value>;<Dimension2_techname>,<Dimension2_value>
<empty>
This option sets the selection rules when you are extracting transaction data from an infoprovider. Use the following parameter definitions to set your selection:
<Dimension1_techname> is the technical name of the dimension. Navigation attributes are not supported.
<Dimension1_value> is the value of a condition statement set to this dimension. For one dimension, you can specify only one value.
EXAMPLE0SX_ACCS, US;0SX_CSLC, 1 is the result of the following selection statement: 0SX_ACCS=US and 0SX_CSLC= 1
This option is only used for importing transaction data from an infoprovider. It is illegal when running other packages.
By the default value, it is to load all data.
NOTE
This is used for loading transactional data as is.
SKIP= integer 0 (zero) This option specifies the number of lines to skip at the top of a data file.
EXAMPLE
Use this option to skip header lines during transformation.
Option Default Description
SKIPIF= text_string |text_string2 empty_string
This option causes the transformation to skip a line in the data file if it begins with the specified strings. The strings are separated by |, in the above case. If a record contains <text_string> or <text_string2>, the record is skipped. To include all lines in the transformation, set this option to an empty string. If you use this option, you must enter a parameter.
SPECIFICMAPPING=YES/NO No It allows you to turn off the automatic dimension mapping feature. When set to YES, Data Manager does not automatically map dimension names. This option works both for importing and exporting and is especially useful for data export.
For example:
The columns in the database are CATEGORY, TIME, ENTITY, ACCOUNT, PRODUCT, SIGNEDDATA
For importing:
The columns in source data are CATEGORY, TIME_NEW, ENTITY_NEW, ACCOUNT_NEW, PRODUCT, SIGNEDDATA
If SPECIFICMAPPING = YES
This means, after transformation, all data should have the same columns that you define in the mapping section of the
Option Default Description
transformation file.
You should write mapping rules in the mapping section such as:CATEGORY = CATEGORY
TIME = TIME_NEW
ENTITY = ENTITY_NEW
ACCOUNT = ACCOUNT_NEW
PRODUCT = PRODUCT
SIGNEDDATA = SIGNEDDATA
This means, even when the column names of source and target are the same, you have to write the mapping rules for all columns.
If you write the following mapping rules:CATEGORY = CATEGORY
TIME = TIME_NEW
ENTITY = ENTITY_NEW
ACCOUNT = ACCOUNT_NEW
This means to import only these four specified columns from the source data file to the database.
This case can be applied in
Option Default Description
the scenario that the source data file has more columns than the target database.
If SPECIFICMAPPING = NO (default value)
This means, after transformation, all data should have the same columns with the target database.
You should write mapping rules in mapping section like:TIME = TIME_NEW
ENTITY = ENTITY_NEW
ACCOUNT = ACCOUNT_NEW
This means, when the column names of source and target are the same, you need to write only the mapping rules for all columns that have different names between source and target. The other columns of the database automatically map from the source columns with the same names. In this example, all six columns are
Option Default Description
imported into the database.
For exporting:
The source columns in cube data are CATEGORY, TIME, ENTITY, ACCOUNT, PRODUCT, SIGNEDDATA.
If SPECIFICMAPPING = YES
To export all columns of the source database, you should write mapping rules in the mapping section such as:CATEGORY = CATEGORY
TIME_NEW = TIME
ENTITY_NEW = ENTITY
ACCOUNT_NEW = ACCOUNT
PRODUCT = PRODUCT
SIGNEDDATA = SIGNEDDATA
This means, even when the column names of source and target are the same, you have to write the mapping rules for all columns. Then the exported data file has these six columns, three of them having the same names as the source database
Option Default Description
columns.
If you only want to export several specific columns, write the mapping rules such asCATEGORY = CATEGORY
TIME_NEW = TIME
ENTITY_NEW = ENTITY
The exported data file contain only these three columns; the other columns are not exported.
If SPECIFICMAPPING = NO (by default)
To export all columns of the source database, you should write mapping rules in the mapping section such as:TIME = TIME_NEW
ENTITY = ENTITY_NEW
ACCOUNT = ACCOUNT_NEW
This means that when the column names of the source and target are the same, you only need to write the mapping rules for the columns that have different names
Option Default Description
between the source and target. The other columns of the database are automatically mapped to the target columns with the same names. In this example, all six columns are exported from the database
STARTROUTINE <empty>
This option specifies the filter value to call a Start routine used in a BAdI.
Option Default Description
VALIDATERECORDS= No | Yes No This option specifies whether or not to validate records. If this parameter is set to No, the validation does not occur. If this parameter is set to Yes, check the following items before the import:
Validate the transformation.
Ensure that the members exist.
Verify that the record is proper for the Planning and Consolidation application.
When this option is enabled, the following rules apply:
If a member ID is not mapped, the record associated with the ID is rejected during validation and ignored.
If the import file has an extra field that is not mapped, all records are rejected during validation.
VALIDATERECORDS is only relevant for importing files. If you are using Planning and Consolidation for the Microsoft platform, ensure that VALIDATERECORDS is set to No when exporting files.
Mapping Section
The *Mapping section of the transformation file defines how data is mapped to the application.
EXAMPLE
For a header row and that defines a column named AccountVal, you can map the Account dimension to the Account field from the data file this way:
Account = AccountVal
The following table details the available mapping functions:
Mapping Function Parameters Description
*COL(A) A = column index in the data file
This function defines a dimension for a field in the data file when the data file does not have a header row. See the note below about automatic field names when you do have a header row.
EXAMPLEAccount =*COL(2)
*COL(A, B:C) A = column index in the data file
B:C = the start and end positions within the column
This function defines a dimension for a subset of a field in the data file.
EXAMPLEAccount=*COL(3,1:4)
*FCOL(A:B) A:B = the start and end positions within the data row
This option allows you to define the start and end character columns for each field when you are using Fixed format data files, In the example below, the columns 4 through 7 represent the Account dimension.
EXAMPLEAccount=*FCOL(4:7)
*MVAL(A:B)
orDimension =*MVAL(keyfiguretype1|dim_mem1||keyfiguretype2|dim_mem2||keyfiguretype3|dim_mem3)
A:B = the start and end time period columns
This function supports the following types of usage:
Allows you to use multiple time period columns
EXAMPLE
If you have a number of consecutive columns that are based on time periods, you can use this function to include all of them. In the following set of columns, you can use the following command:Time = *MVAL(7:18)
Account,Category,DATASRC,entity,IntCo,RptCURRENCY,JAN,FEB,MAR,APR,MAY,JUN,JUL,AUG,SEP,OCT,NOV,DEC
Using this command requires that you use a time.xls conversion sheet. To see the sample time.xls conversion file, open the existing conversion definition window. If your data does not have a header row, the time periods are named P1, P2, P3,...,PN by default.
Allows you to convert multiple key figures to one key figure according to the following guidelines:
The dimension must be an existing column in the database.
The dimension members in dim_mem must be the noncalculated members of the dimension.
The keyfiguretype must be the field name of the source data.
You can input the dimension members in the dim_mem with a *STR mapping command, or input any existing mapping command except *IF in the dim_mem, such as *newcol, *col or *newcol(cash)+*col(1),
EXAMPLE
Source data:
Account, Entity, Data
source, LC, GC, TC.
Cash, SalesItaly, Input, key1, key2, key3
Mapping command:Account=*MKEY(LC|*NEWCOL(Cash_lc)||GC|*COL(1)+*STR(gc)||TC|*NEWCOL(Cash_tc))
Target data:
Account, Entity, Data source, keyfigure
Cash_lc, SalesItaly, Input, key1
Cash_gc, SalesItaly, Input, key2
Cash_tc, SalesItaly, Input, key3
EXAMPLE
Source data:
Account, Entity, Data source, LC, GC, TC.
Cash, SalesItaly, Input, key1, key2, key3
Mapping command:Keyfiguretype=*MKEY(LC|*NEWCOL(LC)||GC|*STR(GC)||TC|*NEWCOL(TC))
Target data:
Account, Entity, Data source, Keyfiguretype, keyfigure
Cash, SalesItaly, Input, LC, key1
Cash, SalesItaly, Input, GC, key2
Cash, SalesItaly, Input, TC, key3
*NEWCOL(A) A = dimension member
This function creates a new field with the given value.
EXAMPLEAccount=*NEWCOL(Revenue)
*Str(string) Not applicable This function adds a text string to the members of a column. This function is useful if you need to map data file fields to fields in your database that have the same names, except that the field names contain extra characters (either before or after the name).
EXAMPLEEntity = *Str(NE) + *COL(1)
*PAD(colname,length,direction,letter)
colname – column name in the source header
length – the length of the output value
direction – the direction padding the letter to the input value; could be L (left) or R (right)
letter – the letter to be padded; by default, is a space
This function is used for padding imported fields.
EXAMPLE
To prepend the letter A to the field time (such as the member ID) use Time = *PAD(time,5,L,A). If the time field contains 123 before the command, the resulting value is AA123. If you change the direction to R, the result is 123AA.
*If(Condition1 then Action1;Condition2 then Action2;Default Action)
Planning and Consolidation takes the following actions, depending on the results of the condition evaluations:
Condition1- If this evaluates toTrue, map using Action1
Condition2- If Condition1 is "False" and Condition2 is "True," map using Action2
Default Action - If both Condition1 and Condition2 are "False", map using this Default Action
Condition1andCondition2can contain multiple items
This function allows you to test a series of conditions, and to apply a corresponding action if the condition is true. You cannot join *IF with other commands using a plus sign (+), such as *IF(..)+*COL(1).
EXAMPLEProduct=*if (Product+ID+Entity = *str(148552) then *str(MHarn);ID(1:1) = *str(C) then *str(XX) ; *str(YY))
Explanation: This means that if the sum of the product, ID, and entity value are equal to 148552 then change product value to MHarn or
Else IF first value of ID field is equal to C then Change Product value to XX
Else change product value to YY
NOTE
The *STR() function must be used when evaluating numeric constants in an *IF statement.
EXAMPLE
Examine the following series of data sets, mapping function examples, and result sets to gain an understanding of how the *IF function can be used in various scenarios:
Data Set 1:PRODUCT,ID,ENTITY
14,85,52
AB,CD,EF GH,IJ,KL
Mapping Function 1:Product=*IF (product+ID+Entity=*Str(148552) then *str(MHarn);ID(1:1) = *str(C)
then *str(XX) ; *str(YY))
Result Set 1:PRODUCT,ID,ENTITY
MHarn,85,52
AB,XX,EF
YY,IJ,KL
Data Set 2:Entity, SEntity
U1000000, US01
Z2000A01, CA03
K3430000, JP04
Mapping Function 2:Entity=*IF(*col(1,1:1)=U then
that are added together (using the plus + sign).
SEntity;*col(1,1:1)=Z then *col(1,3:6); *STR(ERR))
Result Set 2:Entity, SEntity
US01, US01
A01, CA03
ERR, JP04
Conversion Section
The *CONVERSION section of the transformation file defines which conversion sheet to use with which dimensions. Use the following syntax to associate a dimension with a conversion sheet:Dimension Name = [COMPANY]WorkbookName[!SheetName]
NOTE
Items in brackets are optional.
The following table describes the variables.
Variable Description
DimensionName
Either the dimension name to correlate with the conversion file or the keyword Amount. Use the Amount option to specify the conversion file to be used if you specify the ConverAmountWDim option in the*Options section. This allows you to use a formula to scale the input or output values.
Workbookname The name of the conversion file
SheetName This is the name of the worksheet to use within the conversion file. If a name is not specified, the system assumes the sheet name is Conversion.
[COMPANY] If [COMPANY] is defined or does not exist, then the Data Manager tries to obtain the conversion file from the Main company Data Manager folder. If [TEAM_NAME] is defined, the Data Manager looks to the corresponding team folder.
Activities To create a new transformation file, select eData New Transformation File. Enter data as
required.
To edit transformation files, select eData Manage Transformation Files, then browse to the desired file. Enter data as required.
To copy a transformation file, open the file you want to copy by selecting Manage Data from the Getting Started - Interface for Excel action pane. Select Maintain transformations Manage existing transformation . Open the desired file and select Copy Transformation File.
To copy dimension files between applications, you create a transformation file to map the dimensions. See Sample Transformation File.
ExampleIn this example, AccountConv.xls is the name of the Account dimension conversion file.
Account = AccountConv.xls
Amount = AccountConv.xls (Use the Amount keyword with the ConvertAmountWDim transformation option.)
Account = AccountConv.xls!newaccount (This conversion file should be in the company folder.)
Account = [COMPANY]AccountConv.xls!newaccount (This conversion file should be in the company folder.)
Account = [AdminTeam]AccountConv.xls!newaccount (This conversion file should be located in the corresponding folder of AdminTeam.)
More InformationValidating Transformation Files
Importing and Exporting Data Having Multiple Key Figures
BAdI for Start Routine and End Routine
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Sample Transformation File
When you are copying or importing data between applications and need to map the dimensions that are different, you can create a transformation file to map the dimensions.
The following table contains a list of the dimensions in a sample source and target application:
Source Application Target Application
Category
Account
Entity
Time
Rptcurrency
Intco
Datasrc
Cat
Acc
Ent
Tim
Currency
Int
Dat
To map the dimensions from the source application to the target application, you can create a transformation file as follows:
*OPTIONSFORMAT = DELIMITED
HEADER = YES
DELIMITER =
SKIP = 0
SKIPF =
CREDITNEGATIVE=NO
CONVERTAMOUNTWDIM=
MAXREJECTCOUNT=
VALIDATERECORDS=YES
*MAPPINGcat=category
Acc=Account
Ent = Entity
Tim=time
Currency=Rptcurrency
int=intco
dat=Datasrc
*CONVERSION
More InformationData Transformation Maintenance
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Validating Transformation Files
Use this function to validate transformation files prior to running them to prevent transformations from erring out when running in production.
PrerequisitesThe ValidateRecords keyword has been set to Yes in the transformation file. When set to Yes, the system validates the data during the process of validating transformation file. The system also checks to see if the converted member exists in the current dimension. If it does not exist, the record is rejected. When the ValidateRecords keyword is set to No, the system does not perform this checking during the transformation process. If some members are converted incorrectly, the system rejects the data during writing process.
FeaturesAfter running a transformation file validation, you can view a status log of successful and unsuccessful tasks, the output file of the transformed data, and any rejected data.
You can save the status log information in a Microsoft Excel workbook or a text file.
ActivitiesTo validate transformation files, choose Validate transformation definitions from the Transformation Maintenance Options action pane, select a data type, and select a data file.
To change the information displayed in the status log, choose the appropriate view option.
To save the information displayed in the status log, choose Save in Excel Workbook or Save as Text File.
Importing and Exporting Data Having Multiple Key Figures
You can import and export transactional data that consists of more than one key figure for the same source into the same Planning and Consolidation application. Use the *MVAL keyword in the mapping section of the transformation file (see Data Transformation Maintenance).
Syntax:Dimension =*MVAL(keyfiguretype1|dim_mem1||keyfiguretype2|dim_mem2||keyfiguretype3|dim_mem3)
PrerequisitesThe dimension must exist in the application.
The passed dimension members in dim_mem must be the noncalculated (CALC = N) members of the dimension.
The keyfiguretype must be the field name of the source data.
Procedure1. Access the Launch Page and log on to to the ApShell application set.2. Choose eData New transformation file .3. Map the multiple key figures to the single key figure using a keyword in the mapping section of the
transformation file.4. Save the transformation file.5. Run the package and choose the transformation file.
ExampleExample 1:
Source data:Account, Entity, Data source, LC, GC, TC.
Cash, SalesItaly, Input, key1, key2, key3
Mapping command:Account =*MVAL(LC|*STR(Cash_lc)||GC|*COL(1)+*STR(gc)||TC|*STR(Cash_tc))
Target data:Account, Entity, Data source, keyfigure
Cash_lc, SalesItaly, Input, key1
Cash_gc, SalesItaly, Input, key2
Cash_tc, SalesItaly, Input, key3
Example 2:
Source data:Account, Entity, Data source, LC, GC, TC.
Cash, SalesItaly, Input, key1, key2, key3
Mapping command:Keyfiguretype =*MVAL(LC|*NEWCOL(LC)||GC|*STR(GC)||TC|*NEWCOL(TC))
Target data:Account, Entity, Data source, Keyfiguretype, keyfigure
Cash, SalesItaly, Input, LC, key1
Cash, SalesItaly, Input, GC, key2
Cash, SalesItaly, Input, TC, key3
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
BAdI for Start Routine and End Routine
Startroutine and Endroutine can be called from a transformation file to modify the incoming data and the transformed data. The Start and Endroutine are implementations based on BAdIs. The BAdI UJD_ROUTINE covers the startroutine and endroutine.
Activities1. Create a BAdI implementation for UJD_ROUTINE in transaction SE19.2. Enter the filter of the BAdI. The filter value is used in the transformation file to call the BAdI
implementation.3. Create a transformation file.4. Enter the BAdI filter value in the *OPTIONS section.5. Define a package to use the transformation file.6. Run the package.
ExampleTransformation file*OPTIONS
FORMAT = DELIMITED
HEADER = YES
DELIMITER =
SKIP = 0
SKIPF =
CREDITNEGATIVE=NO
CONVERTAMOUNTWDIM=
MAXREJECTCOUNT=
VALIDATERECORDS=YES
STARTROUTINE = BADI_FILTER1
ENDROUTINE = BADI_FILTER2
*MAPPING
cat=category
Acc=Account
Ent = Entity
Tim=time
Currency=Rptcurrency
int=intco
dat=Datasrc
*CONVERSION
More InformationSteps to Activate BAdI Implementations in the Business Address Services application help available on SAP Service Marketplace
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Modifying the Dynamic Script of a Package
Use this to modify the parameters the system passes to the process chain and the user interface of a Data Manager package.
Procedure1. Access the Launch Page and log on to the application set.2. On the action pane, choose Manage data.3. On the action pane, choose Maintain data management Manage packages (organize list) .4. Select a package and choose Modify Package.5. Choose the View package browse icon.6. Choose <Package name> Dynamic Package Script (MODIFYSCRIPT) PROMPT.7. Select the Type cell and select a prompt. Enter data as required.
NOTE
You cannot select or deselect the Activate option until you save the package.
8. Choose the Advanced button to change the script directly (see Defining Dynamic Script Instructions).
9. Save the package.
More InformationProcess Chains Delivered with ApShell
Defining Dynamic Script Instructions
You can adjust a script to meet your needs using predefined constants within the following types of commands:
INFO Instructions Task Instructions Prompt Commands
More InformationPredefined Constants
INFO Instructions
An INFO instruction defines and assigns a value to a script variable. It is not an executable instruction nor does it affect a package directly.
FeaturesThe syntax for an INFO instruction is:
INFO("variablename",value)
where
variable name is the name of the variable value is the value of the variable
Instead of assigning a value directly to a task, you can replace the value (or part of it) with the name of a variable defined in an INFO instruction. At runtime, the task replaces the name of all INFO variables found in all executable instructions with the value of those variables before executing the executable instructions.
EXAMPLE
The following example illustrates how to define a variable with an INFO instruction and how to use it in another instruction such as TASK. The parameters %EQU% and %TAB% are passed to the process type/CPMB/ALLOCATION_LOGIC, which is defined in the process chain /CPMB/ALLOCATION.
INFO(%EQU%,=)
INFO(%TAB%,;)
TASK(/CPMB/ALLOCATION_LOGIC,TAB,%TAB%)
TASK(/CPMB/ALLOCATION_LOGIC,EQU,%EQU%)
RECOMMENDATION
We recommend the use of expressions that are enclosed between easily identifiable characters such as the % character (%VARIABLE%, for example), This makes the script more readable and less subject to errors when the substitutions are performed.
NOTE
All system generated INFO variables comply with this practice. For a list of predefined constants list, see Predefined Constants.
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Predefined Constants
The following constants are in use by the system, which you can use within the context of an INFO instruction:
Predefined Constant
Description
%ACCOUNT_DIM% Returns dimension name where dimension type = A.
%APP% Returns current application name.
%APPBINAME% Returns current application technical name
%APPLIST% Returns a list of applications.
%APPSET% Returns current application set name.
%CATEGORY_DIM% Returns dimension name where dimension type = C.
%CURRENCY_DIM% Returns dimension name where dimension type = R.
%DATASRC_DIM% Returns dimension name where dimension type = D.
%DIMS% Returns list of dimensions based on the application.
%ENTITY_DIM% Returns dimension name where dimension type = E.
%GROUP_DIM% Returns dimension name where dimension type = G or (type = U and has an attribute named GROUP_CURRENCY)
%INCREASENO% Returns the file number
%INTCO_DIM% Returns dimension name where dimension type = I.
%PACKAGE% Return package ID
%PACKAGESIZE% Returns package size
%SUBTABLES_DIM% Returns dimension name where dimension type = S.
%TEMPPATH% Returns the temp folder path. The path returned has the trailing back slash (\) appended to it.
%TIME_DIM% Returns dimension name where dimension time = T.
%USER% Returns full user name (with domain name).
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Task Instructions
You can pass parameters to the process types defined in a process chain by using the TASK instruction. Only the process types that are defined for Planning and Consolidation process chains can be used. The parameters need to be defined in the process chain as well.
ExampleThe process type is /CPMB/ALLOCATION_LOGIC and the parameter is %TAB%.
INFO(%TAB%,;)
TASK(/CPMB/ALLOCATION_LOGIC,TAB,%TAB%)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Prompt Commands
A prompt command generates customized dialog boxes that prompt users for answers. By completing these dialog boxes, a user can select such things as the files to upload, the data to export, or the target applications for selected data. When multiple prompt commands are entered in the same script, the system combines all of the prompts into one dialog box. This rule applies to all prompt commands asking for the selection of a file, a delimiter, or text, but not to the COPYMOVE and SELECT prompts. The
COPYMOVE and SELECT prompts are presented individually, with as many dialog boxes as prompts are found in the script. All file selection prompts return the name of the selected file with the complete path. If the user leaves a selection field blank in a SELECT or COPYMOVE dialog box, the system assumes all members for that dimension; the system does not insert a range for the dimension in the returned statement.
Prompt commands are dependent on the variables defined in the process chains delivered with Planning and Consolidation. For information about the parameters you can change, see Process Chains Delivered with ApShell.
Prompt commands are stored by package. Therefore, you can create multiple packages based on the same process chain template and provide different prompts to users for each package.
More InformationCHECKBOX Prompt() Command
CHECKBOXGROUP Prompt() Command
CHECKBOXNO Prompt() Command
COMBOBOX Prompt() Command
CONVERSION Prompt() Command
COPYBOXNO Prompt() Command
COPYBOXYES Prompt() Command
COPYMOVE Prompt() Command
COPYMOVEINPUT Prompt() Command
DELIMITER Prompt() Command
DIMENSIONMEMBER Prompt() Command
DIMENSIONNAME Prompt() Command
HIERARCHYSELECTION Prompt() Command
INFILE Prompt() Command
INFILES Prompt() Command
LOGICFILE Prompt() Command
MASTERSELECTION Prompt() Command
MEASURELIST Prompt() Command
MEMBERFROMTOINPUT Prompt() Command
MESSAGE Prompt() Command
OUTFILE Prompt() Command
RADIOBUTTON Prompt() Command
SELECT Prompt() Command
SELECTINPUT Prompt() Command
SELECTION Prompt() Command
SELECTIONFILE Prompt() Command
TEXT Prompt() Command
TRANSFORMATION Prompt() Command
Process Chains Delivered with ApShell
The Data Manager delivers Planning and Consolidation process chains in the following areas:
Data management System administration Financial processes
You can execute all delivered process chains through a Data Manager package.
The execution of the process chains for system administration and financial processes are included in the system administration and business rule functionality.
You set the parameters for the Planning and Consolidation process chains through instructions.
The Planning and Consolidation process chains do not require any modification. You can parameterize and execute them using packages.
When creating a Data Manager package, you choose a Planning and Consolidation process chain (see Adding and Modifying Packages).
Adding and Modifying Packages
Procedure1. Access the Launch page and log on to the application set.2. On the action pane, choose Manage data Maintain data management Manage packages
(organize list) .3. Choose Add Package or select the package and choose Modify Package.4. Choose one of the delivered process chains.5. Enter a package name.6. Select the package group.
To create a new group, enter the name of the new group in the Group field.
7. Enter a package description.8. Choose Add or Save as appropriate.9. Choose Save.
You must save before the package can run. Adding the package only adds it to the folder list. Saving it makes it available for use.
10. Customize the user interface of the package using dynamic script instructions (see Modifying the Dynamic Script of a Package).
More InformationPackage Properties
Process Chains Delivered with ApShell
Defining Dynamic Script Instructions
Package Properties
The following table describes the fields you must complete when adding or editing packages. If any of these fields are incorrect or left blank, the package generates an error when the package is executed.
Field Description
PackageType Choose Process Chain. There is currently only one type of package.
Process Chain
Select the Planning and Consolidation process chain.
Dynamic Script
The dynamic script defines the user interface of the package. Dynamic scripts are delivered by default, which you can modify (see Modifying the Dynamic Script of a Package).
PackageName
The name of the package.
Group The folder group to which the package is added.
Description A description of the package.
Task Type You can control who has access to run the package. If you select Admin Package, you are defining this package as an administrative package. Only users who are Planning and Consolidation Administrators can see and run the package. A non-administrative user cannot see or run the package. If you select User Package, users who have been assigned the Execute Data Management task security privilege can execute the task.
More InformationAdding and Modifying Packages
CHECKBOX Prompt() Command
This command is used to present the user with a checkbox to select or leave empty.
Syntax: PROMPT (CHECKBOX, [variable],[checkbox label text],[default value])
Parameter Description Default Value
CHECKBOX checkbox n/a
[variable] The name of the returned variable %CHECKBOX%
[checkbox label text] The text to display to the user. Please select.
[default value] The default value of the checkbox
The default value can be 0 (unchecked by default) or 1 (checked by default).
ExamplePROMPT(CHECKBOX,%CheckBox%,"Test for CheckBox",1)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
CHECKBOXGROUP Prompt() Command
This command is used to present the user with a set of check boxes to select or leave empty.
Syntax: PROMPT (CHECKBOX, [variable],[label],[default values],[label for check items])
Parameter Description Default Value
CHECKBOXGROUP A set of check boxes n/a
[variable] The name of the returned variable %CHECKBOX%
[label] The text to display to the user Please select.
[label for check items] The text of checkboxes to display to the user
[default value for check items] The default value of the checkboxes
The default value can be 0 (unchecked by default) or 1 (checked by default).
NOTE
Separate multiple values with commas.
ExamplePROMPT(CHECKBOXGROUP,%CHECKGROUP%,"Text for CheckBoxGroup",{1,0,1},{"ch1","ch2","ch3"},,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
CHECKBOXNO Prompt() Command
This command is used to present with a checkbox to select or leave empty. By default, this prompt type always presents the user with an empty checkbox.
Syntax: Syntax: PROMPT(CHECKBOXNO, [variable],[label],,,,)
Parameter Description Default Value
CHECKBOXNO A checkbox n/a
[variable] The name of the returned variable %CHECKBOX%
[label] The text to display to the user. Please select a transformation file.
ExamplePROMPT(CHECKBOXNO,%CHECKBOXNO%,"Test for CheckBoxNo",,,,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
COMBOBOX Prompt() Command
This command is used to present the user with a combination box (that is, a dropdown list).
Syntax: PROMPT (COMBOBOX, [variable],[label],[combo style],[default value],[select items])
Parameter Description Default Value
COMBOBOX combo box n/a
[variable] The name of the returned variable %COMBOBOX%
[label] The text to display to the user Enter source and target time.
[combo style] The style of combo box
0 — the item the user selects should be one of the items in the select items)
Any number other than 0 — the item the user selects can be any value, which does not need to be one of the items in the select items
[default value]
The preselected choice
[dimensions] The dimensions to select. Separate multiple values with commas.
Category, Time, Entity
%DIMS% is the dimension list in the current application
The default value determines the preselected choice (in terms of order, starting with 0).
NOTE
Separate multiple values with commas.
ExamplePROMPT(COMBOBOX,%COMOBOBOX%,"Text for Combobox:",0,t2,t1,t2)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
CONVERSION Prompt() Command
This command is used to prompt the user for a transformation file to use.
Syntax: PROMPT(CONVERSION, [variable], [label], [mask], [path])
Where Means Default Value
CONVERSION Select an existing DATA file. n/a
[variable] The name of the returned variable %CONVERSION%
[label] The text to display to the user. Please select a transformation file.
[mask] The types of files to select. Data files (*.txt), *.txt, All files(*.*),*.*
[path] The search path. The transformation files directory.
ExamplePROMPT(CONVERSION,%CONVERSION%,"Text for Conversion:",”Excel files (*.xls), *.xls, All files(*.*),*.*”,,”Import.xls”)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
COPYBOXNO Prompt() Command
Presents the user with a checkbox to select or leave empty. By default, this prompt type always presents the user with an empty checkbox.
Syntax: PROMPT(CHECKBOXNO, [variable],[label],,,,)
ExamplePROMPT(CHECKBOXNO,%CHECKBOXNO%,"Test for CheckBoxNo",,,,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
COPYBOXYES Prompt() Command
Presents the user with a checkbox to select or leave empty. By default, this prompt type always presents the user with a selected checkbox.
Syntax: PROMPT(CHECKBOXYES, [variable],[label],,,,)
ExamplePROMPT(CHECKBOXNO,%CHECKBOXNO%,"Test for CheckBoxNo",,,,)
COPYMOVE Prompt() Command
This command is used to prompt the user for a source and destination data range. The number of members in FROM and TO should be the same.
Syntax: PROMPT(COPYMOVE, [variable], [second variable], [label], [dimensions])
Where Means Default Value
COPYMOVE Select two data ranges. n/a
[variable] The name of the returned variable. %SELECTION%
[second variable] The name of the second returned variable. %TOSELECTION%
[label] The text to display to the user. Enter your selection
[dimensions] The dimensions to select from. Category, Time, Entity
EXAMPLEPROMPT(COPYMOVE,%SELECTION%,%TOSELECTION%,"Test for COPYMOVE",”%DIMS%”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
COPYMOVEINPUT Prompt() Command
This command prompts the user for two noncalculated data ranges (for copying data, for example). The number of members in FROM and TO should be the same.
Syntax: PROMPT(COPYMOVEINPUT, [variable], [second variable], [label], [dimensions])
Where Means Default Value
COPYMOVEINPUT Select noncalculated data ranges.
n/a
[variable] The name of the returned variable
%SELECTION%
[second variable]
The name of the second returned variable
%TOSELECTION%
[label] The text to display to the user. Please select a file..
[dimensions] The dimensions to select from Category, Time, Entity
%DIMS% is the dimension list in current application.
EXAMPLEPROMPT(COPYMOVEINPUT,%SELECTION%,%TOSELECTION%,"Test for COPYMOVEINPUT",”%DIMS%”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only
intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
DELIMITER Prompt() Command
This command is used to prompt the user for a delimiter to be used in the import or export file. The possible delimiter options are Comma, Tab, or other delimiter.
Syntax: PROMPT(DELIMITER, [variable], [label])
Where Means Default Value
DELIMITER The data delimiter n/a
[variable] The name of the returned variable %DELIMITER%
[label] The text to display to the user Please select a delimiter.
If you are using Planning and Consolidation for the Microsoft platform, you need to distinguish between the delimiters for input and output. You do this in the Data Manager Dynamic Script editor by appending a command similar to the following:
TASK(CONVERT data,DELIMITERFORINPUT,%DELIMITER%).
ExamplePROMPT(DELIMITER,%DELIMITER%,"Text for delimiter")
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
DIMENSIONMEMBER Prompt() Command
Used to prompt for selecting a dimension and the members when exporting master data.
Syntax: PROMPT (DIMENSIONMEMBER,[variable],[label],[the second label],[dimensions])
Where Means Default Value
DIMENSIONMEMBER Select a dimension and the members
n/a
[variable] Variable for the selected info object
%DIMENSIONMEMBER%
[label] The text to display to the user Select dimension.
[the second label]
The second text to display to the user
Select members.
[dimensions] The dimensions to select. Separate multiple values with commas.
Category, Time, Entity%DIMS% is the dimension list in current application.
EXAMPLEPROMPT(DIMENSIONMEMBER,% DIMENSIONMEMBER%,"Select a dimension","Select members","%DIMS%")
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
DIMENSIONNAME Prompt() Command
Used to prompt for selecting a BPC dimension when importing master data.
Syntax: PROMPT (DIMENSIONNAME, [variable],[label],[combo style],[default value],[dimensions])
Where Means Default Value
DIMENSIONNAME Select a dimension. n/a
[variable] Variable %COMBOBOX%
[label] The text to display to the user Enter source and target time.
[combo style] The style of combo box
0 — The item user selects should be one of the item in the select items
Any number that is not 0 — The item user selects can be any value, which does not need to be one of the item in the select items.
[default value]
The preselected choice
[dimensions] The dimensions to select.
Separate multiple values with commas.
Category, Time, Entity
%DIMS% is the dimension list in current application.
EXAMPLEPROMPT(DIMENSIONNAME,%DIMNAME%,"Test for DIMENSIONNAME:",TIME, "%DIMS%")
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for
errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
HIERARCHYSELECTION Prompt() Command
Used to prompt for selecting an info object and the hierarchy selection when importing a hierarchy from an SAP NetWeaver InfoObject.
Syntax: PROMPT (HIERARCHYSELECTION,[variable],[the second variable],[label]])
Where Means Default Value
HIERARCHYSELECTION Select info object and selection n/a
[variable] Variable for the selected info object %INFOOBJECT%
[the second variable] The second variable for the selection %HIERARCHYSELECTION%
[label] The text to display to the user. Set selection.
EXAMPLEPROMPT(HIERARCHYSELECTION,%INFOOBJECT%,%SELECTION%,"Test for HIERARCHYSELECTION")
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
HIERARCHYSELECTION Prompt() Command
Used to prompt for selecting an info object and the hierarchy selection when importing a hierarchy from an SAP NetWeaver InfoObject.
Syntax: PROMPT (HIERARCHYSELECTION,[variable],[the second variable],[label]])
Where Means Default Value
HIERARCHYSELECTION Select info object and selection n/a
[variable] Variable for the selected info object %INFOOBJECT%
[the second variable] The second variable for the selection %HIERARCHYSELECTION%
[label] The text to display to the user. Set selection.
EXAMPLEPROMPT(HIERARCHYSELECTION,%INFOOBJECT%,%SELECTION%,"Test for HIERARCHYSELECTION")
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only
intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
INFILE Prompt() Command
This command is used to prompt the user for a file to import.
Syntax: PROMPT(INFILE, [variable], [label], [mask])
Where Means Default Value
INFILE One or more data files n/a
[variable] The name of the returned variable %FILE%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder Data files (*.txt), *.txt, All files(*.*),*.*
The INFILE prompt command supports file names stored on the Application Server and FTP. The qualified path and file name need to be entered, for example, \uxcikf1\usr\sap\TEMP\file.csv.
ExamplePROMPT(INFILE,%FILE%,"Test for INFILE:",”Data files (*.txt), *.txt, All files(*.*),*.*”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
INFILE Prompt() Command
This command is used to prompt the user for a file to import.
Syntax: PROMPT(INFILE, [variable], [label], [mask])
Where Means Default Value
INFILE One or more data files n/a
[variable] The name of the returned variable %FILE%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder Data files (*.txt), *.txt, All files(*.*),*.*
The INFILE prompt command supports file names stored on the Application Server and FTP. The qualified path and file name need to be entered, for example, \uxcikf1\usr\sap\TEMP\file.csv.
ExamplePROMPT(INFILE,%FILE%,"Test for INFILE:",”Data files (*.txt), *.txt, All files(*.*),*.*”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
INFILES Prompt() Command
This command is used to prompt the user for a file to import.
Syntax: PROMPT(INFILEs, [variable], [label], [mask])
Where Means Default Value
INFILES One or more DATA files n/a
[variable] The name of the returned variable %FILE%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder *.*
EXAMPLEPROMPT(INFILES,%FILE%,"Test for INFILES:",” All files(*.*),*.*”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
INFILES Prompt() Command
This command is used to prompt the user for a file to import.
Syntax: PROMPT(INFILEs, [variable], [label], [mask])
Where Means Default Value
INFILES One or more DATA files n/a
[variable] The name of the returned variable %FILE%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder *.*
EXAMPLE
PROMPT(INFILES,%FILE%,"Test for INFILES:",” All files(*.*),*.*”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
LOGICFILE Prompt() Command
This command is used to prompt the user for a logic file to import.
Syntax: PROMPT(LOGICFILE, [variable],[label],[mask])
Where Means Default Value
LOGICFILE One or more logic files n/a
[variable] The name of the returned variable %LOGICFILE%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder *.lgx, *.lgf
EXAMPLEPROMPT(LOGICFILE,%LOGICFILE%,"Test for LOGICFILE:",” Logic files(*.lgx),*.lgx”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
MASTERSELECTION Prompt() Command
Used for selecting an info object, attribute, and hierarchy when importing a master data package from an SAP NetWeaver InfoObject.
Syntax: PROMPT (MASTERSELECTION,[variable],[the second variable],[label]])
Where Means Default Value
MASTERSELECTION Select info object and selection n/a
[variable] Variable for the selected info object %INFOOBJECT%
[the second variable] The second variable for the selection %MASTERSELECTION%
[label] The text to display to the user Set selection.
EXAMPLE
PROMPT(MASTERSELECTION,%INFOOBJECT%,%SELECTION%,"Test for MASTERSELECTION")
MEASURELIST Prompt() Command
Used to prompt for selecting measures when exporting transaction data. The measures are: PERIODIC, YTD, QTD, and SIGNEDDATA. You can select SIGNEDDATA or any combination of PERIODIC, YTD, and QTD.
Syntax: PROMPT (MEASURELIST,[variable],[label])
Where Means Default Value
MEASURELIST Select measures n/a
[variable] Variable %MEASURES%
[label] The text to display to the user Select measures.
MEMBERFROMTOINPUT Prompt() Command
This command is used to prompt the user for an existing data selection file. The number of members in FROM and TO range do not need to be the same.
Syntax: PROMPT(MEMBERFROMTOINPUT,[dim_type],[source_variable],[target_variable],[label])
Where Means Default Value
[dim_type] Select a data type. n/a
[source_variable] Source variable n/a
[target_variable] Target variable n/a
[label] The text to display to the user Enter source and target time.
ExamplePROMPT(MEMBERFROMTOINPUT,%SOURCE_TM%,%TARGET_TM%,”Enter Source and Target Time”,”%TIME_DIM%”)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
MESSAGE Prompt() Command
This command sets the text to be displayed to the user at the time the package is set. The text is displayed at the top of the dialog box.
Syntax: PROMPT(MESSAGE, [content])
ExamplePROMPT(MESSAGE,"When this package is running, end user functionality will be affected: Data cannot be sent to the database or incorrect numbers can be retrieved from the database")
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
OUTFILE Prompt() Command
This command is used to prompt the user for the name of the export file.
Syntax: PROMPT(OUTFILE, [variable], [label], [mask],)
Where Means Default Value
OUTFILE An existing DATA file. n/a
[variable] The name of the returned variable %FILE%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder Data files (*.txt), *.txt,All files(*.*),*.*
EXAMPLEPROMPT(OUTFILE,%FILE%,"Test for OUTFILE:",”Data files (*.txt), *.txt, All files(*.*),*.*”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
RADIOBUTTON Prompt() Command
This command is used to present the user with a radio button control.
Syntax: PROMPT(RADIOBUTTON, [variable],[label],[default value],[label for choices],[values for choices])
Separate multiple values with commas.
[label for choices] and [values for choices] should be a one to one mapping.
The default value can be empty or one of the value in the [values for choices]. If it is empty, no radio button is checked by default. If it is one of the value in the [values for choices], the corresponding radio button is checked by default.
ExamplePROMPT(RADIOBUTTON,%CHECKLCK%,"Select whether to check work status settings when importing data.",1,{"Yes, check for work status settings before importing","No, do not check work status settings"},{"1","0"})
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
SELECT Prompt() Command
This command is used to prompt the user for a data range (for export, for example).
Syntax: PROMPT(SELECT, [variable], [second variable], [label], [dimensions])
Where Means Default Value
SELECT Select one data range. n/a
[variable] The name of the returned variable %SELECTION%
[label] The text to display to the user Enter your selection
[dimensions] The dimensions from which to select members Category, Time, Entity
ExamplePROMPT(SELECT,%SELECTION%,,"Select the members to export","CATEGORY,ENTITY")
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
SELECTINPUT Prompt() Command
This command is used to allow the user to select only noncalculated members (for export, for example).
Syntax: PROMPT(SELECTINPUT, [variable], [second variable], [label], [dimensions])
Where Means Default Value
SELECTINPUT Select one noncalculated data range n/a
[variable] The name of the returned variable %SELECTION%
[label] The text to display to the user. Enter your selection
[dimensions] The dimensions from which to select members Category, Time, Entity
Activities%DIMS% is the dimension list in the current application. The value can be ACCOUT, ENTITY, TIME. %SELECTION% is the result that the user selects in the Run Package dialog box.PROMPT(SELECTINPUT,,,,"%DIMS%")
%SELECTION% is the result that the user selects in the Run Package dialog box. The script can be the following:PROMPT(SELECTINPUT,%SELECTION%,,,"%DIMS%")
%DIMS% creates the screen, and the selected result is saved in %SELECTION%. Without %selection%, you use %SELECTION% as the default. Therefore, you can also write the script asPROMPT(SELECTINPUT,%ANYNAME%,,,"%DIMS%"), then use %ANYNAME% in the task commands.
ExampleIf you need only one SELECTINPUT prompt command, create the package script as follows:PROMPT(SELECTINPUT,%SOURCEENTITY%,,"Enter Source Entity","%ENTITY_DIM%") TASK(/CPMB/ALLOCATION_LOGIC,SELECTION,%SOURCEENTITY%)
If you need more than one SELECTINPUT prompt command, create the package script as follows:PROMPT(SELECTINPUT,%SOURCEENTITY%,,"Enter Source Entity","%ENTITY_DIM%")
PROMPT(SELECTINPUT,%TARGETENTITY%,,"Enter Target Entity","%ENTITY_DIM%")
INFO(%EQU%,=)
INFO(%TAB%,;)
TASK(/CPMB/ALLOCATION_LOGIC,TAB,%TAB%)
TASK(/CPMB/ALLOCATION_LOGIC,EQU,%EQU%)
TASK(/CPMB/ALLOCATION_LOGIC,REPLACEPARAM,ASARENT%EQU%%ASARENT%%TAB%SOURCE%EQU%%SOURCEENTITY%%TAB
%TARGET%EQU%%TARGETENTITY%)
TASK(/CPMB/ALLOCATION_LOGIC,MEMBERSELECTION,SOURCE%EQU%%SOURCEENTITY%%TAB %TARGET%EQU%%TARGETENTITY%)
You can hardcode the selection using INFO commands, as follows:INFO(%DIMVALUE%,E=24)
INFO(%SELECTION%, /APP123/PLANNING/PrivatePublications/I045795/TempFiles/FROM.TMP@@@SAVE@@@@@@EXPAND@@@|DIMENSION:ENTITY|A1000|DIMENSION:CATEGORY||DIMENSION:TIME||)
INFO(%DIMVALUE%,E=24) means that 24 different entity members are selected in a group.
In the import package, the package_size specifies how large each group is. In the export, this value is used to specify the group to improve the export performance.
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
SELECTION Prompt() Command
This command is used to prompt the user for an existing data selection file.
Syntax: PROMPT(SELECTION, [variable], [label], [mask],)
Where Means Default Value
SELECTION Select an existing data selection file. n/a
[variable] The name of the returned variable %SELECTION%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder Data files (*.txt), *.txt,All files(*.*),*.*
EXAMPLEPROMPT(SELECTION,%SELECTION%,"Test for SELECTION:",”Data files (*.txt), *.txt, All files(*.*),*.*”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
SELECTIONFILE Prompt() Command
This command is used to prompt the user for a file to import.
Syntax: PROMPT(SELECTIONFILE, [variable], [label], [mask])
Where Means Default Value
SELECTIONFILE Select existing DATA files. n/a
[variable] The name of the returned variable %FILE%
[label] The text to display to the user Please select a file.
[mask] The file types to display in the selected folder *.*
EXAMPLEPROMPT(SELECTIONFILE,%FILE%,"Test for SELECTIONFILE:",”All files(*.*),*.*”,)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
TEXT Prompt() Command
This command is used to display a text message to the user.
Syntax: PROMPT(TEXT, [variable], [label], [PWD], [VALIDATE LIST])
Where Means Default Value
TEXT This is the function name. None
[variable] The name of the returned variable %TEXT%
[label] The text to display to the user None
[PWD] Use this variable when you want to display the password as asterisks (*****) in the text box.
None
[VALIDATE LIST]
This parameter contains a list of items used to validate the input text. The delimiter must be a comma, and the list must close with a double quotation.
None
ExampleExample 1
This function shows a text box with the label Application list:. The system validates the user entry against an application list.PROMPT(TEXT,%APPLIST%,"Application list:",,"%APP_LIST%")
Example 2
This function shows a text box with the label Dimension list:. The system validates the user entry against a dimension list.PROMPT(TEXT,%DIMLIST%,"Dimension list:",,"%DIMS%")
Example 3
This function shows a text box with the label Alphabet list:. The system validates the user entry against A,B,C,D,E.PROMPT(TEXT,%AlphabetList%,"Alphabet list:",,"A,B,C,D,E")
Example 4
This function shows a text box with a password value shown in asterisks (*).
PROMPT(TEXT,%Password%,"Please enter your password",PWD)
CAUTION
All parameter values containing the string password, for example, %Password1%, %password2% or %FtpPassword% are masked in the log. If you use PSD as the parameter name for passwords, the password values are not masked in the log. For instance, in PROMPT(TEXT,%PSD%,"Please enter your password",PWD)), the value for the parameter names %Password1%, %password2%, and %FtpPassword%are masked.
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
TRANSFORMATION Prompt() Command
This command is used to prompt the user for a transformation file.
Syntax: PROMPT(TRANSFORMATION, [variable], [label], [mask],,[default file name])
Where Means Default Value
TRANSFORMATION Select an existing DATA file. n/a
[variable] The name of the returned variable %TRANSFORMATION%
[label] The text to display to the user Please select a transformation file.
[mask] The file types to display in the selected folder
Excel files (*.xls), *.xls
All files(*.*),*.*
[default file name]
The default file name import.xls.
ExamplePROMPT(TRANSFORMATION,%TRANSFORMATION %,"Text for Transformation:",”Excel files (*.xls), *.xls, All files(*.*),*.*”,,”Import.xls”)
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or by its gross negligence.
Currency Conversions
Currency conversions typically run by default when default logic runs. You can also create a new logic file to run a currency conversion.
You run this rule by calling the stored procedure SPRUNCONVERSION from any logic file.
*RUN_STORED_PROCEDURE=SPRUNCONVERSION(Parameters list)
Example:*RUN_STORED_PROCEDURE=SPRUNCONVERSION([%APP%],[%CATEGORY_SET%],[%CURRENCY_SET%],[GLOBAL],[%SCOPETABLE%],[%LOGTABLE%])
Parameter Description
Application The application ID.
Category The category ID. We currently support the handling of only one category at a time.
Currency The currency, blank, or Multi.
Rateentity The default Entity member for the Rate application.
%SCOPETABLE% %SCOPETABLE% is a variable used by the system to define the name of a logic table.
%LOGTABLE% %LOGTABLE% is a variable used by the system to define the name of a Log table.
The stored procedure SPRUNCONVERSION scans all records found in the selected region of data. It translates them according to the RATETYPE property assigned to the ACCOUNT specified in each record, based on the mechanism that all ACCOUNTS are translated according to the definitions contained in the table of parameters called clcFXTRANS.
For information on required properties of the Category and Data Source dimensions, see Dimensions Setup for Consolidations.
The following table describes the fields for the currency conversion rules table.
Field name Description
Account rate type
The currency conversion type, for example, AVG, END, HIST, taken from the Account dimension's RATETYPE property. This is the main driving field, controlling the translation rule to apply to a given account.
NOTE
One RATETYPE may generate more than one translated value. This can be defined by entering more than one entry with the same RATETYPE in the business rule interface for currency rules.
Source flow This field, combined with the 'Account rate type' field, completes the definition of the criteria that drive the applicability of a given rule. In other words, the instruction can be read as follows:
If the account has such RATETYPE and the FLOW is such and such, then apply this rule.
This field may contain the following values:
A valid base level or parent member ID from the FLOW dimension A list of members of the FLOW dimension, as defined filtering the members using a
value of the DIMLIST property (or any property whose name begins with DIMLIST)
For information about the Flow dimension, see Setting up a legal consolidation application set.
Destination account
The account that stores the specific conversion. If empty, it is the same as the source account's member.
Destination flow
The specific Accdetail member where translations are stored. If empty, then it is the same as the source subtable member.
Formula This field can contain any arithmetic expression combining any defined RATE as per the ACCOUNT dimension of the RATE application. All rates with the RATETYPE property value of FX TRANS can be used.
Force closing
If checked, force the generation of an additional record where the member of the destination FLOW is the closing balance. The closing balance member of the FLOW dimension is identified as the member with the property FLOW_TYPE = CLOSING.
Apply to periodic
This field should only be used in a YTD application for the cases in which the currency conversion should be performed on the PERIODIC values and not on the YTD values. If the box is checked, the engine calculates the difference between current period and prior period amounts, and it applies the rate specified in RATE_FORMULA field. At the end, the result is added back to prior period's value as written in current period.
Entity FX type
This field can be used to enforce a given set of rules to only apply to a desired set of ENTITIES. If this field has a value, the rule is only applied to the entities having a matching value in a similarly named property (FX_TYPE) of the ENTITY dimension.
Remarks A short description for this rule.
Formula field
In the FORMULA field, the rates must be enclosed in square brackets:
[END]
[END] – [AVG]
The OPENING value of any rate can also be specified adding the prefix OPE to the rate itself.
Examples:[OPEEND] – [END]
[OPEAVG]
These OPENING rates do not need to exist in the RATE cube. For example, if there is an [END] rate, the currency translation also automatically recognizes a rate called [OPEEND], which simply corresponds to the [END] rate of the OPENING period (typically last period of last year).
In addition, the RATE_FORMULA field supports the following keywords:
[AS_IS]: Leave untouched a value already existing in the destination currency. The keyword cannot be combined with other rates in the same line. The only valid exception is the format [AS_IS]*-1.
[COPYLC]: This correspond to applying a rate of 1 in the translation.
How the RATE table is selected
While most customers require a single table of rates, there are situations when more than one set of rates is required. In this situation, the translation procedure uses the RateEntity dimension to select the correct table of rates to use.
Whenever a destination currency is selected, the procedure searches for a RateEntity member flagged with this currency in the Currency property. For example, if translating into USD, the system uses the RateEntitymember that has the Currency property set to USD.
If there is no RateEntity flagged as the destination currency, the system uses the RateEntity with Currency = ‘’ (blank).
In addition to this, some exceptions by ENTITY can be applied. For example, some entities just entering in the consolidation perimeter may need to be converted at their own specific set of rates. These entities may have a corresponding RateEntity member in the RATE cube. All ENTITIES having a corresponding RateEntity member in the RATE cube use that member as rate table. For example, if there is a RateEntity member named in the same way as the ENTITY USOps, the RateEntity member USOps is used to translate the values of entity ENTITY USOps.
The RateEntity member, when representing an ENTITY, may be any of the following:
A valid base level or parent member ID from the ENTITY dimension of the main cube. A list of members of the ENTITY dimension, as defined filtering the members using a value of
the DIMLIST property (or any property whose name begins with DIMLIST) of such dimension.
Dimensions Setup for Consolidations
This function enables you to set up the dimensions used to run consolidations.
PrerequisitesThe application set used for consolidations has been created and its parameters set up.
FeaturesYou set up consolidation dimensions by:
Setting up dimension library dimensions Updating dimension properties Updating dimension members and property values
Setting Up Dimension Library Dimensions
You must ensure that all the dimensions are available in the Dimension Library of the new application set. (The names need not be exactly the same, but the types of the dimensions are mandatory for corresponding applications.)
For information on creating dimensions, see Dimension Management.
For a legal consolidation application, the following dimension types are required: C_Acct (A) C_Category (C) C_Datasrc (D) Flow (S) Groups (R) Entity (E) IntCo (I) Time (T)
For a rate application that contains exchange rates, the following dimension types are required: R_Acct (A) C_Category (C) R_Entity (E) InputCurrency(R) Time (T)
For an ownership application that stores ownership details, the following dimension types are required: O_Acct (A) C_Category (C) Entity (E) Time (T) IntCo (I) Groups (R)
Updating Dimension Properties
When you create a dimension, all the required properties (attributes) are created automatically. Typically, however, a consolidation process (such as currency conversion, simulation, automatic adjustment, and so on) needs additional properties for the filtering, flagging, and calculation of the target data. Therefore, it is necessary to ensure that these properties are correctly maintained with the expected value to be used in the consolidation process, according to business requirements.
The following dimension properties are required for a consolidation. The dimension properties listed here are only intended to help with checking the completeness of the master data setting for a basic consolidation process; the required properties that are automatically generated by the system are not included in this list. For those dimensions, only the requested properties are needed.
For more information about properties, see Member Behavior using Dimension Properties.
C_Category
Property Length
Category_For_OPE 20
FX_DIFFERENCE_ONLY 2
FX_SOURCE_CATEGORY 20
OPENING_PERIOD 10
OPENING_YEAR 10
RATE_CATEGORY 20
RATE_PERIOD 10
RATE_YEAR 10
YEAR 10
C_Acct
Property Length
DIMLIST 20
ELIMACC 20
IC_MATCH 20
VARIATION 20
O_Acct
Property Length
IS_Input 2
Entity
Property Length
Elim 10
FX_Type 20
IntCo 20
Owner 255
C_DataSrc
Property Length
COPYOPENING 2
DATASRC_TYPE 2
IS_CONSOL 2
IS_CONVERTED 2
OPENING_DATASRC 20
Groups
Property Length
CURRENCY_TYPE 2
DATASRC_LEVEL 10
ENTITY 20
GROUP_CURRENCY 20
PARENT_GROUP 20
STORE_ENTITY 20
STORE_GROUP_CURR 10
Flow
Property Length
DIMLIST 20
FLOW_TYPE 10
IS_INPUT 2
Time
Property Length
MonthNum 3
Updating Dimension Members and Property Values
Update the dimension members and property values to meet your business needs. To maintain the dimension members, see Maintenance of Dimension Members.
NOTE
If the dimension is created as a time-dependant dimension, you cannot delete a hierarchy assigned dimension member out of the timestamp after it has been created.**
In the NetWeaver version of the system, the dimension member values are case sensitive. This means that if two members have the same name but one is in upper case and one in lower case, they are recognized as two different members. For example, the R_ACCT dimensions AVG and Avg could be two different members to store the AVG exchange rate. However, for a rate or ownership application, we
strongly recommend that you do not define members this way. It could cause confusion in the script logic or consolidation engine, as well as for users.
Dimension Management
A dimension consists of members. If the members of a dimension are arranged in a hierarchical order, the relationship between members is described with terms such as Parent, Child, and Sibling.
Managing dimensions involves tasks such as creating new dimensions, defining members, and assigning properties. You manage dimensions in an application set using the dimension library. The dimensions in an application set's dimension library can be added to one or more applications in the application set.
FeaturesYou can manage dimensions in the following ways:
Creating dimensions
You add dimensions to the dimension library of an application set to make them available to your applications. You can create a new dimension or copy an existing dimension.
You can create a new dimension by clicking Add a new dimension from the Dimensions Tasks action pane, then entering the required data. Dimension names are not case sensitive and display in the case you typed; dimension names must be unique regardless of case.
Specifying reference dimensions
When adding a new dimension, you can specify a reference dimension to validate a property of your dimension with the dimension member IDs of a different dimension. When you process the dimension, Planning and Consolidation checks the values of the reference dimension property (see Dimension Processing). Validation does not complete if they do not pass validation. The following table shows the dimension validation rules:
Dimension Type Reference Type Property Name Reference Attribute Name
A — ACCOUNT A — ACCOUNT RATETYPE ID
C — CATEGORY T — TIME YEAR YEAR
E — ENTITY R — CURRENCY CURRENCY ID
I — INTERCOMPANY E — ENTITY ENTITY ID
Copying dimensions
You can copy an existing dimension within the dimension library of an application set by selecting a dimension and choosing Copy a dimension from the Dimension tasks action pane. You then select an existing dimension, enter a new name and description, then modify its members or properties if needed.
Naming conventions
You can use any name you want for a dimension as long as you follow these guidelines:
When defining or importing dimensions or other metadata such as applications, members, or security profiles in the NetWeaver BW table, do not use special characters such as accented characters or Cyrillic fonts in IDs.
Create dimension names with a maximum of 16 characters and without single quotation marks ('), double quotation marks ("), back slashes (\), or ampersands (&). Dimension IDs cannot contain a dash (-), but can support an underscore (_).
Do not use the following names: App, AppAccess, AvlObject, CategoryAccess, CollabDoc, CollabIcons, CollabRecipient, CollabSupport, CollabType, DBVERSION, Defaults, DesktopStyleDef,Dimension, DrillDef, DTIParam, Function, Formula, Group, InvestParam, MemberAccess, MessageLog, Packages, PageDef, Permission, PublishedBooks, Rate, ReportParam, SectionDef,Status, StatusCode, TaskAccess, User, UserGroup, UserPackages, UserPovDef, WebContents, SOURCE, SIGNEDDATA
Create dimension descriptions with a maximum of 50 characters and without double quotation marks (").
You have the ability to control the length of the user-defined properties to meet your needs. For information about changing the length of a property, see Member Behavior using Dimension Properties.
You can add new properties to a dimension through Maintain dimension property, if needed.
Deleting dimensions
You can delete dimensions from an application set by choosing Dimension Library from the Admin Console, then choosing Delete dimension from the Manage Dimensions action pane. Select one or more dimensions, then choose Delete Selected Dimensions. You cannot delete a dimension when it is being used by an application.
Dimension Processing
When you create a dimension or make changes to an existing dimension, you need to manually process the dimensions.
Features When you process a new dimension, its properties are defined in the database. Processing an existing dimension stores any changes made to a dimension in the database. When using the Microsoft version of the system, you can use Validate formula only to validate
dimension formulas without processing the dimension. You can quickly validate any formulas in the dimension before sending them to the system.
Schedule the processing of dimensions using a master Data Manager package (see Scheduling Dimension Member Processing).
When using the Microsoft version of the system, you can use Show deleted members to have a list of deleted members appear before processing.
ActivitiesTo process dimensions:
1. Go to the dimension library in the Admin Console.2. Select Process Dimensions in the Manage Dimensions action pane.3. Choose desired processing options and dimensions.
Scheduling Dimension Member Processing
PrerequisitesThe dimension is validated using Administration.
If you have an existing application set, copy this package from the most recent version of ApShell to get the appropriate updates.
Procedure1. Add the ADMINTASK_MAKEDIM package.2. Run the package. See Running a Package.3. Ensure that the correct dimension name is in the Input Dimension name field. Leave the Input
Source table name field blank. Choose Next.4. In the Schedule the processing of dimension members field, choose Yes, and choose Finish.5. Enter data as required.6. Enter the following package property. See Package Properties.
TASK(Admin_Makedim,BSCHEDULEPROCESS,%ScheduleProcess%)
Ensure that the value of %ScheduleProcess% is 1 (Yes).
Member Behavior Using Dimension Properties
Dimension properties are attributes that are assigned to dimensions. Many of the attributes are generic, such as ID and EvDescription, while others can be unique to a dimension, such as Scale. These categories define the behavior of members within the dimension.
FeaturesYou can use the following features when working with dimensions:
Default dimension properties
Based on their assigned type, dimensions are assigned default properties, some of which are required. You can add more properties to further customize your dimension members.
NOTE
The SOLVE_ORDER property defines the order in which the system solves calculated members when they intersect with other calculated members. SOLVE_ORDER determines the order in which the system evaluates and calculates dimensions, members, calculated members, custom rollups, and calculated cells. The system evaluates the member with the highest solve order first, and calculates it last. Zero is the highest priority.
Guidelines for implementing SOLVE_ORDER:
Specify up to 3 measures and 5 members within a SOLVE_ORDER property. Specify dimensions by dimension name, making sure that capitalization is correct.
EXAMPLE[ACCOUNT].[Account1] / [ACCOUNT].[Account2]
[PRODUCT].[Product1] + [PRODUCT].[Product2]
The only exception to this rule is that you do not need to specify an Account dimension by name.
Adding properties to dimensions
By assigning properties to dimensions, you can implement powerful features in your reporting, member lookup, formulas, Data Manager selections, and so on. You can filter on properties in many places in the system. For example, if you want to be able to easily select entities by geographic region, you simply add a Region property and enter a region value for each entity. Then you can filter and sort by region, apply account logic by region, or define a report format based on region.
The system requires various properties depending on the dimension. You can also assign additional properties for your business needs.
You can add properties to a dimension by selecting a dimension within the dimension library and adding a property ID at the bottom of the property list. Property names appear as column headings on the Member Sheet for a dimension. When you save the dimension after new properties have been added, columns are added to the Member Sheet for the new properties. The system does not permit you to keep columns on a member sheet that are not related to properties.
NOTE
If you reorder the columns in the dimension sheet, the system does not maintain the new order when you close the sheet.
Maintaining dimension properties
You maintain dimension properties by adding new properties to a dimension. After you add a property to a dimension, you can assign property values to members in the dimension. To add dimension properties, select a dimension within the dimension library and enter the name of the property and the maximum alphanumeric size of the property values.
There is no limit to the length of dimension attributes you create. To reduce the length of an existing dimension attribute, create a new property, copy the values over from the old property, then delete the old property.
You can also delete dimension properties as long as they are not required. To delete a dimension property, select a dimension within the dimension library, delete the text from the Property Name column, then select Modify Dimension Property from the action pane.
Dimension formulas
The optional property FORMULA allows you to define calculations to perform for dimensions. This powerful feature of the system gives you the ability to customize data management to meet your business requirements. For information about implementing formulas, see Dimension Logic.
More InformationRequired Properties for Account Dimensions
Required Properties for Category Dimensions
Required Properties for Currency Dimensions
Required Properties for Entity Dimensions
Required Properties for Intercompany Dimensions
Required Properties for Time Dimensions
Required Properties for User-Defined Dimensions
Required Properties for Datasrc Dimensions
Required Properties for Subtables Dimensions
Dimension Logic
Dimension logic, which is also known as member formulas, allows you to create and execute formulas and calculations on dimension members.
FeaturesUse the following guidelines when implementing formulas:
The system calculates dimension formulas at retrieval time. Formulas can slow retrieval performance if you use them incorrectly.
Implement dimension formulas only for members that need calculating after aggregations, such as ratios. Do not use formulas on members that need to aggregate.
Use dimension formulas only for ratios that need to be calculated at both the base and parent level. If the resulting value is aggregated to the parent, use script logic to write the results to the database.
Defining dimension logic
To use dimension logic, you must add the property FORMULA to a dimension by choosing Maintain dimension property. FORMULA then appears as a column in the dimension member sheet, which is where you define the calculation you need Planning and Consolidation to execute.
NOTE
The dimension property SOLVE_ORDER is required when you use the property FORMULA; the system automatically adds the property SOLVE_ORDER (see Member Behavior Using Dimension Properties.
You cannot reference MDX functions, also known as user-defined functions, from a library file.
For information about restrictions pertaining to dimension logic, see SAP Note 1356081.
Required Properties for Account Dimensions
The account dimension defines the chart of accounts for your application, and how those accounts are calculated and aggregated. Any dimension that is assigned the type A is considered an account dimension. Each application can have only one account-type dimension.
FeaturesAn account dimension has the following required properties:
Property Name Description
ACCTYPE Account type. Can be INC for Income, EXP for Expense, AST for Asset, LEQ for Liabilities and Equity
EVDESCRIPTION
A user-defined description for the member. Can be up to 50 characters and does not need to be unique. It cannot contain double quotation marks ("). This description appears in the language specified in My Settings within Interface for the Web (see My Settings). For information about loading a list of languages into the system, see Data Management for the NetWeaver platform or Data Management for the Microsoft platform.
RATETYPE Used by the currency conversion business rules. Value is optional.
SCALING Scaling options are Y or N. Used by EvDRE, EvGTS, and Live Reporting. Value is optional, but if a value is not defined, scaling is unavailable for the associated member ID.
More InformationMember Behavior Using Dimension Properties
Business Rules Management for the Microsoft platform or Business Rules Management for SAP NetWeaver
My Settings
You can select the language in which you view user interface text in Interface for the Web and member descriptions in your reports and input schedules in Interface for Office.
PrerequisitesTo see messages and text in a specific language, the administrator has applied the language pack on the server.
To see member descriptions in a specific language, the administrator has loaded the member descriptions in that language using Data Manager.
ActivitiesTo change the language, start Interface for the Web, select My Settings from the action pane, and select the desired language.
Data Management
The Data Manager is a Planning and Consolidation module that helps you move data in to Planning and Consolidation, as well as copy or move data within and across applications. The Data Manager supports mapping and complex transformations of data.
IntegrationYou can use Microsoft SQL Business Intelligence Development Studio or the Data Manager user interface to manage your packages. If using Microsoft SQL, we recommend that you have advanced knowledge with working in Microsoft SQL Server Integration Services (SSIS).
FeaturesStarting Data Manager
The Data Manager is integrated with Planning and Consolidation for Excel. To start the Data Manager, start Interface for Excel, then choose Manage Data from the Getting Started action pane.
Data Manager Packages
A package is a set of specific tasks that define the work to be done. These tasks are based on information you provide either by entering information in Data Manager package prompts or by modifying the package directly through Microsoft SQL Server. Planning and Consolidation is delivered with a set of standard packages that you can use as they are, or modify (see Standard Packages). The example packages provided need to be added to Data Manager from your file system (see Example Packages).
Transforming Data
Data Manager performs data transformations and mapping using transformation and conversion files (see Data Transformations).
More InformationAdding and Modifying Packages
Interface for Office
Example Packages
In addition to the standard packages provided with the Data Manager, Planning and Consolidation provides several additional sample Microsoft SSISpackages that you can add to Data Manager.
You need to modify some of the packages before they can be used. You can use all other sample packages as provided, or you can modify them to suit your needs. The following tables describe the sample packages.
They can be found on the Planning and Consolidation file server in the \\DataManager\PackageFiles\Examples folder of the associated application set and application.
Features
Package Description
Admin_Makedim Creates dimension members using a SQL table and schedules the processing of dimension members. For example, if a new member ID is added, this process updates the fac2 table with the updated list.
Admin_Optimize Optimizes applications with lite, incremental, or full option.
AdminTask_LogicValidation Validates the logic file.
AdminTask_Process Processes the application with incremental or full option.
Append Appends an ASCII file into the current application.
AuditBackup Backs up audit data.
AuditClear Clears audit data.
AuditPurge Purges audit data.
AuditRestore Restores audit data.
ClearComment Clears comments from the comments table.
Clear from Fact Table Removes the data from the Fact and FAC2 tables. The optimize process synchronizes the Fact and FAC2 tables with the cube. Running this package also clears comments from the comments table.
Clear the Journal Tables Clears the Journals table and creates an output file.
Copy Application Copies the application database.
Copy from Fact Table Copies the Fact table.
Export the Journal tables Exports the Journals table to an output file.
Import Access into Fact Table
Imports the Microsoft Access database into the Fact table. You can use the import.xls transformation file with this package.
Import Access Imports the Microsoft Access database into the Fac2 table. You can use the import.xls transformation file with this package.
Import Access2007 Imports the MS Access 2007 database into the fac2 table.
Import Category by Time into Fact Table
Imports Category by Time data into the fact table. You can use the Category_By_Time.xls transformation file with this package.
Import Category by Time Imports Category by Time data into the Fac2 table. You can use the Category_By_Time.xls transformation file with this package.
Import Dimension Available for the purposes of backward compatibility.
Import Excel2007 into Fact Table
Imports contents of a Microsoft Excel file into the fact table. You can use the import.xls transformation file with this package.
Import Excel2007 Imports the contents of a Microsoft Excel 2007 file into the Fac2 table. You can use the import.xls transformation file with this package.
Import SQL into Fact Table Imports a Microsoft SQL Server database into the Fact table.
When running this package, you are prompted for the SQL database and table to import.
Import SQL Imports a Microsoft SQL Server database into the Fac2 table. You can use the import.xls transformation file with this package.
When running this package, you are prompted for the SQL database to import.
ImportUsingFTP Allows you to import an ASCII file to download from an FTP site into the current application. You can use Microsoft SQL to modify the server name in the package. After you modify the server name, you can run this sample package at any time.
ImportAndSendmail Imports an ASCII file and sends the result to specific user.
Move from Fact Table Moves data from the fact table.
OwnershipCalculation Performs calculations typical of a statutory consolidation application. It is located in the Rate application in Apshell.
Restore the Journal table Restores Journals tables from an output file.
Scenario Modeling Allows you to use scenario modeling for forecasting purposes. This package calls a logic file, which is designed for your specific needs.
More InformationAdding and Modifying Packages
Adding and Modifying Packages
After creating a package in SQL Server Business Intelligence Development Studio, you must add it to the Data Manager.
You can also take that package and modify it within Data Manager. You can modify packages through SSIS (as described below) or you can modify packages using custom tasks using the MODIFYSCRIPT package variable. The MODIFYSCRIPT package variable allows you to set up predefined answers to package prompts so that you can automate running packages. See MODIFYSCRIPT Package Variable Task Usage.
PrerequisitesYou have created a package using SQL Server Business Intelligence Development Studio, and you have appropriate task security to add or modify packages. See the Planning and Consolidation Security Guide for more information.
ProcedureTo add a package to Data Manager:
1. Choose eData Organize Package List 2. Select a team and package group and click Add Package.3. Enter data as required. See Package Properties.4. Save your changes.
To modify a package:
1. From the application server, start Microsoft SQL Server Business Intelligence Developer Studio.2. In the context menu of the Microsoft SSIS folder, click Open Package.3. In the target application set and application, choose \\DataManager\PackageFiles\
Examples\.4. Select a sample package.5. In the Select Package dialog box, select the package you want to modify and click OK.6. Open the task to modify and view its properties. See Custom Tasks.
Interface for Office
The Interface for Office client includes interfaces for Microsoft Excel, Word, and PowerPoint.
These interfaces leverage your familiarity with the Microsoft Office applications of Excel, Word, and PowerPoint, enabling you to collect, analyze, and store financial data and efficiently distribute enterprise performance management reports.
The Interface for Excel is the primary interface you use, complemented by features of the Interface for Word and Interface for PowerPoint.
FeaturesWith Interface for Office, you can perform the following tasks:
Utilize the powerful and flexible formulas and functions within reports and input schedules to retrieve, display, and submit data for a real-time view of the financial position of your organization.
Use predefined report and input schedule templates that you can customize to meet your specific business requirements.
Instantly change the information you see in a report or the entities, accounts, time period, and so on, of input data simply by changing your current view.
Display accurate, live data from the database within Microsoft Excel worksheets, Microsoft Word documents, and Microsoft PowerPoint slides.
Analyze data in reports, perform data entry in input schedules, and distribute information based on user access rights when you are completely offline from the system.
Submit budgets with a wide range of supporting attachments in the form of spreadsheets, documents, and presentations.
Create hypothetical scenarios of future outcomes using powerful modeling functions. Post journal entries to carefully track changes to your data. Schedule and run Data Manager packages for loading, transforming, and manipulating financial
data.
ActivitiesTo start one of the interfaces, select one of them from the launch page, or from another module (such as Interface for the Web or Administration), expandAvailable Interfaces in the action pane and make your selection.
NOTE
If you see a prompt to update files, select Yes.
More InformationReports and Input Schedules
Interface for Word and PowerPoint
Journals
Data Management for the NetWeaver platform or Data Management for the Microsoft platform
Interface for Word and PowerPoint
You use this function to send and retrieve data, and enter and view comments in your documents and slide shows.
FeaturesWith the interfaces for Word and PowerPoint, you can perform many tasks on the data contained in your documents.
Feature Description
Insert data Allows you to insert a value from the database based on the current view. Clicking this link inserts a placeholder. You must select Retrieve all data to retrieve the value.
You can insert or view comments in Word or PowerPoint.
Insert Insight KPI (for the Microsoft version only)
Once defined in Insight, KPIs, can be added to your documents and slides. When you are connected to a Planning and Consolidation server, the KPI is updated based on the current date.
Choose Retrieve all data from the action pane to refresh all the KPI values in the Word document or PowerPoint slide.
Insert Interface for Excel object
You can insert a report or input schedule into a Word document or PowerPoint slide. The report or input schedule you want to embed must be saved on the server.
You can insert an object from the Getting Started action pane, then select Insert Interface for Excel object.
If you insert an input schedule, you can enter data and use the Send data values link to submit it to the database.
If you insert a report, you can use the Expand All and Retrieve all data links to refresh data.
NOTE
The system refreshes only embedded objects based on the current view. The individual objects are static at the time of the insert.
Feature Description
Insert Dashboard Allows you to embed an Xcelsius SWF file into a Word document or PowerPoint presentation. The Xcelsius document is based on the current view. If you change the current view, the Xcelsius document is updated. If you embed an Xcelsius document in any other way through a Word or PowerPoint function, it is not based on the current view.
Toggle Edit Mode (Word only)
Allows you to resize an Xcelsius SWF file frame once it has been inserted into a Word document.
Add New/View Comment
You can add a comment to the document or slide, or view associated comments. See Comments.
Retrieve all data Allows you to retrieve data values from the database based on the current view. Clicking this link refreshes data values in the entire document or slide show.
Expand all Allows you to expand functions contained in embedded objects.
Send all data After at least one data value has been inserted in your document or slide show, you can use this link to send the values to the database. If there are multiple inserted data values, this command sends all of them to the database.
Insert a base member and then enter a value over that object before sending the value.
Open/Save Dynamic Documents
You can open and save Word documents to the server.
Open/Save Dynamic Presentations
You can open and save PowerPoint presentations to the server.
ActivitiesTo start Interface for Word, select Interface for Word from the Launch page, or from the Available Interfaces drop down list in the action pane.
To start the Interface for PowerPoint, select Interface for PowerPoint from the Launch page, or from the Available Interfaces drop-down list in the action pane.
Comments
Comments provide a vehicle for submitting, storing, and retrieving text commentary associated with Planning and Consolidation data cells. This allows users to annotate data so other users can view supporting information associated with a particular data point.
IntegrationThe Comments function is fully integrated in Interface for Excel, Interface for Word, Interface for PowerPoint, and Interface for the Web. Therefore, you can enter and view comments from within any interface that manages data.
FeaturesYou can use comments in the following ways:
You send/retrieve a comment using the action pane. You can see comments on a series of data such as a specific report or Content Library document
that is not driven by the current view. You can retrieve a comment for a specific cell in Interface for Excel, but not in Interface for the Web
live reports. You can use functions to retrieve comments based on a fully specified or partially qualified current
view. See EvCGP and EvCGT.
Adding Comments
You can add comments using the EvCOM function or through the action pane. The Add comment link is available on any action pane from which the context of the page allows you to enter a comment. In the Microsoft version, you can set the comment length using the COMMENT_MAX_LENGTH parameter. The maximum length is 4,000 characters. For more information, see Application Parameters.
NOTE
If you use EvCOM, you must pass along all the dimension members and application with the text within the formula syntax.
When adding a comment, you may specify the following items:
Item Description
Context Select how to apply the comment:
The published page (Interface for the Web)
This option is available when a published report or input schedule is active. The comment becomes associated with the active report or input schedule.
The active report or schedule cell (Interface for Excel)
This option is available when a live report or schedule is active. The comment is applied to the data region associated with the selected cell.
The selected Planning and Consolidation data (Interface for Word/Powerpoint)
This option is available when you select Insert data object.
The active current view
This option applies the comment to the current view shown in the action pane.
Custom current view
This option allows you to specify a specific current view to which to associate the comment. From the Comment for These CV Values table, select the application. For each dimension, select the check box next to the dimensions for which you want a specific member or all members to apply. Leaving a check box unselected ignores the members for that dimension for this comment. To select a member using the Member Lookup, click a dimension link. See Member Lookup.
Priority Select the desired priority level or No Priority. The reports show comments in order of their priority level.
Keywords
Use keywords to organize and search for comments in the database. This field takes blanks and empty strings.
Viewing Comments
If you have a live report or input schedule open, you can view any comments that are associated with it. You can also view comments associated to the current view of a selected cell within that report or input schedule, or view any comments for a specific current view. To view relevant comments, you must answer some questions so the system can filter the database.
Item Description
Context Select how to apply the comment:
The published page (Interface for the Web)
This option is available when a published report or input schedule is active. The comment becomes associated with the active report or input schedule.
The active report or schedule cell (Interface for Excel)
This option is available when a live report or schedule is active. The comment is applied to the data region associated with the selected cell.
The selected Planning and Consolidation data (Interface for Word/Powerpoint)
This option is available when you select Insert data object.
The active current view
This option applies the comment to the current view shown in the action pane.
Custom current view
This option allows you to specify a specific current view to which to associate the comment. From the Comment for These CV Values table, select the application. For each dimension, select the check box next to the dimensions for which you want a specific member or all members to apply. Leaving a check box unselected ignores the members for that dimension for this comment. To select a member using the Member Lookup, click a dimension link. See Member Lookup.
Comment History
You select the checkbox to show multiple comments for the specified search criteria. Leave the checkbox blank to return only the most recent comment that meets the criteria.
Priority You select one or more priority options to return comments associated with that priority.
Keywords You can enter a keyword (up to 50 characters) to return only comments with a matching keyword.
Comments from what origin
You can select one of the following:
Comments from anyone. This option returns comments entered by all users. Comments from myself. This option returns comments that were entered by you. Comments from another user. This option returns comments entered by a specific
user. Enter a valid user in the User edit box.
Comments by date range
You can select the Search by date range check box to specify a date range for which to return comments. Use the From and To drop-down lists to specify the desired date range.
Clearing Comments
You can delete comments from the comment history, except for the last comment entered, using the CLR_COMMENTS_HISTORY application set parameter. For more information see Application Set Parameters.
You can also delete or remove comments with conditions through the ClearComment package in Data Manager.
Comments Summary Page
When you add a comment or choose your view options, you can display them on the Comments Summary page. If other comments exist for the same data region, those also appear in the summary
page. If associated data regions contain comments, those data regions also appear in the page. If you define view options, all associated comments are displayed.
To change views, you can do one or more of the following:
To change what displays in the Data Region with Comments table, choose the Display Criteria hyperlink at the top of the page. See Viewing Comments, above.
To delete a comment, select the check box next to the comment in the Comments for the selected data region table, then choose Delete selected comments from the action pane. Only the owner of the comment or a user with administrative rights can delete a comment.
Comments Summary Table
Item Description
Comment Displays the entire comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the cell. When you finish modifying the text, choose Update Comment.
Priority Displays the priority for the comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the cell by selecting another option from the drop-down list.
Keyword Displays the keyword associated with the comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the field.
Originator Displays the comment originator’s name. The value in this cell is display only.
Date Displays the date that the comment was saved to the database. If the comment is updated by the originator or an administrator, the updated date appears in this cell. The value in this cell is display only.
Show (drop-down list)
Allows you to specify the comment blocks to display in the table.
ActivitiesAdding Comments
To add a comment, open the report or input schedule and select the cell in which you want to add a comment. From the Report State action pane, select the Add a new comment link. Specify the requested information, then enter the comment (up to 265 characters).
Viewing Comments
To view a comment, from a live report/input schedule or a selected cell in a report/input schedule, select View comments from the action pane. Specify the requested information to view the Comments Summary page.
More InformationEvCOM
Required Properties for Category Dimensions
The category dimension defines the groupings in which you store information in your application. Typical categories would be Budget, Actual, Forecast, and so on. Any dimension that is assigned the type C is a category dimension. Each application can have only one category-type dimension.
FeaturesA category dimension has the following required properties:
Property Name Description
EVDESCRIPTION
A user-defined description for the member. Can be up to 50 characters and does not need to be unique. It cannot contain double quotation marks ("). This description appears in the language specified in My Settings within Interface for the Web (see My Settings). For information about loading a list of languages into the system, see Data Management for the NetWeaver platform or Data Management for the Microsoft platform..
YEAR Used to assign a YEAR to the category, to be used with the EVGET and EVTIM functions in reporting. For more information, see Reports and Input Schedules.
More InformationMember Behavior Using Dimension Properties
Business Rules Management for the Microsoft platform or Business Rules Management for SAP NetWeaver
Reports and Input Schedules
Reports
With Planning and Consolidation reporting, you can retrieve requested data from the database into an Excel interface. You can analyze your multidimensional data using the current view, which is available on the action pane. The system provides a variety of report templates to which you can add common formulas to design your own reports.
Input Schedules
Input schedules allow you to send data directly from your spreadsheet to the databases. Input schedules contain all of the same formatting and functionality as reports. The difference is that reports are used for analysis purposes, and input schedules are used for writing data to the database. Data can be written to base-level members to which you have write access.
In addition to the common features of reports and input schedules, here are some unique features of input schedules:
Modeling Options
You can use the provided modeling options (spread, trend, and weight). See Data Modeling.
Submitting Data
If you have the proper authority, you can send data to the database. There are several submission options available. See Data Submission.
Upon sending data to the database, if the work status or data submission validation is enabled by your administrator, the system checks to make sure there are no work status locks or validity issues, respectively, on the member intersections. A validity check includes making sure that the members are valid, the periodicity is correct, and the member type is correct (for example, the member is not a calculated member). A concurrency check is always performed by the system for data submissions. See Data Submission.
Changing the Work Status Code
After submitting data, you can change the work status code to enforce data locks on authorized data points. See Work Status.
Distribution and Collection
You can use the distribution feature to distribute a set of input schedules to users, then use the collection feature to get the input schedules back. SeeDistribute and Collect Offline Data.
Using Special Formatting
If you want to apply special formatting to read-only cells, cells that are ready for input, or changed cells, you can use the FormatRange option in EvDRE. For example, for calculated cells, you can set the USE formatting option to LOCK (then lock those cells through native Excel), to prevent the user from changing calculated cells. See Format Ranges.
More InformationCreating Reports and Input Schedules
Common Report and Input Schedule Features
Dynamic Report and Input Schedule Templates
EvDRE Builder
Drag and Drop Reporting
Live Reporting
Data Submission
Distribute and Collect Offline Data
This feature allows you to distribute reports and input schedules to multiple recipients, based on a predefined distribution list. You can then collect multiple input schedules from users.
PrerequisitesYou have task security rights to distribute and collect data.
FeaturesNote the following features when you distribute and collect input schedules:
Reports or input schedules are locked (parked). You can collect changes to offline input schedules and send the data to a database. Reports and input schedules are distributed through e-mail or a designated network folder.
ActivitiesDistributing offline reports involves the following steps (with an optional step to collect modified input schedules):
1. Create a distribution list that defines the scope (current view) of the data for one or more users. See Create Distribution Lists.
2. Use the Distribution Wizard to distribute offline reports or input schedules through e-mail or a network folder. The system creates reports for each user and for each current view described by the distribution report. SeeDistribute Reports and Input Schedules.
3. (Optional) If you distribute input schedules, users can enter data offline, and then e-mail the reports back to you or save them in a designated directory. You can then use the Distribution Wizard to collect the data from the modified reports and send it to the database. See Collect Input Schedules.
Create Distribution Lists
You create a distribution list that defines the current view settings for different users. This allows you to distribute the same report or input schedules to a group of users, showing only information relevant to them.
Features You can e-mail reports and input schedules to users, or place them in a designated folder.
Users can modify offline input schedules and e-mail them back to you using the same distribution list.
After creating one or more report or input schedules, you can create a new distribution list, or use the a Distribution List template as a guide. The template is located in\Webfolders\ApShell\Planning\eExcel\PDBooks\Distribtution Template.xlt.
The Distribution list template contains the following fields:
Field Description
BOOK The title of your distribution list.
SECTION Denotes the beginning of a section of the distribution list. You can have multiple sections in your distribution list.
Each section must include REPNAME, FIXKEY and VARYKEYS, defined below. The Distribution Wizard allows you to select the sections you want to publish within a book.
See Distribute Reports and Input Schedules.
REPNAME The file path to the report template being used to create the reports. You can also add a title for the report in the cell immediately following the path. You must set a password before you distribute report or input schedule templates. See Workbook Options.
FIXKEY Used to set a dimension value for all reports in the distribution (for example, TIME - 2008.JAN).
FixKey also supports the use of dimension members from another application within the application set.
To specify a dimension member from another application, use the following syntax: APPLICATION:DIMENSIONNAME.
VARYKEYS The list of dimensions and user IDs for which the distribution is created. Enter the dimensions and the user IDs in columns. The system creates reports for each intersection of dimensions and users that have access to the data.
To include all the children of a parent use the following syntax: %All%. For example, SalesUS.%ALL% creates reports for Sales US and all its children.
To include the base member of a parent, use the following syntax: %BAS%. For example, WorldWide1.%BAS% returns the base members of WorldWide1.
To include the immediate descendants of a parent use the following syntax: %DEP%. For example, WorldWide1.%DEP% returns the children of WorldWide1.
To use the CurrentView for a dimension instead of specifying a view use the following syntax: %CUR%.
SECTIONEND
Denotes the end of a distribution section.
NOTE
Any dimension not specified in the distribution template has its value (member) taken from the current view.
ActivitiesTo create a distribution list, take the following steps:
1. From Interface for Excel, select ePublish Manage distribution list New .
2. Edit the distribution list, as described in the table above. Make sure to protect any specified reports or input schedule template(s) with a workbook password. See Workbook Options.
3. When you are satisfied with the distribution list, select ePublish Manage distribution list Validate . Validating checks the template for workbook protection, and errors in syntax, structure, and provided information.
4. Select ePublish Manage distribution list Save .
Distribute Reports and Input Schedules
After you create a distribution list, you send report or input schedule templates to users defined in the distribution list. You use the Distribution Wizard to distribute reports and input schedules using a predefined distribution list.
Features You can use the Distribution Wizard to distribute the templates to a folder or through e-mail. The Offline Distribution Wizard also generates the reports or input schedules before distributing
them.
ActivitiesTo use the Offline Distribution Wizard, take the following steps:
1. From Interface for Excel, select ePublish Offline Distribution Wizard . Select Distribution, then do one of the following:
Select Lockdown and Send mail. Select Lockdown and Save to folder.
2. Choose Distribute Now.3. In the Select Distribution List dialog box, select the distribution list you want to use. See Create
Distribution Lists.4. If you chose to distribute into a folder, specify the folder. If you chose to distribute by e-mail, enter
your e-mail address.5. Choose Next to generate the reports or input schedules, and then send the e-mail or save the
reports to the designated folder.
6. Required Properties for Entity Dimensions 7. 8. The entity dimension defines the organizational structure of the business units for your application
and how the units aggregate. Any dimension that is assigned the type E is an entity dimension. Each application can have only one entity-type dimension.
9. Features10. An entity dimension has the following required properties:
Property Name Description
CURRENCY The currency used by the entity
Property Name Description
EVDESCRIPTION
A user-defined description for the member. Can be up to 50 characters and does not need to be unique. It cannot contain double quotation marks ("). This description appears in the language specified in My Settings within Interface for the Web (see My Settings. For information about loading a list of languages into the system, see Data Management for the NetWeaver platform or Data Management for the Microsoft platform.
11. More Information12. Member Behavior Using Dimension Properties 13. Business Rules Management for the Microsoft platform or Business Rules Management for SAP
NetWeaver
Business Rules Management
Business rules are parameter-driven functions within Planning and Consolidation applications for calculating and posting monetary amounts in support of common accounting activities, such as intercompany booking and currency translation.
FeaturesAdding Business Rules to Applications
When you create or modify an application, you can add business rules to it. You can add the following business rules:
Account Transformations Automatic Adjustments Carry-Forwards Currency Conversions Intercompany Bookings US Eliminations Validations
After adding a business rule to an application, you must customize it to meet your needs by specifying parameter values. You run the business rules by adding a stored procedure to a script logic file. For more information about adding business rules to applications, see Application Management.
Business Rule Reports
You can view and print a rule table report. You might want to save the report for historical purposes.
Editing Business Rules
You can edit the content of a business rule by choosing the business rule within an application, then selecting a header record. You can use standard Microsoft Excel functionality to perform the following actions:
Select multiple detail record rows Copy, paste, and delete detail records by row Copy or paste within a cell by right-clicking and selecting a context menu option or using CTRL +
C or CTRL + V respectively Copy rows from one header record to another
You can look up members within the cells of a detail record by choosing the Lookup button that appears when you place the cursor within that cell.
Validating Business Rules
The system automatically validates entries in the business rules tables. If it finds an invalid value, a tooltip displays the error.
You can verify the structure of a business rule after modifying it by choosing Validate dimensions and properties in the action pane. This displays a successful status or any errors encountered.
More InformationLogic Execution