Document Creator

2.82.0 (2024-04-23)¶

Fix: Do not throw an error during license check if the Document Creator Setup has Enabled set to false.
Resolve bug with nested custom data items in the Dataset Extensions feature.

2.80.0 (2024-04-15)¶

Import Design - Confirm Mismatching Report IDs¶

The Import Design action (on the Report Layouts/Document Creator User-Defined Report Layouts page) now checks if the ID of the report object of the design file matches with the ID of the report object for the target layout record into which the user attempts to import the layout.

If the IDs of the report objects of the design file and layout record are not matching, a confirmation dialog is shown to have the user confirm the import:

Separate "Show Comments" and "Show Dimensions" Request Page Options¶

Added a new Use "Show Comments" and "Show Dimensions" setting to the Document Creator Setup page (Default = true (for new installations)). This setting can be used to specify whether you would like to have a Show Internal Information request page option (legacy/original behaviour), or two separate Show Comments and Show Dimensions request page options on the Document Creator report objects.
- When the setting is disabled, the reports have the (legacy) Show Internal Information setting on the request pages:
- When the setting is enabled, the reports have separate Show Comments and Show Dimensions settings on the request pages:

Inventory Shipments and Receipt Reports and Layouts¶

With this release we are adding new report objects and layouts for the following document types:
- Inventory Shipment
- Posted Inventory Shipment
- Inventory Receipt
- Posted Inventory Receipt
- The request pages for the report objects have the following options:
  - Show Comments – Specifies whether to show the comments of the document on the rendered report. (Default = false)
  - Show Dimensions – Specifies whether to show the dimensions of the document on the rendered report. (Default = false)
  - Show Serial/Lot Number – Specifies whether to show the serial and lot no. details of the document on the rendered report. (Default = false)
  - Option to apply filters on which documents to print.
- The new report objects can be used for their corresponding report selections (which can easily be configured via the Apportunix Report Selection page)
  
  The Set Document Creator Defaults action also sets these report objects as the report selection for the current company.
- The output of the default report layouts look like the following:
- When you would like to edit the report layouts of these documents and create your own layout, then you already get a rich set of columns and labels available.

New Usages and Print Actions¶

Added Report Selection Usage for the following documents:
- Sales - Commercial Invoice, which is based on the posted sales shipment.
- Service - Commercial Invoice, which is based on the posted service shipment.
- Service - Draft Invoice, which can be printed for a service order or service invoice.
- Service - Picklist (based on service orders)
The report selections for these new report selection usages can be easily customized using the Apportunix Report Selection page (alternatively, you can use any of the default report selection pages, such as the Report Selection - Sales page).

The Set Document Creator Defaults action will set the corresponding report selection records to use the report objects included in the Document Creator extension for these new report selection usages.
Added Print button for the new report selection usages:
- Added Commercial Invoice print action to the Posted Sales Shipment (card) and Posted Sales Shipments (list) pages.
- Added Commercial Invoice print action to the Posted Service Shipment (card) and Posted Service Shipments (list) pages.
- Added Picklist print action to the Service Order (card) and Service Orders (list) pages.
- Added Picklist print action to the Service Order Subform (listpart) page, which can be used to the print the picklist for the selected service item lines.
- Added Draft Invoice print action to the Service Order (card), Service Orders (list), Service Invoice (card) and Service Invoices (list) pages.

Improved Error Details¶

Improved error messages for errors that are raised from report rendering requests:
- The error message includes the caption of the report and the output file type for which the rendering request failed.
- The error message includes a possible explanation for the error that occurred with some initial suggestions/directions on how to resolve the error.
- The error messages clearly informs you that you can use the Copy details link to get full details on the error.
- When you use the Copy details link you get full details on the error and troubleshooting details which include the following:
  - Entra Tenant ID (online) or VOICE ID / Serial Number (on-premise)
  - Environment Type (Production vs. Sandbox)
  - Environment Name
  - SaaS Infrastructure (this can be used to check if the user is running in an actual BC online environment or a Docker Sandbox environment (which is considered SaaS, but not SaaS infrastructure))
  - Report ID and Report Caption
  - Layout (Name, App ID, MIME Type)
  - Output File Type (N.B. PDF, HTML, Word or Excel)
  - Dataset Length
  - Report Render Object Payload (includes the request page parameters/filters that were used)
  - Session Type (e.g., Web, Background)
  - Format Locale/Region (both the ISO 639-1 language tag and the corresponding LCID)
  - Session Locale/Region (both the ISO 639-1 language tag and the corresponding LCID)
  - Current Culture Locale/Region (both the ISO 639-1 language tag and the corresponding LCID)
  - Global Language Locale/Region (both the ISO 639-1 language tag and the corresponding LCID)
  - Export Profile
  - The exception that occurred.

Export Profile PDF Merges Revised¶

From now on Export Profile PDF merges will only be applied when the PDF Merge app is set to Enabled = TRUE.
Added PDF Merge Enabled field which shows whether or not the PDF Merge app is enabled.
Split the PDF merge configurations into two page parts, one for the Underlays and one for the Append PDFs.

Instructional Text, Tooltips and Other Changes¶

Added instructional text on the following card pages:
- Document Creator Design File Analysis card page
- Document Creator Export Profile card page
  - On the PDF Export Settings group
  - On the PDF Merges group
  - On the Word Export Settings group
  - On the Excel Export Settings group
- Filter Set card page
Added missing tooltips to the PDF Export Settings group fields on the Document Creator Export Profile card page.
Changed the caption of the Document Creator Support File Analysis page to Document Creator Design File Analysis and obsoleted support file (.dcrz) in favor of design files (.dcrd) which are a better fit for support scenarios.
Changed the caption of the Job Quote report object to Project/Job Quote (for the transition between BC23 and BC24).
Used TextBuilder instead of DotNet_StreamWriter to generate HTTP request contents (which slightly improves performance).

2.78.0 (2024-03-18)¶

Sales - Commercial Invoice¶

Added new Sales Pro Forma Invoice (Posted Shipment) report and layout that can be used for commercial invoices.

Comment Visibility by Usage¶

Applied integration with upcoming Document Comments feature in the Apportunix Convenient Comments app. This feature in the Apportunix Convenient Comments app allows you to apply document group codes to comment lines to specify on which documents comments should be visible.

2.76.2 (2024-03-01)¶

Fix: ShipToAddr.Get("Ship-to Code") should be ShipToAddr.Get("Customer No.", "Ship-to Code")

2.76.0 (2024-02-01)¶

Retrieve all sales lines in the Sales Draft Invoice report object, not just the sales lines to invoice.
Introduced new OnAfterGetPurchLines/OnAfterGetSalesLines/... event publishers to the purchase, sales and service report objects.

2.74.0 (2024-01-10)¶

Miscellaneous changes in preparation for upcoming next-major BC 24.0 build changes.

2.72.0 (2023-12-14)¶

Preview Email Body Action¶

Added new Preview Email Body action that you can use to preview what the HTML of an email body report layout will look like when the HTML contents are used as email body.
- The action can be invoked from the Report Layouts and Document Creator User-Defined Report Layouts page.
  
  This will open the standard Dynamics 365 Business Central Email Editor page where you can view what the email body will look like.
- The action can also be invoked from the Document Creator Support File Analysis page so that you can preview how an email body will look like for an uploaded Document Creator Design File (.dcrd).

2.70.0 (2023-11-28)¶

Fix for Use Region-Independent Datasets feature (experimental): If the feature is enabled, then the Export Design action would export a design file that includes the wrong localeID value (which should be 127 (which corresponds to the culture-invariant region)), which could prevent some users from opening the design file in the designer.
Fix for Create Support File action not exporting a file.

2.68.0 (2023-11-23)¶

Work-around for bug introduced by Microsoft in BC23.0 (certain page triggers not getting fired anymore): Fixes filtering of Layout Selection factbox

2.66.0 (2023-11-16)¶

Added internal event to allow for custom configuration.

2.64.0 (2023-11-14)¶

Throw custom error messages if calls to Evaluate in Dataset Extensions fail to better describe the context of the error that occurred.
Removed obsoleted permission sets WSB_SYS and WSB_MON from IncludedPermissionSets property of the Document Creator permission sets.
Fix: Changed initialization of Format Region field in Document Creator Setup record to not rely on the (per-company) Language table.
Fix: When rendering reports from design (.dcrd) files from the Document Creator Support File Analysis page, pass the data locale ID to the API so the user does not have to switch region to render the report when doing support file analysis.

2.62.0 (2023-10-05)¶

Initialize CurrReport.FormatRegion only once based on the Format Region of the document that is processed first.
Added BlanketOrderNo and BlanketOrderLineNo columns to misc. purchase and sales document reports.
Added QtyShippedBase, QtyToShip, QtyToShipBase and QuantityShipped columns to sales blanket order document report.
Added SpecialOrder, SpecialOrderPurchaseNo and SpecialOrderPurchLineNo columns to sales document reports.
Added AppliesToDocumentNo and AppliesToDocumentType columns to the ReminderLine dataitem on the reminder document report.
Small fix for initializing the (Attachment) Layout Name field on the Business Rel. Layout Selections page when invoking the Copy from Report Selection action (the action could clear any existing values).

2.58.0 (2023-10-03)¶

Requires Business Central 23.0

Changed ObsoleteState of wDCR_EmailBodyLayoutName and wDCR_EmailBodyLayoutAppID fields from Pending to Removed and use the new "Email Body Layout Name" and "Email Body Layout AppID" fields that have (finally) been introduced in "Microsoft Base Application v23.0".
Applied bug fixes for the "Email Body Layout" implementation introduced in "Microsoft Base Application v23.0":
- The "Email Body Layout" selections set by users for purchase documents and/or specific vendors is not respected. Document Creator applies a fix for this bug until this is resolved in an update of the "Microsoft Base Application".
- The "Report Selections.CopyToReportSelection procedure is missing statements for copying the new "Email Body Layout Name" and "Email Body Layout AppID" fields. Document Creator applies a fix for this bug until this is resolved in an update of the "Microsoft Base Application".
Use the new "Format Region" fields (introduced in "Microsoft Base Application v23.0") to set the format region in the extension-provided report objects.
Misc. maintenance changes (misc. options having changed to enums, replacing obsoleted procedures with replacements)

2.56.0 (2023-10-03)¶

Added Assign Extension Permission Sets step to the Document Creator Setup Wizard page.
Added QuoteNo column to Purchase Order document report.
Added OrderNo column to Purchase Receipt document report.
Added ReturnOrderNo column to Purchase Return Shipment and Sales Return Receipt document reports.
Set the Document Creator Setup Wizard assisted setup page as the Primary setup page that will automatically be opened after installing the extension.
Added Description field as column to ProdOrderComponent data item in the Prod. Order - Job Card report.
Added Unit of Measure Code (UOMCode) and its (translated) Description (UOM) as columns to the ProdOrderComponent data item in the Prod. Order - Job Card report.

2.54.0 (2023-09-11)¶

Check Out Layouts¶

New Check Out Layouts feature:

The "Check Out Layouts" feature helps users to avoid conflicts that could emerge when multiple users are working on the same user-defined report layout at the same time.

This feature warns users when they are about to make an attempt to edit (i.e., export or import) a user-defined report layout while there is already another user that is also busy editing the same layout.

Setup

For this feature some new setup fields have been added, which are as follows:
- Use Check-Out - Specifies whether the "Check Out Layouts" feature should be enabled in the current Business Central environment. If the checkbox is disabled, the fields will not be visible and checks will be skipped.
- Auto Check-Out - If "Use Check-Out" is enabled, then you can use this setup field to specify when layouts should be checked out automatically. The options are "Never" (i.e., users will check out layouts manually) and "Export Design" (i.e., whenever a user invokes the "Export Design" action the "Checked Out" fields will be updated automatically)
Usage

On the Report Layouts page and Document Creator User-Defined Report Layouts page the following new fields and action will be available when the "Check Out Layouts" feature is enabled (N.B. they only apply to user-defined report layouts):
- Checked Out - Specifies whether a layout is checked out by a user for editing. As a user you can check or uncheck the box and the other "Checked Out" fields will be updated accordingly.
- Checked Out By - Specifies the name of the user who checked out the layout for editing.
- Checked Out At - Specifies the date and time that the layout was checked out for editing.
- Check Out for Editing action - Checks out the selected layout for editing.
Example Scenarios

The Check Out Layouts feature protects users from conflicts while editing user-defined Document Creator report layouts. Here are some scenarios that illustrate how the feature helps users to avoid such conflicts while import/exporting layouts for editing:
1. Import Layout while Checked Out by Current User
  
  Given that a user-defined Document Creator report layout is checked out by user A.
  
  When user A imports a new design file into the layout record using the Import Design action.
  
  Then user A will be asked if he/she would like to clear the Checked Out fields for the layout record.
  - If the user answers with Yes, then the layout will be imported and all the Checked Out fields of the record will be cleared.
  - If the user answers with No, then the layout will be imported, but the Checked Out fields will not be cleared.
2. Import Layout while Checked Out by Other User
  
  Given that a user-defined Document Creator report layout is checked out by user A.
  
  When user B attempts to import a new design file into the layout record using the Import Design action.
  
  Then user B will be asked if he/she is sure he/she would like to import the layout and if so whether he/she would also like to clear the Checked Out fields of the record.
  - If the user responds with Import and clear "Checked Out" field, then the layout will be imported and all the Checked Out fields of the record will be cleared.
  - If the user responds with Import only, then the layout will be imported, but the Checked Out fields will not be cleared.
  - If the user responds with Cancel, then the layout will NOT be imported and an error occurs to inform the user that the action has been canceled accordingly.
3. Export Design File while not checked out
  
  Given the setup field Use Check-Out is set to TRUE (i.e., marked/ticked/enabled) and Auto Check-Out is set to Export Design and given a new user-defined Document Creator report layout.
  
  When the current user invokes the Export Design action.
  
  Then the Checked Out fields will have been updated accordingly.
4. Export Design File while checked out by other user
  
  Given that a user-defined Document Creator report layout is checked out by user A.
  
  When user B attempts to import a new design file into the layout record using the Export Design action.
  
  Then user B will be warned that the layout record has been checked out by user A and asked if he/she would like to export the design file regardless, e.g.,
  
  Layout "My Sales Invoice Layout" is checked out by user "User A".
  
  Would you still like to export a design file for this layout?
Implemented update notification which informs users that a new version has been installed and links them to the changelog where they can find more information about the new features of the extension.
Miscellaneous maintenance (e.g., API/XML docs update, preparations for vNext changes/obsoletions, resolve new internal info diagnostics)

2.52.0 (2023-07-24)¶

Added multi-fieldselect support adding custom columns in Dataset Extensions.
Added Select Fields action for selecting multiple fields to add as new custom columns.
Miscellaneous maintenance (API docs update, resolve new internal info diagnostics).

2.50.0 (2023-06-08)¶

Addressed warnings for next-major builds.
Miscellaneous code clean-up and additional XML documentation.

2.48.0 (2023-05-17)¶

Requires Business Central 22.0

Production Order Reports and Layouts¶

Added Production Order document reports and built-in layouts for:
- Production Order - Job Card
- Production Order - Mat. Requirements
- Production Order - Shortage List
See Reports for more information.

Support for Overriding Format Region¶

Added support for overriding "Format Region":
- Via the Report Limits and Settings page:
- Via the report request page:
Added public codeunit wDCR_FormatRegion which is used in report objects to pass along the format region that should be used by the API for rendering (based on the value of CurrReport.FormatRegion).
Added column FormatRegion to the top-level dataitem of all report objects, which contains the value of CurrReport.FormatRegion.

Miscellaneous¶

Fixed bug in the Use Region-Independent Datasets (experimental) feature/switch: it was possible for Date and Time columns to be parsed incorrectly.
Replaced usages of (internal) codeunit wDCR_JITLayoutSelection with new procedures in codeunit "Design-time Report Selection" that were introduced in BC21.0. The codeunit wDCR_JITLayoutSelection has been removed.
Removed (obsoleted) usages of the "Document Report Mgt." event publishers which have been removed in the upcoming, next major release of BC (23.0). Using the legacy rendering engine will no longer be possible.
Maintenance:
- Replaced 'integer' arguments for "log interaction" with the new "Interaction Log Entry Document Type" enum in report objects.
- Replaced calls to "VAT Clause".GetDescription with "VAT Clause".GetDescriptionText in report objects.
- Resolved ApplicationArea property redundancy on pages.
- Call FindSet with only 1 parameter instead of the obsoleted second parameter.
- Removed occurrences of the obsoleted [InDataSet] attribute.
- Changed accessibility from internal to local for procedures that were only used in the same object.
- Resolved miscellaneous info diagnostics.

2.46.0 (2023-05-05)¶

Added the Usage Layout Selection field to the Apportunix Report Selection page which allows one to set up a layout selection specifically for the report selection. Note that this overrules the report object's report layout selection.
Added the Apportunix Report Selection page as an action on the Apportunix Role Center in the Document Creator group (besides the Setup group from the System Library).

2.44.0 (2023-04-21)¶

Prepayment Details on Invoices/Credit Memos¶

Added new feature that allows you to show more line details on Prepayment Sales/Purchase Invoices/Cr. Memos. (in the extension-provided Document Creator report layouts).

The feature can be enabled (or disabled) using the Show Prepayment Invoice/Cr. Memo Details setting on the Prepayment tab of the Document Creator Setup page (disabled by default)

Miscellaneous¶

Added TableRelation to the Tag field on the Custom Labels page, so that you can now easily select a tag from the existing ones if you want to reuse label translations.
Fixed a bug with the Language Code page field on the Custom Columns/Custom Labels page that would result in the record to be cleared.
New public procedure wDCR_LayoutSelectionMgt.wgFncSelectReportLayout(pReportID: Integer; var vRecReportLayoutList: Record "Report Layout List"; pForEmailBody: Boolean): Boolean
Added XML documentation to codeunit wDCR_Publishers and added event publisher wgEvpReportExecutionParameters_OnAfterGetFormattingCulture.
Added feature uptake telemetry.
Hook into new Document Mail Queue features: "Email Body Report Layout" and "Report Layout" on queue entry

2.42.0 (2023-03-16)¶

Fix for setting a customer-/vendor-specific layout using the Layout Name field on custom report selections, e.g., via the Business Rel. Layout Selections page (resolved bug introduced with refactoring in version 2.32.0.0)

2.40.0 (2023-03-15)¶

Fix for Export Design with Edit with Data disabled from the Report Layouts page.

2.38.0 (2023-03-07)¶

Restored Set Document Creator Defaults action on the "Apportunix Report Selection" page that was moved to the "System Library" app.
Fixed permissions of the 'Apportunix Doc. Creator User' permission set to grant direct execute permissions for codeunits.
Make the Convert Selected and Copy As Tenant Report Layout actions visible on the (legacy) Custom Report Layouts page (for conversion purposes) if Show Legacy Controls is disabled.

2.36.0 (2023-03-06)¶

Added lblSellToAddress and SellToAddr columns to all sales document reports.
Removed "Apportunix Report Selection" from the "Document Creator" app in favor of the new "Apportunix Report Selection" page in the "System Library" app.
Clear the "Product Key" field (legacy) automatically if the license status check finds there is an active Apportunix subscription for the "Document Creator" product and the entered product key (legacy) is invalid.

2.34.0 (2023-02-21)¶

Fixed an issue with BC online environment ODataV4/Web sessions returning invalid session locale IDs (i.e., SessionSettings.LocaleID() = 0). Procedure wDCR_Setup.wgFncGetSessionLocaleID(): Integer will now check the session's current culture if SessionSettings.LocaleID returns 0.

2.32.0 (2023-02-15)¶

Changed the Layout Name field on the Apportunix Report Selection page to show/edit the report layout selection for the report for the current company. The previous implementation would override the report layout selection, which has now been adjusted, to avoid confusion.
Added Change Layout Selection action to the Layout Selection factbox.
The Apportunix Report Selection page (and accompanying public objects and procedures) will be moved to the "System Library" app and has therefore been obsoleted in the "Document Creator" app. The page in the "System Library" app will offer the same functionality (the 'new' page is currently hidden from search, i.e., UsageCategory = None). If you have extensions on the current "Apportunix Report Selection" page, then please mind the obsoletion warnings and adjust your extensions accordingly.
Added Layout App ID and Layout User Defined page fields to the Apportunix Report Selection page (hidden by default).

2.30.0 (2023-02-01)¶

Fix for Export Design with Edit with Data disabled for a report that has dataset extensions: The dataset extension columns and data items would not be included in the .dcrd design file.

2.28.0 (2023-01-30)¶

Fixed casing of label lblBilltoCustomerNo tag: BillToCustomerNo; in "Job Quote" report.

2.26.0 (2023-01-30)¶

Applied partial record loading in the Dataset Extensions feature.
Added support for leaving the Language Code Column field blank for Custom Labels.
Added LanguageCode and LanguageId column to all report objects where these were not present yet.
Fix for company-specific PDF merges: Only call PDF Merge API if at least 1 merge is applicable for the current company
Added several fields and labels as columns to the "Job Quote" report object.
The source code of the report objects in the "Document Creator" app is now available (see Downloads).
The resourceExposurePolicy.allowDebugging property is now set to true in the app.json manifest file of the "Document Creator" app.

2.24.0 (2022-11-25)¶

Fix for Use Region-Independent Datasets (experimental) feature: Parse values of Date and Time columns as DateTime (instead of BC Date and Time types).
Changed fonts in Service document reports and Job Quote reports to use Arial instead of Segoe UI throughout the entire document layouts (using Styles).
Align Sales document report layouts and use more descriptive names for bands.
Fix: If during Export Design (with data) the Report.SaveAs method runs into an error (e.g., an error related to Database Access Intent, such as "Cannot modify a record. Current connection intent is Read-Only."), then throw the error to present it to the user.
Fix: Import Layout Package would do a duplicate import (from the legacy format and new format).

2.22.0 (2022-11-18)¶

Fix for adding custom data item when the parent data item has no existing data items yet.

2.20.0 (2022-11-03)¶

Added Layout Name and Email Body Layout Name page fields to the Document Layouts (aka Customer/Vendor Report Selections) pages.
Added Apportunix Report Selection navigation action to the Document Layouts (aka Customer/Vendor Report Selections) pages.
Fixed issue with the Copy from Report Selection action. The action now also copies the values of the new page fields to the customer/vendor report selection records, if applicable.
Fixed issue with the Import Layout Package action which occurs when a legacy layout/report package is imported.
Enhanced Copy action on the Document Creator Translations page:
- Multi-select/filter capabilities.
- Copy translations from one tag to another.
- Support for copying from/to language code '' (i.e., the Default Translation/Unspecified Language Translation).
Changed caption of Default Translation field to Default Translation/Unspecified Language Translation (to make more clear this concerns a translation for documents where the language code is '').
Added Language Name field to the Document Creator Translations Subpage.
Set default visibility for Last Used fields to be hidden.
Added the Translations subpage to the Custom Labels page.
Set the Enabled property of the Translations subpage to false when we are on a new line (Tag is empty).
Changed the drill-down for looking up columns using the Report Columns page (used in Dataset Extensions and Conditional Layout Selections) to set focus on the first record of the direct parent data item.
Added the Payment Discount % and Pmt. Discount Date columns to applicable sales, purchase and service document reports. Also added prepayment-related columns to the sales order confirmation document report.
Allow Cast Data Type = Integer for Boolean field custom columns.
Added Conditional Layout Selections section to the Document Creator Setup Wizard page.
Added ContextSensitiveHelpPage property to Conditional Layout Selections.
Removed the deprecated New Blank Layout action (which was replaced by the New Layout action).
Deprecated the VATPerc_3 column in the Sales Order Confirmation, Sales Blanket Order and Service Credit Memo reports (N.B. no plans to delete the column in the near future).
Fixed miscellaneous next-major build warnings.

2.18.0 (2022-10-20)¶

Added Email Template layouts for applicable sales, purchase, service and reminder reports as built-in/extension-provided layouts.
Updated the Set Document Creator Defaults action in the Apportunix Report Selection page to also set the Email Body Layout field to the new built-in/extension-provided email body template layouts for all applicable document types/usages.
Added Bill-to/Buy-from/Pay-to/Sell-to Contact, Bill-to/Buy-from/Pay-to/Sell-to Vendor Name, Bill-to/Buy-from/Pay-to/Sell-to Vendor Formal Salutation Text, Bill-to/Buy-from/Pay-to/Sell-to Vendor Informal Salutation Text, Bill-to/Sell-to Contact No., Contact, Name fields to applicable sales, purchase, service and reminder reports.
Added lblEmailClosing and lblEmailIntroduction labels to applicable sales, purchase, service and reminder reports.
Enhancement: For some reports, if "CurrencyCode" is empty, then "CurrencySymbol" would be empty as well. CurrencySymbol will now contain the Local Currency Symbol from the General Ledger Setup. (This is something that is not properly aligned for all document types throughout the procedures provided by the Microsoft Base Application.)
VATClause data item added to all reports where applicable (in report object and built-in/extension-provided layout).
Fixed MediaSet custom columns not working anymore (bug introduced due to breaking change in the Business Central platform).
Added DecimalFormatter setting to the Custom Columns page for Decimal fields. You can use the format syntax as described on the Custom Numeric Format Strings and Standard Numeric Format Strings pages.
Fix: Added missing CastDataType field to XMLport for exporting/importing dataset extensions.
Enhancement for better integration with new upcoming Document Mail Queue feature for linking XML request page parameters to reports that should be e-mailed.
Set actions on the Document Creator User-Defined Report Layouts page to Enabled = false if the page does not contain any records.
Misc. small code-cleanup (e.g., fixing casing of keywords of code, removed redundant DataClassification for some fields on field-level).

2.16.0 (2022-09-12)¶

Fixed bug in Edit without data (small bug introduced with Use Region-Independent Datasets feature)

2.14.0 (2022-09-08)¶

New feature: Conditional Layout Selections:
- New page: Document Creator Conditional Layout Selections
  - Layout Mappings action (and flowfield) to view and edit mappings from conditions to layouts to use for the report
  - Enabled field to disable the conditional layout selection configuration for the report
  - Export and Import action to/from an XML file
  - If there are zero mappings, then the Layout Mappings field is displayed in red.
  - Convenient actions like, Report Layouts, Run Report, View Columns, View Data Items, Dataset Extensions
Through this page, you can set up the configurations for conditional layout selections using the following new pages:
- New page: Conditional Layout Mappings
  - Map conditions to a layout
  - Mappings can be company-specific (flowfield with drilldown, action, factbox):
  - If there are zero conditions, then the Conditions field is displayed in red. Note that if there are zero conditions for a layout mapping, the layout mapping will never be used.
  - There is a Description (optional) where you can leave additional information about the layout mapping.
  - Enabled field to disable the conditional layout selection configuration for the report
  - Convenient actions like, Report Layouts, Run Report, View Columns, View Data Items, Dataset Extensions
- New page: Layout Selection Conditions
  - Allows you to specify a condition for a column value.
  - Condition Column select a column from the report dataset to put the condition on
  - Either set up a Constant Value (aka fixed value), Value Column (comparison against the value of another column) or a Filter String
  - In the Filter String field you can also use a placeholder %1 which you can use if you want to compare the value of the Condition Column with the value of another column (Value Column). For example, you can check if the Bill-to Customer No. is not equal to the Sell-to Customer No. (see example in the screenshot).
  - The Fulfillment Method field allows you to specify which records should satisfy the conditions. For example, if you want to check that all sales lines of your sales document satisfy a condition you can put this to All, while if you want to check if there is at least 1 sales line that meets the condition you can set this to Any.
  - Convenient actions like, Report Layouts, Run Report, View Columns, View Data Items, Dataset Extensions
The Apportunix "Document Mail Queue" app now uses the custom layout and e-mail body template layout as configured in Document Creator’s Apportunix Report Selection page (Document Creator 2.14.0.0 required for this feature) (Document Mail Queue 1.24.0.0 required for this feature)
Added Custom Columns, Custom Data Items and Custom Labels flowfield to the Document Creator Report Dataset Extensions page.
Improved duplicate custom dataset node name check to also check existing column/data item names.
Fixed issue preventing from opening the Custom Columns page when an app/extension whose fields were used for custom columns was uninstalled.

2.12.0 (2022-08-22)¶

New setting Use Region-Independent Datasets which allows one to specify whether the region-dependent XML BC report dataset should be converted to a region-independent format. The standard XML dataset is generated based on the region of the user, which could lead to errors when being parsed by third-party extensions/integrations. This feature resolves this bug in BC by converting the XML dataset in a preprocessing step. (Experimental feature)
Updated the Document Creator Setup Wizard to allow for both Apportunix Subscription and Product Key (legacy) activation.
Fixed minor bug on Document Creator Setup bug which would show a notification that the product is not activated when Document Creator is activated with a product key instead of a subscription.

2.10.0 (2022-08-09)¶

Requires Business Central 20.2

Fixed Run Report action on Document Creator User-Defined Report Layouts page (not working when report selection is absent).
Use the layout specified for the run of a report in the ObjectPayLoad parameter of the new OnCustomDocumentMergerEx event. If there are multiple report layouts with the same name, then a notification will be shown to the user (known limitation/bug: #18941).
If the HttpClient used in the Check License action fails, then show a detailed error message.
Check for PDF Merges when the "Owner Password" or "User Password" settings are used.
Abort PDF Merge if the DocStream provided by BC is empty.

2.6.0 (2022-06-27)¶

Requires Business Central 20.1

Added support for license activation through the "Apportunix Subscriptions" page. You can now create a subscription for Document Creator directly from within Business Central, using the "Create Subscription" action on the "Apportunix Subscriptions" page. It is possible to activate the product with a product key as well (legacy).
The Apportunix Report Selection page has new options:
1. There is a new Email Body Layout Name field which allows you to select a Document Creator or Word layout to use as the e-mail body for the report selection. You can use the drill-down of this field to open up the lookup for the configured report and select a different layout to use for the e-mail body. The Use for Email Body field will automatically be checked if you select an email body layout.
2. There is a new Layout Name field which allows you to select a different report layout to use specifically for when the report is printed via this report selection record. Note that you could use this if you would like to use the same report for different report selection records, but with different report layouts. The Reset Layout action allows you to clear the selected layout.
3. The Use for Email Attachment field is available on this page.
4. There is a new Business Rel. Layout Selections action which opens a new page for the selected usage that allows you to view and edit specific report selections for business relations.
New Business Relation Layout Selections page
1. In this page you have an overview of all business relations that have custom report/layout selections for a specific usage! (In the screenshot you see the custom sales order selections.) Normally you would need to first navigate to the customer/vendor card to view the selections per customer.
2. This page has a Copy from Report Selection action to easily copy the 'main' settings to the selected record.
3. You can specify an Email Body Layout Name and Layout Name for this customer/vendor specifically. You can also select Document Creator layouts for both of these, just like on the Apportunix Report Selection page.
Fixed weird behaviour of the Apportunix Report Selection page setting focus on the last record when the page is refreshed or saved.
Fixed issue with "App ID" being copied to "Layout Settings" records of user-defined report layouts when using the Copy Layout action.
Fixed bug that Attach as PDF (e.g., on Sales Order page) was not working for Document Creator layouts.
Added New Layout... action to the Report Layouts and Document Creator User-Defined Report Layouts page, which replaces the New Blank Layout... action. This action first prompts you whether you want to create a new blank layout or base your new layout on an existing built-in/extension-provided report layout. By default, it opens with Copy from built-in layout selected.
Added support for new export settings:
- PDF:
  - PDF Compliance, new option: "PDF/A-2u"
- Word:
  - Disable Section Break in Document (Default: false)
- Excel:
  - Print Scale (Default: 10)
  - Pinned Cells in X Ordinate (Default: 0)
  - Pinned Cells in Y Ordinate (Default: 0)
  - Use Preset Print Scale (Default: true)
  - Show Gridlines (Default: true)
  - Group on Separate Sheet (Default: false)
Added "License Active" field to the Document Creator Setup page (with drill-down to the "Apportunix Subscriptions" page)
Fixed bug in reports for retrieving service costs with code longer than 10 characters.

2.4.0 (2022-05-03)¶

Changed conversion of custom report layouts to tenant report layouts so that converted report layouts can be used in all companies. If you run the conversion now, the resulting tenant report layouts can be used in all companies, so you do not need a company-specific copy for each company.
Added new page Document Creator User-Defined Report Layouts which shows all Document Creator tenant report layouts with all relevant fields, factboxes and actions.
- Note that some actions are only enabled for report layouts that are not company-specific and/or for the current company. For example, the Run Report action can only be used if the report layout is loaded by Business Central for the current company.
Added new Make Available to All Companies action to the Document Creator User-Defined Report Layouts page which allows you to update selected report layouts from being company-specific to being usable in all companies. You can use this action while having multiple layouts selected that are company-specific.
Added Company Name field to the Report Layouts page, so that you can see whether a report layout is specific to a company.
Raise an error/skip custom report layouts for processing-only reports in the conversion procedure.

2.2.0 (2022-04-28)¶

Added AdditionalSearchTerms to "Report Layouts" page due to inconsistent translation of "Report Layouts" in Microsoft Dynamics 365 Business Central.
Added missing translation of the General tab on the "Document Creator Export Profile" page.
Added new event wDCR_Setup.wlEvpOnBeforeGetUserLocaleID to hook into determining the locale for the session running the report.
Disabled automatic data upgrade of custom report layouts to tenant report layouts due to absent tracing for upgrade codeunits in Business Central.

2.0.0 (2022-03-25)¶

Requires Business Central 20.0

Major release compatible with the major revisions to reporting in the Microsoft Dynamics 365 Business Central 2022 release wave 1 release (April 1st, 2022, version 20.0)
- All features are now available on the new Report Layouts page.
- Document Creator report layouts have "Layout Format" External and "MIME Type" reportlayout/dcrx.
- "New Blank Layout" and "Copy Layout" actions added.
- Layout packages support the new system report layout tables, but also allow export and import to/from older BC/Document Creator versions.
- Conversion from Custom Report Layouts to Tenant Report Layouts (manually from the Custom Report Layouts page and automatically when upgrading from a previous version of Document Creator)
- Legacy features hidden by default, can be made visible again with setting Show Legacy Controls on the Document Creator Setup, but note that these are useless as the platform does not support the old events anymore unless the EnableReportLegacyWordRender setting is enabled on the BC server instance (which is only possible in an on-premise installation)
- Updated permission sets
- Updated translations of the Document Creator app
- Updated manual
Included document report objects in the Document Creator app including built-in/extension-provided, default (Document Creator) layouts.
Added the Apportunix Report Selection page, which allows you to manage all report selections in a single page.
Added the Layout Selection factbox page that allows you to view which layout is used for each company for the target report of the currently selected record.
Added Report Settings for the Document Creator reports.
Added Report Substitutions feature that allows one to replace one report with another, for document types that do not have a document report selection available.

1.44.0 (2022-02-18)¶

Requires Business Central 19.1

Added support for company-specific PDF merges (e.g., stationeries, attachments per company)
Added Include Individual Layout Files setting to the Document Creator Setup page. When enabled exported layout packages will also include the individual .dcrx Document Creator layout files in the archive. (Disabled by default)
Added confirmation dialog for overwriting dataset extension on import.
Different default file name for dataset extension XML export if only 1 dataset extension is selected (include report ID + caption).
Resolved infinite recursion if node name in dataset extension was empty (which could only happen through an (erronous) export/import).
Skip dataset extensions in export/import if essential fields are missing.
Generate different default file name for Layout Packages if only 1 report layout is selected (include report ID + caption).
Added Document Creator Setup Wizard to search.
Added Open Setup Wizard action to the Document Creator Setup page.
Changed image for the Download Designer action.
Fixed video link in Assisted Setup to use an embed video link.

1.42.0 (2022-01-14)¶

Added Export Dataset... action to all Dataset Extensions pages to generate a report dataset and export it to an XML file.
Added a Custom Report Layouts action to Custom Columns/Labels/Data Items pages to view or edit the Document Creator layouts for the report.
Added an Enum Inspector action to the Dataset Extensions "Filter Set" page to lookup members for enum table fields and view their ordinals, names and captions.

i. Invoke the Enum Inspector action:

ii. Select the enum table field for which you want to view the members and choose OK.

iii. The members of the enum will be shown in a list page.
Added Run Report action to the Document Creator Report Dataset Extensions page.
Added an Export Profile action to the Custom Report Layouts page.
Set Scope = Repeater for various page actions.
Fixed issue in Dataset Extension feature where a thousands separator was used for decimals which is not handled well for some user regions.
Fix: Made sure that the PDF Merge feature also works in combination with the "Document Creator On-Premise" app.

1.40.0 (2022-01-11)¶

New feature: Use PDF files as stationeries or append PDF files to your document report PDF outputs.
- Note that PDF merges incur additional time and usage costs for report generation.
- See PDF Merges for more information.
Fixed issue in Dataset Extension feature caused by passing decimals in XML format rather than passing them in the (incorrect) format that Microsoft Dynamics 365 Business Central adheres to (i.e., dependent on user culture/region) that is not in line with the XML standards.
Added "Document Creator Layouts" page view to the Custom Report Layouts page.
Added Document Creator pages to the Apportunix rolecenter.
Added tiles to the Apportunix rolecenter.
Added in-app guided tour for the Dataset Extensions "Filter Set" page.
Use new AL-defined permission set WSB_DCR (with automatic data upgrade/migration).
Updated code for Dynamics 365 Business Central 2021 wave 2 (e.g., resolved deprecation warnings).
- The app now takes a dependency on the "System Library", "Monet" and "PDF Merge" app to offer the newly added features.

1.36.0 (2021-11-18)¶

Added parameter pCduTempBlobOutputDoc: Codeunit "Temp Blob" to event wgEvpReportExecution_OnAfterSendReportRequest that allows one to get the output document from Document Creator.

1.34.0 (2021-11-03)¶

Added various new event publishers to the app to hook into report execution (found in codeunit wDCR_Publishers).
Added various new event publishers to customize file names, hook into the custom report layout archive functions and fast report layout selection.
Marked various objects and procedures with ObsoleteState=Pending.

1.30.0 (2021-08-23)¶

New feature: Linking custom data items/columns to other custom columns in report dataset extensions. You can now go multiple levels deep with adding new columns and data items, now allowing you to include custom columns in filters.
Shifted Document Creator Report Dataset Extensions to DataPerCompany=false. An upgrade option is available from a notification in the role center and the Document Creator Report Dataset Extensions page.
Added Assisted Setup entry with Document Creator Setup Wizard.
Added field "Custom Node Count" to Filter Sets to allow you to check the number of custom nodes the filter set is being used by.
Added "Test Filters" action that checks if your filters are incomplete or otherwise invalid. This same check is now also performed when reports are run, and if any errors are detected in the filters, then report execution will be aborted.
Implemented Restrictions in filter sets.
It is now possible to Cast boolean-, date- and option-/enum-fields for custom columns to different datatypes, e.g., use the caption of an option/enum or its numeric (integer) value. The translation for the column is based on the language specified through the "Language Code" column (which applies to all custom columns of the data item).
The lookup for a filter's "Value Column" is now filtered on data type (by default).
Fix for "Export Design" (without data) not working when dataset extensions exist for the report.
Added "Remove Missing Datasources" setup field, to specify whether datasources and their relations should be removed automatically when the corresponding data items are removed from the report (Default: true).
Updated XmlPort for importing/exporting translations to allow for note and context tags in trans-units.
Updated telemetry for full + device user count.

1.28.0 (2021-05-14)¶

New feature: Export / Import Document Creator translations to/from XLIFF translation files.
Fixes for Document Creator Report Dataset Extensions features:
- Blob fields should be calculated.
- Boolean fields should be formatted in XML format.
Apportunix logo

1.26.0 (2021-03-22)¶

New feature: Document Creator Report Dataset Extensions!

Add your own columns, translatable labels and data items to reports from within your Business Central client without any report(extension) development!

For more information, see: Dataset Extensions
Changed permission set description to "Apportunix Document Creator".

1.24.0 (2021-02-01)¶

Requires Business Central 16.2

The Document Creator Setup now includes a new Fall Back on Default Language setting. When this setting is enabled, Document Creator will fall back on the translation for the configured default language code if a translation for a language could not be found.
The Export Design action now remembers report request page settings.
The Document Creator extension can now also be used in Sandbox Docker containers without a product key.
The Document Creator app now has a transparent logo.
Fix: Show warning about Translation Update Usage setting only once.

1.20.0 (2020-08-28)¶

Rebranding to Apportunix
Enable Cloud Printers

1.18.0 (2020-05-28)¶

Added new Document Creator Export Profile settings:
- PDF - New PDF-Compliance option: PDF/A-1a
- Word - Print Optimized; Do not expand shift return
- Excel - Print Optimized; Split Pages; Font Scale; Print Scaling

1.16.0 (2020-03-23)¶

Updates to target application 16.0 (Dynamics 365 Business Central 2020 release Wave 1)
Added action "Check License" to Document Creator Setup page for Production environments
On-premise only: License check now also reports mismatch of the active and licensed BC Serial No.

1.12.0 (2020-02-14)¶

The demo/trial version is now active in Sandbox environments, also without a product key. Reports generated from a Sandbox environment will have a DEMO watermark.
A new setting "Format Locale" is available on the Document Creator Setup page. With this setting you can specify regional settings, such as date and numeric format, that Document Creator should use.
Show a message to on-premise users to inform about the requirement to install the additional "Document Creator On-Premise" extension for on-premise usage.

1.10.0 (2019-12-13)¶

When a Product Key is entered on the Document Creator Setup page, new-lines and spaces are stripped from the entered string.
Overriding report actions via a Document Creator Export Profile has been deprecated and removed.

1.8.0 (2019-11-28)¶

Initial public release.

Last update: April 23, 2024