Difference between revisions of "Share Types & Products"

From Vital Soft Wiki
Jump to: navigation, search
>Johno
>Johno
 
(11 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
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.
 
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.
+
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
+
 
 +
The SHXREF information is used by the Membership_Analysis and Membership_Summary documents.
  
 
== Configuration File ==
 
== Configuration File ==
Line 13: Line 14:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
| '''Column'''
+
| '''Excel Column (Note)'''
 
| '''Purpose'''
 
| '''Purpose'''
 
|-
 
|-
−
| DESC_ABRV
+
| SH_DESC_ABRV (1)
−
| The shares description abbreviation.
+
| The share's description abbreviation.
 
|-
 
|-
−
| SH_TYPE
+
| SH_ATTR_NBR (2)
−
| A text value assigning the TYPE for this share
+
| A numeric value assigning an optional attribute number to this share.
 
|-
 
|-
−
| SH_TYPE_SORT
+
| SH_PROD_NBR (2)
 +
| A numeric value assigning an optional product number to this share.
 +
|-
 +
| DESCRIPTION (3)
 +
| The description of the share.
 +
|-
 +
| SH_TYPE (4)
 +
| A text value assigning the TYPE for this share.
 +
|-
 +
| SH_TYPE_SORT (5)
 
| A numeric value assigning the sort value for this share TYPE.
 
| A numeric value assigning the sort value for this share TYPE.
 
|-
 
|-
−
| SH_PRODUCT
+
| SH_PRODUCT (6)
−
| A text value assigning the PRODUCT (within the TYPE) for this share
+
| A text value assigning the PRODUCT (within the TYPE) for this share.
 
|-
 
|-
−
| SH_PRODUCT_SORT
+
| SH_PRODUCT_SORT (7)
 
| A numeric value assigning the sort value for this share PRODUCT.
 
| A numeric value assigning the sort value for this share PRODUCT.
 
|}
 
|}
−
== Columns ==
 
  
−
'''SH_DESC_ABRV'''
+
:Notes:
−
    The Share Description Abreviation which is gathered directly from share-file
+
:# The DESC-ABRV for this share.  All shares configured on the core should be listed.
 +
:# 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.
 +
:# 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.
 +
:# The text value assigned to the TYPE must be identical for all shares assigned to that TYPE.
 +
:# 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.
 +
:# 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.
 +
:# 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.
 +
 
 +
== Assigning the Type and Product ==
 +
 
 +
* The share '''TYPE''' is assigned by entering a '''text''' value in the SH_TYPE column and a '''numeric''' sort value in the SH_TYPE_SORT column.  The text and sort values must be identical for all shares that are assigned to the '''same''' share TYPE.
 +
 
 +
* The share '''PRODUCT''' is assigned by entering a '''text''' value in the SH_PRODUCT column and a '''numeric''' sort value in the SH_PRODUCT_SORT column.  The text and sort values must be identical for all shares that are assigned to the '''same''' share TYPE/PRODUCT combination.
 +
 
 +
* The SORT numbers for TYPEs and PRODUCTs must be identical for each TYPE (and PRODUCT).  Th sorts do not need to be contiguous.
 +
 
 +
* Any shares that are not listed in the SHXREF configuration file will be assigned a TYPE of '''Unknown'''.
  
−
'''SH_ATTR_NBR'''
+
== Assigning Attribute and Product Numbers ==
−
    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'''
+
Assigning Attribute Numbers:
−
    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'''
+
* Member attributes can be assigned during the host extract jobs or when processing the SHXREF and LNXREF configuration files.  Attributes are defined in the host ATTRFILE.
−
    The description of the Share that is displayed in Vital Signs
 
  
−
'''SH_TYPE'''
+
* To assign a member attribute using the SHXREF file, enter the corresponding attribute number (see ATTRFILE) in the SH_ATTR_NBR column.  The attribute flag for the member will be set to true (Yes) if the member has at least one of the shares assigned with that attribute number.  The attribute number is used to position the attribute on the ''Member Attributes'' page.  Attributes 1-15 are shown in the first column and 16-30 appear in the second column.
−
    The Share Type is the master hierarchical grouping of Shares, example : BUSINESS
 
  
−
'''SH_TYPE_SORT'''
+
Assigning Product Numbers:
−
    The Share Type Sort is the sequential order that the Unique Share Type groups will be displayed in Vital Signs
 
  
−
'''SH_PRODUCT'''
+
* Member attributes can also be considered products, in which case they are counted.  This is not the same as the SH_PRODUCT discussed above.
−
    The Share Product Sub group of the Share Type grouping, example : SAVINGS
 
  
−
'''SH_PRODUCT_SORT'''
+
* To make the attribute a product, enter a product number in the SH_PROD_NBR column.  When assigning product numbers, it is very important that all rows with the same attribute number are also assigned the same product number.  Products are not defined in a separate file.  The product name is determined by the attribute name.  The product number is used only for screen placement.  Product numbers are limited to 1-20, the first 10 appear in the first column and the remainder appear in the second column.
−
    The Share Product Sort is the sequential order that the Unique Share Product groups will be displayed in Vital Signs
 

Latest revision as of 20:02, 30 November 2015

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 SHXREF information is used by the Membership_Analysis and Membership_Summary documents.

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.

Excel Column (Note) Purpose
SH_DESC_ABRV (1) The share's description abbreviation.
SH_ATTR_NBR (2) A numeric value assigning an optional attribute number to this share.
SH_PROD_NBR (2) A numeric value assigning an optional product number to this share.
DESCRIPTION (3) The description of the share.
SH_TYPE (4) A text value assigning the TYPE for this share.
SH_TYPE_SORT (5) A numeric value assigning the sort value for this share TYPE.
SH_PRODUCT (6) A text value assigning the PRODUCT (within the TYPE) for this share.
SH_PRODUCT_SORT (7) A numeric value assigning the sort value for this share PRODUCT.
Notes:
  1. The DESC-ABRV for this share. All shares configured on the core should be listed.
  2. 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.
  3. 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.
  4. The text value assigned to the TYPE must be identical for all shares assigned to that TYPE.
  5. 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.
  6. 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.
  7. 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.

Assigning the Type and Product

  • The share TYPE is assigned by entering a text value in the SH_TYPE column and a numeric sort value in the SH_TYPE_SORT column. The text and sort values must be identical for all shares that are assigned to the same share TYPE.
  • The share PRODUCT is assigned by entering a text value in the SH_PRODUCT column and a numeric sort value in the SH_PRODUCT_SORT column. The text and sort values must be identical for all shares that are assigned to the same share TYPE/PRODUCT combination.
  • The SORT numbers for TYPEs and PRODUCTs must be identical for each TYPE (and PRODUCT). Th sorts do not need to be contiguous.
  • Any shares that are not listed in the SHXREF configuration file will be assigned a TYPE of Unknown.

Assigning Attribute and Product Numbers

Assigning Attribute Numbers:

  • Member attributes can be assigned during the host extract jobs or when processing the SHXREF and LNXREF configuration files. Attributes are defined in the host ATTRFILE.
  • To assign a member attribute using the SHXREF file, enter the corresponding attribute number (see ATTRFILE) in the SH_ATTR_NBR column. The attribute flag for the member will be set to true (Yes) if the member has at least one of the shares assigned with that attribute number. The attribute number is used to position the attribute on the Member Attributes page. Attributes 1-15 are shown in the first column and 16-30 appear in the second column.

Assigning Product Numbers:

  • Member attributes can also be considered products, in which case they are counted. This is not the same as the SH_PRODUCT discussed above.
  • To make the attribute a product, enter a product number in the SH_PROD_NBR column. When assigning product numbers, it is very important that all rows with the same attribute number are also assigned the same product number. Products are not defined in a separate file. The product name is determined by the attribute name. The product number is used only for screen placement. Product numbers are limited to 1-20, the first 10 appear in the first column and the remainder appear in the second column.
Retrieved from "https://wiki.vital-soft.com/index.php?title=Share_Types_%26_Products&oldid=525"