Codeunit WSB_BRGFileFactBoxPublishers¶
Exposes event publishers to hook into events raised by file changes that occur via the Bridge app file factbox.
Properties¶
| Name | Value |
|---|---|
| Access | Public |
Methods¶
wgEvpOnAfterDeleteFile¶
Allows to hook into the moment after a file has been deleted via the file factbox in the Bridge app.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_BRGFile" temporary |
vRecTempWSB_BRGFile |
The temporary file record. |
wgEvpOnAfterDownloadFile¶
Allows to hook into the moment after a file has been downloaded via the file factbox in the Bridge app.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_BRGFile" temporary |
vRecTempWSB_BRGFile |
The temporary file record. |
wgEvpOnAfterGetFileCategoryRecords¶
Allows to hook into the moment after file categories have been retrieved for a certain record to display them in the Bridge app.
Parameters¶
| Type | Name | Description |
|---|---|---|
RecordId |
pRecordId |
The record ID of the record to retrieve the files for. |
Record "WSB_BRGFileCategory" temporary |
vRecTempWSB_BRGFileCategory |
The temporary file category record set. |
wgEvpOnAfterGetFileRecords¶
Allows to hook into the moment after files have been retrieved for a certain record to display them in the Bridge app.
Parameters¶
| Type | Name | Description |
|---|---|---|
RecordId |
pRecordId |
The record ID of the record to retrieve the files for. |
Record "WSB_BRGFile" temporary |
vRecTempWSB_BRGFile |
The temporary file record set. |
wgEvpOnAfterUploadFile¶
Allows to hook into the moment after a file has been uploaded via the file factbox in the Bridge app.
Parameters¶
| Type | Name | Description |
|---|---|---|
RecordId |
pSourceTableRecordID |
The record ID of the source table. |
Text |
pBase64Data |
The file contents as Base 64 string. |
Text |
pFileName |
The name of the file. |
Text |
pFileExt |
The file extension of the file. |
DateTime |
pCurrentDateTime |
The date time at which the file was uploaded. |
Text |
pMessageFrom |
From whom the email message is from. The parameter only has a value when the file is an .msg file uploaded via the drag and drop control add-in. |
DateTime |
pMessageDateTime |
the date and time that the email message was sent. The parameter only has a value when the file is an .msg file uploaded via the drag and drop control add-in. |
Code[20] |
pCategoryCode |
The code of the (selected) file category. |
wgEvpOnDeleteFile¶
Allows the Document Archive extension to implement the logic to delete the file from the remote file storage location.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_BRGFile" temporary |
vRecTempWSB_BRGFile |
The temporary file record. |
wgEvpOnDownloadFile¶
Allows the Document Archive extension to implement the logic to download the file from the remote file storage location.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "WSB_BRGFile" temporary |
vRecTempWSB_BRGFile |
The temporary file record. |
wgEvpOnGetFileCategoryRecords¶
Allows the Document Archive extension to implement the logic to get the file category records for a certain (source table) record.
Parameters¶
| Type | Name | Description |
|---|---|---|
RecordId |
pRecordId |
The record ID of the record to retrieve the files for. |
Record "WSB_BRGFileCategory" temporary |
vRecTempWSB_BRGFileCategory |
The temporary file category record set. |
wgEvpOnGetFileRecords¶
Allows the Document Archive extension to implement the logic to get the file records for a certain (source table) record.
Parameters¶
| Type | Name | Description |
|---|---|---|
RecordId |
pRecordId |
The record ID of the record to retrieve the files for. |
Record "WSB_BRGFile" temporary |
vRecTempWSB_BRGFile |
The temporary file record set. |
wgEvpOnGetPrimaryValues¶
Allows one to support additional source record types that Document Archive files can be linked.
Parameters¶
| Type | Name | Description |
|---|---|---|
RecordRef |
pRecRef |
The source record as RecordRef. |
Integer |
vSourceType |
The type of the source record (if applicable). |
Code[20] |
vSourceNo |
The no. of the source record (if applicable). |
Code[20] |
vSourceSubNo |
The sub no. of the source record (if applicable). |
Integer |
vSourceNoOccurrence |
The occurrence of the no. of the source record (if applicable). |
Integer |
vSourceVersionNo |
The version no. of the source record (if applicable). |
Integer |
vSourceLineNo |
The line no. of the source record (if applicable). |
Boolean |
vIsHandled |
Set this to true if your extension handles setting the source link field values for the record type specified in the RecordRef. |
wgEvpOnShouldShowFactBox¶
Allows the Document Archive extension to implement the logic that determines whether a factbox type is visible.
Parameters¶
| Type | Name | Description |
|---|---|---|
Enum "WSB_BRGFactBoxType" |
pFactBoxType |
The factbox type. |
Boolean |
vResult |
A boolean that is set to true by the Document Archive extension if the factbox type is to be shown. |
wgEvpOnUploadFile¶
Allows the Document Archive extension to implement the logic to upload the file to the remote file storage location.
Parameters¶
| Type | Name | Description |
|---|---|---|
RecordId |
pSourceTableRecordID |
The record ID of the source table. |
Text |
pBase64Data |
The file contents as Base 64 string. |
Text |
pFileName |
The name of the file. |
Text |
pFileExt |
The file extension of the file. |
DateTime |
pCurrentDateTime |
The date time at which the file was uploaded. |
Text |
pMessageFrom |
From whom the email message is from. The parameter only has a value when the file is an .msg file uploaded via the drag and drop control add-in. |
DateTime |
pMessageDateTime |
the date and time that the email message was sent. The parameter only has a value when the file is an .msg file uploaded via the drag and drop control add-in. |
Code[20] |
pCategoryCode |
The code of the (selected) file category. |