Viewer Ratios and Tabs

Purpose:

This registry entry controls the appearance and organization of specific record viewers. For example, it can be used to set the proportion of the top and bottom sections, or to change tab labels or order.

Testing Your Registry Entries
The system does not verify the validity of registry entries. Be sure to test your registry entries after completing them to verify that they are functioning correctly.

Important Fields:

Id: sys-viewer-vfunction

where vfunction is replaced by the Id of the viewer you wish to adjust. Note that you may use the registry Id hierarchy discussed in Registry Viewer to control views for all or only some of your users.

 

Controlling the Top Ratio

This option allows you to control the top/bottom proportion of the screen used to display the parent versus the child tabs are displayed.

Setting Key: TopRatio Setting Value: aFraction

 Examples:

Registry Id: sys-viewer-vapjrnl   Registry Name: AP Journal

Setting Key: TopRatio Setting Value: 1/3 (1/3 of the screen for parent tabs, 2/3 for child tabs)

 

Registry Id: sys-viewer-vdsptchbrd Registry Name: Dispatch Board

Setting Key: TopRatio Setting Value: 7/10 (7/10 for parent tabs, 3/10’s for WO list/summary) (Useful for Classic Board users)

Important: New Call Ratios
See New Call Registry Option for special settings required to define the size and position of the New Call Main, Site, Equipment and Work Order panes.

Customizing Child Tabs

Warning: If you upgrade to a newer version of SAM Pro and a new tab has been added, it MUST added to any registries that specify child or parent tab overrides or the new tab will NOT appear in the viewers.

Setting Key: ChildTabs

Setting Value: TabId:newlabels pairs separated by commas (changes the order and label)

Setting Value: TabId list (changes the order, but retains the default title)

A TabId is the internal name by which a tab is identified. To find the tab id of a tab, just click on the tab. The tab’s tabid will appear in the Status Pane.

For example, these are the default tabs in the 8.0 employee viewer:

earnings,taxes,deductions,paidtimeoff,directdeposits,registry,labor,other,event

Changing the Title of a Tab
To change the title of a tab, follow the tabid with a colon and the new title. For example, to change the label of a ‘labor’ tab from ‘Recurring Wages’ to ‘Recurring Labour’, include ‘labor:Recurring Labour’ in the tabid:newlabels list.

Changing the Tab Order
The tabs will appear in the left-to-right order that they occur in the list. You many change their order on the screen by changing the order in the list.

Eliminating a Tab
If you wish to eliminate a tab, simply do not include it in the list. This should only be done if you are absolutely sure that the users at your firm will never need to enter information on this tab. You may wish to use the registry hierarchy to allow some users to access these tabs.

Example: AP Journal

The following example changes the tab order and titles, and eliminates the subcontractor tab from the AP Journal.

Registry Id: sys-viewer-vapjrnl

Contents: childtabs=general:Gen,inventory:Inventory,materialreturns:Returns

Example: AR Cash Receipts

Most users will never need to use the Other tab in AR Cash Receipts. Implementing this option restricts the child tabs to those on the list.

Id: sys-viewer-varrcptslst

Setting Key: ChildTabs Setting Value: ar

Customizing Parent Tabs

Warning: If you upgrade to a newer version of SAM Pro and a new tab has been added, it MUST added to any registries that specify child or parent tab overrides or the new tab will NOT appear in the viewers.

Setting Key: ParentTabs

Setting Value: TabId:newlabels pairs separated by commas (changes the order and label)

Setting Value: TabId list (changes the order, but retains the default title)

A TabId is the internal name by which a tab is identified. There is currently no direct way for determining a parent tab id like there is for the Children, but in most cases it the same as it is labeled....and the Case Sensitivity is as it is displayed. Contact your support representative if additional help is required. For example on the client site when it says...."QuoteDefault" the key is "QuoteDefault".

Note: Changing the Title of a Tab
To change the title of a tab, follow the tabid with a colon and the new title. For example, to change the label of a tab from ‘Main’ to ‘Primary’, include ‘Main:Primary’ in the tabid list.

Note: Changing the Tab Order

The tabs will appear in the left-to-right order that they occur in the list. You many change their order on the screen by changing the order in the list.

Note: Eliminating a Tab
If you wish to eliminate a tab, simply do not include it in the list. This should only be done if you are absolutely sure that the users at your firm will never need to enter information on this tab.

Example: Eliminating The Purchase Order’s Remit To Tab:

Id: sys-viewer-vprchseordrlst

Setting Key: ParentTabs

Setting Value: Main,Mail Address,Ship Address,Comments,Extended Desc,Status,IMH,JCH,GLH

Changing a viewer’s startup screen:

StartAt=Filter or StartAt=Form

By default, a viewer will open at the list view. This option allows the default view to be a blank record form or the record filter view (if available).