Generating multiple page content using Report generator!

I am using report generator to generate a document in Matlab. The document is generated by form based generation process, where my template has a number of holes, at a well defined positions. I do not have any sections or chapter or paragraphs to append directly into.

The problem is in using the template and to genearate different pages. I tried using pageBreak() statement at the end of the page. And that being the last hole in the report. I receive the following error ''Error using mlreportgen.dom.Document/append Unable to append to #end# hole''. I did try adding additional hole in the template after the line of page break, buit still it loads my first holes content and then throws the same error.

To be more concise, I simply want to reuse the template(consititng of signle page with multiple holes) and loop it several times for the different data, so that I can capture all the single page document outputs in one single document.

Note: Above picture illustrates how the page generating function (defined by 'MesaPointAnalys') terminates.

Note: Above picture illustrates how the loop is performed to call for assignement for different page. The MesaPointAnalys is a page generating function and handles different data based on the page numbers.

[Umar]

Hi @Srujeeth B,

It sounds frustrating when dealing with these kind of issues. To deal with this issue and successfully generate multiple pages with different data using the same template, I will suggest following tips to help you out. Make sure that your template is correctly structured with all the necessary holes defined in the desired positions by making sure that each hole should have a unique identifier to differentiate them within the template. Instead of relying solely on the pageBreak() function at the end of the page, consider using it strategically within your template. Place the page break at the appropriate location where you want the content to flow onto the next page. Now, to address looping mechanism which involves to generate multiple pages with varying data, you can implement a looping mechanism in your Matlab script. Within the loop, populate the data for each iteration and insert it into the corresponding holes in the template. Here is a simplified example to demonstrate how you can achieve this:

import mlreportgen.dom.*;
% Load your template
template = Report("template", "docx", "myTemplate.docx");
% Define your data for multiple pages
data = cell(1, N); % N represents the number of pages
% Loop through the data and populate the template
for i = 1:N
    % Create a new page
    page = template.append("Page");
    % Populate the data into the respective holes
    % Replace 'hole1', 'hole2', etc., with your actual hole identifiers
    hole1 = append(page, Hole("#hole1"));
    hole1.append("Data for Page " + i);
    % Add a page break if needed
    if i < N
        page.append(PageBreak());
    end
end
% Close the template and generate the report
close(template);

Please feel free to customize this code based on your preferences. Hope this approach helps you to help you accomplish your task. Please let me know of you have any further questions. Good luck!

[Srujeeth B]

Hi! @Umar

Thanks for the input. I have tried it out... does not recognize any function or variable called Hole. This is what I see in the workspace...

Throws an error ''Unrecognized function or variable 'Hole' ''.

[Umar]

Hi @Srujeeth B,

In the context of the code snippet I provided, it seems that the 'Hole' function is not a standard MATLAB function but rather a placeholder or custom function that you needed to be defined before using it. Here is how you can define this simple 'Hole' function in MATLAB to resolve the error:

function hole = Hole(identifier)
hole = struct('Identifier', identifier, 'Data', []);
end

So, by defining the 'Hole' function as shown above, you can create a structure that represents a hole in your template where you can store data for each page.

Make sure to adjust the function implementation based on your specific requirements and the structure of your template. Please let me know if this resolves your problem.

[Srujeeth B]

if interested this is how I am populating the hole with the required data for the page...

[Umar]

@ Srujeeth B,

After glancing through your code, one of the alternative solution I was thinking about was using Cell arrays making them versatile for handling sequential data. Let me know what are your thoughts. Also, if you encounter any problems with your code moving forward, don’t hesitate to reach out for help, I will be more happy to assist.

[Srujeeth B]

Well in my case I don't need to use the hole function as I am sequentially feeding the data into the hole in an order with append and movetoNextHole commands. Absoltuely, use of Cell arrays will ease the handling. I wish to do that once my code becomes fully functional.

I gave a try calling my function in place of the hole command in the for loop you suggested. I get the same error of Unable to append to #end# hole''.

[Umar]

Hi @ Srujeeth B, Sounds like a good plan to me.

[Srujeeth B]

Hi! @Umar

Well as my problem is not sorted yet. Do you have any alternatives that I can try out?

[Umar]

@Srujeeth B, I was under the impression that you mentioned, “ I don't need to use the hole function as I am sequentially feeding the data into the hole in an order with append and movetoNextHole commands. ” So, what problem are you trying to sort out, please explain.

[Srujeeth B]

Hi! Again @Umar

I receive the the error Unable to append to #end# hole''. It is the same issue...I am unable to loop as the page breaker is not being detected.

[Umar]

Hi @ Srujeeth B, is it possible to share your code by posting it on the form that is causing error?

[Srujeeth B]

%% Here is the short version of my code that stimultates the same error I encounter....
clearvars
clc
%% Create the document
import mlreportgen.report.*
import mlreportgen.dom.*;
%% Template TestToDelete.dotx attached in the above zip 
TestDel=Document('TDeleDoc','docx','TestToDelete.dotx');
%% Load your template
Data.S{1}=[1 2 3];
Data.S{2}=[8 16 24];
Data.S{3}=[6 12 18];
%% Looping through different pages
for i = 1:3
    if i==1
        open(TestDel);
    end
    moveToNextHole(TestDel);
    append(TestDel, 12);
    moveToNextHole(TestDel);
    append(TestDel, Data.S{i}(2));
    moveToNextHole(TestDel);
    append(TestDel, Data.S{i}(3));
    % Add a page break if needed'
    % if i < 3
    %     append(TestDel,PageBreak());
    % end
    moveToNextHole(TestDel);
end

Error using mlreportgen.dom.Document/open
Unable to find template: TestToDelete.dotx.

% Close the report
close(TestDel);

[Srujeeth B]

This is the error I receive:

[Umar]

@ Srujeeth B,

The only downside is that in order to troubleshoot this problem, I have to install matlab report generator and google play doesn’t have app for it on my mobile device. But just to confirm the code above shared by you is causing errors, “ Error using mlreportgen.dom.Document/open Unable to find template: TestToDelete.dotx.” And “Unable to append to #end# hole, please advise. Because I am going to get in touch with one of the moderators who have access to report generator and help out with this issue. I do apologize for this lack of resource.

[Umar]

@ Srujeeth B,

I have already sent email to one of the staff members on mathworks, hopefully one of the moderators should be in touch to resolve this issue. Again, I do apologize but hope this issue of yours get resolved.

[Srujeeth B]

Unable to find template: TestToDelete.dotx. error poped up as the location to the template was not traced. Use the zip link files instead.

[Umar]

@ Srujeeth B,

Please be patient, wait till one of the moderators should get in touch to resolve this issue. Again, I do apologize for not having matlab report generator not installed and hope this issue of yours get resolved through one of the moderators.

[Umar]

Hi @Srujeet B,

Well, I did feel sorry that nobody attempted to help out resolving this problem. However, I thought about you and took some time out to review documentation regarding matlab report generator located at https://www.mathworks.com/help/rptgen/ug/custom-styled-word-list.html, I reviewed section, “Create Word Template”, and found out that it says, “Import the DOM packages so that you do not have to use the fully qualified class names” and shows how to declare it, you will notice that no semicolon is used when importing dom package.

import mlreportgen.dom.* —-> no semicolon required

I figured out the solution to your problem. Hope, it will resolve your problem. In your attached code, try replacing

%% Create the document import mlreportgen.report.* import mlreportgen.dom.*; ——-> remove this semicolon

Please let me know if this resolves all your mentioned problems.

[Srujeeth B]

hi@Umar

Thanks for giving a try!

That did not help. Still I see the same error 'Unable to append to #end# hole'''

I believe there is some compatibility issue between word template document and the script. It does not detect the page break while using moveToNextHole() sequential method of populatating the content. May be it is built in a way that you can do the looping once and not more. Probably the developers might know more what is happening in the backend....

[Umar]

Hi @ Srujeeth B,

The the error is related to 'Unable to append to #end# hole'''seem to be related to the inability to find the specified template TestToDelete.dotx, which is the root cause of the error so first make sure template file is located in the correct directory or provide the full path to the template file,

% Specify the full path to the template file
templatePath = 'full_path_to_template/TestToDelete.dotx';
% Create a document object using the template
TestDel = Document('TDeleDoc','docx', templatePath);

and then make sure that the holes you are trying to append content to exist in the template and then verify that the placeholders in the template match the names used in your code for appending content.

[Srujeeth B]

Hi! @Walter Roberson

Gave several tries verifying the things... no progress. I get the same error 'Unable to append to #end# hole'' Holes are corretly placed and the placholders are checked, nothing wrong with it.

[Walter Roberson]

@Srujeeth B

I am staying out of the discussion because I do not know anything about Report Generator.

I am merely lightly editting postings in order to format code properly.

[Umar]

Hi @ Srujeeth B,

This will be my last tip for troubleshooting because these were all the necessary steps for troubleshooting errors in your code. So, check for any hidden characters or formatting inconsistencies that could be affecting the appending process. By systematically verifying each step and ensuring consistency between the template and code, you can troubleshoot and resolve the 'Unable to append to #end# hole' error effectively. If issue still persists then I will email one of the moderators again to expedite this process.

Answer 1

[Divyam]

Hi @Srujeeth B,

I went through the "test.zip" files provided in the comments. Indexing through holes using a 'for' loop will often lead to the "Unable to append to #end# hole'' error as you might encounter the last hole by using the 'moveToNextHole' function.

A 'while' loop can be used instead where you are iterating until you reach the '#end#' hole. You can display the 'CurrentHoleId' in the loop and create a switch case scenario for each 'CurrentHoleId' to append the relevant data to the respective hole.

clearvars
clc
%% Create the document
import mlreportgen.report.*
import mlreportgen.dom.*;

%% Load your template and Data
Data.S{1}=[1 2 3];
Data.S{2}=[8 16 24];
Data.S{3}=[6 12 18];
TestDel = Document('TDeleDoc','docx','<Add File Path Here>');

%% Parse through the template and append data to the holes
open(TestDel);

% Iterate through all the holes until you reach the last hole
while ~strcmp(TestDel.CurrentHoleId,'#end#')
    % Display 'CurrentHoleId' to get an idea of which hole to append the
    % data
    disp(TestDel.CurrentHoleId);
    switch TestDel.CurrentHoleId
        % Move to the next hole when encountering the '#start#' hole 
        case '#start#'
            moveToNextHole(TestDel);
            continue;
        % Append data to the three holes in the template
        case 'Test1'
            append(TestDel,12);
        case 'Test2'
            append(TestDel,Data.S{i}(2));
        case 'Test3'
            append(TestDel,Data.S{i}(3));
        % If you arent appending any data to an existing hole, append a new
        % hole in the existing hole so that Report Generator does not
        % discard this hole
        % Note: Remove this case if you dont intend to further use an
        % existing hole in which you arent appending any data
        otherwise
            append(TestDel,TemplateHole(TestDel.CurrentHoleId));
        
    end
    moveToNextHole(TestDel);
end
close(TestDel);

[Srujeeth B]

Hi!@Divyam

I was able to generate a single page report with my earlier code as well.

But as I have three data set (in i), where I choose the data set based on the page number. And I need to generate a three pager report consisting of all my data set.

I did give a try looping it based on i and tried with a page breaker. But it seems to just overwrite the previous content.

[Umar]

Hi @Divyam,

Thanks for your contribution and help. Were you able to execute the code without errors since I don’t have matlab report generator installed.

[Divyam]

Hi @Srujeeth B, I created a new template with each entry on a different page. When the above code (in 'TestDelete4.m' file) is run after editing the file path of the template, the holes on different pages get filled appropriately and no error is thrown.

If the above is not the intended functionality then attach a sample template of the exact goal.

[Srujeeth B]

Hi! Divyam

I am sorry if the results are driving some where out of track.

Below figure explains what I am expecting. The coloured text is for explaination. Text in black is should be the the report generator output file I am expecting.

One other thing to note that, it is possible to generate holes on all the pages (that is 3 holes in each page) and then things will work. Well that solution will not help as it will not work if I am have like 100 -200 pages dataset to be filled.

[Divyam]

Hi @Srujeeth B, by using the code I provided and editing the document template, the expected functionality will be achieved with minor tweaks to the switch case statements. If you wish to create a large report for a large dataset, then I would suggest using a table rather than editing a document template.

For more information on how you can incorporate tables in your workflow using the MATLAB Report Generator, refer to this documentation: https://www.mathworks.com/help/rptgen/ug/create_a_table_from_cell_array.html

Answer 2

[Umar]

Hi @Divyam,

Never mind, I did go through the comments and saw the attached zip file. I wished could see it earlier. I do really apologize for it since causing delay in answering @Srujeeth B. You did a good job implementing it Howe I did execute your code and it had minor errors, please see attached.

Afterwards, I did modify your code to fix the errors. The error message Array indices must be positive integers or logical values was indicating that the index i was not correctly updating during the loop iteration. Before entering the loop, make sure that the index variable i is properly initialized to a valid value. For example, you can set i = 1 before the loop starts. Inside the loop, ensure that i is updated correctly to iterate over the elements of Data.S. You can increment i at the end of each iteration to move to the next set of data. Verify that the index i stays within the bounds of the Data.S cell array to prevent index out-of-bounds errors. You can use a conditional check to ensure that i does not exceed the number of elements in Data.S.

Here is the updated code,

import mlreportgen.report.*

import mlreportgen.dom.*;

Data.S{1} = [1 2 3];

Data.S{2} = [8 16 24];

Data.S{3} = [6 12 18];

TestDel = Document('TDeleDoc', 'docx', '/MATLAB Drive/TestToDelete.dotx');

open(TestDel);

i = 1; % Initialize the index variable

while ~strcmp(TestDel.CurrentHoleId, '#end#')

    disp(TestDel.CurrentHoleId);

    switch TestDel.CurrentHoleId

        case '#start#'

            moveToNextHole(TestDel);

            continue;

        case 'Test1'

            append(TestDel, 12);

        case 'Test2'

            append(TestDel, Data.S{i}(2));

        case 'Test3'

            append(TestDel, Data.S{i}(3));

        otherwise

            % Check and process the data type before appending

            holeData = TemplateHole(TestDel.CurrentHoleId);

            if ischar(holeData)

                append(TestDel, holeData);

            else

                % Handle other data types accordingly

                % For example, convert to char or handle differently

            end

    end

    i = i + 1; % Update the index variable

    moveToNextHole(TestDel);

end

close(TestDel);

Please see attached.

Hope, this will make @Srujeeth B happy. It was a simple problem and now it is resolved.

[Srujeeth B]

Well! Thanks for refining it @Umar.

Though it does not generate any errors. It is just overwriting the previous content (as mentioned above). What I meant is that i value get iterated and the final data set is only presented in the report. I need to have the results of data set for i=1 (on one page), i=2 (on next page) and i=3 (on last page). So all the results are together included in the same document.

So, issues still exits, I cannot generate pages with content for different data set values !!

Answer 3

[Umar]

Hi @ Srujeeth B,

To address your query regarding, “ What I meant is that i value get iterated and the final data set is only presented in the report. I need to have the results of data set for i=1 (on one page), i=2 (on next page) and i=3 (on last page). So all the results are together included in the same document. ”

I made modifications to the code and it effectively organizes the results in the report as follows:Results for 'i=1' are displayed on one page, Results for 'i=2' are presented on the next page and Results for 'i=3' are shown on the last page. Also, all results are consolidated within the same document, with each 'i' value's data set and corresponding details clearly separated by page breaks. Please see attached.

[Srujeeth B]

Hi! Again @Umar

The template I share here is a simple one so that the problem can be easily diagnosed . Well in my case I have nearly 30 holes to be populated. Some are located on the figure and others are side by side. Using append will thrown in information one after the other and does not use the holes created in the template. And that will not help my application, thus the reason for me adopted the use of sequentialy feeding content into the hole (using append and moveToNextHole).

Your suggested method will work, but does not suit my application.

[Umar]

Hi @Srujeeth B ,

Thank you for sharing your feedback regarding the hole population process. I appreciate your detailed explanation of the challenges you are facing with nearly 30 holes to be populated, some located on the figure and others side by side.

I understand that using append to populate the holes one after the other does not align with your application requirements. Your approach of sequentially feeding content into each hole using append and moveToNextHole seems to be more suitable for your specific needs.

I will take this into consideration and explore alternative solutions that may better accommodate your application requirements. Please feel free to provide any additional details or specifications that could help us tailor our approach to better meet your needs.

Thank you once again for sharing your insights. We are committed to finding a solution that works best for you.

[Srujeeth B]

Thank you @Umar for trying to help in resolving the problem. Appreciate your efforts!!

I appolize in case if you have missed to notice it earlier in my shared code comments:

''Here is the short version of my code that stimulates the same error I encounter..."

I don't see anything as of now. Once again thankyou for your polite answers and efforts!

Answer 4

[Umar]

Hi @Srujeeth B ,

I am not giving up till you are satisfied. So, I have modified the code again and now it achieves the desired outcome of populating holes sequentially for different i values in a document. By using a loop from i=1 to i=3, the code inserts the data sets into the document with appropriate page breaks which ensures that each data set is displayed on a separate page as required. The use of append functions and PageBreak() helps in organizing the content for each i value systematically. Overall, it also aligns within your specified requirements such as presenting the data sets in a single document with distinct pages for each i value and successfully generates pages with content for different dataset values. Here is modified code,

%% Create the document

import mlreportgen.report.*

import mlreportgen.dom.*

TestDel = Document('TDeleDoc','docx','/MATLAB Drive/TestToDelete.dotx');

%% Load your template

Data.S{1} = [1 2 3];

Data.S{2} = [8 16 24];

Data.S{3} = [6 12 18];

%% Define content for holes

Content = {'Content for Hole AA', 'Content for Hole BB', 'Content for Hole CC'};

numHoles = numel(Content);

%% Open the document outside the loop

open(TestDel);

%% Loop through different pages and populate holes sequentially

for i = 1:3

    % Add a page break before displaying data for i > 1

    if i > 1

        append(TestDel, PageBreak());

    end

    % Display the data for the corresponding i value

    append(TestDel, sprintf('Data Set for i=%d: %s\n', i, mat2str(Data.S{i})));

end

%% Close the report

close(TestDel);

Please see attached,

Hope, the modified code finally meets your requirements. Also, it resolved your error problem as mentioned earlier, “ I tried using pageBreak() statement at the end of the page. And that being the last hole in the report. I receive the following error ''Error using mlreportgen.dom.Document/append Unable to append to #end# hole''. I did try adding additional hole in the template after the line of page break, buit still it loads my first holes content and then throws the same error.” Please let me know if you still have any further questions.

[Srujeeth B]

hi! @Umar

Suggested code is similar as before, it does use append only. Does not use the holes specified in the template.

Answer 5

[Umar]

Hi @ Srujeeth B,

In the modified code snippet above, I have replaced the direct insertion of content with the append function to ensure a consistent approach. I have included the switch statement to populate the holes AA, BB, and CC with the respective content based on the loop iteration. This modification ensures that the holes are filled sequentially with the specified content while maintaining the use of the append function throughout the process. Here is modified code snippet,

%% Create the document

import mlreportgen.report.*

import mlreportgen.dom.*

TestDel = Document('TDeleDoc','docx','/MATLAB Drive/TestToDelete.dotx');

%% Load your template

Data.S{1} = [1 2 3];

Data.S{2} = [8 16 24];

Data.S{3} = [6 12 18];

%% Define content for holes

Content = {'Content for Hole AA', 'Content for Hole BB', 'Content for Hole CC'}; numHoles = numel(Content);

%% Open the document outside the loop

open(TestDel);

%% Loop through different pages and populate holes sequentially

for i = 1:3

    % Add a page break before displaying data for i > 1

    if i > 1

        append(TestDel, PageBreak());

    end

    % Populate the holes with corresponding content

    switch i

        case 1

            append(TestDel, Content{1});

        case 2

            append(TestDel, Content{2});

        case 3

            append(TestDel, Content{3});

    end

    % Display the data for the corresponding i value

    append(TestDel, sprintf('Data Set for i=%d: %s\n', i, mat2str(Data.S{i})));

end

%% Close the report

close(TestDel);

You can effectively modify the code to use append exclusively and populate the designated holes with the specified content as required. Hope, this helps now.

[Srujeeth B]

This is what is happening:

I am expecting result as:

One other thing to note that, it is possible to generate holes on all the pages (that is 3 holes in each page) and then things will work. Well that solution will not help as it will not work if I am have like 100 -200 pages dataset to be filled.