InterChange Widgets Reference Guide
Version 3.4 (March 2017)
Table of Contents
List of Available InterChange Widgets ................................................................................................................................ 3
AnnouncementItems Widget ............................................................................................................................................. 5
Banner Widget .................................................................................................................................................................... 7
Calendar Widget ............................................................................................................................................................... 10
CompanyCalendar Widget ................................................................................................................................................ 12
Content Block Widget ....................................................................................................................................................... 14
DocumentsSummaryList Widget ...................................................................................................................................... 17
EventDetail Widget ........................................................................................................................................................... 20
GenericItem Widget ......................................................................................................................................................... 21
GenericList Widget ........................................................................................................................................................... 23
Important Dates Widget ................................................................................................................................................... 49
My Teams Widget ............................................................................................................................................................. 52
People Directory Widget .................................................................................................................................................. 55
QuickLinks Widget ............................................................................................................................................................ 57
RSSNews Widget ............................................................................................................................................................... 59
Traffic Widget ................................................................................................................................................................... 60
Weather Widget ............................................................................................................................................................... 62
Document Management System (DMS) Control .............................................................................................................. 64
Discussion Board Control.................................................................................................................................................. 66
Adding a Widget based Control ............................................................................................................................................ 71
When do I use an OOB widget versus creating a new one? ................................................................................................. 73
Decision Tree .................................................................................................................................................................... 73
Use Case 1......................................................................................................................................................................... 74
Use Case 2......................................................................................................................................................................... 76
Use Case 3......................................................................................................................................................................... 79
Use Case 4......................................................................................................................................................................... 80
Use Case 5......................................................................................................................................................................... 82
Akumina: InterChange Widgets Reference Guide
2
List of Available InterChange Widgets
Click on the widget title or image to jump to the detail for the widget.
AnnouncementItems
Banner
Calendar
CompanyCalendar
ContentBlock
DocumentSummaryList
EventDetail
GenericItem
GenericList – NewsDetail
GenericList – Hero Item
GenericList –
DepartmentListing
GenericList – My Apps
GenericList –Department
News
GenericList –Photos List
Akumina: InterChange Widgets Reference Guide
GenericList – Photos Media GenericList – FAQ Summary
Gallery
3
GenericList – Department
News Listing
ImportantDates
MyTeams
PeopleDirectory
Quicklinks
RSSNews
Traffic
Weather
Document Management
(DMS)
Discussion Summary
Discussion – Create New
Discussion - Listing
Discussion - Thread
Akumina: InterChange Widgets Reference Guide
4
AnnouncementItems Widget
Main Features
•
•
•
•
•
•
Displays the Announcement Title, Summary text and creation date
Lists the latest items in reverse chronological order by creation date
Provides the ability to set the maximum number of items to display
Includes both start and expiration dates to automatically expose and remove content from site
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
5
AnnouncementItems Widget Properties Example Instance
PROPERTY
DETAILS
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
DISPLAYED TITLE
If a value is entered, then the title will appear on the header of the App.
ICON
Selects the icon that is displayed to the left of the widget title.
DISPLAYTEMPLATE
Value = PageTemplate for this widget
# OF ITEMS TO DISPLAY
This controls how many items to display. A value of “0” will display all items.
VIEW ALL LINK
N/A
ENABLE PAGING
Value for this type of instance = false
VIEW
View Name = NewsList
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/AnnouncementItems/Default.html
Akumina: InterChange Widgets Reference Guide
6
Banner Widget
Main Features
•
•
•
•
•
•
•
•
Supports image, title, sub-text, button text and link on a per slide basis
Control the positioning of text on the slides
Control the display of slide controls
Supports both slide and fade animation types
Unique drag/drop UI in InterChange allows for easy ordering and activation/deactivation of individual items
Dynamically adjusts to accommodate image size
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
7
Banner Widget Properties Example Instance
PROPERTY
DETAILS
LISTNAME
Name of the SharePoint list that contains the data to be displayed for this instance.
INFINITE LOOP
Sets the slideshow to automatically loop the content. Values are “true” and “false”
Akumina: InterChange Widgets Reference Guide
8
AUTOPLAY
Causes the banner to automatically start playing on page access. Values are “true” and
“false”
SHOW NAVIGATION
Enable the display of the slide navigation selector (dots). Values are “true” and “false”
TRANSITION EFFECT
Transition between slides.
Values are “horizontal” or “fade”
SLIDE DURATION (MS)
The amount of time spent on each slide before progressing. Time is in milliseconds.
TEXT COLOR
Text color themes. Values are “white“, “black”, “grey”
TEXT LOCATION
Location on the slide for the text block.
Values are
TEXT ALIGNMENT
1. “top_left”
• “top_center”
• “top_right”
• “middle_left”
• “middle_center”
• “middle_right”
• “bottom_left”
• “bottom_center”
• “bottom_right”
Alignment of the text displayed in the set location. Values are “left”, “center” and “right”
MAX H1 CHARACTERS
Maximum number of characters that the H1 title will display
MAX H2 CHARACTERS
Maximum number of characters that the H2 subtitle will display
MAX BUTTON
CHARACTERS
Maximum number of characters that the button will display
WEBPARTTHEME
N/A (future)
LINKBUTTONTHEME
N/A (future)
ENABLEPREVIEW
Value = false for this instance
VIEW
View Name = BannerDefault
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/Banner/Default.html
Akumina: InterChange Widgets Reference Guide
9
Calendar Widget
Main Features
•
•
•
•
•
•
Includes both a grid view and list view of the calendar events
Supports category filtering
Supports .ics calendar format download of an event to add to calendars such as Outlook
Supports recurring events
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
10
Calendar Widget Properties Example Instance
PROPERTY
DETAILS
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
DISPLAYED TITLE
If a value is entered, then the title will appear on the header of the App.
ENABLE PREVIEW
Value = false for this instance
ICON
Selects the icon that is displayed to the left of the widget title.
CATEGORY
If desired, the name of an existing event category can be entered here which will render
the calendar with that category selection chosen by default.
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SHOW CATEGORIES
If false, the Category Filter will not be displayed
If true, the Category Filter will be displayed
VIEW
View Name = Calendar
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/Calendar/Default.html
Akumina: InterChange Widgets Reference Guide
11
CompanyCalendar Widget
Main Features
•
•
•
•
•
Utilizes the Microsoft Graph API to display event data from a shared calendar in Office 365 (AzureAD required)
Provides a grid view, list view and detail view of events
Support .ics calendar format download of an event to add to calendars such as Outlook
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
12
CompanyCalendar Widget Properties Example Instance
PROPERTY
DETAILS
GROUP NAME
REQUIRED – Name of the O365 Group that contains the calendar to display
COLOR
Choices are “Blue” and “Green”
ICON
Selects the icon that is displayed to the left of the widget title.
VIEW
View Name = CompanyCalendar
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/CompanyCalendar/Default.html
Akumina: InterChange Widgets Reference Guide
13
Content Block Widget
Main Features
•
•
•
•
•
•
Optional header bar supporting web part title and icon
Full rich text support, editable using InterChange's WYSIWYG editor.
Alert style option which changes control display and icon to call additional attention to the content
Expiration date to automatically remove content block from site, if desired
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
14
Content Block Widget Properties Example Instance
PROPERTY
DETAILS
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
SITE WIDE ALERT
MESSAGE
This text message displays on the page where the text is set on the snippet. This value
would rarely be used as a site wide alert, since a better approach is to use a control item
across all pages that would be set on the ak:instructionset.
DISABLEALERT
If false, the alert message will not be displayed
If true, the alert message will be displayed
ENABLE PREVIEW
Value = false for this widget
DYNAMIC PREVIEW
Value = true for this widget
DISPLAYED TITLE
If a value is entered, then the title will appear on the header of the App.
ICON
Selects the icon that is displayed to the left of the widget title.
INSTRUCTION SET
Path to the IDS list if it exists. This value will be found on the Control App item. Example
for a site wide alert message highlighted in yellow:
Akumina: InterChange Widgets Reference Guide
15
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = ContentBlock
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/contentBlock/alert.html
Akumina: InterChange Widgets Reference Guide
16
DocumentsSummaryList Widget
Main Features
•
•
•
•
•
•
Can be used in two modes: display documents from all Document libraries in the site collection, or ONLY from
the current site.
Supports up to four tabs: Newest, My Recent, Popular, Recommended
The number of documents to display in each category can be controlled
Easily sort documents by title, date modified, site, or modified by
Documents displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
17
DocumentsSummaryList Widget Properties Example Instance
PROPERTY
DETAILS
DISPLAYED TITLE
If a value is entered, then the title will appear on the header of the App.
ICON
Selects the icon that is displayed to the left of the widget title.
DOCUMENT LIBRARY NAME
This is the name of the document library to search. There is only one name allowed,
so when searching across all sites in a site collection, the document library names must
be the same.
Akumina: InterChange Widgets Reference Guide
18
TABS TO DISPLAY
There are four tabs available for display: "Newest,My Recent,Popular,Recommended".
This comma separated list (no space between items) is used to determine which to
display and in what order.
NEWEST FILES TO DISPLAY
Maximum number of newest files to display
RECENT FILES TO DISPLAY
Maximum number of recent files to display
POPULAR FILES TO DISPLAY
Maximum number of popular files to display
RECOMMENDED FILES TO
DISPLAY
Maximum number of recommended files to display
NEWEST INFORMATION
TEXT
Specifies the message text to display when viewing the Newest tab
RECENT INFORMATION
TEXT
Specifies the message text to display when viewing the Recent tab
POPULAR INFORMATION
TEXT
Specifies the message text to display when viewing the Popular tab
RECOMMENDED
INFORMATION TEXT
Specifies the message text to display when viewing the Recommended tab
POPULAR NUMBER OF
DAYS
Size of the window to calculate the popular results. For example, a window of 30 days
would calculate the most popular based on the number of hits over the last 30 days.
ONLY LOOK ON CURRENT
SITE
When set to “false” the DSL will bring results from all sites in the Site Collection with
the target document library name. When set to “true”, only results from the current
site will be displayed.
VIEW
View Name = DocumentsSummaryList
View Template URL =
/Style
Library/DigitalWorkPlace/Content/Templates/DocumentsSummaryList/Default.html
Akumina: InterChange Widgets Reference Guide
19
EventDetail Widget
Main Features
•
•
•
•
Displays the detail for a calendar event. Most often used in conjunction with a calendar widget page. Note that
the calendar widget expects the detail page to be “EventDetail.aspx”.
Support .ics calendar format download of an event to add to calendars such as Outlook
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
EventDetail Widget Properties Example Instance
PROPERTY
DETAILS
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALENDAR LINK
The URL of the associated calendar page which is mapped to the same list
VIEW
View Name = EventDetail
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/EventDetail/Default.html
Akumina: InterChange Widgets Reference Guide
20
GenericItem Widget
The GenericItem widget is a flexible widget which can work with any content type (list structure) to retrieve data for a
single list item that is then passed to a View to render on the site. The following is just one example of a component
found in the OOTB Digital Workplace which uses the GenericItem Widget.
Main Features
•
•
•
•
The GenericItem widget returns a single content item from the specified list
The column data returned for that item can be specified on an instance basis
The GenericItem widget can work with any list and is not dependent on a specific content type
As a flexible content data retrieval widget, many views can be associated with the widget to provide flexible
rendering of the data elements on the site. The New Detail item above is just one example of a view that can be
associated with the GenericItems widget.
Akumina: InterChange Widgets Reference Guide
21
GenericItem Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for
use in this instance.
For this example, the selectfields = AnnouncementTitle,Image,Start_x0020_Date,Body
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowNewsDetail”
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = NewsDetail-MainContent
View Template URL =
/Style Library/digitalworkplace/Content/Templates/GenericList/NewsItem.html
Akumina: InterChange Widgets Reference Guide
22
GenericList Widget
The GenericList widget is a flexible widget which can work with any content type (SharePoint list structure) to retrieve
data for an array of list items that is then passed to a View to render on the site.
Main Features
•
•
•
•
The GenericList widget returns an array of content item from the specified list
The column data returned for those items can be specified on an instance basis
The GenericList widget can work with any list and is not dependent on a specific content type
As a flexible content data retrieval widget, many views can be associated with the widget to provide flexible
rendering of the data elements on the site.
The following sections are examples of the widget instances found in the OOTB Digital Workplace which use the
GenericList Widget.
Akumina: InterChange Widgets Reference Guide
23
GenericList – NewsDetail
Main Features
•
•
•
•
Provides a summary list of the items in the news list
Displays and Orders the items based on their Start Date
Does not display items that have reached their Expiration Date
Includes a link to the full news listing page
Akumina: InterChange Widgets Reference Guide
24
GenericList – News Detail Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for use
in this instance.
For this example, the selectfields =
Created,Image,FriendlyUrl,Start_x0020_Date,AnnouncementTitle
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
Akumina: InterChange Widgets Reference Guide
25
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowNewsItems”
ISASYNCCALLBACK
Value for this type of instance = false
VIEWXML
The viewxml contains any special manipulation of the data that needs to be done by the
widget BEFORE it gets render by the specified view. In this case, the viewxml is set to
the following string:
<View><Query><OrderBy><FieldRef Name='Start_x0020_Date'
Ascending='FALSE'></FieldRef></OrderBy><Where><And><Leq><FieldRef
Name='Start_x0020_Date'></FieldRef><Value IncludeTimeValue='TRUE'
Type='DateTime'><Today ></Today></Value></Leq><Or><Geq><FieldRef
Name='Expires' ></FieldRef><Value IncludeTimeValue='TRUE' Type='DateTime'><Today
></Today></Value></Geq><IsNull><FieldRef Name='Expires'
></FieldRef></IsNull></Or></And></Where></Query><RowLimit>4</RowLimit></View>
Note that the number of items (Rows) to display on the site is specified in the
<RowLimit>4</RowLimit> argument.
CALLBACKTYPE
Value for this type of instance = postdataload
DATALOADPROPERTIES
N/A
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = NewsDetail-SideContent
View Template URL =
/Style Library/digitalworkplace/Content/Templates/GenericList/NewsList.html
Akumina: InterChange Widgets Reference Guide
26
GenericList – Hero Item
Main Features
•
•
•
•
•
Displays a single news item from a list as a hyperlinked image with a display title overlay
Selection of the new item to display is determined by tags in the widget instance
Can be set to display the latest content with a specific tag
Can be targeted based on the current user’s department, city or AD group
Item is hyperlinked using the FriendlyURL to the dynamic display page for the content
Akumina: InterChange Widgets Reference Guide
27
GenericList – Hero Item Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for
use in this instance.
For this example, the selectfields = AnnouncementTitle,Image,Category,FriendlyUrl
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowHeroItem”
ISASYNCCALLBACK
Value for this type of instance = false
VIEWXML
N/A for this type of instance
Akumina: InterChange Widgets Reference Guide
28
CALLBACKTYPE
Value for this type of instance = customdataload
DATALOADPROPERTIES
{"tag":"CORPORATE","featured":"true","callback":"GetTagAsValue"}
For this widget, you can specify several “name”:”value” properties to control the
functionality:
tag – this value is used when you want to display content based on a specific metadata
tag that has been applied. In the example above, the widget is looking for content that
has been tagged with the term CORPORATE.
featured – this is another flag which can be used to further refine the content criteria to
only select from content that has the “featured” flag set (an option in the App Manager
content app). Values are true or false.
callback – this determines the type of logic which will be used to determine the content
to display. The following are the values that can be used:
GetTagAsValue – will select from content that has the metadata tag defined in
the tag property.
• GetTagAsDepartment – will select from content that has the metadata tag that
matches the Department value from their AzureAD user data. For example, if
the current user is in the Finance department as defined in Azure AD, using this
callback value would display content tagged with “Finance”. This is used for
targeting content to the current user.
• GetTagAsCity - will select from content that has the metadata tag that matches
the City value from their AzureAD user data. For example, if the current user is
in Boston as defined in Azure AD, using this callback value would display
content tagged with “Boston”. This is used for targeting content to the current
user.
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
•
CACHE INTERVAL
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = HomePage-Hero
View Template URL =
/Style
Library/digitalworkplace/Content/Templates/GenericList/TargetedNewsItem.html
Akumina: InterChange Widgets Reference Guide
29
GenericList – Department Listing Page
Main Features
•
•
Automatically displays the list of enabled subsites (Departments) with hyperlinked icons and titles
Uses the settings in the Department Manager management app to determine the color and the visibility of the
department link.
GenericList – Department Listing Widget Properties Example Instance
Akumina: InterChange Widgets Reference Guide
30
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
N/A for this use.
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
N/A for this use.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowDepartmentItems”
ISASYNCCALLBACK
Value for this type of instance = false
VIEWXML
N/A for this use.
CALLBACKTYPE
Value for this type of instance = customdataload
DATALOADPROPERTIES
N/A for this use.
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = DepartmentList
View Template URL =
/Style Library/digitalworkplace/Content/Templates/GenericList/DepartmentList.html
Akumina: InterChange Widgets Reference Guide
31
GenericList – Dashboard My Apps
Main Features
•
•
•
Provides quick access to InterChange AppManager apps directly from the front end site
Once logged into InterChange, displays a select list of sites that the current user can access, along with the
associated apps the user can access for each site.
Clicking on an app icon launches the app in a new tab or window
Akumina: InterChange Widgets Reference Guide
32
GenericList – My Apps Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
N/A for this use.
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
N/A for this use.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “DashboardShowAppsItems”
ISASYNCCALLBACK
Value for this type of instance = false
VIEWXML
N/A for this use.
CALLBACKTYPE
Value for this type of instance = customdataload
DATALOADPROPERTIES
N/A for this use.
Akumina: InterChange Widgets Reference Guide
33
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = Dashboard-My-Apps
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/Dashboard/AppsList.html
Akumina: InterChange Widgets Reference Guide
34
GenericList – Home Page Department News
Main Features
•
•
•
•
Displays news items from specified departments (subsites)
If UserContext is enabled, displays the news item from the current user’s department in the lead (top) position.
If more departments than slots available, does a random display of 4 sites (configurable)
Each item is linked to the FriendlyURL
Akumina: InterChange Widgets Reference Guide
35
GenericList – Home Page Department News Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for use
in this instance.
For this example, the selectfields = Title,Image,FriendlyUrl
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowHomePageDepartmentNewsItems”
ISASYNCCALLBACK
Value for this type of instance = false
Akumina: InterChange Widgets Reference Guide
36
VIEWXML
The viewxml contains any special manipulation of the data that needs to be done by the
widget BEFORE it gets render by the specified view. In this case, the viewxml is set to
the following string:
<View><Query><OrderBy><FieldRef Name='Start_x0020_Date'
Ascending='FALSE'></FieldRef></OrderBy><Where><And><Leq><FieldRef
Name='Start_x0020_Date' ></FieldRef><Value IncludeTimeValue='TRUE'
Type='DateTime'><Today ></Today></Value></Leq><Or><Geq><FieldRef
Name='Expires' ></FieldRef><Value IncludeTimeValue='TRUE' Type='DateTime'><Today
></Today></Value></Geq><IsNull><FieldRef Name='Expires'
></FieldRef></IsNull></Or></And></Where></Query><RowLimit>1</RowLimit></View>
Note that the number of items (Rows) to display on the site is specified in the
<RowLimit>1</RowLimit> argument.
CALLBACKTYPE
Value for this type of instance = customdataload
DATALOADPROPERTIES
For this widget, you can specify the list of departments/sub-sites from which you want
to display news items. If you specify more than four departments, the widget will pull
from four departments randomly.
To specify departments, add in the ‘URL’ value (not name) for the department using the
following format
="{‘sites’:[‘Marketing’,’HR’,’IT’,’Finance’]}"
NOTE: If targeting is enabled, the lead article will be displayed from the current users
Department as defined in their User profile. If their department is not in the list of
available departments, then the widget will default to displaying random departments.
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = Home-DeptNews
View Template URL =
/Style
Library/DigitalWorkPlace/Content/Templates/GenericList/HomeDepartmentNews.html
Akumina: InterChange Widgets Reference Guide
37
GenericList – Home Page Photos list
Main Features
•
•
Provides a summary listing of the most recent additions to the Photo Gallery, with a link to the Media Galley
page
Click on an image will launch a modal window viewer for that image
Akumina: InterChange Widgets Reference Guide
38
GenericList – Home Page Photos List Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for
use in this instance.
For this example, the selectfields = _ModerationStatus,Image
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowFeaturedPhotoItems”
ISASYNCCALLBACK
Value for this type of instance = false
Akumina: InterChange Widgets Reference Guide
39
VIEWXML
The viewxml contains any special manipulation of the data that needs to be done by
the widget BEFORE it gets render by the specified view. In this case, the viewxml is set
to the following string:
<View><Query><OrderBy><FieldRef Name='Created'
Ascending='FALSE'></FieldRef></OrderBy></Query><RowLimit>5</RowLimit></View>
Note that the number of items (Rows) to display on the site is specified in the
<RowLimit>5</RowLimit> argument.
CALLBACKTYPE
Value for this type of instance = postdataload
DATALOADPROPERTIES
N/A for this use.
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = HomePage-Photos
View Template URL =
/Style Library/digitalworkplace/Content/Templates/GenericList/FeaturedPhotos.html
Akumina: InterChange Widgets Reference Guide
40
GenericList – Photos Media Gallery Page
Main Features
•
•
•
Provides a listing of images which have been enabled for display in the Gallery using the Image Gallery App
Clicking on an image will launch a modal window viewer for that image
Supports lazy load of images as the user scrolls the browser window to optimize performance
Akumina: InterChange Widgets Reference Guide
41
GenericList – Photos Media Gallery Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for
use in this instance.
For this example, the selectfields = Image
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowMediaGalleryPhotoItems”
ISASYNCCALLBACK
Value for this type of instance = false
VIEWXML
N/A for this use
Akumina: InterChange Widgets Reference Guide
42
CALLBACKTYPE
Value for this type of instance = postdataload
DATALOADPROPERTIES
N/A for this use
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = MediaGallery-Photos
View Template URL =
/Style
Library/digitalworkplace/Content/Templates/GenericList/MediaGalleryPhotoList.html
Akumina: InterChange Widgets Reference Guide
43
GenericList – FAQ Summary
Main Features
•
•
•
Summary list of the Question/Answer pairs for the FAQ’s
Maximum number of items to be displayed can be set
Displays link to the full FAQ listing page
GenericList – FAQ Summary Widget Properties Example Instance
Akumina: InterChange Widgets Reference Guide
44
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for
use in this instance.
For this example, the selectfields = Title,Answer,ItemActive
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowFAQItems”
ISASYNCCALLBACK
Value for this type of instance = false
VIEWXML
The viewxml contains any special manipulation of the data that needs to be done by
the widget BEFORE it gets render by the specified view. In this case, the viewxml is set
to the following string:
<View><Query><OrderBy><FieldRef Name='ItemOrder'
Ascending='TRUE'></FieldRef></OrderBy></Query><RowLimit>10</RowLimit></View>
Note that the number of items (Rows) to display on the site is specified in the
<RowLimit>10</RowLimit> argument.
CALLBACKTYPE
Value for this type of instance = postdataload
DATALOADPROPERTIES
N/A for this use.
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
For the Summary FAQ that appears on the Subsite Home Page:
View Name = Subsite-Home-FAQ
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/GenericList/FAQ.html
For the FAQ Page that lists all the FAQ Questions (with no ALL QUESTIONS link):
View Name = Subsite-FAQPage
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/GenericList/FAQPage.html
Akumina: InterChange Widgets Reference Guide
45
GenericList – Department Home Page News listing
Main Features
•
•
•
Displays the four most recent news articles from the current site (can be used on the parent or subsites)
Filters out news articles that are past their expiration date or before their start date
Includes link to the full news listing page
Akumina: InterChange Widgets Reference Guide
46
GenericList – Department Home Page News Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
The data fields (columns) from the SharePoint list that the widget should retrieve for use
in this instance.
For this example, the selectfields = AnnouncementTitle,Image,FriendlyUrl
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowDepartmentFeaturedNewsItems”
ISASYNCCALLBACK
Value for this type of instance = false
Akumina: InterChange Widgets Reference Guide
47
VIEWXML
The viewxml contains any special manipulation of the data that needs to be done by the
widget BEFORE it gets render by the specified view. In this case, the viewxml is set to
the following string:
<View><Query><OrderBy><FieldRef Name='Start_x0020_Date'
Ascending='FALSE'></FieldRef></OrderBy><Where><And><Leq><FieldRef
Name='Start_x0020_Date' ></FieldRef><Value IncludeTimeValue='TRUE'
Type='DateTime'><Today ></Today></Value></Leq><Or><Geq><FieldRef
Name='Expires' ></FieldRef><Value IncludeTimeValue='TRUE' Type='DateTime'><Today
></Today></Value></Geq><IsNull><FieldRef Name='Expires'
></FieldRef></IsNull></Or></And></Where></Query><RowLimit>4</RowLimit></View>
Note that the number of items (Rows) to display on the site is specified in the
<RowLimit>4</RowLimit> argument.
CALLBACKTYPE
Value for this type of instance = postdataload
DATALOADPROPERTIES
N/A for this use.
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
VIEW
View Name = Subsite-Home-DepartmentNews
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/GenericList/DepartmentNews.html
Akumina: InterChange Widgets Reference Guide
48
Important Dates Widget
Main Features
•
•
•
•
•
•
Items can be explicit items in a list OR linked to calendar events
Links can be set to open in the same window (site links) or a new window (external links)
Includes expiration date support to automatically remove content from site
Support for unlimited number of events
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
49
Important Dates Widget Properties Example Instance
PROPERTY
DETAILS
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
VIEW ALL LINK
Name of the page which contains the associated Calendar if being used to read calendar
events (in this example, the widget is reading an explicit list of dates and not linked to a
Calendar list)
DISPLAYED TITLE
If a value is entered, then the title will appear on the header of the App.
ICON
Selects the icon that is displayed to the left of the widget title.
DATES ARE FROM
CALENDAR
A null or “false” value means that the dates are not coming from a calendar list type.
FEATURED FIELD
This is the name of the field in the list which contains the “featured” flag. When the “Dates
are from Calendar” is set to “true”, the featured flag in the list is required to be set to true
for the event to be displayed on the widget.
CALENDAR DISPLAY
This field is ONLY used if the "Dates are from Calendar" field is true. The values for the
Calendar Display field are either:
A “true” value means that the dates are coming from a calendar list type
blank = show dates beginning from yesterday
Akumina: InterChange Widgets Reference Guide
50
CACHE INTERVAL
month = show dates beginning one month ago
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
# OF ITEMS TO
DISPLAY
VIEW
[whole number] = cache for specified time (secs)
This controls how many items to display.
View Name = HomePage-ImportantDates
View Template URL =
/Style
Library/digitalworkplace/Content/Templates/ImportantDates/DigitalWorkspaceDefault.html
FIELD
Details
Akumina: InterChange Widgets Reference Guide
51
My Teams Widget
Main Features
•
•
Displays the team members (based on the People Directory) with the same “Department” profile value as the
current user
Requires that user profile information is enabled either through the GraphAPI/AzureAD or through the
SharePoint Profile Service synchronization
Akumina: InterChange Widgets Reference Guide
52
My Team Widget Properties Example Instance
PROPERTY
DETAILS
LIST IS ON ROOT SITE
If false, the list which contains the data for this instance is on the current site.
If true, the list which contains the data is on the root of the Site Collection.
SELECTFIELDS
N/A for this use.
ENABLE PAGING
If false, the widget will not display paging controls
If true, the widget will display paging controls (if implemented by developer in widget)
ITEMS/PAGE
Sets the number of items to display on each page IF paging is enabled.
LIST NAME
Name of the SharePoint list that contains the parameters for this widget.
CALLBACKMETHOD
The callbackmethod is set by the developer of the widget. For this use, the method to
specify is “ShowMyTeamItems”
ISASYNCCALLBACK
Value for this type of instance = true
Akumina: InterChange Widgets Reference Guide
53
VIEWXML
N/A for this use.
CALLBACKTYPE
Value for this type of instance = postdataload
DATALOADPROPERTIES
N/A for this use.
CACHE INTERVAL
Sets the time (in secs) that the data should be saved in the local browser cache of the
current user.
0 = do not cache the data for this widget
-1 = use the default caching strategy set in the Digital Workplace configuration
[whole number] = cache for specified time (secs)
GET PHOTO FROM AD
If true, the photo to display is pulled from AzureAD.
If false, the photo to display is pulled from another source.
VIEW
View Name = Dashboard-MyTeam
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/Dashboard/MyTeamList.html
Akumina: InterChange Widgets Reference Guide
54
People Directory Widget
Main Features
•
•
•
•
Utilizes either the SharePoint Profile Service or Azure Active Directory/Microsoft Graph API to display personnel
data
Includes search and filtering for fast and efficient employee lookups
Includes both a grid view (shown) as well as a list view
Provides ability to adjust and add new filter facets
Akumina: InterChange Widgets Reference Guide
55
People Directory Widget Properties Example Instance
PROPERTY
DETAILS
DISPLAYED TITLE
If a value is entered, then the title will appear on the header of the App.
SORT BY
Sort order for the listing. Choices are “First Name” or “Last Name”
FACETS
Determines the facets which will be displayed for filtering on the left side of the display.
These facets can be modified by developers to match the data content which exists for
users. For this OOTB example the facets are defined as follows:
[{ "facetName":"department","facetDisplayName":"Department"},{
"facetName":"officelocation","facetDisplayName":"Office Location"}]
GET PHOTO FROM AD
If true, the photo to display is pulled from AzureAD.
If false, the photo to display is pulled from another source.
DISPLAY NAME AS
Sets how the name will be displayed in the listing. Choices are “First Last” or “Last, First”
SHOW A-Z SELECTOR
Controls the display of the A-Z selector. “True” displays the selector, “False” hides the
selector.
DEFAULT DISPLAY VIEW
Sets the default display view for the Directory. Choices are “Tile” or “List”
VIEW
View Name = PeopleDirectory
View Template URL =
/Style Library/digitalworkplace/Content/Templates/PeopleDirectory/Default.html
Akumina: InterChange Widgets Reference Guide
56
QuickLinks Widget
Quicklinks View
DeptMenu View
Main MenuView
Main Features
•
•
•
•
•
•
•
•
•
Features top level links and categories with fly-out menus to display second level items
Allows for an unlimited number of top level links and categories
Links can be set to open in the same window (site links) or a new window (external links)
Supports two levels of categorization
Supports both a list of links and menu controls
Easily managed via an InterChange Content App using a drag/drop, tree style UI for adding categories and links
Automatically adjusts the size of the main level and fly-outs to support list lengths
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
57
Quicklinks Widget Properties Example Instance
PROPERTY
DETAILS
LIST NAME
Name of the SharePoint list that contains the data to be displayed for this instance.
DISPLAYED TITLE
If a value is entered, then the title will appear on the header of the App.
ICON
Selects the icon that is displayed to the left of the widget title.
VIEW
View Name = MainMenu
View Template URL =
/Style
Library/DigitalWorkPlace/Content/Templates/Quicklinks/DigitalWorkplaceMenu.html
View Name = DeptMenu
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/QuickLinks/ItemTemplateSubSite.html
View Name = Quicklinks
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/QuickLinks/ItemTemplate.html
Akumina: InterChange Widgets Reference Guide
58
RSSNews Widget
Main Features
•
Displays an RSS feed. The view controls the number of items to display.
RSSNews Widget Properties Example Instance
PROPERTY
DETAILS
RSS FEED URL
Valid URL for the RSS feed
CALLBACKMETHOD
N/A for this use.
VIEW
View Name = RssNews
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/RssNewsList.html
Akumina: InterChange Widgets Reference Guide
59
Traffic Widget
Main Features
•
•
•
Utilizes Google Maps API for traffic data (free Google Developer account required)
Location display can be preset or detected based on user city attribute
Mobile-ready via Responsive Web Design
Traffic Widget Properties Example Instance
PROPERTY
DETAILS
CITY
N/A for this use.
STATE
N/A for this use.
POSTAL CODE
Postal Code is used to communicate with the Google Maps API to retrieve the traffic data.
If not using targeting (user location attribute) then the location displayed is this postal
Akumina: InterChange Widgets Reference Guide
60
code location. If using targeting, the current user’s postal code (if it exists) will override
this value.
CALLBACKMETHOD
Value = GetTrafficLocation
VIEW
View Name = Traffic
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/Traffic/Default.html
Akumina: InterChange Widgets Reference Guide
61
Weather Widget
Main Features
•
•
Weather location can be preset or detected based on current user’s city attribute if using targeting
Mobile-ready via Responsive Web Design
Weather Widget Properties Example Instance
The following is the properties panel which is displayed when a new instance of the XXXXXXX is created:
PROPERTY
DETAILS
CITY
City for the default Postal Code. This is required as the weather API service does not
return the city associated with the Postal Code. If using targeting, the City will be read
from the current user’s profile data along with the postal code.
Akumina: InterChange Widgets Reference Guide
62
STATE
State for the default Postal Code. This is required as the weather API service does not
return the state associated with the Postal Code. If using targeting, the State will be read
from the current user’s profile data along with the postal code.
POSTAL CODE
Postal Code is used to communicate with the weather API service to retrieve the weather
data. If not using targeting (user location attribute) then the location displayed is this
postal code location. If using targeting, the current user’s postal code (if it exists) will
override this value.
CALLBACKMETHOD
Value = GetWeatherLocation
VIEW
View Name = Weather
View Template URL =
/Style Library/DigitalWorkPlace/Content/Templates/Weather.html
Akumina: InterChange Widgets Reference Guide
63
Document Management System (DMS) Control
The InterChange DMS Controls are a full document management listing that combines a folder tree view, document list,
search filter, refiners and multiple tab views into one easy to use interface. Each of these controls can be used together
or separately in any needed combination to address specific site needs. That said, together the InterChange DMS
controls deliver a complete replacement for, and significant upgrade to, the standard SharePoint Library experience.
The DMS controls includes a powerful drag/drop mode with a tagging wizard that prompts users to complete any
required metadata fields and select whether they want to check-in the documents as part of the upload. No more
documents being left checked out by accident. As with all InterChange Controls the DMS Controls support mobile access
via Responsive Web Design out of the box.
The DMS Control uses the existing Snippet technology, so it is setup and managed differently than the other
InterChange widgets.
Main Features
•
•
•
•
•
•
•
•
•
Four controls combine to provide the full experience:
Folder tree
View tabs (Most Recent, My Documents, Popular, Recommended)
Document Grid
Refiners
Includes a powerful drag/drop mode with wizard which prompts user to complete any required fields and select
whether they want to check-in the documents as part of the upload.
Context menu appears with the correct options based on user selection
Create new files or drag/drop them to add
Folder tree navigation linked to the document grid
Akumina: InterChange Widgets Reference Guide
64
•
•
•
•
•
•
Refiners adjust as documents list changes
Quick search filters files listed in the grid dynamically as user types
Preview pane provides document preview (requires Office Web Apps installed) and quick link to the document
Fully supported by the IDS (Instruction Data Set) technology and InterChange Control Apps
Items displayed are security trimmed based on specific site user's SharePoint permissions
Mobile-ready via Responsive Web Design
Akumina: InterChange Widgets Reference Guide
65
Discussion Board Control
The InterChange Discussion Board control, allows organizations to offer an engagement and communication tool for
users of the SharePoint site. The control leverages and the SharePoint discussion board app, but improves the
experience for the visitors and administrators of the control.
The Discussion Board Controls use the existing Snippet technology, so are setup and managed differently than the
other InterChange widgets.
Main Features
•
•
•
•
Special InterChange control that leverages the SharePoint discussion board app
Discussion boards provide forums for site participants to discuss topics with each other.
Fully supported by the IDS (Instruction Data Set) technology and InterChange Control Apps
Mobile-ready via Responsive Web Design
Discussion Summary Control Snippet
<div id="discussionsummary12" ak:title="Human Resources DiscussionSummary" class="ak-controls akdiscussionsummary-control" ak:icon="None" ak:previewcount="100" ak:titlecount="20" ak:posttype="op"
ak:noofposts="5" ak:displayavatar="true" ak:discussioncreateurl="/sites/TestD/HR/Pages/DiscussNew.aspx"
ak:discussionthreadurl="/sites/TestD/HR/Pages/DiscussThread.aspx"
ak:discussionlistingurl="/sites/TestD/HR/Pages/DiscussList.aspx" ak:documentlistname="Documents"
ak:discussionlistname="Discussions_AK">
</div>
FIELD
DETAILS
id
Unique name for this instance of the control
ak:title
If a value is entered, then the title will appear on the header of the App.
ak:icon
Selects the icon that is displayed to the left of the Document Summary List title.
See “Reference Values for Icons” section for list of available icons
ak:previewcount
The number of characters to display of the message body preview
ak:titlecount
The number of characters to show in the title of each discussion item displayed
ak:posttype
Choose to display the “original post” (op) or the “last post” (lp) for each
discussion thread
ak:noofposts
The number of discussion threads to display in the summary
ak:displayavatar
Display (true) or disable (false) the avatar
ak:discussioncreateurl
Relative url to the discussion creation page
ak:discussionthreadurl
Relative url to the discussion thread page
ak:discussionlistingurl
Relative url to the discussion listing page
ak:documentlistname
Specifies the name of the document library to use for documents that are added
to a discussion thread
ak:discussionlistname
SharePoint list which contains the content
Akumina: InterChange Widgets Reference Guide
66
Discussion Board Create New Control Snippet
<div id="creatediscussion19" ak:title="Human Resources CreateDiscussion" class="ak-controls ak-creatediscussioncontrol" ak:discussioncreateurl="/sites/TestD/HR/Pages/DiscussNew.aspx"
ak:discussionthreadurl="/sites/TestD/HR/Pages/DiscussThread.aspx"
ak:discussionlistingurl="/sites/TestD/HR/Pages/DiscussList.aspx" ak:documentlistname="Documents"
ak:discussionlistname="Discussions_AK">
</div>
FIELD
DETAILS
id
Unique name for this instance of the control
ak:title
If a value is entered, then the title will appear on the header of the App.
ak:discussioncreateurl
Relative url to the discussion creation page
ak:discussionthreadurl
Relative url to the discussion thread page
ak:discussionlistingurl
Relative url to the discussion listing page
ak:documentlistname
Specifies the name of the document library to use for documents that are added
to a discussion thread
ak:discussionlistname
SharePoint list which contains the content
Discussion Board Listing Control Snippet
<div id="discussionboardlisting17" ak:title="Human Resources DiscussionBoardListing" class="ak-controls akdiscussionboardlisting-control" ak:previewcount="100" ak:titlecount="20" ak:posttype="op" ak:noofposts="5aak"
ak:displayavatar="true"ak ak:discussioncreateurl="/sites/TestD/HR/Pages/DiscussNew.aspx"
ak:discussionthreadurl="/sites/TestD/HR/Pages/DiscussThread.aspx"
ak:discussionlistingurl="/sites/TestD/HR/Pages/DiscussList.aspx" ak:documentlistname="Documents"
ak:discussionlistname="Discussions_AK">
</div>
FIELD
DETAILS
id
Unique name for this instance of the control
ak:title
If a value is entered, then the title will appear on the header of the App.
ak:previewcount
The number of characters to display of the message body preview
ak:titlecount
The number of characters to show in the title of each discussion item displayed
ak:posttype
Choose to display the “original post” (op) or the “last post” (lp) for each
discussion thread
ak:noofposts
The number of discussion threads to display in the summary
ak:displayavatar
Display (true) or disable (false) the avatar
ak:discussioncreateurl
Relative url to the discussion creation page
ak:discussionthreadurl
Relative url to the discussion thread page
Akumina: InterChange Widgets Reference Guide
67
ak:discussionlistingurl
Relative url to the discussion listing page
ak:documentlistname
Specifies the name of the document library to use for documents that are added
to a discussion thread
ak:discussionlistname
SharePoint list which contains the content
Discussion Thread Control Snippet
<div id="discussionthread21" ak:title="Human Resources DiscussionThread" class="ak-controls ak-discussionthreadcontrol" ak:displayavatar="true" ak:discussioncreateurl="/sites/TestD/HR/Pages/DiscussNew.aspx"
ak:discussionthreadurl="/sites/TestD/HR/Pages/DiscussThread.aspx"
ak:discussionlistingurl="/sites/TestD/HR/Pages/DiscussList.aspx" ak:documentlistname="Documents"
ak:discussionlistname="Discussions_AK">
</div>
FIELD
DETAILS
id
Unique name for this instance of the control
ak:title
If a value is entered, then the title will appear on the header of the App.
ak:discussioncreateurl
Relative url to the discussion creation page
ak:discussionthreadurl
Relative url to the discussion thread page
ak:documentlistname
Specifies the name of the document library to use for documents that are added
to a discussion thread
ak:discussionlistname
SharePoint list which contains the content
Akumina: InterChange Widgets Reference Guide
68
Discussion Summary
Discussion Board Listing
Akumina: InterChange Widgets Reference Guide
69
Discussion Board Create New Discussion
Discussion Thread
Akumina: InterChange Widgets Reference Guide
70
Adding a Widget based Control
Adding a widget to a page involves the following steps:
1. Put the page in Edit mode
2. Add a SharePoint “Content Editor” web part (located in the “Media and Content” Category of the web part
gallery) to the page in the position you want the control
3. After adding the web part, click inside the Content Block web part. The SharePoint ribbon options will change
and the “
” button will appear.
4. Click on Edit Source and an HTML Source window will open in which you can paste the widget instance code that
you copied from the widget instance you wanted to add. The widget instance code is available in the Widget
Manager for the instance you created:
Akumina: InterChange Widgets Reference Guide
71
5. NOTE: If you are adding a new Content Editor web part to the page, you should edit the web part to turn the
“Chrome Type” to None so that the Content Editor web part title will not be displayed on the page.
Akumina: InterChange Widgets Reference Guide
72
When do I use an OOB widget versus creating a new one?
Decision Tree
We have three options for widgets with Digital Workplace Framework:
•
•
•
Existing Control
Generic List Control (GLC)
Custom Widget
When we determine our approach we will need to ask the following questions:
Does the functionality of proposed control
resemble that of an existing control?
Does the data model of existing control contain
the required columns of the data model for the
proposed control?
Yes
No
Use Existing
Control
Does the output of the existing control conform
to that of the proposed control?
Yes
Does the data for proposed control sit inside
SharePoint?
Yes
No
No
Use GLC
Use Custom Widget
Does the data origin of the existing control
conform to that of the proposed control?
Yes
No
You will need:
You will need:
Widget Snippet
Customdata
callback
Widget Snippet
Akumina: InterChange Widgets Reference Guide
You will
need:
Widget
Snippet
Template
You will need:
You will need:
SharePoint List with
Data
Widget Definition
Callback function
Widget Snippet
Template
Template
Widget Snippet
73
Consider the following use cases to help you better understand the Widget Design decision making process.
Use Case 1
Jim has been tasked with building a FAQ page for his company’s Sales Team. After meeting with them, the Sales Team
gives Jim the following requirements
•
•
•
•
Sales team members need to be able to do all content management for the FAQ within InterChange
Questions can be edited
Answers can be edited
Questions can be archived, meaning they will not show up on the page but they will remain in the system
Now that Jim has his requirements he is ready to go through the Widget Decision Tree to design his widget.
Does the functionality of the proposed control resemble that of an existing control?
Jim opens up the widget manager and searches through the widget instances. He notices an instance of the GenericList
widget called Finance-FAQ-FAQ
Jim investigates further by editing the app. He takes note of the fact that it refers to a list called FAQ_AK
He creates a new page on the site, adds a content editor, pastes the snippet in and publishes.
Jim affirms that this widget displays items comprised of questions and answers stored in a SharePoint list. This resembles
the proposed control. The answer to this question is yes.
Does the data model of the existing control contain the required columns of the data model for
the proposed control?
From the requirements, Jim determines that his FAQ data model has 3 required columns
•
•
•
A Text field for the question
A Text field for the answer
A Boolean field for the Archived Item
Jim compares these columns to the FAQ_AK list.
Akumina: InterChange Widgets Reference Guide
74
The Title and Answer fields conform to his requirements for the question and answer. Jim assumes ItemOrder allows the
user to reorder the items, this exceeds his requirements but doesn’t impede on what was initially requested so he is fine
with it. He suspects ItemActive may work as the Archived Item field. He tests this out by modifying the item within the
FAQ content app in InterChange. FAQ is configured as a slider app, so he flips ItemActive to false by hitting the On-Off
switch on the item.
He clicks ‘Publish’ and visits his snippet he pasted earlier
The question is no longer in the page, but remains in the list. The data model of the existing control does contain the
required columns of the data model for the proposed control. The answer to this question is yes. Jim knows he can use
this Existing Widget.
Does the output of the existing control conform to that of the proposed control?
Judging from his observations of the snippet’s output in the previous questions. Jim concludes that the output of the
existing control conforms to that of the proposed control. The answer to this question is yes.
Does the data origin of the existing control conform to that of the proposed control?
Jim notes that the existing control draws its data from the FAQ_AK list within SharePoint. Since the Sales Team wants to
be able to edit FAQ entries within SharePoint he concludes that proposed control also will store its data within a single
list inside of SharePoint. The answer to this question is yes. All Jim will need is the Widget Snippet of the existing FAQ
widget. He gets it from the Widget Instances window that he accessed when answering the first question. For details on
how to use Existing Widgets, see the Akumina - Digital Workplace – Widget Manager Overview Document.
Akumina: InterChange Widgets Reference Guide
75
Use Case 2
Han has been tasked by her company’s Marketing Department with building an image gallery linked to the company’s
Facebook page. After her meeting with the Vice President of Marketing she has gathered the following requirements.
•
•
•
•
The image gallery will retrieve images from a Facebook album specified by the Marketing department
The image gallery will need to be on a designated ‘Image gallery page’
A set number of images should display on the page
When the user clicks on an image it should be displayed in a popup
Now that Han has her requirements she is ready to go through the Widget Decision Tree to design her widget.
Does the functionality of the proposed control resemble that of an existing control?
Han is viewing her company’s Digital Workplace site and notices a link on the top bar called Media Gallery. She clicks on
it.
This navigates her to a page called MediaGalleryPhotoList.aspx. On a page there is an existing photo gallery widget.
Han clicks on an image and it appears as a popup.
Akumina: InterChange Widgets Reference Guide
76
Han affirms that this widget displays a set of images and displays them in a popup when clicked. She concludes that the
functionality of this existing widget resembles that of the proposed widget. The answer to this question is yes.
Does the data model of the existing control contain the required columns of the data model for
the proposed control?
From the requirements, Han determines that her Facebook Photo Gallery Data Model contains the following columns
•
An Image Hyperlink column called Image
Han opens up the Digital Workplace Widget Manager and observes that the photo gallery widget she found is a
GenericList widget instance that is pulling data from the ImageGallery_AK list.
Akumina: InterChange Widgets Reference Guide
77
Han decides to investigate the ImageGallery_AK list.
The Image column in the ImageGallery_AK list conforms to the required column in Han’s data model. The answer to this
question is yes.
Does the output of the existing control conform to that of the proposed control?
Han recalls the requirements related to output
•
•
A set number of images should display on the page
When the user clicks on an image it should be displayed in a popup
She compares each requirement to the output of the existing control. Han observes that the existing control displays a
set of images on the page, and the number of images to be displayed can be controlled from the Widget Manager.
The first requirement is met. Han also remembers that when she clicked on an image it was displayed in a popup. The
second requirement is met. The output of the existing control conforms to the proposed control. The answer to this
question is yes.
Does the data origin of the existing control conform to that of the proposed control?
Han knows that the data for the existing photo gallery widget is stored within a list inside of SharePoint. However, the
photo gallery widget that the Marketing Department wants needs to draw its data from the company Facebook page, a
Akumina: InterChange Widgets Reference Guide
78
third party source. Therefore, the data origin of the existing control does not conform to that of the proposed control.
The answer to this question is no. Han will need to create a Customdataload callback for the existing photo gallery
widget. She will also need the Widget Snippet of an instance of the existing photo gallery widget that is using her
Customdataload callback. For details on how to create Customdataload callbacks, see the Akumina – DigitalWorkplace
– Customdataload Callback Widget Document.
Use Case 3
Sarah has been tasked with building a news ticker for her company homepage by the Digital Outreach team. After her
meeting with the Director of Digital Outreach she has gathered the following requirements.
•
•
•
•
News on the ticker needs to be the latest news stories from the web (ie from AP)
A story should be the title with a link to the actual news article
Ticker should grab the top ten stories at time of retrieval
Ticker should display one story at a time and rotate on a timer
Now that Sarah has her requirements she is ready to go through the Widget Decision Tree to design her widget.
Does the functionality of proposed control resemble that of an existing control?
Sarah opens up the widget manager and searches through the widget instances. She sees a widget called ‘RssNews’ that
looks promising.
Sarah creates a new page on the site, adds a content editor, and pastes the snippet within
Sarah affirms that the widget is displaying news stories that link to articles. This resembles the Proposed Control. The
answer to this question is yes.
Akumina: InterChange Widgets Reference Guide
79
Does the data model of the existing control contain the required columns of the data model for
the proposed control?
From the requirements, Sarah concludes that the proposed control has 2 columns in her data model.
•
•
A Text Field called Title
A Text Field called Url
The existing RSS news feed is a custom widget that retrieves its data from a third party. Sarah will verify the data model
by inspecting the widget’s output.
She right clicks on the first item in the RSS Feed and sees what data is returned.
The item contains both a url, href=http://blogs.findlaw.com/in_house/2017/01/i-9-issues-when-hiring-foreignworkers.html, and a title, I-9 Issues When Hiring Foreign Workers. Sarah affirms that the answer to this question is yes.
She can use an Existing Widget.
Does the output of the existing control conform to that of the proposed control?
To answer this question, Sarah compares to output of the existing control to her requirements. The requirements
relating to output are the following
•
•
•
A story should be a title that links to the actual news story
Ticker should grab the top ten news stories upon retrieval
Ticker should display one story at a time and rotate on a timer
The first requirement is met by the output. However, the last two requirements are not. The existing control only
retrieves 4 stories, not 10, and the stories do not display one at a time on a carousel. The answer to this question is no.
Sarah will need to create a custom Template. Add the new template to the RssNews control. Create a new instance of
the control using the new template and grab the Widget Snippet from it. For details on how to use an Existing Widget
with a custom Template, see the Akumina - Digital Workplace – Widget Manager Overview Document.
Use Case 4
Praneet has been tasked with creating a Featured Event widget by his company’s HR department. After meeting with
Director of HR he has gathered the following requirements:
•
•
•
•
•
•
•
The Featured Event widget needs to be on the HR department’s home page
Members of the HR department need to be able to add and edit events via InterChange
Each individual event must link to a page for each event
A featured event has a title and description, the description will only appear on the page though
A featured event has the start date and time
A featured event as an image, when the user clicks on the image it will send them to the page.
The widget will not feature past events
Does the functionality of proposed control resemble that of an existing control?
Praneet opens up the widget manager and searches through the widget instances. He sees a widget called
‘ImportantDates’ that looks promising.
Akumina: InterChange Widgets Reference Guide
80
Praneet investigates further by editing the widget instance. He notes that the widget is referring to data stored in a list
called ‘ImportantDates_AK’.
Praneet creates a new page on the site, adds a content editor, and pastes the snippet within.
Praneet notes that although the widget does not identically conform to his requirements, it is displaying event dates,
titles, and descriptions. This is enough for him to continue exploring using it. He concludes that this existing widget
resembles the proposed widget. The answer to this question is yes.
Does the data model of existing control contain the required columns of the data model for the
proposed control?
From the requirements, Praneet can deduce that the required columns for the data model of the proposed control are
the following:
•
•
•
•
•
A Text field for the Title field
A Date field for the Start Date field
A Date field for the Expires field
A Text field for the Description field
A Hyperlink field for the FriendlyUrl field
Akumina: InterChange Widgets Reference Guide
81
•
An Image field for the Image field
Praneet compares these columns to those of ImportantDates_AK
Praneet observes that an Image column is missing and concludes that the data model of items in ImportantDates_AK
does not contain the required columns for the data model of the proposed control. The answer to this question is no.
Does the data for proposed control sit inside SharePoint?
Praneet recalls the following requirement.
•
Members of the HR department need to be able to add and edit events via InterChange
Since users are adding and editing content in InterChange the data is being stored in a SharePoint list. The answer to this
question is yes. Praneet will need to build a new Generic List Widget. He will need to create a custom SharePoint List,
which he will base off of the ImportantDates_AK but with additional columns. In addition, he will need to define a
custom Callback function in digitalworkplace.custom.js, upload a custom Template, create a new instance of the
GenericList widget using this template, and the Widget Snippet from this instance. For details on how to build a Generic
List Control see the Akumina - Digital Workplace – GLC Quick Start Document.
Use Case 5
Zoran has been tasked with creating a Stock Ticker widget by his company’s Finance Department. After a meeting with
the CFO he has gathered the following requirements
•
•
•
•
•
The widget will need to display current stock prices
The widget will need to allow users to customize what symbols they want the stock prices for
The widget will need to display multiple stock prices at the same time
The widget will need to display the price differential
The widget will need to display a chart of the daily price
Now that Zoran has his requirements, he starts down the Widget Design Decision Tree.
Does the functionality of proposed control resemble that of an existing control?
Zoran searches the widget instances within the Widget Manager and he cannot find anything that is related to displaying
stock prices. The answer to this question is no.
Akumina: InterChange Widgets Reference Guide
82
Does the data for proposed control sit inside SharePoint?
Zoran recalls one of the requirements he gathered.
•
The widget will need to display current stock prices
Since the stock price has to be current, the data will need to be retrieved from a third party that is reporting stock
market prices. Therefore, the data for the proposed control does not sit inside SharePoint. Zoran will need to build a
Custom Widget for this task. He will need to define a custom Widget Definition within digitalworkplace.custom.js,
upload a custom Template, create a new custom widget within the Widget Manager, create a new instance of this
custom widget, and the Widget Snippet from this instance. For details on how to build a Custom Widget see the
Akumina - Digital Workplace – Custom Widget Document.
Akumina: InterChange Widgets Reference Guide
83