Namespace: Consultingwerk.SmartFramework.Authorization
Class 
FormAuthorizationBusinessTask Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessTask
Consultingwerk.SmartFramework.Authorization.FormAuthorizationBusinessTask

Inherits: Consultingwerk.OERA.BusinessTask
Implements: Consultingwerk.OERA.IBusinessService, ISupportsRestMethods


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddContainerElements (handle, handle, character, character, character, character, integer) Adds the elements of the given container Object Master to the ttFormAuthorizationElement temp-table
AddFieldGroupItems () Adds the field groups referenced by the field security items of the form to the ttFormAuthorizationItem temp-table
AddFieldItems (handle, handle) Adds the fields of the viewer and grid elements to the ttFormAuthorizationItem temp-table
AddPages (handle) Adds the tab pages of the tab folder elements to the ttFormAuthorizationPage temp-table
AddToolbarItems (handle) Adds the toolbar items of the toolbar elements to the ttFormAuthorizationItem temp-table
CreateFieldItem (character, character, character, integer) Creates a ttFormAuthorizationItem record for a field of a viewer or grid and resolves the SmartFieldSecurityItem record when it exists
CreateItem (character, character, character, character, character, character, character, character, character, logical, integer) Creates a ttFormAuthorizationItem record
CreateToolbarItem (character, character, character, integer) Creates a ttFormAuthorizationItem record for a toolbar item and resolves the SmartToolbarSecurityItem record when it exists
LOGICAL CreateWildcardFieldItem (character, character, character, integer) Creates a ttFormAuthorizationItem record for the wildcard field security item matching a field of a viewer or grid, when such a security item exists
GetAuthorization (dataset, FormAuthorizationParameter) Returns the dsAuthorizationMaintenance Dataset with the current authorization assignment for the given security realm, the given list of security items and the given list of users/groups
CHARACTER GetElementType (character) Returns the element type of the given repository object type
GetFormStructure (dataset, GetFormStructureParameter) Returns the structural data of the given repository based form required by the Form Authorization Maintenance
CHARACTER GetInstanceAttribute (handle, character, character, character) Returns the value of a design time attribute of the given object instance
CHARACTER GetItemRowKey (character, character, character, character) Returns the unique row key of a ttFormAuthorizationItem record
Consultingwerk.SmartFramework.Authorization.IAuthorizationMaintenanceHelper GetMaintenanceHelper () Returns the reference to the IAuthorizationMaintenanceHelper implementation
CHARACTER GetObjectTypeName (handle, character) Returns the object type name of the given object instance
Consultingwerk.SmartFramework.Repository.ISmartRepositoryService GetRepositoryService () Returns the reference to the ISmartRepositoryService implementation
CHARACTER GetToolbarTableIOTargets (handle, character) Returns the security keys of the TableIO targets of the given toolbar element
CHARACTER GetTypeIconKey (character) Returns the type icon key of the given repository object type
LoadToolbarButtonDefinitions () Loads the toolbar button definition JSON files referenced by the WindowsToolbarButtonDefinitions and Web2ToolbarButtonDefinitions configuration entries
CHARACTER ResolveToolbarItemKey (character) Resolves the effective tool key of a toolbar button id
StoreAuthorization (dataset, FormAuthorizationParameter) Stores the security assignment based on the dsAuthorizationMaintenance Dataset for the given security realm and the given list of users/groups
StoreFieldSecurityItems (dataset, GetFormStructureParameter) Creates the missing SmartFieldSecurityItem records for the fields of the given repository based form and returns the refreshed structural data
StorePageSecurityTokens (dataset, GetFormStructureParameter) Stores the security tokens of the tab pages of the given repository based form and returns the refreshed structural data
StoreToolbarSecurityItems (dataset, GetFormStructureParameter) Creates the missing SmartToolbarSecurityItem records for the toolbar items of the given repository based form and returns the refreshed structural data
CHARACTER VerifyParameter (FormAuthorizationParameter) Returns the GUID of the security realm of the given Parameter Object and verifies the Parameter Object


Method Detail
Top

AddContainerElements (handle, handle, character, character, character, character, integer)
Purpose: Adds the elements of the given container Object Master to the
ttFormAuthorizationElement temp-table
Notes: Recurses into the MetaControlGroup instances of the container up to
the maximum element level. The method works on a dedicated dynamic
buffer, so that the query of the recursion does not detach the query
of the caller from the eSmartObjectInstance buffer

Parameters:
phData HANDLE
The handle of the repository data ProDataset
phTypeMap HANDLE
The handle of the _InstanceTypeMap buffer, may be an invalid handle
pcContainerObjectMasterGuid CHARACTER
The GUID of the Object Master of the container to add the elements for
pcContainerObjectName CHARACTER
The name of the Object Master of the container to add the elements for
pcParentElementGuid CHARACTER
The ElementGuid of the parent element
pcQualifiedPrefix CHARACTER
The prefix for the QualifiedInstanceName of the elements, empty on the form level
piElementLevel INTEGER
The nesting level of the elements to add
Top

AddFieldGroupItems ()
Purpose: Adds the field groups referenced by the field security items of the
form to the ttFormAuthorizationItem temp-table
Notes: Only field security items that already exist can reference a field
group

Top

AddFieldItems (handle, handle)
Purpose: Adds the fields of the viewer and grid elements to the
ttFormAuthorizationItem temp-table
Notes: The fields of a viewer or grid are the object instances of its Object
Master that carry a FieldName attribute. Those instances are part of
the repository data ProDataset, because MetaViewer and MetaGrid are
container object types

Parameters:
phData HANDLE
The handle of the repository data ProDataset
phTypeMap HANDLE
The handle of the _InstanceTypeMap buffer, may be an invalid handle
Top

AddPages (handle)
Purpose: Adds the tab pages of the tab folder elements to the
ttFormAuthorizationPage temp-table
Notes: A page belongs to the tab folder element whose container Object Master
and TabGroup attribute match the page. Pages that carry a security
token also produce a security item of the SST realm

Parameters:
phData HANDLE
The handle of the repository data ProDataset
Top

AddToolbarItems (handle)
Purpose: Adds the toolbar items of the toolbar elements to the
ttFormAuthorizationItem temp-table
Notes: The tool keys are resolved from the ToolbarButtonsBase and
ToolbarButtons attributes of the toolbar instance, in the same way the
DefaultToolbarRenderer resolves them at rendering time

Parameters:
phData HANDLE
The handle of the repository data ProDataset
Top

CreateFieldItem (character, character, character, integer)
Purpose: Creates a ttFormAuthorizationItem record for a field of a viewer or
grid and resolves the SmartFieldSecurityItem record when it exists
Notes: The security item is looked up by the field name and the security key
of the viewer or grid first and by the field name alone afterwards, in
the same way the SmartFieldAuthorizationProvider resolves it at runtime

Parameters:
pcElementGuid CHARACTER
The ElementGuid of the viewer or grid element
pcFieldName CHARACTER
The qualified name (Table.Field) of the field
pcSecurityKey CHARACTER
The security key of the viewer or grid element
piSequence INTEGER
The sequence of the field within the viewer or grid element
Top

CreateItem (character, character, character, character, character, character, character, character, character, logical, integer)
Purpose: Creates a ttFormAuthorizationItem record
Notes: Leaves the created record available, so that the caller can assign the
item type specific fields

Parameters:
pcElementGuid CHARACTER
The ElementGuid of the element the security item belongs to
pcPageGuid CHARACTER
The PageGuid of the tab page the security item belongs to, may be empty
pcItemType CHARACTER
The item type, one of the values of the FormAuthorizationItemType class
pcItemKey CHARACTER
The key of the security item within its element
pcItemObjectName CHARACTER
The object name scope of the security item, e.g. the security key of the TableIO target of a toolbar item, may be empty
pcItemLabel CHARACTER
The label of the security item
pcItemDescription CHARACTER
The description of the security item
pcSecurityItemGuid CHARACTER
The GUID of the security item record, empty when the security item does not exist yet
pcSecurityRealmCodes CHARACTER
The comma-delimited list of the codes of the security realms the item participates in
plItemExists LOGICAL
Logical value indicating if the security item record exists
piSequence INTEGER
The sequence of the security item within its element
Top

CreateToolbarItem (character, character, character, integer)
Purpose: Creates a ttFormAuthorizationItem record for a toolbar item and
resolves the SmartToolbarSecurityItem record when it exists
Notes: The security item is looked up by the given object name scope and the
toolbar item key first and by the toolbar item key alone afterwards, in
the same way the AuthorizationClient resolves it at runtime. When only
a global security item exists, the item is registered with the empty
object name - the label of an item carries its effective scope, so
that scoped and global items are distinguishable in the maintenance

Parameters:
pcElementGuid CHARACTER
The ElementGuid of the toolbar element
pcObjectName CHARACTER
The object name scope of the toolbar item - the security key of the TableIO target for TableIO tools, the name of the container otherwise
pcToolbarItemKey CHARACTER
The key of the toolbar item
piSequence INTEGER
The sequence of the toolbar item within the toolbar element
Top

LOGICAL CreateWildcardFieldItem (character, character, character, integer)
Purpose: Creates a ttFormAuthorizationItem record for the wildcard field
security item matching a field of a viewer or grid, when such a
security item exists
Notes: The runtime checks the abbreviated "*.<field>" name after the exact
field name (see SmartFieldAuthorizationProvider:IsFieldRestricted).
Wildcard security items cannot be created or removed from the Form
Authorization Maintenance - a record is only added for an existing
security item, so that its assignment can be maintained. The security
item is looked up by the security key of the viewer or grid element
first and without a security key afterwards, like the exact field name

Parameters:
pcElementGuid CHARACTER
The ElementGuid of the viewer or grid element
pcFieldName CHARACTER
The qualified name (Table.Field) of the field
pcSecurityKey CHARACTER
The security key of the viewer or grid element
piSequence INTEGER
The sequence of the wildcard item within the viewer or grid element
Returns LOGICAL
Logical value indicating if a wildcard security item exists and has been added
Top

GetAuthorization (dataset, FormAuthorizationParameter)
Purpose: Returns the dsAuthorizationMaintenance Dataset with the current
authorization assignment for the given security realm, the given list
of security items and the given list of users/groups
Notes: Unlike AuthorizationMaintenanceService:GetAuthorization this method is
limited to an explicit list of security items - the security items of
a single repository based form.
Currently a maximum of 20 entries in the OwnerGuids list is supported.
The OwnerGuids list may contain the SecurityAssignmentOwner:EVERYBODY
pseudo owner key addressing the Default (Everybody) security
assignments (records with neither the UserGuid nor the GroupGuid set)

Parameters:
dsAuthorizationMaintenance DATASET dsAuthorizationMaintenance
INPUT-OUTPUT DATASET with the resulting authorization assignments
poParameter Consultingwerk.SmartFramework.Authorization.FormAuthorizationParameter
The FormAuthorizationParameter with the parameters for this call
Top

CHARACTER GetElementType (character)
Purpose: Returns the element type of the given repository object type
Notes: Sub-types of the meta object types are classified like their parent
object type

Parameters:
pcObjectTypeName CHARACTER
The name of the repository object type
Returns CHARACTER
The element type, one of the values of the FormAuthorizationElementType class
Top

GetFormStructure (dataset, GetFormStructureParameter)
Purpose: Returns the structural data of the given repository based form
required by the Form Authorization Maintenance
Notes: Returns the tab folder instances with their tab pages (matched by
the TabGroup attribute of the tab folder instance), the toolbar
instances with their resolved tool keys, the viewer and grid
instances with their bound fields, the referenced field groups and
the security items that already exist for those elements.
MetaControlGroup instances and nested MetaControlGroup instances are
resolved recursively

Parameters:
dsFormAuthorizationStructure DATASET dsFormAuthorizationStructure
INPUT-OUTPUT DATASET with the structural data of the form
poParameter Consultingwerk.SmartFramework.Authorization.GetFormStructureParameter
The GetFormStructureParameter with the parameters for this call
Top

CHARACTER GetInstanceAttribute (handle, character, character, character)
Purpose: Returns the value of a design time attribute of the given object
instance
Notes: The attribute values of the object instances are provided in one buffer
per repository object type, added to the repository data ProDataset by
the SmartRepositoryService

Parameters:
phData HANDLE
The handle of the repository data ProDataset
pcObjectTypeName CHARACTER
The name of the repository object type of the object instance
pcObjectInstanceGuid CHARACTER
The GUID of the object instance
pcAttributeName CHARACTER
The technical name of the attribute
Returns CHARACTER
The value of the attribute or the empty value when the attribute is not available
Top

CHARACTER GetItemRowKey (character, character, character, character)
Purpose: Returns the unique row key of a ttFormAuthorizationItem record
Notes:

Parameters:
pcElementGuid CHARACTER
The ElementGuid of the element the security item belongs to
pcItemType CHARACTER
The item type, one of the values of the FormAuthorizationItemType class
pcItemKey CHARACTER
The key of the security item within its element
pcItemObjectName CHARACTER
The object name scope of the security item, may be empty
Returns CHARACTER
The unique row key of the ttFormAuthorizationItem record
Top

Consultingwerk.SmartFramework.Authorization.IAuthorizationMaintenanceHelper GetMaintenanceHelper ()
Purpose: Returns the reference to the IAuthorizationMaintenanceHelper
implementation
Notes:

Returns Consultingwerk.SmartFramework.Authorization.IAuthorizationMaintenanceHelper
The reference to the IAuthorizationMaintenanceHelper implementation
Top

CHARACTER GetObjectTypeName (handle, character)
Purpose: Returns the object type name of the given object instance
Notes: The _InstanceTypeMap temp-table is added to the repository data
ProDataset by the SmartRepositoryService

Parameters:
phTypeMap HANDLE
The handle of the _InstanceTypeMap buffer, may be an invalid handle
pcObjectInstanceGuid CHARACTER
The GUID of the object instance
Returns CHARACTER
The name of the repository object type or the empty value
Top

Consultingwerk.SmartFramework.Repository.ISmartRepositoryService GetRepositoryService ()
Purpose: Returns the reference to the ISmartRepositoryService implementation
Notes:

Returns Consultingwerk.SmartFramework.Repository.ISmartRepositoryService
The reference to the ISmartRepositoryService implementation
Top

CHARACTER GetToolbarTableIOTargets (handle, character)
Purpose: Returns the security keys of the TableIO targets of the given toolbar
element
Notes: The TableIO targets are the viewer and grid elements the toolbar is
connected to through TableIO links - the objects whose security key
the runtime verifies the TableIO tools of the toolbar with

Parameters:
phData HANDLE
The handle of the repository data ProDataset
pcElementGuid CHARACTER
The ElementGuid of the toolbar element
Returns CHARACTER
The comma-delimited list of the security keys of the TableIO targets
Top

CHARACTER GetTypeIconKey (character)
Purpose: Returns the type icon key of the given repository object type
Notes: The TypeIcon fields of the repository temp-tables are calculated
fields that only the ObjectMasterBusinessEntity fills - the repository
data returned by FetchRepositoryObject does not carry them, so the
icon key is resolved from the object type name through the same
ITypeIconProvider the ObjectMasterBusinessEntity uses

Parameters:
pcObjectTypeName CHARACTER
The name of the repository object type
Returns CHARACTER
The type icon key of the object type or the empty value
Top

LoadToolbarButtonDefinitions ()
Purpose: Loads the toolbar button definition JSON files referenced by the
WindowsToolbarButtonDefinitions and Web2ToolbarButtonDefinitions
configuration entries
Notes: Mirrors the initialization of the SmartToolbarControllerRenderer. The
Web2 definitions are loaded after the Windows definitions, so that on
PAS for OpenEdge - where the Windows entries may not be configured -
the tool keys can still be resolved. Definition files that are not
available in the running environment are skipped

Top

CHARACTER ResolveToolbarItemKey (character)
Purpose: Resolves the effective tool key of a toolbar button id
Notes: The entries of the ToolbarButtonsBase and ToolbarButtons attributes are
button ids of the toolbar button definition JSON files. The effective
tool key is the buttonName of the definition when present and the id
itself otherwise - e.g. the id "add" resolves to the tool key
"TableIOAdd" (see the RibbonRenderer). Separators and ids without a
definition are not rendered as tools and resolve to the empty value.
When no definition files are available at all, the id is returned
unchanged as the best effort

Parameters:
pcButtonId CHARACTER
The button id from the toolbar instance attributes
Returns CHARACTER
The effective tool key or the empty value when the id does not render a tool
Top

StoreAuthorization (dataset, FormAuthorizationParameter)
Purpose: Stores the security assignment based on the dsAuthorizationMaintenance
Dataset for the given security realm and the given list of users/groups
Notes: Creates or updates the SmartSecurityAssignment record when the
Restricted entry of the owner is TRUE or FALSE and deletes the record
when the entry is the unknown value (Default).
The security items are taken from the records of the ProDataset, the
SecurityItemGuids of the Parameter Object are not evaluated here

Parameters:
dsAuthorizationMaintenance DATASET dsAuthorizationMaintenance
INPUT-OUTPUT DATASET with the authorization to store
poParameter Consultingwerk.SmartFramework.Authorization.FormAuthorizationParameter
The FormAuthorizationParameter with the parameters for this call
Top

StoreFieldSecurityItems (dataset, GetFormStructureParameter)
Purpose: Creates the missing SmartFieldSecurityItem records for the fields of
the given repository based form and returns the refreshed structural
data
Notes: A SmartFieldSecurityItem is created for every FIELD record of the
ProDataset whose ItemExists flag is set although it references no
security item record yet. The item is created with the field name as
the FieldName and the security key of the viewer or grid element as
the SecurityKey - the key the ViewerRenderer and GridRenderer verify
the fields with at rendering time. Existing security items are never
deleted here. Afterwards the structural data is rebuilt
(GetFormStructure), so that the response carries the GUIDs of the
created security items

Parameters:
dsFormAuthorizationStructure DATASET dsFormAuthorizationStructure
INPUT-OUTPUT DATASET with the fields to create the security items of, refreshed on output
poParameter Consultingwerk.SmartFramework.Authorization.GetFormStructureParameter
The GetFormStructureParameter with the parameters for this call
Top

StorePageSecurityTokens (dataset, GetFormStructureParameter)
Purpose: Stores the security tokens of the tab pages of the given repository
based form and returns the refreshed structural data
Notes: Applies the SecurityToken values of the ttFormAuthorizationPage records
of the ProDataset to the eSmartPage records of the repository - the
token of a page is updated when it differs from the stored value.
Afterwards the structural data is rebuilt (GetFormStructure), so that
the response carries the security items of the newly assigned tokens
and their resolved SecurityTokenGuid values

Parameters:
dsFormAuthorizationStructure DATASET dsFormAuthorizationStructure
INPUT-OUTPUT DATASET with the tab pages to store the security tokens of, refreshed on output
poParameter Consultingwerk.SmartFramework.Authorization.GetFormStructureParameter
The GetFormStructureParameter with the parameters for this call
Top

StoreToolbarSecurityItems (dataset, GetFormStructureParameter)
Purpose: Creates the missing SmartToolbarSecurityItem records for the toolbar
items of the given repository based form and returns the refreshed
structural data
Notes: A SmartToolbarSecurityItem is created for every TOOLBARITEM record of
the ProDataset whose ItemExists flag is set although it references no
security item record yet. The item is created with the object name
scope of the record as the ObjectName - the security key of the
TableIO target for TableIO tools and the name of the container the
toolbar is placed on otherwise - and the resolved tool key as the
ToolbarItemKey. Existing security items are never deleted here.
Afterwards the structural data is rebuilt (GetFormStructure), so that
the response carries the GUIDs of the created security items

Parameters:
dsFormAuthorizationStructure DATASET dsFormAuthorizationStructure
INPUT-OUTPUT DATASET with the toolbar items to create the security items of, refreshed on output
poParameter Consultingwerk.SmartFramework.Authorization.GetFormStructureParameter
The GetFormStructureParameter with the parameters for this call
Top

CHARACTER VerifyParameter (FormAuthorizationParameter)
Purpose: Returns the GUID of the security realm of the given Parameter Object
and verifies the Parameter Object
Notes: When the SecurityRealmGuid is not provided, the GUID is resolved from
the SecurityRealmCode

Parameters:
poParameter Consultingwerk.SmartFramework.Authorization.FormAuthorizationParameter
The FormAuthorizationParameter to verify
Returns CHARACTER
The GUID of the security realm


ProDataset Detail

ProDataset dsAuthorizationMaintenance

Member tables: ttAuthorizationMaintenance

ProDataset dsFormAuthorizationStructure

Member tables: ttFormAuthorizationElement, ttFormAuthorizationPage, ttFormAuthorizationItem


Temp-Table Detail

Temp-Table ttAuthorizationMaintenance

Defined in:

Temp-Table ttFormAuthorizationElement

Defined in:

Temp-Table ttFormAuthorizationItem

Defined in:

Temp-Table ttFormAuthorizationPage

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.08.2026 06:00:36