Class FSCTEAMROOM@1.1001:Room

Abstract base class to mange the security for a bunch of objects

Class Hierarchy

Direct Subclasses

AppConfigurationRoom, AppRoom, InboxRoom, PersonalTemplateCollection, RoomWithUserForm, TeamRoom

Properties

Type	Property	Name
Thesaurus	acrdefaultthesaurus	Default Thesaurus for New Terms
Object[]	acreporttemplates	Reports and OData Services
Object[]	acrthesauri	Thesauri
Object	bostate	Processing State
Room[]	trallorphanteamrooms	Orphaned Teamrooms (incl. Hierarchy)
boolean	trallowrestrictedcollaboratorhistory	Display Events for Team Members Who Are Not Allowed to View the Team
Room[]	trallreferencedteamrooms	Referenced Teamrooms (incl. Hierarchy)
Room[]	trallsubordinatedteamrooms	Subordinate Teamrooms (incl. Hierarchy)
Group[]	trcollaborationscope	Restrict Team Members
boolean	trdelegateinvitation	All Team Members May Add Members
boolean	trenableaccessdefinitions	Use Access Definitions
InsightApp[]	trinsightapps	Insight Apps
User	trinvitedby	Invited by
LinkUsage	trlinkusage	Restrict Shortcuts Within Teamroom
User[]	trmasterrolemembers	Team Members Who Can Manage All Roles
Room[]	trorphanteamrooms	Orphaned Teamrooms
boolean	trpublicaccess	Allow Public Links
RoomPublishState	trpublishstate	Access Protection
Room[]	trreferencedteamrooms	Referenced Teamrooms
Room[]	trreferencingteamrooms	Referencing Teamrooms
boolean	trrequireinherittemplatesecurity	Security Settings and Permissions Must Be Taken From the Template
RoomStructureType	trroomstructuretype	Display of Lists
boolean	trshowcollaborators	Team Members Visible to All Members
Room[]	trsubordinatedteamrooms	Subordinate Teamrooms
Room	trsuperordinatedteamroom	Superordinate Teamroom
Object[]	trtemplates	Templates
AppCategory	trtype	Type

Actions

Return Type	Signature
boolean	CanReleaseTemplate( out retval boolean canrelease)
Room[]	GetAllOrphanTeamRooms( out retval Room[] orphanrooms)
Room[]	GetAllReferencedTeamRooms( out retval Room[] referencedrooms)
Room[]	GetAllSubOrdinatedTeamRooms( out retval Room[] subordinatedrooms)
Content	GetLogo( out retval Content logo, optional LogoType type, out object source)
MBInSpireService	GetMBInSpireService( out retval MBInSpireService svc, optional object context)
Room	GetObjectRoom( out retval Room room, optional boolean includeself)
User[]	GetTeamMembersSecured( optional boolean expandorgelements, optional RoomRole[] roles, out retval User[] members, out optional object[] groups)
RoomRole[]	GetUserRoomRolesSecured( User targetuser, out retval RoomRole[] roles)
RoomRole[]	GetUserRoomRolesSecuredCached( User targetuser, out retval RoomRole[] roles)
boolean	HasRoomCustomAssignmentAccess( User user, out retval boolean hasaccess, optional object context)
boolean	HasRoomDeleteAccess( optional User user, out retval boolean hasdeleteaccess)

Properties

Default Thesaurus for New Terms (FSCTEAMROOM@1.1001:acrdefaultthesaurus)

The default thesaurus of the room which is used for automated creation of terms by action AutoCreateTerms.

Explanation:
If a standard thesaurus is specified, new terms can be created directly during tagging.

Thesaurus FSCTEAMROOM@1.1001:acrdefaultthesaurus readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Object Classes Allowed: Thesaurus

Reports and OData Services (FSCREPORTING@1.1001:acreporttemplates)

List of report templates in a room/configuration room.

unique Object[] FSCREPORTING@1.1001:acreporttemplates

Additional Information

Access Types for Changing Property: AccTypeChangeSec, AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: Report, ODataService, ReportCollectionFolder

Thesauri (FSCTEAMROOM@1.1001:acrthesauri)

A list of available thesauri which are used to select terms to tag objects in the currrent room.

unique Object[] FSCTEAMROOM@1.1001:acrthesauri readonly volatile

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: Thesaurus, ThesaurusCollectionFolder

Processing State (FSCFOLIO@1.1001:bostate)

Defines the processing state of the object
FSCFOLIO@1.1001 provides following state component objects:

StateAccepted, StateApproved, StateCalculating, StateCanceled, StateClosed,
StateDeclined, StateDiscarded, StateDone, StateFailed, StateForApproval, StateFulfilled,
StateIgnored, StateInProgress, StateNotReleased, StateNotRelevant, StatePlanning,
StatePreparation, StateReceived, StateRejected, StateReleased, StateReplaced, StateTentative,
StateToVerify, StateUnfulfilled

Note: StateCanceled is set to the object if the document state was set to DS_CANCELLED
StateClosed is set to the object if the document state was set to DS_CLOSED

Explanation:
In each Category different States can be defined that are available for business objects of this type.
Note: In each State different Template Categories can be defined that are available to business objects of this state.

Object FSCFOLIO@1.1001:bostate

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState
Object Classes Allowed: State, ComponentState

Orphaned Teamrooms (incl. Hierarchy) (FSCTEAMROOM@1.1001:trallorphanteamrooms)

Obsolete: Use GetAllOrphanTeamRooms.
Calculates all orphan Teamrooms of the current room when room hierarchy is supported.

Explanation:
A list of all Teamrooms that are assigned to the current Teamroom or to a Teamroom in the Teamroom assignment hierarchy but which are no longer stored in the Teamroom.

unique Room[] FSCTEAMROOM@1.1001:trallorphanteamrooms readonly volatile

Additional Information

Object Classes Allowed: Room, RoomWithUserForm

Display Events for Team Members Who Are Not Allowed to View the Team (FSCTEAMROOM@1.1001:trallowrestrictedcollaboratorhistory)

Stores if users who are not allowed to see the team of the room are allowed to subscribe to notifications of the room.

Explanation:
Only team members with "Full Control" see the events by default. The display of events can also be enabled for team members who are not allowed to view the team. However, only events that could not lead to conclusions about team members with read access will be displayed.

boolean FSCTEAMROOM@1.1001:trallowrestrictedcollaboratorhistory

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Referenced Teamrooms (incl. Hierarchy) (FSCTEAMROOM@1.1001:trallreferencedteamrooms)

Obsolete: Use GetAllReferencedTeamRooms.
Calculates all referenced Teamroom of the current room when room hierarchy is supported.

Explanation:
A list of all Teamrooms that are stored in the current Teamroom or in a Teamroom in the Teamroom hierarchy.

unique Room[] FSCTEAMROOM@1.1001:trallreferencedteamrooms readonly volatile

Additional Information

Object Classes Allowed: Room, RoomWithUserForm

Subordinate Teamrooms (incl. Hierarchy) (FSCTEAMROOM@1.1001:trallsubordinatedteamrooms)

Obsolete: Use GetAllSubOrdinatedTeamRooms.
Calculates all subordinate Teamroom of the current room when room hierarchy is supported.

Explanation:
A list of all Teamrooms that are assigned to the current Teamroom or to a Teamroom in the Teamroom assignment hierarchy. A Teamroom is assigned to another Teamroom, if an entry exists on the "Relations" tab, in the Superordinate Teamroom field.

unique Room[] FSCTEAMROOM@1.1001:trallsubordinatedteamrooms readonly volatile

Additional Information

Object Classes Allowed: Room, RoomWithUserForm

Restrict Team Members (FSCTEAMROOM@1.1001:trcollaborationscope)

Only members of the defined groups can be invite for collaboration.

Explanation:
Defines the groups whose members may be added to the Teamroom. If the list does not contain any entries, members can be added without restriction.

unique Group[] FSCTEAMROOM@1.1001:trcollaborationscope

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec
Object Classes Allowed: Group
Object Classes Not Allowed: Mailbox

All Team Members May Add Members (FSCTEAMROOM@1.1001:trdelegateinvitation)

Configuration to allow delegated invitations.

Explanation:
Defines whether all team members can add users to the team or only team members with "Full Control". Members with change access may grant or revoke change access or read access to other members. Members with read access may grant or revoke read access to other members.

boolean FSCTEAMROOM@1.1001:trdelegateinvitation

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Use Access Definitions (FSCTEAMROOM@1.1001:trenableaccessdefinitions)

Use of Access Definitions can be enabled

boolean FSCTEAMROOM@1.1001:trenableaccessdefinitions readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Insight Apps (FSCMINDBREEZEINSIGHT@1.1001:trinsightapps)

unique InsightApp[] FSCMINDBREEZEINSIGHT@1.1001:trinsightapps

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: InsightApp, InsightAppCollectionFolder

Invited by (FSCTEAMROOM@1.1001:trinvitedby)

Calculates the user who invited the current user to participate in the room.

Explanation:
In this field, the contact who invited you to this Teamroom is displayed.

User FSCTEAMROOM@1.1001:trinvitedby readonly volatile

Restrict Shortcuts Within Teamroom (FSCTEAMROOM@1.1001:trlinkusage)

Allowed objects in child attributes of the room and it's assigned objects are restricted by this property.

Explanation:
Defines which type of shortcuts may be stored in the Teamroom. You can restrict the permitted shortcuts to objects that are assigned to the organization or to objects that are assigned to the Teamroom. In this way, you can prevent, for example, that shortcuts are stored to which the members of the Teamroom do not have access.

LinkUsage FSCTEAMROOM@1.1001:trlinkusage

Additional Information

Access Types for Changing Property: AccTypeChangeSec

Team Members Who Can Manage All Roles (FSCTEAMROOM@1.1001:trmasterrolemembers)

Members of the master roles of the room

User[] FSCTEAMROOM@1.1001:trmasterrolemembers readonly volatile invisible

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel

Orphaned Teamrooms (FSCTEAMROOM@1.1001:trorphanteamrooms)

A calculated list of the Teamrooms assigned to the current room which can not be located by browsing through the object hierarchy.

Explanation:
A list of all Teamrooms that are assigned to the current Teamroom but which are no longer stored in this Teamroom.

unique Room[] FSCTEAMROOM@1.1001:trorphanteamrooms readonly volatile

Additional Information

Object Classes Allowed: Room, RoomWithUserForm

Allow Public Links (FSCTEAMROOM@1.1001:trpublicaccess)

Configuration to allow public access to objects of the Teamroom.

Explanation:
This field defines whether public links to objects of the Teamroom may be sent. If disabled, already published links cannot be accessed any more.

boolean FSCTEAMROOM@1.1001:trpublicaccess

Additional Information

Access Types for Changing Property: AccTypeChangeSec

Access Protection (FSCTEAMROOM@1.1001:trpublishstate)

Publishing state of a Teamroom

Note: The ACL of the room depends on its publishing state

Explanation:
Defines whether only the specified team is allowed to access the Teamroom or whether everyone can read the Teamroom but not search for it.

RoomPublishState FSCTEAMROOM@1.1001:trpublishstate not null

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec
Object Classes Allowed: RoomPublishState

Referenced Teamrooms (FSCTEAMROOM@1.1001:trreferencedteamrooms)

Stores the list of Teamrooms in have been shared into the current room when room hierarchy is supported.

Explanation:
A list of all Teamrooms that are stored in the current Teamroom.

unique Room[] FSCTEAMROOM@1.1001:trreferencedteamrooms readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSec, AccTypeChangeSecRel
Object Classes Allowed: Room, RoomWithUserForm

Referencing Teamrooms (FSCTEAMROOM@1.1001:trreferencingteamrooms)

Stores the list of Teamrooms in where the current room was shared into when room hierarchy is supported.

Explanation:
A list of all Teamrooms in which the current Teamroom is stored.

unique Room[] FSCTEAMROOM@1.1001:trreferencingteamrooms readonly

Additional Information

Object Classes Allowed: Room, RoomWithUserForm

Security Settings and Permissions Must Be Taken From the Template (FSCTEAMROOM@1.1001:trrequireinherittemplatesecurity)

Defines if the security settings have to be copied when creating a room from a template.

Explanation:
Defines whether the user can select whether to apply the security settings and permissions (team members) when instantiating the template.

boolean FSCTEAMROOM@1.1001:trrequireinherittemplatesecurity

Display of Lists (FSCTEAMROOM@1.1001:trroomstructuretype)

Stores how lists are organized in the room.

Explanation:
Shows whether a structured or unstructured display of lists is used.

RoomStructureType FSCTEAMROOM@1.1001:trroomstructuretype readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Team Members Visible to All Members (FSCTEAMROOM@1.1001:trshowcollaborators)

Configuration to allow Teamroom members to see other collaborators of the Teamroom.

Explanation:
Defines whether all members are allowed to see the team members. Note that disabling this setting also restricts other use cases:

Only team members with "Full Control" have access to the "Permissions" action, can start processes, use templates and release templates and presettings.
Only team members with "Full Control" see the events by default. The display of events can also be enabled for team members who are not allowed to view the team. However, only events that could not lead to conclusions about team members with read access will be displayed.
Team members with read access cannot use remarks, public comments, signatures, processes or comment on news feeds.
Team members with read access cannot use the time travel.
Team members with read access cannot be selected as participants in processes.
Team members with read access cannot create public links.
Team members with read access cannot view the "Processes" and "Activities" tabs of assigned objects.

Note: Team members with change access can be eventually seen by all members, since changes are logged in log properties such as Last Change by.

boolean FSCTEAMROOM@1.1001:trshowcollaborators

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Subordinate Teamrooms (FSCTEAMROOM@1.1001:trsubordinatedteamrooms)

Stores the directly subordinate Teamroom of the current room when room hierarchy is supported.

Explanation:
A list of all Teamrooms that are assigned to the current Teamroom. A Teamroom is assigned to another Teamroom, if an entry exists on the "Relations" tab, in the Superordinate Teamroom field.

unique Room[] FSCTEAMROOM@1.1001:trsubordinatedteamrooms readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSec, AccTypeChangeSecRel
Object Classes Allowed: Room, RoomWithUserForm

Superordinate Teamroom (FSCTEAMROOM@1.1001:trsuperordinatedteamroom)

Stores the superior Teamroom of the current room when room hierarchy is supported.

Explanation:
A Teamroom can be assigned to exactly one superordinate Teamroom.

Room FSCTEAMROOM@1.1001:trsuperordinatedteamroom readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSec, AccTypeChangeSecRel
Object Classes Allowed: Room, RoomWithUserForm

Templates (FSCTEAMROOM@1.1001:trtemplates)

Teamroom Templates.

Explanation:
This objects can be used as templates for creating new objects in the Teamroom.

Object[] FSCTEAMROOM@1.1001:trtemplates volatile

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: BasicObject, CompoundObject, ContentObject, ComponentTemplateCategory
Object Classes Not Allowed: AppConfigurationRoom, AppDashboard, ExternalRoom, Wastebasket, SearchForm, PrescriptionTemplate, WorkFlowDiagram, DisplayView

Type (FSCTEAMROOM@1.1001:trtype)

App category of the Teamroom.

Explanation:
The type of the Teamroom defines which Apps are automatically activated in this Teamroom, regardless of the personal settings. The type can also predefine the appearance of the Teamroom by a default theme.

AppCategory FSCTEAMROOM@1.1001:trtype

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeRead
Object Classes Allowed: AppCategory

Actions

COOTC@1.1001:CanReleaseTemplate

Check if the current user is allowed to release a template or to withdraw the release

boolean COOTC@1.1001:CanReleaseTemplate(
out retval boolean canrelease)

Name	Description
canrelease	the result;

FSCTEAMROOM@1.1001:GetAllOrphanTeamRooms

Calculates all orphan Teamrooms of the current room when room hierarchy is supported.

Room[] FSCTEAMROOM@1.1001:GetAllOrphanTeamRooms(
out retval Room[] orphanrooms)

Name	Description
orphanrooms	the orphan Teamrooms

FSCTEAMROOM@1.1001:GetAllReferencedTeamRooms

Calculates all referenced Teamrooms of the current room when room hierarchy is supported.

Room[] FSCTEAMROOM@1.1001:GetAllReferencedTeamRooms(
out retval Room[] referencedrooms)

Name	Description
referencedrooms	the referenced Teamrooms

FSCTEAMROOM@1.1001:GetAllSubOrdinatedTeamRooms

Calculates all subordinate Teamrooms of the current room when room hierarchy is supported.

Room[] FSCTEAMROOM@1.1001:GetAllSubOrdinatedTeamRooms(
out retval Room[] subordinatedrooms)

Name	Description
subordinatedrooms	the subordinate Teamrooms

COODESK@1.1:GetLogo

Retrieves a logo for the current object. The type of logo is defined by LogoType.
Since the source of a logo, i.e. the object which stores the logo, may differ from the current object, GetLogo will also return this source object.
To determine the source object, GetLogo will evaluate the customization GetLogoContainer.
GetLogo will retrieve the logo image either from objlogoimage or objlogothumbimage. If there is no content available in these properties, the logo will be retrieved from the object stored in objlogoref.
If no logo content could be retrieved, the parameter logo and source will not be set.

Content COODESK@1.1:GetLogo(
  out retval Content logo,
  optional LogoType type,
  out object source)

Name	Description
logo	The logo image. Only contents of type png, svg, jpg or gif are allowed.
type	The type of logo that should be retrieved. The type will be used as key in the customization `GetLogoContainer`. The default value is `LT_CONTENT`.
source	The object that stores the logo content.

FSCMINDBREEZE@1.1001:GetMBInSpireService

Determine Mindbreeze Inspire Service

MBInSpireService FSCMINDBREEZE@1.1001:GetMBInSpireService(
out retval MBInSpireService svc,
optional object context)

Name	Description
svc	InSpire service
context	Context for service selection

FSCTEAMROOM@1.1001:GetObjectRoom

Action to retrieve the room of an object

Room FSCTEAMROOM@1.1001:GetObjectRoom(
out retval Room room,
optional boolean includeself)

Name	Description
room	the room
includeself	if the current object is a room it will return himself. By default no room will be returned for a room. This parameter has no effect for other objects.

FSCTEAMROOM@1.1001:GetTeamMembersSecured

Returns the users directly authorized in the room. If the parameter expandorgelements is set to true, then the users contained in authorized organizational elements are also returned.

User[] FSCTEAMROOM@1.1001:GetTeamMembersSecured(
  optional boolean expandorgelements,
  optional RoomRole[] roles,
  out retval User[] members,
  out optional object[] groups)

Name	Description
expandorgelements	If set, all organizational elements will be resolved to users.
roles	If set, only users with the specified role will be returned. In a Teamroom or a room with user data, the roles `RoleTeamRoomFullControl`, `RoleTeamRoomChangeAccess` and `RoleTeamRoomReadAccess` can be used. In an app configuration, usually the roles `RoleAppConfigurationRoomAdmin` and `RoleAppConfigurationRoomUser` are available.
members	The team members.
groups	The authorized organizational elements

FSCTEAMROOM@1.1001:GetUserRoomRolesSecured

This action retrieves the room roles which are assigned to the supplied user.

RoomRole[] FSCTEAMROOM@1.1001:GetUserRoomRolesSecured(
User targetuser,
out retval RoomRole[] roles)

Name	Description
targetuser	The user for whom the roles should be evaluated.
roles	RoomRoles which are assigned to the specified user.

FSCTEAMROOM@1.1001:GetUserRoomRolesSecuredCached

This action retrieves the room roles which are assigned to the supplied user.

RoomRole[] FSCTEAMROOM@1.1001:GetUserRoomRolesSecuredCached(
User targetuser,
out retval RoomRole[] roles)

Name	Description
targetuser	The user for whom the roles should be evaluated.
roles	RoomRoles which are assigned to the specified user.

FSCTEAMROOM@1.1001:HasRoomCustomAssignmentAccess

Check if the supplied user can assign a new object to the room. This action is used to allow to assign an object to an app Room when the user does not have the sufficient access permissions returned by HasRoomFullControl, HasRoomChangeAccess and HasRoomChildChangeAccess

boolean FSCTEAMROOM@1.1001:HasRoomCustomAssignmentAccess(
  User user,
  out retval boolean hasaccess,
  optional object context)

Name	Description
user	the user for whom the permission will be checked
hasaccess	the result
context	the object which should be assigned to the room

FSCTEAMROOM@1.1001:HasRoomDeleteAccess

Checks for change access on the room or a role that is allowed to move objects to the wastebasket

boolean FSCTEAMROOM@1.1001:HasRoomDeleteAccess(
optional User user,
out retval boolean hasdeleteaccess)

Name	Description
user	the user for whom the permission will be checked
hasdeleteaccess	the result