2022 June Release

Actions of FSCORGMGMT@1.1001 Permanent link for this heading

Return Type

Signature

void

AttrGrAdministrationsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

object[]

AttrGrAdministrationsUIFilter(
  ref retval object[] objects,
  AttributeDefinition attrdef)

void

AttrGrPaymentUserSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

UserSessionInfo[]

CalcSessionInfos(
  optional boolean interactive,
  optional Group[] masterorgs,
  out retval UserSessionInfo[] sessioninfos)

WorkGroup[]

CalcUserWorkGroups(
  out retval WorkGroup[] workgroups)

boolean

CanManageRoles(
  Group orgcontext,
  optional User user,
  optional boolean checkastargetuser,
  out retval boolean canmanage)

boolean

CanManageUser(
  User user,
  optional boolean donotcheckrole,
  out retval boolean canmanage,
  out Group[] managingorgs,
  optional boolean personalinformations,
  optional AttributeDefinition[] policies)

void

ChangeDefaultHolidayTable(
  optional integer unused1,
  optional integer unused2)

void

ChangeDefaultHolidayTableSelected(
  optional integer unused1,
  optional integer unused2)

boolean

CheckAdminRole(
  object[] objs,
  out retval boolean valid,
  optional boolean checkallroles)

void

CreateHolidayTable(
  optional integer unused1,
  optional integer unused2)

void

CreateOrganizationalPosition(
  optional integer unused1,
  optional integer unused2)

void

CreateOrganizationalUnit(
  optional integer unused1,
  optional integer unused2)

StructuralChange

CreateStructuralChange(
  dictionary params,
  out retval StructuralChange structchange)

User

CreateUser(
  string email,
  optional string firstname,
  optional string surname,
  optional string middleinitial,
  optional Country country,
  optional Language language,
  out retval User user,
  optional string externalkey,
  optional Group organization,
  optional boolean sendinvitationmail)

void

DeleteOrganizationalUnit()

void

DeleteOrgWastebasketObjects(
  optional integer unused1,
  optional integer unused2)

void

DeleteOrgWastebasketObjectsSelected(
  optional integer unused1,
  optional integer unused2)

void

DuplicateHolidayTable(
  optional integer unused1,
  optional integer unused2)

void

DuplicateHolidayTableSelected(
  optional integer unused1,
  optional integer unused2)

void

EditOrgUnitHierarchySettings(
  optional integer unused1,
  optional integer unused2)

void

EmptyOrgWastebasket(
  optional integer unused1,
  optional integer unused2)

void

FilerDataImportClearEmpty(
  DataImportComponentObject datimpobj,
  dictionary values)

void

FillSettingsOverviewPostWrapper(
  ref InfoList[] infolist,
  object[] prerequfailed,
  object[] prerequfailedopt)

void

FilterDataImportExpr(
  DataImportComponentObject datimpobj,
  AttributeDefinition attrdef,
  ref dictionary params)

object

FindOrgElementByExternalKey(
  string externalkey,
  ObjectClass class,
  optional Group owngroup,
  out retval object element)

User

FindUser(
  string searchpattern,
  optional Group needmembership,
  out retval User user)

User[]

GetAllManagers(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

User[]

GetAllManagersTopDown(
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

User[]

GetAllOrganizationManagers(
  Group organization,
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

AppPackage

GetAssignedEdition(
  out retval AppPackage assignededition)

DataImportComponentObject

GetDataImport(
  ComponentObject context,
  out retval DataImportComponentObject datimpobj,
  ref ComponentContentObject template,
  ref string exportfilename)

DataImportContainer

GetDataImportContainer(
  AttributeObjectDef attrdef,
  boolean create,
  boolean share,
  boolean reset,
  optional object context,
  out retval DataImportContainer importcontainer)

DataImportControl

GetDataImportControl(
  DataImportComponentObject datimpobj,
  AttributeObjectDef attrdefforcontrol,
  optional integer bulksize,
  optional String namesuffix,
  optional ContentObject predefinedimportsource,
  out ContentObject importsource,
  out retval DataImportControl importcontrol)

ObjectClass

GetDataImportDataSourceClass(
  out retval ObjectClass targetclass)

dictionary

GetDataImportKeyDictionary(
  object[] objects,
  ObjectClass[] classes,
  ref retval dictionary keydict)

dictionary

GetDataImportParameters(
  DataImportComponentObject importdefinition,
  DataImportControl importctrl,
  optional object appconfig,
  optional object[] availablerooms,
  optional object importcontext,
  ref retval dictionary importparams,
  optional DataImportContainer importcontainer)

object[]

GetDeletionChildren(
  out retval object[] deletionchildren)

Group[]

GetDependingGroups(
  optional boolean includesubgroups,
  optional boolean includerelatedgroups,
  optional boolean includedependingorgs,
  optional boolean includedependingextorgs,
  ref retval Group[] dependinggroups,
  optional boolean includedeleted,
  optional boolean includedependingdefaultextorg)

User[]

GetGroupMembers(
  out retval User[] members,
  optional boolean includesubgroups)

User[]

GetGroupUsersWithAdminRights(
  boolean includeadmins,
  boolean includepaymentuser,
  out retval User[] groupadmins,
  optional boolean skipbackrounduser)

User[]

GetHeadManager(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] manager)

string

GetLoginEMailAddress(
  out retval string logemail,
  optional string[] lognames,
  optional boolean checkaccess)

Group[]

GetManageableReleaseLocations(
  AttributeDefinition accessattribute,
  optional Group[] organizationalelements,
  out retval Group[] releaselocations)

User[]

GetManager(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] manager)

Group

GetMasterGroup(
  out retval Group group,
  optional boolean considerversion)

Group

GetMasterGroupCached(
  out retval Group group)

Group

GetMasterGroupCheckCache(
  optional boolean usecache,
  out retval Group group)

OrganizationalUnit

GetOrganizationalUnitByLevel(
  OrgUnitType level,
  out retval OrganizationalUnit orgunit)

OrganizationalUnit

GetOrganizationalUnitByPosition(
  Position position,
  Position actingposition,
  boolean usevacantpositions,
  out retval OrganizationalUnit orgunit)

OrgWastebasket

GetOrganizationWastebasket(
  boolean create,
  out retval OrgWastebasket wb)

User[]

GetOrgEMailRecipients(
  out retval User[] recipients)

OrganizationalUnitType[]

GetOrgUnitTypes(
  out retval OrganizationalUnitType[] unittypes)

string

GetPositionCompanyKey(
  out retval string companykey)

OrganizationalPosition

GetPrimaryPosition(
  Group organization,
  out retval OrganizationalPosition primaryposition)

User[]

GetStaffManager(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] manager)

OrganizationalUnitType[]

GetValidOrgUnitTypes(
  out retval OrganizationalUnitType[] orgunittypes,
  optional boolean objiscontainer)

void

GetVirusInfoText(
  optional object context,
  optional string virusdetail,
  optional boolean isoverview,
  out string text1,
  out string text2,
  out string text3,
  out string text4)

void

HandleInfectedObject(
  optional integer unused1,
  optional integer unused2)

void

ImportOrgStructureCSV(
  optional integer unused1,
  optional integer unused2)

void

ImportOrgStructureCSVSelected(
  optional integer unused1,
  optional integer unused2)

boolean

IsDataImportUsable(
  DataImportComponentObject datimpobj,
  out retval boolean isusable)

boolean

IsOpUserValid(
  User opuser,
  out retval boolean isvalid)

boolean

IsOrgPosUserAllowed(
  User user,
  out retval boolean allowed)

boolean

IsReleaseLocationRestrictedToObjectGroup(
  out retval boolean isrestricted)

void

MoveOrganizationalPosition(
  optional integer unused1,
  optional integer unused2)

void

MoveOrganizationalPositionSelected(
  optional integer unused1,
  optional integer unused2)

void

MoveOrganizationalUnit(
  optional integer unused1,
  optional integer unused2)

void

MoveOrganizationalUnitSelected(
  optional integer unused1,
  optional integer unused2)

void

OpenOrgWastebasket(
  optional integer unused1,
  optional integer unused2)

void

OpenScSourceObject()

dictionary

PrepareCleanDataImportDataSource(
  ref retval dictionary paramdict,
  out optional string errortext)

void

RestoreOrgWastebasketObjects(
  optional integer unused1,
  optional integer unused2)

void

RestoreOrgWastebasketObjectsSelected(
  optional integer unused1,
  optional integer unused2)

object[]

RestrictOrgElementsToContextMasterGroup(
  AttributeDefinition patternattrdef,
  string pattern,
  AttributeDefinition targetattrdef,
  CheckAllowedMode targetmode,
  integer objectlimit,
  optional QueryScope userscope,
  out retval object[] hits,
  out QuickSearchActionMessage message)

object[]

RestrictOrgUsersGroupsToContextMasterGroup(
  AttributeDefinition patternattrdef,
  string pattern,
  AttributeDefinition targetattrdef,
  CheckAllowedMode targetmode,
  integer objectlimit,
  optional QueryScope userscope,
  out retval object[] hits,
  out QuickSearchActionMessage message)

void

SearchOrgVirus(
  optional integer unused1,
  optional integer unused2)

void

SetOrganizationalPositionName(
  boolean force,
  optional object[] attrlist)

void

ShowAccountActivity(
  optional integer unused1,
  optional integer unused2)

void

ShowGroupAccountActivity(
  optional integer unused1,
  optional integer unused2)

void

ShowGroupAccountActivitySelected(
  optional integer unused1,
  optional integer unused2)

void

ShowOrganizationalChart(
  optional integer unused1,
  optional integer unused2)

void

ShowUserAccountActivity(
  optional integer unused1,
  optional integer unused2)

void

ShowUserAccountActivitySelected(
  optional integer unused1,
  optional integer unused2)

void

UpdateManagedTemplateCollections(
  TemplateCollection[] collections,
  boolean add,
  object[] templates)


FSCORGMGMT@1.1001:AttrGrAdministrationsGet Permanent link for this heading

void FSCORGMGMT@1.1001:AttrGrAdministrationsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCORGMGMT@1.1001:AttrGrAdministrationsUIFilter Permanent link for this heading

object[] FSCORGMGMT@1.1001:AttrGrAdministrationsUIFilter(
  ref retval object[] objects,
  AttributeDefinition attrdef)

Name

Description

objects

attrdef

Additional Information


FSCORGMGMT@1.1001:AttrGrPaymentUserSet Permanent link for this heading

Set action called when changing the payment user

void FSCORGMGMT@1.1001:AttrGrPaymentUserSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCORGMGMT@1.1001:CalcSessionInfos Permanent link for this heading

UserSessionInfo[] FSCORGMGMT@1.1001:CalcSessionInfos(
  optional boolean interactive,
  optional Group[] masterorgs,
  out retval UserSessionInfo[] sessioninfos)

Name

Description

interactive

masterorgs

sessioninfos

Additional Information


FSCORGMGMT@1.1001:CalcUserWorkGroups Permanent link for this heading

Calculate all work groups of the user

WorkGroup[] FSCORGMGMT@1.1001:CalcUserWorkGroups(
  out retval WorkGroup[] workgroups)

Name

Description

workgroups

all work groups

Additional Information


FSCORGMGMT@1.1001:CanManageRoles Permanent link for this heading

Helper to check if the current user can change the roles of a given user resp. can change the organizational structure

boolean FSCORGMGMT@1.1001:CanManageRoles(
  Group orgcontext,
  optional User user,
  optional boolean checkastargetuser,
  out retval boolean canmanage)

Name

Description

orgcontext

the organizational context

user

the user context

checkastargetuser

canmanage

the result

Additional Information


FSCORGMGMT@1.1001:CanManageUser Permanent link for this heading

Helper to check if the user on which the action is called is allowed to manage the user supplied as parameter

boolean FSCORGMGMT@1.1001:CanManageUser(
  User user,
  optional boolean donotcheckrole,
  out retval boolean canmanage,
  out Group[] managingorgs,
  optional boolean personalinformations,
  optional AttributeDefinition[] policies)

Name

Description

user

the user which should be managed

donotcheckrole

canmanage

the result

managingorgs

the organizations that manage the user

personalinformations

the users of the organization who can view personal informations (e.g Compliance-Managers)

policies

Additional Information


FSCORGMGMT@1.1001:ChangeDefaultHolidayTable Permanent link for this heading

Menu usecase to change the default holiday table

void FSCORGMGMT@1.1001:ChangeDefaultHolidayTable(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ChangeDefaultHolidayTableSelected Permanent link for this heading

void FSCORGMGMT@1.1001:ChangeDefaultHolidayTableSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:CheckAdminRole Permanent link for this heading

Checks whether the current user has one the specified positions and orgunittypes in his current role

boolean FSCORGMGMT@1.1001:CheckAdminRole(
  object[] objs,
  out retval boolean valid,
  optional boolean checkallroles)

Name

Description

objs

list of positions and orgunittypes

valid

true if the current user has one the specified positions and orgunittypes in his current role

checkallroles

if set to true all available roles are checked for the current user

Additional Information


FSCORGMGMT@1.1001:CreateHolidayTable Permanent link for this heading

Menu usecase for creating a holiday table

void FSCORGMGMT@1.1001:CreateHolidayTable(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:CreateOrganizationalPosition Permanent link for this heading

Menu usecase to create an organizational position from the group dashboard

void FSCORGMGMT@1.1001:CreateOrganizationalPosition(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:CreateOrganizationalUnit Permanent link for this heading

Menu usecase to create an organizational unit from the group dashboard

void FSCORGMGMT@1.1001:CreateOrganizationalUnit(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:CreateStructuralChange Permanent link for this heading

Action to create a structual change

StructuralChange FSCORGMGMT@1.1001:CreateStructuralChange(
  dictionary params,
  out retval StructuralChange structchange)

Name

Description

params

the attributes of the object are filled with the values of the parameters dictionary

structchange

the result

Additional Information


FSCORGMGMT@1.1001:CreateUser Permanent link for this heading

Creates a new contact with the specified e-mail address and returns the created contact in the user parameter. If a contact with this e-mail address exists already the existing contact is returned.

Note: To check if a new contact has been created, use the cootx.IsCreated(user) statement.

User FSCORGMGMT@1.1001:CreateUser(
  string email,
  optional string firstname,
  optional string surname,
  optional string middleinitial,
  optional Country country,
  optional Language language,
  out retval User user,
  optional string externalkey,
  optional Group organization,
  optional boolean sendinvitationmail)

Name

Description

email

the e-mail address of the new contact

firstname

the first name of the new contact

surname

the surname of the new contact

middleinitial

the middle name of the new contact

country

the country of the new contact

language

the communication language of the new contact

user

the created contact

externalkey

the external key of the user

organization

the organization of which the user should become a member resp. external member

sendinvitationmail

send invitation mail

Additional Information


FSCORGMGMT@1.1001:DeleteOrganizationalUnit Permanent link for this heading

Delete organizational unit and all subordinated objects (positions and subordinated organizational units)

void FSCORGMGMT@1.1001:DeleteOrganizationalUnit()

Additional Information


FSCORGMGMT@1.1001:DeleteOrgWastebasketObjects Permanent link for this heading

Delete objects in the organization wastebasket

void FSCORGMGMT@1.1001:DeleteOrgWastebasketObjects(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:DeleteOrgWastebasketObjectsSelected Permanent link for this heading

void FSCORGMGMT@1.1001:DeleteOrgWastebasketObjectsSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:DuplicateHolidayTable Permanent link for this heading

Menu usecase for duplicating a holiday table

void FSCORGMGMT@1.1001:DuplicateHolidayTable(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:DuplicateHolidayTableSelected Permanent link for this heading

void FSCORGMGMT@1.1001:DuplicateHolidayTableSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:EditOrgUnitHierarchySettings Permanent link for this heading

Menu usecase to create an organizational unit from the group dashboard

void FSCORGMGMT@1.1001:EditOrgUnitHierarchySettings(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:EmptyOrgWastebasket Permanent link for this heading

Context menu usecase to empty an organization wastebasket

void FSCORGMGMT@1.1001:EmptyOrgWastebasket(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:FilerDataImportClearEmpty Permanent link for this heading

void FSCORGMGMT@1.1001:FilerDataImportClearEmpty(
  DataImportComponentObject datimpobj,
  dictionary values)

Name

Description

datimpobj

values

Additional Information


FSCORGMGMT@1.1001:FillSettingsOverviewPostWrapper Permanent link for this heading

void FSCORGMGMT@1.1001:FillSettingsOverviewPostWrapper(
  ref InfoList[] infolist,
  object[] prerequfailed,
  object[] prerequfailedopt)

Name

Description

infolist

prerequfailed

prerequfailedopt

Additional Information


FSCORGMGMT@1.1001:FilterDataImportExpr Permanent link for this heading

This action can be called in the filter actions of a cold loader to handle the data rows

void FSCORGMGMT@1.1001:FilterDataImportExpr(
  DataImportComponentObject datimpobj,
  AttributeDefinition attrdef,
  ref dictionary params)

Name

Description

datimpobj

the cold object

attrdef

the filter attribute definition

params

the global scope of the filter

Additional Information


FSCORGMGMT@1.1001:FindOrgElementByExternalKey Permanent link for this heading

Action to find an organizational element based on the external key

object FSCORGMGMT@1.1001:FindOrgElementByExternalKey(
  string externalkey,
  ObjectClass class,
  optional Group owngroup,
  out retval object element)

Name

Description

externalkey

the external key

class

the target class

owngroup

the owning organization

element

the found element

Additional Information


FSCORGMGMT@1.1001:FindUser Permanent link for this heading

Locate a user by use of a search pattern

User FSCORGMGMT@1.1001:FindUser(
  string searchpattern,
  optional Group needmembership,
  out retval User user)

Name

Description

searchpattern

the pattern can be an object address or an email

needmembership

the found user will require a membership for this organization

user

the result.

Additional Information


FSCORGMGMT@1.1001:GetAllManagers Permanent link for this heading

User[] FSCORGMGMT@1.1001:GetAllManagers(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

Name

Description

positionstoskip

orgunitstoskip

allmanagers

Additional Information


FSCORGMGMT@1.1001:GetAllManagersTopDown Permanent link for this heading

User[] FSCORGMGMT@1.1001:GetAllManagersTopDown(
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

Name

Description

orgunitstoskip

allmanagers

Additional Information


FSCORGMGMT@1.1001:GetAllOrganizationManagers Permanent link for this heading

Get all managers of an user in the target organization

User[] FSCORGMGMT@1.1001:GetAllOrganizationManagers(
  Group organization,
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

Name

Description

organization

the target organization

positionstoskip

positions which should be skipped in calculation

orgunitstoskip

organizational units which should be skipped in calculation

allmanagers

the managers

Additional Information


FSCORGMGMT@1.1001:GetAssignedEdition Permanent link for this heading

This action returns the currently assigned edtion of an user

AppPackage FSCORGMGMT@1.1001:GetAssignedEdition(
  out retval AppPackage assignededition)

Name

Description

assignededition

the assigned edition

Additional Information


FSCORGMGMT@1.1001:GetDataImport Permanent link for this heading

Retrieve the correct data import object for a specific import usecase

DataImportComponentObject FSCORGMGMT@1.1001:GetDataImport(
  ComponentObject context,
  out retval DataImportComponentObject datimpobj,
  ref ComponentContentObject template,
  ref string exportfilename)

Name

Description

context

describes the import usecase

datimpobj

the data import object

template

the template object with a sample content which can be used for the import

exportfilename

the file name used when the template is exported

Additional Information


FSCORGMGMT@1.1001:GetDataImportContainer Permanent link for this heading

Returns the ContactImportContainer used as container to import.

DataImportContainer FSCORGMGMT@1.1001:GetDataImportContainer(
  AttributeObjectDef attrdef,
  boolean create,
  boolean share,
  boolean reset,
  optional object context,
  out retval DataImportContainer importcontainer)

Name

Description

attrdef

create

share

reset

context

importcontainer

Additional Information


FSCORGMGMT@1.1001:GetDataImportControl Permanent link for this heading

Retrieve the Import Control to perform a CSV Import

DataImportControl FSCORGMGMT@1.1001:GetDataImportControl(
  DataImportComponentObject datimpobj,
  AttributeObjectDef attrdefforcontrol,
  optional integer bulksize,
  optional String namesuffix,
  optional ContentObject predefinedimportsource,
  out ContentObject importsource,
  out retval DataImportControl importcontrol)

Name

Description

datimpobj

the data import object

attrdefforcontrol

the attribute definition where the import control should be stored

bulksize

the record amount when the commit should be triggered

namesuffix

the suffix of the name of the import control

predefinedimportsource

the content is copied to the importsource

importsource

the content object with the import source linked to the import control

importcontrol

the import control

Additional Information


FSCORGMGMT@1.1001:GetDataImportDataSourceClass Permanent link for this heading

Retrieve the object class for the datasource

ObjectClass FSCORGMGMT@1.1001:GetDataImportDataSourceClass(
  out retval ObjectClass targetclass)

Name

Description

targetclass

Additional Information


FSCORGMGMT@1.1001:GetDataImportKeyDictionary Permanent link for this heading

Generate a dictionary for with the external key of the objects as key and the address as value

dictionary FSCORGMGMT@1.1001:GetDataImportKeyDictionary(
  object[] objects,
  ObjectClass[] classes,
  ref retval dictionary keydict)

Name

Description

objects

the objects

classes

the objects are restricted to this classes

keydict

the result

Additional Information


FSCORGMGMT@1.1001:GetDataImportParameters Permanent link for this heading

dictionary FSCORGMGMT@1.1001:GetDataImportParameters(
  DataImportComponentObject importdefinition,
  DataImportControl importctrl,
  optional object appconfig,
  optional object[] availablerooms,
  optional object importcontext,
  ref retval dictionary importparams,
  optional DataImportContainer importcontainer)

Name

Description

importdefinition

importctrl

appconfig

availablerooms

importcontext

importparams

importcontainer

Additional Information


FSCORGMGMT@1.1001:GetDeletionChildren Permanent link for this heading

Get children objects, which are deleted on ojbect deletion

object[] FSCORGMGMT@1.1001:GetDeletionChildren(
  out retval object[] deletionchildren)

Name

Description

deletionchildren

the children objects

Additional Information


FSCORGMGMT@1.1001:GetDependingGroups Permanent link for this heading

Get a list of depending groups

Group[] FSCORGMGMT@1.1001:GetDependingGroups(
  optional boolean includesubgroups,
  optional boolean includerelatedgroups,
  optional boolean includedependingorgs,
  optional boolean includedependingextorgs,
  ref retval Group[] dependinggroups,
  optional boolean includedeleted,
  optional boolean includedependingdefaultextorg)

Name

Description

includesubgroups

if true subgroups will be included

includerelatedgroups

if true related groups (e.g. teams) will be included

includedependingorgs

if true depending groups (e.g. managed organizations) will be included

includedependingextorgs

if true external organizations will be included the default external organization will also be part of the result

dependinggroups

result list of depending groups

includedeleted

if true deleted organizational elements will be included

includedependingdefaultextorg

if true the default external organization will be included even if the parameter includedependingextorgs is set to false

Additional Information


FSCORGMGMT@1.1001:GetGroupMembers Permanent link for this heading

Retrieve the group members

User[] FSCORGMGMT@1.1001:GetGroupMembers(
  out retval User[] members,
  optional boolean includesubgroups)

Name

Description

members

includesubgroups

include the members of subordinated groups

Additional Information


FSCORGMGMT@1.1001:GetGroupUsersWithAdminRights Permanent link for this heading

Gets the owners (objowner, objsecsecurity) of the organization

User[] FSCORGMGMT@1.1001:GetGroupUsersWithAdminRights(
  boolean includeadmins,
  boolean includepaymentuser,
  out retval User[] groupadmins,
  optional boolean skipbackrounduser)

Name

Description

includeadmins

also include administrators (objsecchange) of the organization

includepaymentuser

also include payment user (grpaymentuser) of the organization

groupadmins

the administrators of the organization

skipbackrounduser

the background user is not returned

Additional Information


FSCORGMGMT@1.1001:GetHeadManager Permanent link for this heading

User[] FSCORGMGMT@1.1001:GetHeadManager(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] manager)

Name

Description

positionstoskip

orgunitstoskip

manager

Additional Information


FSCORGMGMT@1.1001:GetLoginEMailAddress Permanent link for this heading

This action returns the email address currently used by a user to login (Cloud Edition only)

string FSCORGMGMT@1.1001:GetLoginEMailAddress(
  out retval string logemail,
  optional string[] lognames,
  optional boolean checkaccess)

Name

Description

logemail

the email address used to login

lognames

if supplied these names are used instead of userlogname

checkaccess

the action checks access permissions before accessing the attributes

Additional Information


FSCORGMGMT@1.1001:GetManageableReleaseLocations Permanent link for this heading

Check if the current user is allowed to release objects like workflow diagrams or user forms to these targets

Group[] FSCORGMGMT@1.1001:GetManageableReleaseLocations(
  AttributeDefinition accessattribute,
  optional Group[] organizationalelements,
  out retval Group[] releaselocations)

Name

Description

accessattribute

the attribute definition for which the user needs access persmissions to change it

organizationalelements

the organizational elements to check

releaselocations

the result

Additional Information


FSCORGMGMT@1.1001:GetManager Permanent link for this heading

User[] FSCORGMGMT@1.1001:GetManager(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] manager)

Name

Description

positionstoskip

orgunitstoskip

manager

Additional Information


FSCORGMGMT@1.1001:GetMasterGroup Permanent link for this heading

Retrieve the owning group of an object

Group FSCORGMGMT@1.1001:GetMasterGroup(
  out retval Group group,
  optional boolean considerversion)

Name

Description

group

the owning group

considerversion

if the current object is in time travel, the group will returned in the same version

Additional Information


FSCORGMGMT@1.1001:GetMasterGroupCached Permanent link for this heading

Retrieve the master group of an object. Note.: This action calls GetMasterGroup but just once

Group FSCORGMGMT@1.1001:GetMasterGroupCached(
  out retval Group group)

Name

Description

group

the group

Additional Information


FSCORGMGMT@1.1001:GetMasterGroupCheckCache Permanent link for this heading

Retrieve the master group of an object. Note.: This action calls GetMasterGroup but just once

Group FSCORGMGMT@1.1001:GetMasterGroupCheckCache(
  optional boolean usecache,
  out retval Group group)

Name

Description

usecache

if set to true an the current object was not created the in the current transaction the mastergroup is evaluated by calling GetMasterGroupCached. Otherwise the mastergroup is evaluated by calling FSCORMGMT@1.1001:GetMasterGroup

group

the group

Additional Information


FSCORGMGMT@1.1001:GetOrganizationalUnitByLevel Permanent link for this heading

Calculate an organizational unit matching at least the required level following the hierarchy upwards starting at the current object

OrganizationalUnit FSCORGMGMT@1.1001:GetOrganizationalUnitByLevel(
  OrgUnitType level,
  out retval OrganizationalUnit orgunit)

Name

Description

level

the required level

orgunit

the first organizational unit matching the required level

Additional Information


FSCORGMGMT@1.1001:GetOrganizationalUnitByPosition Permanent link for this heading

Calculate an organizational unit matching which has an organizational position with the supplied position. The organizational unit is searched the hierarchy upwards starting at the current object.

OrganizationalUnit FSCORGMGMT@1.1001:GetOrganizationalUnitByPosition(
  Position position,
  Position actingposition,
  boolean usevacantpositions,
  out retval OrganizationalUnit orgunit)

Name

Description

position

the type of the organizational position

actingposition

the position of the current participant acting

usevacantpositions

if set organizational positions with no defined user are included

orgunit

the first organizational unit matching the required position

Additional Information


FSCORGMGMT@1.1001:GetOrganizationWastebasket Permanent link for this heading

Get the organization wastebasket

OrgWastebasket FSCORGMGMT@1.1001:GetOrganizationWastebasket(
  boolean create,
  out retval OrgWastebasket wb)

Name

Description

create

create if not exist

wb

the wastebasket

Additional Information


FSCORGMGMT@1.1001:GetOrgEMailRecipients Permanent link for this heading

Calculates the recipients for emails to organization administrators.

User[] FSCORGMGMT@1.1001:GetOrgEMailRecipients(
  out retval User[] recipients)

Name

Description

recipients

the recipients

Additional Information


FSCORGMGMT@1.1001:GetOrgUnitTypes Permanent link for this heading

OrganizationalUnitType[] FSCORGMGMT@1.1001:GetOrgUnitTypes(
  out retval OrganizationalUnitType[] unittypes)

Name

Description

unittypes

Additional Information


FSCORGMGMT@1.1001:GetPositionCompanyKey Permanent link for this heading

string FSCORGMGMT@1.1001:GetPositionCompanyKey(
  out retval string companykey)

Name

Description

companykey

Additional Information


FSCORGMGMT@1.1001:GetPrimaryPosition Permanent link for this heading

OrganizationalPosition FSCORGMGMT@1.1001:GetPrimaryPosition(
  Group organization,
  out retval OrganizationalPosition primaryposition)

Name

Description

organization

primaryposition

Additional Information


FSCORGMGMT@1.1001:GetStaffManager Permanent link for this heading

User[] FSCORGMGMT@1.1001:GetStaffManager(
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] manager)

Name

Description

positionstoskip

orgunitstoskip

manager

Additional Information


FSCORGMGMT@1.1001:GetValidOrgUnitTypes Permanent link for this heading

Get the valid organization unit types within the current container

OrganizationalUnitType[] FSCORGMGMT@1.1001:GetValidOrgUnitTypes(
  out retval OrganizationalUnitType[] orgunittypes,
  optional boolean objiscontainer)

Name

Description

orgunittypes

the organizational unit types

objiscontainer

consider the current object as container

Additional Information


FSCORGMGMT@1.1001:GetVirusInfoText Permanent link for this heading

This action is called on the room of the object to generate the text for the virus overview

void FSCORGMGMT@1.1001:GetVirusInfoText(
  optional object context,
  optional string virusdetail,
  optional boolean isoverview,
  out string text1,
  out string text2,
  out string text3,
  out string text4)

Name

Description

context

the object containing the virus

virusdetail

the detail information about the virus

isoverview

true if the text is calculated for the PDF overview

text1

The first paragraph

text2

the second paragraph

text3

the third paragraph

text4

the fourth paragraph

Additional Information


FSCORGMGMT@1.1001:HandleInfectedObject Permanent link for this heading

Menu to handle infected objects

void FSCORGMGMT@1.1001:HandleInfectedObject(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ImportOrgStructureCSV Permanent link for this heading

Usecase to import members of an organization

void FSCORGMGMT@1.1001:ImportOrgStructureCSV(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ImportOrgStructureCSVSelected Permanent link for this heading

void FSCORGMGMT@1.1001:ImportOrgStructureCSVSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:IsDataImportUsable Permanent link for this heading

Action to decide if the dataimport is usable for the target in the context of the current user

boolean FSCORGMGMT@1.1001:IsDataImportUsable(
  DataImportComponentObject datimpobj,
  out retval boolean isusable)

Name

Description

datimpobj

the dataimport

isusable

the result

Additional Information


FSCORGMGMT@1.1001:IsOpUserValid Permanent link for this heading

boolean FSCORGMGMT@1.1001:IsOpUserValid(
  User opuser,
  out retval boolean isvalid)

Name

Description

opuser

isvalid

Additional Information


FSCORGMGMT@1.1001:IsOrgPosUserAllowed Permanent link for this heading

boolean FSCORGMGMT@1.1001:IsOrgPosUserAllowed(
  User user,
  out retval boolean allowed)

Name

Description

user

allowed

Additional Information


FSCORGMGMT@1.1001:IsReleaseLocationRestrictedToObjectGroup Permanent link for this heading

Check if the release location is restricted to the group of the object

boolean FSCORGMGMT@1.1001:IsReleaseLocationRestrictedToObjectGroup(
  out retval boolean isrestricted)

Name

Description

isrestricted

Additional Information


FSCORGMGMT@1.1001:MoveOrganizationalPosition Permanent link for this heading

Menu to move the organizational position within the organizational structure

void FSCORGMGMT@1.1001:MoveOrganizationalPosition(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:MoveOrganizationalPositionSelected Permanent link for this heading

void FSCORGMGMT@1.1001:MoveOrganizationalPositionSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:MoveOrganizationalUnit Permanent link for this heading

Menu to move the organizational unit within the organizational structure

void FSCORGMGMT@1.1001:MoveOrganizationalUnit(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:MoveOrganizationalUnitSelected Permanent link for this heading

void FSCORGMGMT@1.1001:MoveOrganizationalUnitSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:OpenOrgWastebasket Permanent link for this heading

Opens the organizations wastebasket

void FSCORGMGMT@1.1001:OpenOrgWastebasket(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:OpenScSourceObject Permanent link for this heading

Open the source objects attributes

void FSCORGMGMT@1.1001:OpenScSourceObject()

Additional Information


FSCORGMGMT@1.1001:PrepareCleanDataImportDataSource Permanent link for this heading

dictionary FSCORGMGMT@1.1001:PrepareCleanDataImportDataSource(
  ref retval dictionary paramdict,
  out optional string errortext)

Name

Description

paramdict

errortext

Additional Information


FSCORGMGMT@1.1001:RestoreOrgWastebasketObjects Permanent link for this heading

Menu usecase to restore objects from the organization wastebasket

void FSCORGMGMT@1.1001:RestoreOrgWastebasketObjects(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:RestoreOrgWastebasketObjectsSelected Permanent link for this heading

void FSCORGMGMT@1.1001:RestoreOrgWastebasketObjectsSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:RestrictOrgElementsToContextMasterGroup Permanent link for this heading

Quicksearch action for organizational elements related to the contexts mastergroup

object[] FSCORGMGMT@1.1001:RestrictOrgElementsToContextMasterGroup(
  AttributeDefinition patternattrdef,
  string pattern,
  AttributeDefinition targetattrdef,
  CheckAllowedMode targetmode,
  integer objectlimit,
  optional QueryScope userscope,
  out retval object[] hits,
  out QuickSearchActionMessage message)

Name

Description

patternattrdef

pattern

targetattrdef

targetmode

objectlimit

userscope

hits

message

Additional Information


FSCORGMGMT@1.1001:RestrictOrgUsersGroupsToContextMasterGroup Permanent link for this heading

Action called when a quick search for users or groups is performed. The pattern is used for searching groups or users having such a name

object[] FSCORGMGMT@1.1001:RestrictOrgUsersGroupsToContextMasterGroup(
  AttributeDefinition patternattrdef,
  string pattern,
  AttributeDefinition targetattrdef,
  CheckAllowedMode targetmode,
  integer objectlimit,
  optional QueryScope userscope,
  out retval object[] hits,
  out QuickSearchActionMessage message)

Name

Description

patternattrdef

pattern

targetattrdef

targetmode

objectlimit

userscope

hits

message

Additional Information


FSCORGMGMT@1.1001:SearchOrgVirus Permanent link for this heading

Menu to search for infected documents manually

void FSCORGMGMT@1.1001:SearchOrgVirus(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:SetOrganizationalPositionName Permanent link for this heading

void FSCORGMGMT@1.1001:SetOrganizationalPositionName(
  boolean force,
  optional object[] attrlist)

Name

Description

force

attrlist

Additional Information


FSCORGMGMT@1.1001:ShowAccountActivity Permanent link for this heading

Usecase to show and download all account activities of a user

void FSCORGMGMT@1.1001:ShowAccountActivity(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ShowGroupAccountActivity Permanent link for this heading

Usecase to show and download all account activities of all users managed by the organization

void FSCORGMGMT@1.1001:ShowGroupAccountActivity(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ShowGroupAccountActivitySelected Permanent link for this heading

void FSCORGMGMT@1.1001:ShowGroupAccountActivitySelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ShowOrganizationalChart Permanent link for this heading

Menu usecase to create an organizational unit from the group dashboard

void FSCORGMGMT@1.1001:ShowOrganizationalChart(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ShowUserAccountActivity Permanent link for this heading

Usecase to show and download all account activities of a user

void FSCORGMGMT@1.1001:ShowUserAccountActivity(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:ShowUserAccountActivitySelected Permanent link for this heading

void FSCORGMGMT@1.1001:ShowUserAccountActivitySelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCORGMGMT@1.1001:UpdateManagedTemplateCollections Permanent link for this heading

void FSCORGMGMT@1.1001:UpdateManagedTemplateCollections(
  TemplateCollection[] collections,
  boolean add,
  object[] templates)

Name

Description

collections

add

templates

Additional Information