Content Repeaters Part 1

Linked Help

 

 

Overview 

Presenting information on web pages is simple - just type it in to an HTML atom!  But most of the content you want to display on a web page already exists in your system - perhaps a list of contacts, a library of documents, a store of images, a product detail etc.

So, whilst we provide the ability to make a web page with simple HTML content included on it, we also manage to present objects, as they exist in the XPOR system BUT only those details you want the User to see.

There are several ways of achieving this.  This Help resource focusses on the Content Repeater method (the other options being Grids, Forms and certain Atom Types).

Guidance

Content Repeaters are a type of "Widget" that are added to a Web page and then focused on one or more objects, where we can select specific fields. Content Repeaters are fast to load the selected data, though are slightly more complicated to setup. A second benefit is the control you have over how the information is presented - grids are ... grids! but HTML repeaters are fully stylable.

This Help resource is part 1 of 4.  In this help file there will be a run-through of what a content repeater is and what all of the fields mean. Part 2 contains examples of how to setup simple content repeaters and part 3 gets into more Complex Examples. Part 4 looks at using Tables and Sub Tables as the Root Source for Content Repeaters

How to Setup

Content Repeaters are added to HTML / Rich Text Atoms.  In the screenshot below we are editing an HTML atom that has been included on a web page.  Under the Advanced tab we can access the "Insert Widget" button.  This will open a drop down to display the Widget Types that can be added to the Atom.  This Help Resource is for the "Repeater" - select and submit.


When the repeater has been generated on the page there will be a box with a dashed outline and the words "Widget Placeholder" in the centre. When the repeater is clicked the edit widget button will become available and no longer greyed out. 

Repeaters will present the data from objects in the system.  Ther are two principal types of repeater;

  1. FIND OBJECTS BY TYPE
  2. FIND OBJECTS FROM A ROOT.

 

What do the Options mean?

When editing a repeater you are greeted by an editor with multiple fields. Below is a description of each field:

Repeater Type - This is where the main purpose of the repeater is set. The options that you can choose from are:

  • Children - If you want to display the children objects of a selected "Root Object" (see below), this option will achieve this.
  • Parents - If you want to display the parent objects of a selected "Root Object" (see below), this option will achieve this.
  • Single Object - Used if only the "Root Object" is needed to be displayed - a very specific selection.
  • Associated Objects - Lists out objects that are associated to the "Root Object" by a selected association type.
  • Parents Repeater -  This can only be used when you want to nest one repeater within another. For example, if you have a repeater to list all contacts in a selected group, and then add a nested sub repeater to list out all documents they have authored. The Parents Repeater will then allow you to select the Sub Repeater type (described below).
  • Associations Recursive - Lists out all objects of a selected "Object Type" that are under (children) a selected "Root Object". For example, all documents inside a folder structure.
  • Independent Table - Lists out all Records from a selected System Table.
  • Logged in User - Provides access to the Users details - if they are logged in!
  • Objects By Type - Lists all objects of a selected "Object Type".

Sub Repeater Type - This is only used for "Parents Repeater" and has 4 options. These are:

  • Children
  • Parents
  • Associated Objects
  • Subtable

Root Object - The base Object for the repeater types requiring a Root.

Parent Object - The location that new objects will be made. This is only relevant if the user that is logged in is an Administrator.

Object Type - The Object Type of the Object we want to repeat out. This is also used to list out the properties of the Object Type.

Page Size - The number of results that are displayed in a page. There is also the option to Render the top and bottom Paging bars under the Advanced Tab.

Reverse Direction - This enables Reversed associations. For more help please see the relevent association help file.

Association Type - This is where you set the association that the objects of the correct "Object Type" have to be associated to the "Root Object".

Reverse Association Type - Same as above but for Reversed associations. If "Reverse Direction" is ticked then this will be used over "Association Type".

Sub Table - The name of the Sub Table that will be listed out.

Published - If the object type being listed is "publishable" (such as Documents), then you can select to limit the objects being returned, by their published status.

Table - The name of the System Table that will be listed out.

Query String - This is used if a variable is to be used, from the web page URL, in place of the "Root Object" objectid. For example if the webpage URL is [WebpageURL]?exampleobject=123456. then the Query string would be "exampleobject", resulting in the root object being set to ObjectId = 123456. This is particularly useful if you need a page that needs to change its root, depending on the object of focus in the starting page.

What do I need for each Repeater Type?

 

Sub Repeater Type

Root Object

Parent Object

Object Type

Page Size

Reverse Direction

Association Type

Reverse Association Type

Sub Table

Published

Table

Query String

Children              
Parents               
Single Object                    
Associated Objects      
Parents Repeater    
Associations Recursive              
Independent Table                    
Logged In User                     
Objects By Type                  

For examples of how to use Content Repeaters please see the relevant help file.

 XPOR Ltd. UK Co. Registered in England No. 10409669
 02392 738000
 02392 739000