{"title":"Codeunit 9988 Word Template Impl., extension points 29","url":"https://jonas-paprotka.de/ref/codeunit/9988-word-template-impl/points/","author":"JOP-AL","license":"Metadata from Microsoft's symbol packages. AL source MIT, Copyright (c) Microsoft Corporation. Selection and wording © 2026 JOP-AL. https://jonas-paprotka.de/licenses/","subject":"Microsoft Dynamics 365 Business Central","checked":"2026-11-20","changed":"2026-10-05","object":{"type":"codeunit","id":9988,"name":"Word Template Impl.","app":"System Application","url":"https://jonas-paprotka.de/ref/codeunit/9988-word-template-impl/"},"major":29,"source":{"url":"https://jonas-paprotka.de/ref/codeunit/9988-word-template-impl/source/","path":"src/System Application/App/Word Templates/src/WordTemplateImpl.Codeunit.al","commit":"4303e5e584d3aa5d9e98cbc615525a5396ad6ed7","lines":"a line is <source url>#L<line>"},"steps":{"event":"[line, \"event\", name, handled]: raises an event of this object; handled 1 when it has an IsHandled parameter","call":"[line, \"call\", name, arguments]: calls a procedure of this object","ext":"[line, \"ext\", type, id, name, arguments]: calls a procedure of another object, through a variable declared with that type","write":"[line, \"write\", table id, method, 1 when called with true]: Insert, Modify, ModifyAll, Delete, DeleteAll or Rename","validate":"[line, \"validate\", table id, field name]","run":"[line, \"run\", type, id]: Codeunit.Run, Page.Run, Report.Run and their kin"},"objects":{"codeunit:4100":{"name":"Temp Blob","url":"https://jonas-paprotka.de/ref/codeunit/4100-temp-blob/"},"codeunit:425":{"name":"Data Compression","url":"https://jonas-paprotka.de/ref/codeunit/425-data-compression/"},"table:9988":{"name":"Word Template","url":"https://jonas-paprotka.de/ref/table/9988-word-template/"},"codeunit:8703":{"name":"Feature Telemetry","url":"https://jonas-paprotka.de/ref/codeunit/8703-feature-telemetry/"},"codeunit:9560":{"name":"Document Sharing","url":"https://jonas-paprotka.de/ref/codeunit/9560-document-sharing/"},"table:9560":{"name":"Document Sharing","url":"https://jonas-paprotka.de/ref/table/9560-document-sharing/"},"table:9987":{"name":"Word Templates Table","url":"https://jonas-paprotka.de/ref/table/9987-word-templates-table/"},"page:9986":{"name":"Word Templates Related Card","url":"https://jonas-paprotka.de/ref/page/9986-word-templates-related-card/"},"codeunit:9989":{"name":"Word Template Field Selection","url":"https://jonas-paprotka.de/ref/codeunit/9989-word-template-field-selection/"},"codeunit:3960":{"name":"Regex","url":"https://jonas-paprotka.de/ref/codeunit/3960-regex/"},"table:9991":{"name":"Word Templates Related Buffer","url":"https://jonas-paprotka.de/ref/table/9991-word-templates-related-buffer/"},"codeunit:9555":{"name":"Record Selection","url":"https://jonas-paprotka.de/ref/codeunit/9555-record-selection/"},"table:9990":{"name":"Word Templates Related Table","url":"https://jonas-paprotka.de/ref/table/9990-word-templates-related-table/"},"codeunit:9981":{"name":"Word Template Custom Field","url":"https://jonas-paprotka.de/ref/codeunit/9981-word-template-custom-field/"},"codeunit:9987":{"name":"Word Template","url":"https://jonas-paprotka.de/ref/codeunit/9987-word-template/"},"codeunit:9983":{"name":"Word Template Field Value","url":"https://jonas-paprotka.de/ref/codeunit/9983-word-template-field-value/"},"table:9989":{"name":"Word Template Field","url":"https://jonas-paprotka.de/ref/table/9989-word-template-field/"}},"procs":[{"name":"DownloadTemplate","line":27,"kind":"procedure","params":0,"steps":[[33,"ext","codeunit",4100,"CreateInStream",2],[34,"call","GetTemplateName",0],[40,"call","PrepareZipFile",0],[41,"ext","codeunit",4100,"CreateInStream",2],[43,"call","GetTemplateName",0]]},{"name":"DownloadTemplate","line":49,"kind":"procedure","params":1,"steps":[[51,"call","Load",1]]},{"name":"PrepareZipFile","line":55,"kind":"procedure","access":"local","params":0,"steps":[[63,"ext","codeunit",425,"CreateZipArchive",0],[64,"ext","codeunit",4100,"CreateInStream",2],[65,"call","TrySetDataSource",1],[69,"ext","codeunit",425,"AddEntry",2],[69,"call","GetTemplateName",0],[70,"call","GenerateSpreadsheetDataSource",1],[72,"ext","codeunit",4100,"CreateOutStream",2],[73,"ext","codeunit",425,"SaveZipArchive",1]]},{"name":"GenerateSpreadsheetDataSource","line":80,"kind":"procedure","access":"local","params":1,"steps":[[94,"ext","codeunit",4100,"CreateOutStream",1],[103,"call","ConvertColNoToColName",1],[107,"ext","codeunit",4100,"CreateInStream",1],[108,"ext","codeunit",425,"AddEntry",2]]},{"name":"DownloadDocument","line":132,"kind":"procedure","params":0,"steps":[[137,"ext","codeunit",4100,"CreateInStream",2],[141,"call","GetFileName",2]]},{"name":"Upload","line":145,"kind":"procedure","access":"internal","params":2,"steps":[[152,"call","SaveTemplate",2]]},{"name":"Upload","line":159,"kind":"procedure","access":"internal","params":1,"steps":[[171,"call","GetTemplate",1],[175,"write",9988,"Modify"]]},{"name":"SaveTemplate","line":178,"kind":"procedure","access":"local","params":2,"steps":[[180,"call","Load",1],[181,"call","TrySetDataSource",1],[186,"call","VerifyMailMergeFieldNameLengths",0]]},{"name":"GetTemplate","line":198,"kind":"procedure","params":1,"steps":[[200,"ext","codeunit",4100,"CreateInStream",2]]},{"name":"GetDocument","line":203,"kind":"procedure","params":1,"steps":[[205,"ext","codeunit",4100,"CreateInStream",2]]},{"name":"GetDocumentSize","line":208,"kind":"procedure","params":0,"steps":[[210,"ext","codeunit",4100,"Length",0]]},{"name":"Create","line":213,"kind":"procedure","params":0,"steps":[[218,"call","SelectTable",0]]},{"name":"Create","line":222,"kind":"procedure","params":2,"steps":[[227,"call","GetMergeFieldsForRecord",3],[228,"call","GetUnrelatedCustomMergeFields",2]]},{"name":"Create","line":232,"kind":"procedure","params":4,"steps":[[241,"call","GetMergeFieldsForRecord",3],[244,"call","GetMergeFieldsForRecord",4],[245,"call","GetUnrelatedCustomMergeFields",2]]},{"name":"Create","line":250,"kind":"procedure","params":1,"steps":[[259,"ext","codeunit",4100,"CreateOutStream",2]]},{"name":"Load","line":264,"kind":"procedure","params":1,"steps":[[273,"ext","codeunit",4100,"CreateOutStream",2],[275,"ext","codeunit",4100,"CreateInStream",2],[277,"call","LoadDocument",1],[278,"call","GetMergeFieldsForRecordAndRelated",2]]},{"name":"Load","line":281,"kind":"procedure","params":1,"steps":[[283,"call","LoadDocument",1],[284,"call","GetMergeFieldsForDocument",0]]},{"name":"Load","line":287,"kind":"procedure","params":2,"steps":[[292,"call","LoadDocument",1],[293,"call","GetMergeFieldsForRecordAndRelated",2]]},{"name":"LoadDocument","line":296,"kind":"procedure","access":"local","params":1,"steps":[[305,"ext","codeunit",4100,"CreateOutStream",2],[307,"ext","codeunit",4100,"CreateInStream",2],[309,"call","TryMailMergeLoadDocument",1],[314,"ext","codeunit",8703,"LogUptake",4],[316,"ext","codeunit",8703,"LogError",6]]},{"name":"TrySetDataSource","line":323,"kind":"procedure","access":"local","params":1,"steps":[[332,"call","GetFileFromZip",2],[339,"call","SetWordDocumentDataSource",1],[342,"call","ReplaceFileInZip",3]]},{"name":"GetFileFromZip","line":345,"kind":"procedure","access":"local","params":2,"steps":[[354,"ext","codeunit",425,"OpenZipArchive",2],[355,"ext","codeunit",425,"GetEntryList",1],[356,"ext","codeunit",4100,"CreateOutStream",2],[357,"ext","codeunit",425,"ExtractEntry",2],[359,"ext","codeunit",4100,"CreateInStream",2]]},{"name":"ReplaceFileInZip","line":381,"kind":"procedure","access":"local","params":3,"steps":[[389,"ext","codeunit",425,"OpenZipArchive",2],[392,"ext","codeunit",4100,"CreateOutStream",2],[394,"ext","codeunit",4100,"CreateInStream",2],[395,"ext","codeunit",425,"RemoveEntry",1],[396,"ext","codeunit",425,"AddEntry",2],[399,"ext","codeunit",425,"SaveZipArchive",1],[400,"ext","codeunit",4100,"CreateInStream",2]]},{"name":"Merge","line":415,"kind":"procedure","params":5,"steps":[[424,"ext","codeunit",4100,"CreateOutStream",2],[427,"call","TryMailMergeExecute",3],[430,"call","EditDocumentAfterMerge",1],[434,"ext","codeunit",8703,"LogUptake",4],[437,"ext","codeunit",8703,"LogUsage",4],[439,"ext","codeunit",8703,"LogError",6]]},{"name":"Merge","line":472,"kind":"procedure","params":5,"steps":[[478,"call","MergeSplitDocument",4],[480,"call","MergeOneDocument",4]]},{"name":"MergeSplitDocument","line":484,"kind":"procedure","access":"local","params":4,"steps":[[498,"ext","codeunit",425,"CreateZipArchive",0],[502,"call","CreateDataTable",1],[503,"call","GetCustomTableColumns",2],[504,"call","FillDataTable",4],[505,"call","FillDataTable",4],[506,"call","ExecuteMerge",5],[507,"call","GetDocument",1],[514,"ext","codeunit",425,"AddEntry",2],[514,"call","GetFileName",2],[515,"call","ReloadWordTemplate",0],[519,"ext","codeunit",4100,"CreateOutStream",2],[520,"ext","codeunit",425,"SaveZipArchive",1]]},{"name":"MergeOneDocument","line":523,"kind":"procedure","access":"local","params":4,"steps":[[531,"call","CreateDataTable",1],[532,"call","GetCustomTableColumns",2],[533,"call","FillDataTable",4],[536,"call","FillDataTable",4],[539,"call","ExecuteMerge",5]]},{"name":"ExecuteMerge","line":542,"kind":"procedure","access":"local","params":5,"steps":[[551,"ext","codeunit",4100,"CreateOutStream",2],[554,"call","TryMailMergeExecute",3],[557,"call","EditDocumentAfterMerge",1],[561,"ext","codeunit",8703,"LogUptake",4],[564,"ext","codeunit",8703,"LogUsage",4],[566,"ext","codeunit",8703,"LogError",6]]},{"name":"EditDocumentAfterMerge","line":591,"kind":"procedure","access":"local","params":1,"steps":[[598,"ext","codeunit",9560,"ShareEnabled",1],[606,"ext","codeunit",4100,"CreateInStream",2],[609,"write",9560,"Insert"],[611,"ext","codeunit",9560,"Share",1],[612,"ext","codeunit",4100,"CreateOutStream",2]]},{"name":"AddTable","line":649,"kind":"procedure","params":1,"steps":[[657,"write",9987,"Insert"]]},{"name":"RunModalWordTemplatesRelated","line":713,"kind":"procedure","access":"internal","params":6,"steps":[[718,"ext","page",9986,"SetEditOnly",1],[719,"ext","page",9986,"SetRelatedTable",1],[720,"ext","page",9986,"SetTableNo",1],[721,"ext","page",9986,"SetFilterExpression",1],[725,"ext","page",9986,"GetRelatedTable",1],[727,"ext","codeunit",9989,"SelectDefaultFieldsForTable",3]]},{"name":"GetTemplateName","line":764,"kind":"procedure","access":"internal","params":1,"steps":[[780,"ext","codeunit",3960,"Replace",3]]},{"name":"RefreshTreeView","line":797,"kind":"procedure","access":"internal","params":2,"steps":[[810,"write",9991,"Insert"],[815,"call","RefreshTreeViewRecursively",4],[823,"write",9991,"Modify"],[827,"call","RefreshTreeViewRecursively",4]]},{"name":"RefreshTreeViewRecursively","line":833,"kind":"procedure","access":"internal","params":4,"steps":[[842,"write",9991,"Modify"]]},{"name":"AddSelectedTable","line":849,"kind":"procedure","access":"internal","params":3,"steps":[[856,"call","GetTable",3],[859,"call","VerifyRelatedTableIdIsUnused",3],[861,"ext","codeunit",9555,"Open",3],[861,"call","GetMaximumNumberOfRecords",0],[864,"call","GenerateCode",2],[864,"call","GetExistingCodes",1],[865,"call","AddTable",6]]},{"name":"AddTable","line":868,"kind":"procedure","access":"internal","params":6,"steps":[[878,"call","VerifyRelatedTableCodeIsUnique",4],[884,"write",9991,"Insert"],[885,"ext","codeunit",9989,"SelectDefaultFieldsForTable",3]]},{"name":"EditRelatedTable","line":889,"kind":"procedure","access":"internal","params":2,"steps":[[894,"call","GetRelatedTablesFilterExpression",1],[897,"call","RunModalWordTemplatesRelated",6],[900,"write",9991,"Modify"]]},{"name":"AddUnrelatedTable","line":935,"kind":"procedure","params":4,"steps":[[941,"call","IsRelatedTableCodeAndIdUnique",3],[949,"write",9990,"Insert"],[951,"ext","codeunit",9989,"SelectDefaultFieldsForTable",3]]},{"name":"AddRelatedTable","line":954,"kind":"procedure","access":"internal","params":4,"steps":[[961,"call","GetRelatedTablesFilterExpression",1],[965,"call","RunModalWordTemplatesRelated",6],[966,"call","AddRelatedTableToBuffer",2]]},{"name":"AddRelatedTableToBuffer","line":974,"kind":"procedure","access":"internal","params":2,"steps":[[976,"call","TryAddRelatedTableToBuffer",2]]},{"name":"TryAddRelatedTableToBuffer","line":983,"kind":"procedure","access":"local","params":2,"steps":[[985,"call","VerifyRelatedTableCodeIsUnique",4],[986,"call","VerifyRelatedTableIdIsUnused",3],[990,"write",9991,"Insert"]]},{"name":"AddRelatedTable","line":1037,"kind":"procedure","access":"internal","params":2,"steps":[[1039,"call","IsRelatedTableCodeAndIdUnique",3],[1044,"write",9990,"Insert"]]},{"name":"RemoveTable","line":1060,"kind":"procedure","access":"internal","params":2,"steps":[[1070,"write",9990,"Delete"]]},{"name":"UpdateRelatedEntity","line":1073,"kind":"procedure","access":"internal","params":2,"steps":[[1078,"ext","page",9986,"SetTableNo",1],[1079,"ext","page",9986,"SetRelatedTable",1],[1082,"ext","page",9986,"GetRelatedTable",1],[1087,"write",9990,"Rename"],[1093,"write",9990,"Insert"],[1094,"write",9990,"Modify"]]},{"name":"ReloadWordTemplate","line":1098,"kind":"procedure","access":"local","params":0,"steps":[[1102,"ext","codeunit",4100,"CreateInStream",2]]},{"name":"InsertWordTemplate","line":1107,"kind":"procedure","access":"internal","params":1,"steps":[[1109,"write",9988,"Insert"]]},{"name":"GetMergeFieldsForRecordAndRelated","line":1120,"kind":"procedure","access":"local","params":2,"steps":[[1125,"call","GetMergeFieldsForRecord",3],[1130,"call","GetMergeFieldsForRecord",4],[1132,"call","GetUnrelatedCustomMergeFields",2]]},{"name":"GetUnrelatedCustomMergeFields","line":1140,"kind":"procedure","access":"local","params":2,"steps":[[1142,"call","GetCustomMergeFields",4]]},{"name":"GetMergeFieldsForRecord","line":1145,"kind":"procedure","access":"local","params":4,"steps":[[1155,"ext","codeunit",9989,"TableUsesDefaultFields",3],[1174,"call","GetAppendValue",3],[1175,"call","GetFieldName",3],[1179,"call","GetCustomMergeFields",4]]},{"name":"GetCustomMergeFields","line":1196,"kind":"procedure","access":"internal","params":4,"steps":[[1203,"ext","codeunit",9981,"SetCurrentTableId",2],[1204,"ext","codeunit",9987,"OnGetCustomFieldNames",1],[1205,"ext","codeunit",9981,"GetCustomFields",1],[1210,"ext","codeunit",9989,"IsCustomFieldSelected",4],[1211,"call","GetCustomFieldName",2]]},{"name":"GetCustomTableColumns","line":1224,"kind":"procedure","access":"local","params":2,"steps":[[1230,"ext","codeunit",9981,"SetCurrentTableId",1],[1231,"ext","codeunit",9987,"OnGetCustomFieldNames",1],[1236,"ext","codeunit",9981,"SetCurrentTableId",2],[1237,"ext","codeunit",9987,"OnGetCustomFieldNames",1],[1240,"ext","codeunit",9981,"SetCurrentTableId",2],[1241,"ext","codeunit",9987,"OnGetCustomFieldNames",1],[1242,"ext","codeunit",9981,"GetCustomFields",1]]},{"name":"AddCustomValuesToDataTable","line":1245,"kind":"procedure","access":"local","params":6,"steps":[[1254,"ext","codeunit",9983,"Initialize",1],[1255,"ext","codeunit",9983,"SetCurrentRecord",2],[1256,"ext","codeunit",9987,"OnGetCustomRecordValues",1],[1271,"call","GetCustomFieldName",2]]},{"name":"FillDataTable","line":1275,"kind":"procedure","access":"local","params":4,"steps":[[1280,"call","AddRecordRefToDataTable",7],[1281,"call","FillDataTableRelatedRecords",7],[1282,"call","FillDataTableUnrelatedRecords",4]]},{"name":"FillDataTableRelatedRecords","line":1288,"kind":"procedure","access":"local","params":7,"steps":[[1302,"call","GetRelatedRecord",2],[1303,"call","AddRecordRefToDataTable",7]]},{"name":"FillDataTableUnrelatedRecords","line":1311,"kind":"procedure","access":"local","params":4,"steps":[[1325,"call","AddRecordRefToDataTable",7],[1326,"call","FillDataTableRelatedRecords",7]]},{"name":"AddRecordRefToDataTable","line":1333,"kind":"procedure","access":"local","params":7,"steps":[[1344,"ext","codeunit",9989,"TableUsesDefaultFields",3],[1361,"call","AddFieldRefToDataTable",9],[1363,"call","AddCustomValuesToDataTable",6]]},{"name":"AddFieldRefToDataTable","line":1366,"kind":"procedure","access":"internal","params":9,"steps":[[1373,"call","GetAppendValue",3],[1374,"call","GetFieldName",3]]},{"name":"GetRelatedRecord","line":1382,"kind":"procedure","access":"internal","params":2,"steps":[[1384,"call","GetByPrimaryKey",2]]},{"name":"VerifyMailMergeFieldNameLengths","line":1432,"kind":"procedure","access":"local","params":0,"steps":[[1437,"call","GetMaximumFieldLength",0]]},{"name":"GenerateCode","line":1494,"kind":"procedure","access":"internal","params":2,"steps":[[1510,"call","IsAlphabetic",1],[1510,"call","IsAlphanumeric",1]]},{"name":"IsAlphanumeric","line":1570,"kind":"procedure","access":"local","params":1,"steps":[[1572,"call","IsAlphabetic",1]]},{"name":"OnBeforeDeleteWordTemplate","line":1601,"kind":"procedure","access":"local","params":1,"steps":[[1610,"write",9990,"DeleteAll"],[1612,"write",9989,"DeleteAll"]]}]}