BPD (Best Practices Documentation)







BPD is a unique form that allows administrators to create documentation for each form.

There are 3 types of BPD Items:

  • Page

  • Applet

  • Tab

Also for a number of dynamic types such as Rules, Imports, Fields which are created automatically. A complete list can be found at the BPD_ITEM_TYPE table.

Documentation can be accessed via the Help icon,  in the lower-left corner of the form. Users with privileges on "ADMIN_BPDOC_ITEM" Security Group may modify the documentation.



Documentation is accessed based on Form Number. These are assigned by OneVizion Developers for every new Grid, Form or Tab (Page, Applet, TAB BPD Item Types). It is important to assign correct form numbers to prevent issues with the documentation.




BPD Editor for Current Object/Tab



The routine for setting up BDP Help for Objects and Tabs is similar. 

 

General Info Tab

 





Field

Description

Item Name

Title of BPD Item.

Form Number

Form Numbers are optional These are located in the top right corner of each form. These can be turned off/on in User settings.

Item Type

Instance (Object) the of BPD Help. (In the example above we are creating an item for Trackor Tours)

Status

Choose the status of the BPD Item.

Web URL

Use if additional help can be found online.






Description Tab

Enter a description for the BPD Help Item. 

 




Steps To Use Tab

Add steps for users to follow when populating data on the trackor.

 




Technical Description

Use this tab to add more detailed information about the process.






Attached Files

Use the add button to add an attachment. The following applet will open.

 

Select the File by clicking on the ellipsis. Enter a description of the File. Then select the File Type. The options are an Attachment or Graphic. 









Trackor Tours 

Administrators may choose to attach a Trackor Tour to the BPD Documentation.

 

Components Packages

On this tab, admins can assign/unassign configuration objects to/from a components package if you have E privilege on ADMIN_COMPONENTS_PACKAGE security group. Add button is displayed if you have A privilege on ADMIN_COMPONENTS_PACKAGE and the Delete button is displayed if you have D privilege on ADMIN_COMPONENTS_PACKAGE.