Codeunit WSB_DCAEntitiesFolderStructure¶
Implements the entities folder structure.
Properties¶
| Name | Value |
|---|---|
| Access | Public |
Methods¶
wgFncGetDocumentTypeTxt¶
Obsolete
WSB_DCAFile parameter will be replaced by WSB_DCARemoteFile parameter in a future update (or when DCASetup FileStructureV2Enabled is set) 1.58.0
Retrieve a descriptive text for known documents.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCAFile" |
pRecWSB_DCAFile |
The file record to get a descriptive name for its source record. |
Boolean |
pPlural |
Whether to use the plural form. |
Text |
vDocumentTypeText |
The descriptive document name that was found. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true iff a matching name was found for the known document. |
wgFncGetDocumentTypeTxt¶
Retrieve a descriptive text for known documents.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCARemoteFile" |
pRecWSB_DCARemoteFile |
The file record to get a descriptive name for its source record. |
Boolean |
pPlural |
Whether to use the plural form. |
Text |
vDocumentTypeText |
The descriptive document name that was found. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true iff a matching name was found for the known document. |
wgFncGetRemoteFolderPath¶
Retrieves the remote folder path for a file record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCARemoteFile" |
pRecWSB_DCARemoteFile |
The file record. |
Returns¶
| Type | Description |
|---|---|
Text |
The remote folder path. |
wgFncGetSourceIdentifier¶
Gets an identifier for a file record's source record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCARemoteFile" |
pRecWSB_DCARemoteFile |
The file record to get an identifier for its source record. |
Boolean |
pIsKnownDocumentType |
Set this to true to skip the "Document Type" from the identifier text. |
Returns¶
| Type | Description |
|---|---|
Text |
The identifier as a text. |
wgFncSetRemoteFilePath¶
Sets the remote file path for a file record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCARemoteFile" |
vRecWSB_DCARemoteFile |
The file record. |
wlEvpOnAfterGetDocumentTypeTxt¶
Obsolete
This publisher will be replaced by wlEvpOnAfterGetDocumentTypeTxtV2 in a future update (or when DCASetup FileStructureV2Enabled is set) 1.58.0
Allows to hook into getting a document type text (e.g., "Sales Order") to use in PDF file names.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCAFile" |
pRecWSB_DCAFile |
The file record. |
Text |
vDocumentTypeText |
The document type text to use for that file record. |
Boolean |
vIsSupportedTable |
Whether it is a supported table to get a document type text for. |
Boolean |
vIsHandled |
Whether this type is handled by an extension. |
wlEvpOnAfterGetDocumentTypeTxtV2¶
Allows to hook into getting a document type text (e.g., "Sales Order") to use in PDF file names.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCARemoteFile" |
pRecWSB_DCARemoteFile |
The file record. |
Text |
vDocumentTypeText |
The document type text to use for that file record. |
Boolean |
vIsSupportedTable |
Whether it is a supported table to get a document type text for. |
wlEvpOnAfterGetSourceIdentifier¶
Obsolete
This publisher will be replaced by wlEvpOnAfterGetSourceIdentifierV2 in a future update (or when DCASetup FileStructureV2Enabled is set) 1.58.0
Allows to hook into getting a source identifier text to use in PDF file names (e.g., the archive sales order no. + occurence + version no.).
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCAFile" |
pRecWSB_DCAFile |
The file record. |
Text |
vSourceIdentifier |
The source identifier text for that file record. |
wlEvpOnAfterGetSourceIdentifierV2¶
Allows to hook into getting a source identifier text to use in PDF file names (e.g., the archive sales order no. + occurence + version no.).
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCARemoteFile" |
pRecWSB_DCARemoteFile |
The file record. |
Text |
vSourceIdentifier |
The source identifier text for that file record. |
wlEvpOnBeforeGetRemoteFolderPath¶
Obsolete
This publisher will be replaced by wlEvpOnBeforeGetRemoteFolderPathV2 in a future update (or when DCASetup FileStructureV2Enabled is set) 1.58.0
Allows to hook into getting the remote folder path for a file record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCAFile" |
pRecWSB_DCAFile |
The file record. |
Text |
vFolderPath |
The result folder path for that file record. |
Boolean |
vIsHandled |
Set this to true if your extension handles getting the remote folder path for this file record. |
wlEvpOnBeforeGetRemoteFolderPathV2¶
Allows to hook into getting the remote folder path for a file record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCARemoteFile" |
pRecWSB_DCARemoteFile |
The file record. |
Text |
vFolderPath |
The result folder path for that file record. |
Boolean |
vIsHandled |
Set this to true if your extension handles getting the remote folder path for this file record. |
wlEvpOnBeforeHandleFileAlreadyExistingOnRemote¶
Obsolete
This publisher will be replaced by wlEvpOnBeforeHandleFileAlreadyExistingOnRemoteV2 in a future update (or when DCASetup FileStructureV2Enabled is set) 1.58.0
Allows to hook into how to handle a remote file conflict.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_DCAFile" |
vRecWSB_DCAFile |
The file record. |
Record "WSB_DCAFile" |
pRecWSB_DCAFileExisting |
The file record for the conflicting file. |
Text |
vFileActionStrMenuOptions |
The StrMenu options to present to the user. |
Option |
vDefaultFileAction |
The default action to apply. |
Text |
vFileAlreadyExistsQst |
The question to display to the user. |
Boolean |
vIsHandled |
Set this to true if your extension handles this remote file conflict. |