{module_case}

Description

Displays customer's case history within a secure zone, so, when customer logs in he/she is identified by the system and this module displays all their previous form submissions, according to the "case list layout" in Admin -> More Customization Options. Customer can view each case and download files attached to the case.

Syntax

{module_case render="item|collection" filter="all" workflowId="123" sortType="Subject" collection="my_custom_collection_name" template="/folder/template.tpl" templateID="1551614"}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • filter - sets display criteria.
    • all - displays all items that belong to that customer
    • workflow - display all cases that have a particular workflow assigned to them. Please note that only if this filter is used is the workflowID used as a next parameter. The best way to set the ID is to use module manager.
  • sortBy - allows you to select the order in which you want to sort the items.
    • Default - default sort here is Date Created
    • Subject - sorts items according to the subject name alphabetically
  • workflowId - appears only when selecting "all items in a workflow" as a display criteria
  • collection - use this if you need to access the module's Liquid output tags
  • template - optional, for this module this can either represent the path of the custom template you want to use, or use a blank value (template="") if you need to suppress the original output and use Liquid output tags instead
  • templateID - optional, the ID of the template used to render the case details view

This module can be rendered using:

  • the list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the Case layout reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:
Liquid tag Description
{{assignedto}} Customer service representatives the case is assigned to e.g. John Smith
{{casenumber}} Case number
{{createdate}} Date and time the case was first created e.g. 25-Mar-2013 01:46 PM
{{lastupdatedate}} Date and time the last message was received e.g. 25-Mar-2013 01:46 PM)
{{ownernam}} Fullname of the owner of the case e.g. John Smith
{{description}} Description of the case
{{filelist}} List of files attached to a case (can be downloaded)
{{status}} Status of the case, possible values are: New, Open, Escalated, Closed, Re-Opened
{{subject}} Subject of the case

Examples

  • {module_case filter="all" sortType="Default"} - This module will display all the cases that belong to a particular customer and those will be sorted by date
  • {module_case filter="all" sortType="Subject"} - This module will display all the cases that belong to a particular customer and those will be sorted by subject which is the web form name if generated automatically and will be displayed alphabetically
  • {module_case filter="workflow" workflowId="25261" sortType="Default" templateId="1440381"} - This module will display all cases that have workflow 25261 assigned to them, sort them by date, and assign template id #1440381 to the detail list for each case opened from the generated list
  • {module_case filter="all" sortType="Default" template="/layouts/template.tpl"} - This module will display all the cases that belong to a particular customer and those will be sorted by date using a custom template
  • {module_case filter="a" collection="custom1" template=""} - in this case nothing will be displayed, however the case details will become available in the custom1 collection.

Syntax

{module_case,filter,workflowID,sortBy,templateId}

Parameters

  • filter - sets display criteria.
    • a - displays all items that belong to that customer
    • c - display all cases that have a particular workflow assigned to them. Please note that only if this filter is used is the workflowID used as a next parameter. The best way to set the ID is to use module manager.
  • sortBy - allows you to select the order in which you want to sort the items.
    • Default - default sort here is Date Created
    • Subject - sorts items according to the subject name alphabetically
  • workflowId - appears only when selecting "all items in a workflow" as a display criteria
  • templateId - the ID of the sitewide template used to display the case details page

Layouts

  • This module is rendered with the Detail Layout
  • This module also supports custom templates
  • User must be logged in in order for the module to render

Examples

  • {module_case,a,,Default} - This module will display all the cases that belong to a particular customer and those will be sorted by date
  • {module_case,a,,Subject} - This module will display all the cases that belong to a particular customer and those will be sorted by subject which is the web form name if generated automatically and will be displayed alphabetically
  • {module_case,c,25261,Default,1440381} - This module will display all cases that have workflow 25261 assigned to them, sort them by date, and assign template id #1440381 to the detail list for each case opened from the generated list