Class FSCTEAMROOM@1.1001:AppDashboard

Abstract base class to define a Dashboard for an AppRoom

Class Hierarchy

Direct Subclasses

ContactDashboard, CRMgmtDashboard, TemplateMgmtDashboard

Properties

Type	Property	Name
Object[]	dbadditionalfeatures	Activate Further Functionalities
boolean	dbadvancedorgdashboardconfigmode	Activate Organization Administration
boolean	dbadvancedroomconfigmode	Enable Advanced Mode
Object	dbstartelement	Start With
ReportResult[]	reportresults	Report Results

Actions

Return Type	Signature
AppConfigurationRoom	GetContextConfiguration( optional boolean recursive, optional ObjectClass configclass, out retval AppConfigurationRoom configuration, out optional AppConfigurationRoom[] additionalconfigs, optional ObjectAspect configaspect)
AppDashboard	GetContextDashboard( optional ObjectClass dashboardclass, optional ObjectClass configclass, out retval AppDashboard dashboard)

Properties

Activate Further Functionalities (FSCTEAMROOM@1.1001:dbadditionalfeatures)

Enables use of additional app dashboard features.

unique Object[] FSCTEAMROOM@1.1001:dbadditionalfeatures readonly volatile

Activate Organization Administration (FSCTEAMROOM@1.1001:dbadvancedorgdashboardconfigmode)

Attribute to define if the organization is displayed on home

boolean FSCTEAMROOM@1.1001:dbadvancedorgdashboardconfigmode readonly volatile

Enable Advanced Mode (FSCTEAMROOM@1.1001:dbadvancedroomconfigmode)

Attribute to define if the room configurations are displayed on dashboard level

boolean FSCTEAMROOM@1.1001:dbadvancedroomconfigmode readonly volatile

Start With (FSCTEAMROOM@1.1001:dbstartelement)

The object stored in this property is navigated into when the user logs in.

Object FSCTEAMROOM@1.1001:dbstartelement readonly volatile

Report Results (FSCREPORTING@1.1001:reportresults)

List of report results

unique ReportResult[] FSCREPORTING@1.1001:reportresults readonly(ui) volatile

Additional Information

Access Types for Changing Property: AccTypeReadSensitive
Access Types for Reading Property: AccTypeReadSensitive
Describes Child Relationship

Actions

FSCTEAMROOM@1.1001:GetContextConfiguration

Gets the configuration for an object taking into account context-specific information.

If no configuration is found, the object contained in transaction variable TV_CONTEXTOBJECT is used.

AppConfigurationRoom FSCTEAMROOM@1.1001:GetContextConfiguration(
  optional boolean recursive,
  optional ObjectClass configclass,
  out retval AppConfigurationRoom configuration,
  out optional AppConfigurationRoom[] additionalconfigs,
  optional ObjectAspect configaspect)

Name	Description
recursive	true if the action is called recursively
configclass	the objectclass of the configuration
configuration	the app configuration room of the current context
additionalconfigs	in context of an global app dashboard (see: `CPUseGlobalAppDashboard`) the parameter configuration returns the first app configuration room stored in `dbconfig`. All other values of `dbconfig` are returned with parameter additionalconfigs.
configaspect	if defined the configuration must have the supplied aspect assigned. This parameter is only considered when an object class is supplied. So the requested configuration has to match the supplied class and the supplied aspect. If the required configuration just needs to match the object aspect the aspect has to be supplied with parameter configclass

FSCTEAMROOM@1.1001:GetContextDashboard

Get the app dashboard for an object taking into account context-specific information.

AppDashboard FSCTEAMROOM@1.1001:GetContextDashboard(
  optional ObjectClass dashboardclass,
  optional ObjectClass configclass,
  out retval AppDashboard dashboard)

Name	Description
dashboardclass	app dashboard object class
configclass	app configuration object class
dashboard	the dashboard