• Navigation
  • Main Page
  • Design Considerations
  • i.STAR Start-up Docs
  • Release Notes
  • Optional Features
  • Modifying i.STAR pages
  • Customizing
  • Action ID Listing
  • Feature HowTo's
  • SEO Tips
  • Recent Changes
  • Help
• Links
  • i.STAR Help Tickets
  • Project Management Login
  • Discussion Forum
• Toolbox
  • What links here
  • Related changes
  • Upload file
  • Special pages
  • Printable version
• Personal tools
  • 38.107.191.98
  • Talk for this IP
  • Admin Login

CategoryLister Data Source

From i.STAR Help

Contents 1 Input Variables 2 Output Variables 3 Variable Availability Notes

Input Variables

Name	Type	Required	Source	Description
dept	String	No	URL/Param	Code/ID of selected department.
class	String	No	URL/Param	Code/ID of selected class.
subclass	String	No	URL/Param	Code/ID of selected subclass.
manufacturer	String	No	URL/Param	Code/ID of selected manufacturer.
forceDept	Boolean	No	URL/Param	Always output $departments collection, regardless of current level in the category hierarchy.
forceClass	Boolean	No	URL/Param	Always output $classes collection, regardless of current level in the category hierarchy.
forceSubclass	Boolean	No	URL/Param	Always output $subclasses collection, regardless of current level in the category hierarchy.
deptMfgOutput	Numeric Enum: DeptMfgOutputType	No	URL/Param	Controls when you want the data source to provide department level manufacturer information.
mfgOutput	Boolean	No	URL/Param	If True (1), the data source will output site wide manufacturer data.
deptSizesOutput	Boolean	No	URL/Param	If True (1) and the "dept" parameter is provided, the data source will output the size groups/codes that are available for the selected department.
deptSubsizesOutput	Boolean	No	URL/Param	If True (1) and the "dept" parameter is provided, the data source will output the subsize groups/codes that are available for the selected department.

Output Variables

Selected Category Information

Name	Type	Description	Availability
$selectedDeptColorAlias	String	The selected department's color alias. Zero length string if no department is selected.
$selectedDeptSizeAlias	String	The selected department's size alias. Zero length string if no department is selected.
$selectedDeptSubsizeAlias	String	The selected department's subsize alias. Zero length string if no department is selected.
$selectedDeptCode	String	The selected department's code. Zero length string if no department is selected.
$selectedDeptName	String	The selected department's name. Zero length string if no department is selected.
$selectedClassCode	String	The selected class' code. Zero length string if no class is selected.
$selectedClassName	String	The selected class' name. Zero length string if no class is selected.
$selectedSubclassCode	String	The selected subclass' code. Zero length string if no subclass is selected.
$selectedSubclassName	String	The selected subclass' name. Zero length string if no subclass is selected.
$selectedMfgCode	String	The selected manufacturer's code. Zero length string if no manufacturer is selected.
$selectedMfgName	String	The selected manufacturer's name. Zero length string if no manufacturer is selected.
$selectedDeptSizes	Sizes Collection	The size groups/codes for the selected department.	1
$selectedDeptSubsizes	Subsizes Collection	The subsize groups/codes for the selected department.	2

Category Information

Name	Type	Description	Availability
$departments	Departments Collection	Data for all web departments system wide.	3
$classes	Classes Collection	Data for all web classes system wide.	4
$subclasses	Subclasses Collection	Data for all web subclasses system wide.	5
$deptManufacturers	Manufacturers Collection	Data for all manufacturers used within the selected department.	6
$manufacturers	Manufacturers Collection	Data for all manufacturers system wide.	7

Miscellaneous Information

Name	Type	Description	Availability
$supportsSizes	Boolean	Does the data source support sizes. If this is set to false then size/subsize data is not applicable to this system.

Classes Collection

Name	Type	Description	Availability
$classCode	String	Class code.
$className	String	Class name.
$classSelected	String	Is this the selected class?
$subclasses	String	Subclasses within this class	10
$classBrowseURL	String	Default URL for browsing products in this department/class .

Departments Collection

Name	Type	Description	Availability
$deptCode	String	Department code.
$deptName	String	Department name.
$deptSelected	String	Is this the selected department?
$classes	String	Classes within this department	8
$manufacturers	String	Manufacturers used within this department	9
$deptBrowseURL	String	Default URL for browsing products in this department .

Manufacturers Collection

Name	Type	Description	Availability
$mfgCode	String	Manufacturer code.
$mfgName	String	Manufacturer name.
$mfgSelected	String	Is this the selected manufacturer?
$mfgBrowseURL	String	Default URL for browsing products for this manufacturer (also will restrict based on department if applicable).

Sizes Collection

Name	Type	Description	Availability
$sizeName	String	Size name.
$sizes	String	Single size code or command delimited list of size codes if size group.

Subclasses Collection

Name	Type	Description	Availability
$subclassCode	String	Subclass code.
$subclassName	String	Subclass name.
$subclassSelected	String	Is this the selected subclass?
$subclassBrowseURL	String	Default URL for browsing products in this department/class/subclass.

Subsizes Collection

Name	Type	Description	Availability
$subsizeName	String	Size name.
$subsizes	String	Single subsize code or command delimited list of subsize codes if subsize group.

Enum: DeptMfgOutputType

Name	Type	Value	Description
None	Numeric	0	Don't output any department manufacturer information.
SelectedDeptOnly	Numeric	1	Output manufacturers existing within the selected department only.
AllDepartments	Numeric	2	Output department manufacturer information for all departments.

Variable Availability Notes

1. Available when the $deptSizeOutput input variable is set to true and $supportsSizes is true.
2. Available when the $deptSubsizeOutput input variable is set to true and $supportsSizes is true.
3. Available in the following cases:
   • No "dept" input parameter is provided.
   • The "forceDept" input parameter is set to true (1).
4. Available in the following case:
   • The "dept" input parameter is provided and the "forceDept" input parameter is set to false (0).

   NOTE: The classes are available if the "forceClass" parameter is set to true and the criteria to output the "$department" variable is met. In this case, classes are found in the $departments collection.

5. Available in the following case:
   • The "dept" and "class" input parameters are provided and the "forceDept" and "forceClass" input parameter is set to false (0).

   NOTE: The subclasses are available if the "forceSubclass" parameter is set to true and the criteria to output the "$department" and "$class" variable is met. In this case, subclasses are found in the classes collection which is accessed from the $departments collection.

6. Available when the "deptMfgOutput" input parameter is set to anything other than None (0).
7. Available when the "mfgOutput" input parameter is set to true (1).
8. Available in the following cases:
   • The current iteration of the departments collection is the selected department (the $selected variable is true (1)).
   • The "forceClass" input parameter is set to true (1).
9. Available in the following cases:
   • The current iteration of the departments collection is the selected department (the $selected variable is true (1)) AND the "deptMfgOutput" input parameter is set to anything other than None (0).
   • The "deptMfgOutput" input parameter is set to AllDepartments (2).
10. Available in the following cases:
    • The current iteration of the classes collection is the selected class (the $selected variable is true (1)).
    • The "forceSubclass" input parameter is set to true (1).