Write Back Implementation Example¶
This page provides an example on how to implement Write Back support.
One implementation example based on General Write Back will be provided. To find out more details about Advanced Write Back please refer to implementation in component
Step 1 - Create Table¶
First we create a new table, representing the source table for a new Information Source but also the target source for the write back.
The table stores information about two amounts that are related to company, account and accounting period. Each combination of company, account and accounting period can appear only once.
Step 2 - Create Fact View¶
Next step will be to create a fact view for online access. The view definition contains both the standard dimension identities, according to the development template and single columns for all key columns in the dimensions to enable true join.
A definition like the one for
dim_accounting_period_id would be bad for performance but is never used in the online case and is there only to fulfill the model requirements. In the Data Mart case this type of identity is used to identify the dimension.
Deploy the file in the database.
Step 3 - Create API¶
Next we will create an API that has a public method that retrieves an attribute string.
Api file: >>
Apy file: >>
Deploy the two files in the database.
Step 4 - Dictionary and Grant¶
First skip this step and jump to Step 5. If there is any problem with security then go back to this step.
Make sure that the new package is granted to the users supposed to handle write back.
- Refresh the Dictionary
- Grant the package to a user or user role/permission set.
- Module: GENLED
- Package: TEST_GEN_WB_API
- Suggested Role: IFSAPP_NORMAL
Step 5 - Metadata File¶
Now create the metadata file for the new fact:
- Define fact header where write back support is enabled and the API to call is defined. Modified write back is supported, since there is no difference between writing back all values or only a few if Advanced Write Back is used.
- Define Online data access support
- Define fact parent (
Define fact items:
- Key items
- Measure items Amounts are write back items that are optional.
- Dimension key items (according to general standard)
- True join items, e.g. the so called joiners
Define supported dimensions
- Define info about dimension identity items
- Define true join for online execution
- Define write back dimension items. Company, account and accounting period code are mandatory write back items.
- Define Zoom In details
Step 6 - Deploy Metadata File¶
Deploy Metadata file and correct all errors
Step 7 - BR Client Navigator¶
Make the new Information Source available in the BR Client Navigator. Normally this is handled during installation but since this is a new Information Source that is only deployed for test purposes, we have to enable the Information Source manually.
Step 8 - Test in IFS Business Reporter¶
Start IFS Business Reporter and define an appropriate design, e.g. sheet criteria on company (
DIM_COMPANY.CODE='10'), a design row repeated on accounts and a design column repeated on accounting period.
Make sure to define a measure cell as a write back cell and define the target item in the new data source.
Run a report, collect write back data and perform write back. Check status messages.
Run the report again to make sure that the written back data is now retrieved.
One example report is provided for download.