Ever wondered what naming conventions should one follow while creating planning objects like Aggregation Level, Filters, variables, functions etc. during the development of a BI Integrated Planning Project? I did, when I started my first project in BI-IP. Since, because SAP doesn’t recommend any naming standards specifically for IP, I came up with the naming convention for every type of object that we have created in our project, starting from the cube till the web templates, classes and function modules.
As per wiki “A naming convention is a set of rules for choosing the character sequence to be used for identifiers which denote variables, types and functions etc. in source code and documentation” . Potential benefits that can be obtained by adopting a naming convention include the following:
- to provide additional information (i.e., metadata) about the use to which an identifier is put;
- to help formalize expectations and promote consistency within a development team;
- to enable the use of automated refactoring or search and replace tools with minimal potential for error;
- to enhance clarity in cases of potential ambiguity;
- to enhance the aesthetic and professional appearance of work product (for example, by disallowing overly long names, comical or “cute” names, or abbreviations);
- to help avoid “naming collisions” that might occur when the work product of different organizations is combined (see also: namespaces);
- to provide meaningful data to be used in project handovers which require submission of program source code and all relevant documentation and
- to provide better understanding in case of code reuse after a long interval of time.
In case of BI Integrated Planning project, advantages of following naming conventions can be:
- Easy sorting and filtering by e.g. project, planning process etc.
- Identification of filters/Variables used in queries only, used in functions only (IP)
- Supporting authorization set up etc.
Therefore, I would suggest developers to follow the below naming conventions/standards while creating your development objects in IP for better portability/flexibility and easy understanding.
When you configure security roles you can start the technical name of BW roles and analysis authorization object with Zfff_ , with Z to denote custom and fff to denote functional area.
Inside FOX you can follow the below naming conventions for the local variables, as suggested by Marc Bernard in his article Tips and Tricks for Implementing and Optimizing Formulas in SAP BI-IP :
- CHA_… for characteristics,
- KYF_… for key figure values,
- VAR_… for global BI variables,
- ATR_… for attributes,
- INT_… for integer numbers,
- DAT_… for dates,
- TIM_… for times.