Share Types & Products

From Vital Soft Wiki
Revision as of 00:23, 24 November 2015 by >Johno (Configuration File)
Jump to: navigation, search

Summary

During configuration, a two level hierarchy is created that groups all shares into SH_TYPE and SH_PRODUCT. The main purpose is to make it easy to report (and select) all shares by TYPE, and by TYPE & PRODUCT. For example, share types might be: Savings, Checking, Certificate, IRA, Business and Other. One or more PRODUCTS is defined for each TYPE. For example, the Savings type might include the products Regular, Money Market, Vacation and Other.

Each unique share DESC-ABRV is assigned a SH_TYPE and a SH_PRODUCT by creating and updating the SHXREF spreadsheet. When new shares are configured in the core this spreadsheet must also be updated to add a new entry for each new share. The share cross reference spreadsheet enables Vital Signs to group and order the products for simpler selection. The CCYYMMDD appended to the SHXREF filename should represent the most recent date that the file was modified

Configuration File

The configuration file is called SHXREFccyymmdd.xls. Where ccyymmdd is the effective date for the product assignments. Typically, ccyymmdd is the date of the initial Vital Signs configuration. The initial Vital Signs design allows for the creation of multiple SHXREF files with different effective dates, however, in practice this is never necessary and only one file should exist.

A Visimage3 context is available to initially create the SHXREF file.

Column Purpose
DESC_ABRV The share's description abbreviation.
SH_ATTR_NBR (1) A numeric value assigning an optional attribute number to this share.
SH_PROD_NBR (1) A numeric value assigning an optional product number to this share.
DESCRIPTION (2) The description of the share.
SH_TYPE (3) A text value assigning the TYPE for this share
SH_TYPE_SORT (4) A numeric value assigning the sort value for this share TYPE.
SH_PRODUCT (5) A text value assigning the PRODUCT (within the TYPE) for this share
SH_PRODUCT_SORT (6) A numeric value assigning the sort value for this share PRODUCT.
  1. The ATTR and PROD numbers are optional. When assigned, member's that have the specified share are assigned the corresponding attribute/product. The attribute number, must correspond to an attribute defined in the Vital Signs host ATTRFILE.
  2. The description listed here is not used by Vital Signs. The description is initially populated by the Visimage3 context to simplify the task of assigning TYPEs and PRODUCTs.
  3. The text value assigned to the TYPE must be identical for all shares assigned to that TYPE.
  4. The SORT value determines the order that types are displayed in charts. The sort values must be identical for all shares that are assigned the same type. Sorts do not have to be contiguous.
  5. The text value assigned to the PRODUCT must be identical for all shares assigned to that PRODUCT. The same PRODUCT name maybe assigned to shares in a different TYPE.
  6. The sort value determines the order that products are displayed in charts. The sort values must be identical for all shares that are assigned the same type and product. Sorts do not have to be contiguous.

Columns

SH_DESC_ABRV

   The Share Description Abreviation which is gathered directly from share-file

SH_ATTR_NBR

   The Share Attribute Number is not a required field. If you wish to define an Attribute based on this particular share or group of shares, then place the attribute number in this column

SH_PROD_NBR

   The Share Product Number is not a required field.  The number should be the sequential Product Name specified for the corresponding attribute in the Master Attribute file ATTRFILE on the HPUX system

DESCRIPTION

   The description of the Share that is displayed in Vital Signs

SH_TYPE

   The Share Type is the master hierarchical grouping of Shares, example : BUSINESS

SH_TYPE_SORT

   The Share Type Sort is the sequential order that the Unique Share Type groups will be displayed in Vital Signs

SH_PRODUCT

   The Share Product Sub group of the Share Type grouping, example : SAVINGS

SH_PRODUCT_SORT

   The Share Product Sort is the sequential order that the Unique Share Product groups will be displayed in Vital Signs