Codeunit WSB_DCASetup¶
Exposes procedures related to the Document Archive setup.
Properties¶
| Name | Value |
|---|---|
| Access | Public |
Methods¶
wgFncAddRequiredOAuth2Scopes¶
Adds the required OAuth2.0 scopes for a Document Archive File Handler type to an OAuth2.0 Application.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_OAuth2Application" |
pRecWSB_OAuth2Application |
The OAuth2.0 Application for which to add the scopes. |
Interface "WSB_IDCAFileHandler" |
pIFileHandler |
The File Handler type. |
wgFncGetDefaultOAuth2Application¶
Retrieves the default OAuth 2.0 Application for a Document Archive File Handler type.
Parameters¶
| Type | Name | Description |
|---|---|---|
Enum "WSB_DCAFileHandler" |
pFileHandler |
The File Handler type. |
Record "WSB_OAuth2Application" |
vRecWSB_OAuth2Application |
The OAuth 2.0 Application record that will hold the result. |
wgFncGetSetup¶
Retrieves the Document Archive Setup record for the current company.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCASetup" |
vRecWSB_DCASetup |
The setup record. |
wgFncInitFileHandlerSetup¶
Initializes the File Handler Setup for the specified file handler.
Parameters¶
| Type | Name | Description |
|---|---|---|
Enum "WSB_DCAFileHandler" |
pFileHandler |
The file handler type. |
wgFncInitSetup¶
Initializes the Document Archive Setup record for the current company.
wgFncIsRemoteFolderOrderEnabled¶
Gets whether the remote folder order setting applies/is relevant for the currently set-up remote folder structure.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCASetup" |
pRecWSB_DCASetup |
The setup. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true iff the remote folder order setting is in use. |
wgFncMoveRemoteFilesToSetupRemoteFolderStructure¶
Move all remote files to follow the default settings in the setup.
wgFncOpenFileHandlerSetupPage¶
Opens the setup page for the currently configured Document Archive File Handler.
wgFncShowFactBox¶
Retrieves whether the factbox page with the specified object ID should be shown.
Parameters¶
| Type | Name | Description |
|---|---|---|
Text |
pPageObjectID |
The object ID of the page. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true if the page should be shown. |
wgFncShowFactBox¶
Retrieves whether the factbox of a specified type should be shown.
Parameters¶
| Type | Name | Description |
|---|---|---|
Enum "WSB_DCAFactBoxType" |
pFactBoxType |
The type of factbox. |
Returns¶
| Type | Description |
|---|---|
Boolean |
System.Xml.XmlElement |
wlEvpOnAfterInitFileHandlerSetup¶
Allows to hook into the initialization of the file handler setup.
Parameters¶
| Type | Name | Description |
|---|---|---|
Enum "WSB_DCAFileHandler" |
pFileHandler |
The file handler type. |
wlEvpOnBeforeIsRemoteFolderOrderEnabled¶
Allows to hook into determining whether the remote folder order setting is in use.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCASetup" |
pRecWSB_DCASetup |
The setup. |
Boolean |
vResult |
Whether the remote folder order setting is in use. |
Boolean |
vIsHandled |
Set this to true if your extension handles determining. |
wlEvpOnBeforeShowFactBox¶
Allows to hook into determining whether the factbox of specified type should be shown on pages.
Parameters¶
| Type | Name | Description |
|---|---|---|
Enum "WSB_DCAFactBoxType" |
pFactBoxType |
The factbox type. |
Boolean |
vHandled |
Set this to true if your extension handles determining this. |
Boolean |
vResult |
Whether factboxes of this type should be shown. |
wlEvpOnBeforeValidateRemoteFolderOrder¶
Allows to hook into validating the "Remote Folder Order" setting.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCASetup" |
pRecWSB_DCASetup |
The new setup values. |
Record "WSB_DCASetup" |
pxRecWSB_DCASetup |
The previous setup values. |
Boolean |
vIsHandled |
Set this to true if your extension handles the validation. |
wlEvpOnBeforeValidateRemoteFolderStructure¶
Allows to hook into validating the "Remote Folder Structure" setting.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCASetup" |
vRecWSB_DCASetup |
The new setup values. |
Record "WSB_DCASetup" |
pxRecWSB_DCASetup |
The previous setup values. |
Boolean |
vIsHandled |
Set this to true if your extension handles the validation. |