CKS - AFS

AFS Integration Guide

Product
AFS
AFS_Version
7.9
Category
Reference Guide

In this configuration section, settings are grouped related to CKS. Properties defined here can change the behavior of all CKS Widgets.

The cks property from the Configuration has the following available parameters.


Parameter Name


Card.


Type


Default


Description

authMode

Optional

String

"INTERNAL"

Defines what kind of authentication mode to use. Values can be INTERNAL or LDAP.

objects

Optional

Object

N/A

Defines settings for objects handled by CKS Widgets. This sub object currently support two properties: searches and bookmarks.

Each kind of CKS objects can be configured with the following properties:


Parameter Name


Card.


Type


Default


Description

enableFolders

Optional

Boolean

false

Indicates if newly objects can be stored in folders.

forceListDisplayOnAdd

Optional

Boolean

false

Indicates if when an object is created, the corresponding list widget should display it.

Configuration example:

var AFSWidgetConfiguration = {
cks: {
authMode: 'LDAP',
objects: {
searches: {
enableFolders: true,
forceListDisplayOnAdd: true
},
bookmarks: {
enableFolders: false
}
}
}
};

The JavaScript-based configuration above indicates the following:

  • the login mechanism has to use LDAP (see Register and Login Widgets)
  • widgets handling searches should allow the user to store new objects in folders (see AddSchedSearch and ListSchedSearches Widgets)
  • widgets handling bookmarks do not provide folders capabilities (see AddBookmark Widget and Component, and ListBookmarks Widget)
  • after a search is created using the AddSchedSearch widget, the object will be revealed in the ListSchedSearches widget (if installed)

The choice of using or not folders should be made carefully since objects created in a given mode cannot be automatically migrated to the other mode.