Analysis Office WorkBook Locking Mechanism

There are 2 types of locking mechanisms in Analysis Office when you open a workbook:

1. Planning lock – prevent other users to input data into the same workbook
2. WorkBook lock – prevent other users to edit the workbook

If you’re opening a workbook that contains an Input Ready Query, Both the planning lock and the Workbook lock will be set. Below is an example of opening an planning workbook.

If you’re opening a workbook that does not contain planning feature, a workbook lock will be set.

WorkBook Lock

is based on DDIC table RSAOOBJ (Analysis Office: Primary Object Table).

Lock mode: Exclusive lock (E)

Information related AO workbook is contained. With the lock entry, the user can change and save AO workbook. Without the lock entry, the user can not save the change of AO workbook.

*Note If a user would like to enter plan data without changing AO workbook, the message “The MS document <document-name> is locked by user <user-name>“ can be ignored.

Lock trigger:

• General rule: When AO workbook is opened, the lock entry for RSAOOBJ is triggered.
• Exceptional case 1: When other user has already opened, the lock entry for RSAOOBJ is NOT triggered. Then the message “The MS document <document-name> is locked by user <user-name>“ showed.
• Exceptional case 2: When User_A opened AO workbook during being used by User_B and then User_B closed AO workbook during being used by User_A,  User_A needs to close Excel and open AO workbook again to trigger the lock entry. (Close and open AO workbook can not trigger the lock entry.)

Lock release:

• General rule: When AO workbook is closed, the lock entry for RSAOOBJ is released.

Planning Lock 

is based on DDIC table RSPLS_S_LOCK (Compressed Selection for Lock Server)

Lock mode: Exclusive lock (E)

Information related Locked data area is contained.

With the lock entry, the user can enter and save plan data. Without the lock entry, the user can not enter and save plan data.

Lock trigger:

• General rule: When a user specified value (or changed to different value) for Prompts and selected “OK” button, the lock entry for RSPLS_S_LOCK is triggered.
• Exceptional case 1: When other user has already used the same cost center, the lock entry for RSPLS_S_LOCK is NOT triggered. Then the message ” Data in InfoProvider * is locked by user <user-name> “ showed.
• Exceptional case 2: When User_A selected for InfoObject A and member A1, during being input for the same cost center by User_B, User_A receive the above message and can not save plan data. User_A needs to close and open AO workbook again to trigger the lock entry. (Close Excel is not required.)

Lock release:

• General rule: When AO workbook is closed, the lock entry for RSPLS_S_LOCK is released.
• Exceptional case 1: When User_A triggered the lock entry for RSPLS_S_LOCK already and then changed to different value for Prompts that used by other user, the lock entry for RSPLS_S_LOCK is released.