Class COOSYSTEM@1.1:Group

An object of this class is used for a team of persons that is registered as a group.

Class Hierarchy

Direct Subclasses

Properties

Type	Property	Name
boolean	active	Active
Address[]	address	Addresses
Object[]	assignedreferences	Assigned References
integer	boremarkamount	Amount of Remarks
content	boremarks	Remarks
content	boviewremarks	Remarks
EmailInformation[]	emailinformation	E-Mail Addresses
boolean	gradvanceddashboardconfigmode	Show Organization Management for Administrators on Home
OrganizationalUnit[]	grallorganizationalunits	All Organizational Units
string	grlongname	Description
User[]	grmembers	Members
OrgUnitType[]	grorgunittype	Organizational Unit Type
boolean	groupsendpushnotifications	Allow Push Notifications for Events
boolean	grroomallowrestrictedcollaboratorhistory	Display Events for Team Members Who Are Not Allowed to View the Team
Group[]	grroomcollaborationscope	Restrict Team Members
boolean	grroomdelegateinvitation	All Team Members May Add Members
LinkUsage	grroomlinkusage	Restrict Shortcuts Within Teamroom
RoomPublishState	grroompublishstate	Access Protection
boolean	grroomshowcollaborators	Team Members Visible to All Members
string(60)	grshortname	Short Name
Group[]	grsubgroups	Subgroups
Group[]	grsupergroups	Supergroups
Notification[]	recipientresubmissions	Follow-Ups
Object[]	references	References
Telephone[]	telephone	Telephone Numbers

Actions

Return Type	Signature
void	EndUserMembership( User user, optional User substitute, optional boolean informuser, optional boolean deactivateuser, optional object policy, optional TimeIntervalComponentObject interval)
Notification[]	GetResubmissions( boolean includedepending, out retval Notification[] resubmissions, out Notification[] dependingresubmissions)
void	LogHistoryEvent( any type, optional object event, optional LanguageStringList[] description, optional datetime timestamp, optional object user, optional object group, optional object position, optional object substuser, optional DocState docstate, optional string[] args, optional boolean nolocktimeout)
void	SendBackgroundSecure( any[] to, optional any[] cc, optional any[] bcc, any subject, string[] body, optional object[] attachments, optional boolean usepubliclinks, optional ContentFormat downloadformat, out string[] errorlog, optional string replytoaddress, optional string headertitle, optional Language fallbacklanguage)

Properties

Active (COOSYSTEM@1.1:active)

Defines whether the working environment of the user is accessible. If set to true, the user is active and can work with the installation. If set to false, the user can only be referenced. The initial value is true.

Explanation:
This field defines whether the user or the organizational unit is active.
Note: Only active users are able to log on to the system.

boolean COOSYSTEM@1.1:active not null

Addresses (FSCFOLIO@1.1001:address)

Stores the address of the contact.

Explanation:
In this field addresses for the contact can be defined.

Address[] FSCFOLIO@1.1001:address

Assigned References (FSCFOLIO@1.1001:assignedreferences)

Stores a list of referenced objects which are also assigned to the object.
This list is a sub set of references.

unique Object[] FSCFOLIO@1.1001:assignedreferences readonly(ui) invisible

Additional Information

Access Types for Changing Property: AccTypeRead
Describes Child Relationship
Object Classes Allowed: ContentObject, URLObject
Property for Back Link: referencedby

Amount of Remarks (FSCFOLIO@1.1001:boremarkamount)

Stores the number of remarks store in property boremarks.

unsigned integer FSCFOLIO@1.1001:boremarkamount readonly invisible

Additional Information

Access Types for Changing Property: AccTypeRead

Remarks (FSCFOLIO@1.1001:boremarks)

Stores the entered remarks for this object.

Explanation:
In this field text inputs are displayed that are made in the scope of processing the business object (e.g. during approval).

content FSCFOLIO@1.1001:boremarks readonly

Additional Information

Access Types for Changing Property: AccTypeRead

Remarks (FSCFOLIO@1.1001:boviewremarks)

Property to display the formatted remarks.

Explanation:
In this field the remarks are shown.

content FSCFOLIO@1.1001:boviewremarks readonly volatile

E-Mail Addresses (COOMAPI@1.1:emailinformation)

Defines the e-mail information for the address book entry.

Explanation:
In this field the e-mail addresses of the contact can be defined.

EmailInformation[] COOMAPI@1.1:emailinformation

Additional Information

Access Types for Changing Property: AccTypeChange
Access Types for Reading Property: AccTypeRead

Show Organization Management for Administrators on Home (FSCTEAMROOM@1.1001:gradvanceddashboardconfigmode)

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

Explanation:
If you disable this option, administrators can manage only selected settings using the "Settings" action of an app's personal dashboard.

boolean FSCTEAMROOM@1.1001:gradvanceddashboardconfigmode readonly volatile

All Organizational Units (FSCORGMGMT@1.1001:grallorganizationalunits)

Calculated list of all organizational elements.

OrganizationalUnit[] FSCORGMGMT@1.1001:grallorganizationalunits readonly volatile

Description (COOSYSTEM@1.1:grlongname)

Defines the long description name for the group.

Explanation:
This field defines the description of the group.

string COOSYSTEM@1.1:grlongname

Members (COOSYSTEM@1.1:grmembers)

In this field all members of the group can be added.

unique User[] COOSYSTEM@1.1:grmembers readonly

Additional Information

Object Classes Allowed: User
Property for Back Link: usermemberof

Organizational Unit Type (COOSYSTEM@1.1:grorgunittype)

Defines the organizational unit type the group is assigned to.

Explanation:
Defines the organizational unit type.

OrgUnitType[] COOSYSTEM@1.1:grorgunittype readonly

Allow Push Notifications for Events (FSCPUSHNOTIFICATION@1.1001:groupsendpushnotifications)

This property defines if push notifications concerning objects of this group are sent.

Explanation:
Defines whether push notifications are sent for events. If the affected object is assigned to another organization, Allow Push Notifications for Events must also be enabled in this organization for the push notification to be sent.

boolean FSCPUSHNOTIFICATION@1.1001:groupsendpushnotifications readonly

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

Defines the initialization value for property trallowrestrictedcollaboratorhistory for new rooms.

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:grroomallowrestrictedcollaboratorhistory

Restrict Team Members (FSCTEAMROOM@1.1001:grroomcollaborationscope)

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:grroomcollaborationscope

Additional Information

Object Classes Allowed: Group

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

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:grroomdelegateinvitation

Restrict Shortcuts Within Teamroom (FSCTEAMROOM@1.1001:grroomlinkusage)

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:grroomlinkusage

Access Protection (FSCTEAMROOM@1.1001:grroompublishstate)

Policy to define the publishing state of new Teamroom s

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:grroompublishstate

Additional Information

Object Classes Allowed: RoomPublishState

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

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 "Team" action, can start processes, duplicate objects, 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.

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:grroomshowcollaborators

Short Name (COOSYSTEM@1.1:grshortname)

Defines the short identification name for the group.

Explanation:
This field defines the short name of the group.

string(60) COOSYSTEM@1.1:grshortname not null

Subgroups (COOSYSTEM@1.1:grsubgroups)

Defines the list of groups, which are subordinate to this group.

Explanation:
In this field subgroups can be defined, to build hierarchies of groups.
Note: A subgroup also contains the actual group as a supergroup.

unique Group[] COOSYSTEM@1.1:grsubgroups readonly

Additional Information

Property for Back Link: grsupergroups

Supergroups (COOSYSTEM@1.1:grsupergroups)

In this field supergroups can be defined, to build hierarchies of groups.
Note: A supergroup also contains the actual group as a subgroup.

unique Group[] COOSYSTEM@1.1:grsupergroups readonly

Additional Information

Property for Back Link: grsubgroups

Follow-Ups (FSCNOTIFICATION@1.1001:recipientresubmissions)

Stores the follow-ups for which the user is defined as recipient.

unique Notification[] FSCNOTIFICATION@1.1001:recipientresubmissions readonly invisible

Additional Information

Access Types for Reading Property: AccTypeRead
Property for Back Link: notificationrecipient

References (FSCFOLIO@1.1001:references)

Stores the references of the object.

Explanation:
In this field references to other objects can be stored.

unique Object[] FSCFOLIO@1.1001:references

Additional Information

Access Types for Changing Property: AccTypeRead
Object Classes Allowed: BasicObject, CompoundObject, ContentObject, URLObject, Folder

Telephone Numbers (FSCFOLIO@1.1001:telephone)

Stores the telephone number of the contact.

Explanation:
In this field the telephone numbers of a contact can be defined.

Telephone[] FSCFOLIO@1.1001:telephone

Actions

FSCFOLIOCLOUD@1.1001:EndUserMembership

Removes the user from an organization, team, organization unit or external organization.
In case of an organization or the default external organization, the user will be excluded from all other organizational elements.

void FSCFOLIOCLOUD@1.1001:EndUserMembership(
  User user,
  optional User substitute,
  optional boolean informuser,
  optional boolean deactivateuser,
  optional object policy,
  optional TimeIntervalComponentObject interval)

Name	Description
user	the user to be excluded
substitute	the substitute for the excluded user
informuser	defines if an e-mail should be sent to inform the user about exclusion
deactivateuser	defines if the user should be deactivated (if it is the last organization, the user will automatically be deactivated)
policy	the policy which defines that the user should be deactivated
interval	the time interval of the policy which defines that the user should be deactivated

FSCNOTIFICATION@1.1001:GetResubmissions

Retrieve resubmissions of the current object and all depending objects if requested

Notification[] FSCNOTIFICATION@1.1001:GetResubmissions(
  boolean includedepending,
  out retval Notification[] resubmissions,
  out Notification[] dependingresubmissions)

Name	Description
includedepending	the resubmissions of depending objects are included
resubmissions	the resubmissions of the current object
dependingresubmissions	the resubmissions of all depending objects

FSCFOLIO@1.1001:LogHistoryEvent

This action can be called to store important events in the life time of an object.

Note: In batch mode and bulk load mode will no history events be recorded.
To force recording history events in batch and bulk load mode to the transaction variable TV_BATCHMODE_LOG_HISTORY can be used.

Hint: If some history events should not be recorded in the current transaction the transaction variable TV_SUPPRESSEDEVENTCATEGORIES can be used.

void FSCFOLIO@1.1001:LogHistoryEvent(
  any type,
  optional object event,
  optional LanguageStringList[] description,
  optional datetime timestamp,
  optional object user,
  optional object group,
  optional object position,
  optional object substuser,
  optional DocState docstate,
  optional string[] args,
  optional boolean nolocktimeout)

Name	Description
type	The type of the event to be logged.
event	An object that is the main data of the event.
description	Obsolete. Multilingual string of the event, this should not be supplied any more.
timestamp	an optional timestamp when the history event occurred. If not set the coonow will be used
user	Optional. The user who initiated the event, if omitted the current user is used.
group	Optional. The group of the initiating user, if omitted the current group is used.
position	Optional. The position of the initiating user, if omitted the current position is used.
substuser	Optional. The user who substitutes the initiating user, if omitted the current substituting user is used.
docstate	Optional. The new docstate if business documents are modified.
args	Optional. Additional arguments for printing the description text of the event. These have to be expression language constants, i.e. 1,"text", 2010-01-30 12:00:00.
nolocktimeout	defines if the default lock timeout should be skipped.

FSCFOLIO@1.1001:SendBackgroundSecure

Sends an e-mail via SMTP to the given users. The body can be defined as plain text only. The mail will be sent as HTML. Sender is defined by the SMTP-Configuration.

void FSCFOLIO@1.1001:SendBackgroundSecure(
  any[] to,
  optional any[] cc,
  optional any[] bcc,
  any subject,
  string[] body,
  optional object[] attachments,
  optional boolean usepubliclinks,
  optional ContentFormat downloadformat,
  out string[] errorlog,
  optional string replytoaddress,
  optional string headertitle,
  optional Language fallbacklanguage)

Name	Description
to	List of objects (users, contacts) or a list of strings to which an e-mail should be sent.
cc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in CC
bcc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in BCC.
subject	A subject is essential for an e-mail to be able to be sent. A subject can be either a plain string or a string object. If a string object is passed as subject, the used language is based on the user communication language. If there is no subject passed, the name or address from the first attachment will be used instead.
body	The text for the e-mail. Can contain: STRING, STRINGLIST.
attachments	A list of attachment objects for which MX urls or public links are inserted into the e-mail.
usepubliclinks	Generate public links instead of MX urls.
downloadformat	Use this download format in case of public links.
errorlog	Error log containing send errors.
replytoaddress	Use this replyto e-mail address.
headertitle	the text will be used as header title of the email.
fallbacklanguage	The fallback language is used when the email recipients are specified only by an email address, or when no communication language can be determined for an email recipient object.