Behavior of %User.Form and %Form.Name in Versions of Metastorm BPM

                                Created: 25 Aug 2005
Last edited: 13 Nov 2007

        The information in this article applies to:

Product: Metastorm BPM (e-Work)
        Version: 6.x 7.x

Discussion

•                                 The following is adapted from the Metastorm BPM documentation.
  
  Metastorm BPM version 7.5 SR1 (7.5.1) corrects the behavior of %User.Form. Once this update is applied, %User.Form returns the form name in an action form (i.e. when the user has started an action and the action form is displayed). However, the function returns an empty value in a folder. This is the same behavior of %User.Form that existed with versions 6.x. In versions 7.0 - 7.5, %User.Form incorrectly returned the form name in both an action form and a folder.
  
                                  For users who have built procedures that rely on the incorrect behavior, a new function (%Form.Name) has been introduced.                                 If process designers wish to have access to the form name in a folder, %Form.Name should be used.                                 This returns the form name in both an action form and a folder.                                
  
                                 
•                                 The following is adapted from the Designer User Manual.                                
  
                                 

  %User.Form
           The function %User.Form returns the form name (string, read-only name of the current form) 
           when viewed in an action, refill, or submit request. For example, the form name is returned 
           where a user has started an action and the action form is displayed.
           
  
  
           This variable should be used only in the following properties:
           Form - When user loads form.
           Form - When user saves form.
           Field - Calculation formula.
           Field - List options.
           Field - When button pressed, When field changed, and When user selects row.
           Roles - When a role is used in the 'Restrict Viewing to roles' property of a form.
           
  
  
           This function returns an empty value in a folder. The function %Form.Name also returns the form
           name; however, unlike %User.Form, it does so in all situations, including in a folder.
  
  %Form.Name
           The function %Form.Name returns the form name (string, read-only name of the current form) 
           when viewed in an action, refill or submit request. For example, the form name is returned 
           where a user has started an action and the action form is displayed.
           
  
  
           This function also returns a value in a folder. 
           
  
  
           This variable should be used only in the following properties:
           Form - When user loads form.
           Form - When user saves form.
           Field - Calculation formula.
           Field - List options.
           Field - When button pressed, When field changed, and When user selects row.
           Roles - When a role is used in the 'Restrict Viewing to roles' property of a form.
           
  
  
           The function %User.Form contains similar functionality except it returns an empty value in a folder.
                                               

                                 

Keywords: kb622