Codeunit WSB_DCATransferFileMgt
Exposes procedures for transferring files from one record to another (N.B. without making actual copies).
Properties
Methods
wgFncEditTransferFileSettingsFilters(WSB_DCATransferFileSettings@, Option):Boolean
Edit the source or target filters for a transfer file settings record.
Parameters
| Type |
Name |
Description |
| `` |
vRecWSB_DCATransferFileSettings |
The entity definition |
Returns
| Type |
Description |
| `` |
true iff the filters were edited successfully. |
wgFncGetAllowedTargetsForSource(Enum::WSB_DCATransferFileSource, List[WSB_DCATransferFileTarget]@)
Gets the targets that are allowed for a source.
Parameters
| Type |
Name |
Description |
Enum "WSB_DCATransferFileSource" |
pSource |
The source. |
List |
vAllowedTargets |
The allowed targets in a list. |
wgFncGetTransferFileSettingsFiltersText(WSB_DCATransferFileSettings@, Option):Text
Gets the transfer file settings' filters as a readable text.
Parameters
| Type |
Name |
Description |
| `` |
vRecWSB_DCATransferFileSettings |
The transfer file settings record. |
Returns
| Type |
Description |
| `` |
The filters as a readable text. |
wgFncGetTransferFileSettingsFilterView(WSB_DCATransferFileSettings@, Option):Text
Gets the transfer file settings record's filter view.
Parameters
| Type |
Name |
Description |
| `` |
vRecWSB_DCATransferFileSettings |
The transfer file settings record. |
Returns
| Type |
Description |
| `` |
The filter view. |
wgFncLookupTransferFileTargets(Boolean, Enum::WSB_DCATransferFileSource, WSB_DCATransferTargetLookup@):Boolean
Opens the "Transfer Target Lookup" page to select transfer targets for a transfer source. If the user clicks on "OK" to close the page, the selected transfer targets will be returned.
Parameters
| Type |
Name |
Description |
Boolean |
pAllowMultiselect |
Whether to allow multi-select. |
Enum "WSB_DCATransferFileSource" |
pSource |
The source to select targets for. |
Record "WSB_DCATransferTargetLookup" temporary |
vRecTempWSB_DCATransferTargetLookup |
The selected transfer target(s). |
Returns
| Type |
Description |
Boolean |
true iff the user entity definition(s) and pressed "OK". |
wgFncRemoveTransferredFiles(Variant, Variant):Boolean
Removes all files that were earlier transferred from one record to another record.
Parameters
| Type |
Name |
Description |
Variant |
pSourceRecRelatedVariant |
The record where the Document Archive Files were copied from. |
Variant |
pTargetRecRelatedVariant |
The record where the Document Archive Files were copied to, and from which they will be unlinked. |
Returns
| Type |
Description |
Boolean |
true iff successfully unlinked/removed the transferred files. |
wgFncSetTransferFileSettingsFilterView(WSB_DCATransferFileSettings@, Option, Text):Boolean
Set the filter view for a transfer file settings record.
Parameters
| Type |
Name |
Description |
Record "WSB_DCATransferFileSettings" |
vRecWSB_DCATransferFileSettings |
The transfer file settings record. |
Option |
pType |
The type of filter (source or target). |
Text |
pNewTableViewAsText |
The table filter view as text |
Returns
| Type |
Description |
Boolean |
true iff applying the view was successful. |
wgFncTransferFiles(Variant, Variant):Boolean
Transfers all Document Archive files attached to one record to another record.
Parameters
| Type |
Name |
Description |
Variant |
pSourceRecRelatedVariant |
The record to copy the Document Archive Files from. |
Variant |
pTargetRecRelatedVariant |
The record to copy the Document Archive Files to. |
Returns
| Type |
Description |
Boolean |
true iff successfully transferred the files. |
wgFncTransferFiles(Variant, Variant, Boolean):Boolean
Transfers all Document Archive files attached to one record to another record.
Parameters
| Type |
Name |
Description |
Variant |
pSourceRecRelatedVariant |
The record to copy the Document Archive Files from. |
Variant |
pTargetRecRelatedVariant |
The record to copy the Document Archive Files to. |
Boolean |
pFollowTransferSettings |
Whether to follow the Transfer File Settings. |
Returns
| Type |
Description |
Boolean |
true iff successfully transferred the files. |
wlEvpOnAfterGetAllowedTargetsForSource(Enum::WSB_DCATransferFileSource, List[WSB_DCATransferFileTarget]@)
Allows to hook into getting the targets that are allowed for a source.
Parameters
| Type |
Name |
Description |
Enum "WSB_DCATransferFileSource" |
pSource |
The source. |
List |
vAllowedTargets |
The allowed targets for the source. |
wlEvpOnAfterGetSourceRecordForProdOrderLine(Prod# Order Line, Variant@, Boolean@)
Allows to hook into getting the source record to possibly transfer Document Archive files from.
Parameters
| Type |
Name |
Description |
Record "Prod. Order Line" |
pRecProdOrderLine |
The production order header record. |
Variant |
vSourceRecordVariant |
The source record for the production order line. |
Boolean |
vSuccess |
Set this to true if your extension successfully found a source record with Document Archive files to transfer files from. |
wlEvpOnAfterGetSourceRecordForProductionBOMLine(Production BOM Line, Variant@, Boolean@)
Allows to hook into getting the source record to possibly transfer Document Archive files from.
Parameters
| Type |
Name |
Description |
Record "Production BOM Line" |
pRecProductionBOMLine |
The production BOM line record. |
Variant |
vSourceRecordVariant |
The source record for the production BOM line. |
Boolean |
vSuccess |
Set this to true if your extension successfully found a source record with Document Archive files to transfer files from. |
wlEvpOnAfterGetSourceRecordForProductionOrder(Production Order, Variant@, Boolean@)
Allows to hook into getting the source record to possibly transfer Document Archive files from.
Parameters
| Type |
Name |
Description |
Record "Production Order" |
pRecProductionOrder |
The production order header record. |
Variant |
vSourceRecordVariant |
The source record for the production order header. |
Boolean |
vSuccess |
Set this to true if your extension successfully found a source record with Document Archive files to transfer files from. |
wlEvpOnAfterGetSourceRecordForPurchaseLine(Purchase Line, Variant@, Boolean@)
Allows to hook into getting the source record to possibly transfer Document Archive files from.
Parameters
| Type |
Name |
Description |
Record "Purchase Line" |
pRecPurchLine |
The purchase line record. |
Variant |
vSourceRecordVariant |
The source record for the purchase line. |
Boolean |
vSuccess |
Set this to true if your extension successfully found a source record with Document Archive files to transfer files from. |
wlEvpOnAfterGetSourceRecordForSalesLine(Sales Line, Variant@, Boolean@)
Allows to hook into getting the source record to possibly transfer Document Archive files from.
Parameters
| Type |
Name |
Description |
Record "Sales Line" |
pRecSalesLine |
The sales line record. |
Variant |
vSourceRecordVariant |
The source record for the sales line. |
Boolean |
vSuccess |
Set this to true if your extension successfully found a source record with Document Archive files to transfer files from. |
wlEvpOnAfterGetTransferFileSourceForTable(Integer, Enum::WSB_DCATransferFileSource@, Boolean@)
Allows to hook into getting the transfer file source for a table ID.
Parameters
| Type |
Name |
Description |
Integer |
pTableNo |
The ID of the table to get the transfer file source for. |
Enum "WSB_DCATransferFileSource" |
vTransferFileSource |
The transfer file source. |
Boolean |
vFound |
Set this to true if your extension found a transfer file source type for the table with this ID. |
wlEvpOnAfterGetTransferFileSourceTableNo(Enum::WSB_DCATransferFileSource, Integer@)
Allows to hook into getting the table ID for a transfer file source.
Parameters
| Type |
Name |
Description |
Enum "WSB_DCATransferFileSource" |
pTransferFileSource |
The transfer file source (enum). |
Integer |
vTableNo |
The corresponding table ID. |
wlEvpOnAfterGetTransferFileTargetForTable(Integer, Enum::WSB_DCATransferFileTarget@, Boolean@)
Allows to hook into getting the transfer file target for a table ID.
Parameters
| Type |
Name |
Description |
Integer |
pTableNo |
The ID of the table to get the transfer file target for. |
Enum "WSB_DCATransferFileTarget" |
vTransferFileTarget |
The transfer file target. |
Boolean |
vFound |
Set this to true if your extension found a transfer file target type for the table with this ID. |
wlEvpOnAfterGetTransferFileTargetTableNo(Enum::WSB_DCATransferFileTarget, Integer@)
Allows to hook into getting the table ID for a transfer file target.
Parameters
| Type |
Name |
Description |
Enum "WSB_DCATransferFileTarget" |
pTransferFileTarget |
The transfer file target (enum). |
Integer |
vTableNo |
The corresponding table ID. |
wlEvpOnAfterTransferFiles(Variant, Variant, Boolean, Boolean@, Boolean@)
Allows to hook into the moment right after files are transferred from a source to target record.
Parameters
| Type |
Name |
Description |
Variant |
pSourceRecRelatedVariant |
The source record. |
Variant |
pTargetRecRelatedVariant |
The target record. |
Boolean |
pFollowTransferSettings |
Whether to follow the transfer settings configuration. |
Boolean |
vSuccess |
Whether transferring files was performed successfully. |
Boolean |
vIsHandled |
Set this to true if your extension handles transferring files for this record-type combination. |
wlEvpOnBeforeRemoveTransferredFiles(Variant, Variant, Boolean@, Boolean@)
Allows to hook into removing linked transferred files from a record.
Parameters
| Type |
Name |
Description |
Variant |
pSourceRecRelatedVariant |
The source record. |
Variant |
pTargetRecRelatedVariant |
The target record. |
Boolean |
vSuccess |
Whether the files were removed successfully. |
Boolean |
vIsHandled |
Set this to true if your extension handles removing the linked transferred files for this record-type combination. |
wlEvpOnBeforeTransferFiles(Variant, Variant, Boolean, Boolean@, Boolean@)
Allows to hook into the moment right before files are transferred from a source to target record.
Parameters
| Type |
Name |
Description |
Variant |
pSourceRecRelatedVariant |
The source record. |
Variant |
pTargetRecRelatedVariant |
The target record. |
Boolean |
pFollowSetup |
Whether to follow the transfer settings configuration. |
Boolean |
vSuccess |
Whether transferring files was performed successfully. |
Boolean |
vIsHandled |
Set this to true if your extension handles transferring files for this record-type combination. |