Using system composer, it is possible to create a report with the sequence diagrams?

Hi @Victoria Ramirez ,

To address the problem you are facing, I had to first understand the context of the error and then provide a solution that not only resolves the issue but also enhances your reporting process.

Understanding the Error

The error message:

Error using zeros Size inputs must be integers.

suggests that somewhere in your code, an operation is trying to use non-integer values for defining array sizes. This typically occurs in MATLAB when a function expects integer dimensions but receives floating-point numbers or undefined variables instead. The stack trace indicates that this error arises during the execution of methods related to exporting or capturing images of the sequence diagrams. Specifically, it seems to be triggered when the createSnapshot method is called within the SequenceDiagram reporter.

So, I will suggest following steps to troubleshoot and resolve this issue.

First, make sure that the seqDiagrams variable correctly retrieves existing sequence diagrams from your model. You can do this by checking its length before entering the loop:

   seqDiagrams = systemcomposer.sequenceDiagrams(model_name);
   if isempty(seqDiagrams)
       warning('No sequence diagrams found in the model.');
       return; % Exit if there are no diagrams
   end

Secondly, when creating instances of systemcomposer.rptgen.report.SequenceDiagram, make sure that both seqDiagram.Name and model_name are valid strings. An invalid name could lead to issues when generating images:

   if ~ischar(seqDiagram.Name) || isempty(seqDiagram.Name)
       error('Invalid sequence diagram name detected.');
   end

Afterwards, catch potential issues while loading models or generating reports, consider adding try-catch blocks around critical sections:

   try
       % Your existing code for generating reports
   catch ME
       fprintf('Error encountered: %s\n', ME.message);
       % Additional logging or handling can go here
   end

After implementing these checks and error handling, run your script with various models and sequences to identify if specific diagrams cause issues.

If you are customizing your sequence diagram reports with templates, make sure that your templates are correctly set up and accessible. Missing or improperly formatted templates could also trigger errors during report generation.

One more thing I forgot to mention if you are using a version of MATLAB that supports all functions used in your script, as discrepancies between versions can lead to unexpected errors.

Hope this helps.

Hi @Victoria Ramirez,

I took some time out of work to resolve your problem. So, first I had to define a generic model in Matlab in order to resolve your issue and used to your code and it did execute successfully with no problems and since the model I defined did not contain any sequence data, I was expecting the warning message as shown below by executing your code. However, the error message you encountered, “Size inputs must be integers." the likely cause of this error is related to your length(seqDiagrams) function call. If seqDiagrams is not a valid array or if it contains elements that do not conform to expected types, the length function will return unexpected results like the one you observed. Also,if seqDiagrams is empty or not properly initialized, it could lead to issues when trying to access its elements in the loop.

import mlreportgen.report.*
import slreportgen.report.*
import slreportgen.finder.*
import mlreportgen.dom.*
import mlreportgen.utils.*
import systemcomposer.query.*
import systemcomposer.rptgen.finder.*
rpt = slreportgen.report.Report('OutputPath','FullArchitecture',...
  'CompileModelBeforeReporting',false);
model = systemcomposer.loadModel(model_name);
seqChapter = Chapter("Title", "Sequence Diagrams");
seqDiagrams = model.getInteractions; 
if isempty(seqDiagrams)
     warning('No sequence diagrams found in the model.');
     return; % Exit if there are no diagrams
end
try
  for i = 1:length(seqDiagrams)
      seqDiagram = seqDiagrams(i);
      % Create a SequenceDiagram reporter for each diagram
      seqReporter =   
systemcomposer.rptgen.report.SequenceDiagram("Name", ...
      seqDiagram.Name, "ModelName", model.Name);
      seqSect = Section("Title", seqDiagram.Name);
      add(seqSect, seqReporter);
      add(seqChapter, seqSect);
  end
add(rpt, seqChapter);  
catch ME
     fprintf('Error encountered: %s\n', ME.message);
     % Additional logging or handling can go here
end

Please see attached results

Afterwards, I had to modify my code that was shared in posted comments. Here is brief summary of the modified version of my code, it does include some part of your code as well. However, it utilizes various libraries to create a report that documents sequence diagrams from a System Composer model. Initially, it imports necessary packages for report generation and model handling. The model is specified by its file path, and a report object is created with a designated output path. The code then loads the specified model and checks for successful loading. If the model is not loaded, it raises an error. It retrieves sequence diagrams from the model and checks if any exist; if none are found, it issues a warning and exits. For each sequence diagram, the code creates a corresponding section in the report, adding the diagram to the report chapter. A try-catch block is employed to handle any potential errors during this process. Finally, the report is closed, which triggers the viewing or saving of the report, depending on the platform.

import mlreportgen.report.*
import slreportgen.report.*
import slreportgen.finder.*
import mlreportgen.dom.*
import mlreportgen.utils.*
import systemcomposer.query.*
import systemcomposer.rptgen.finder.*

% Define a more descriptive model name as a string
modelFileName = '/MATLAB Drive/Examples/R2024a/model_name.slx'; %     
Replace with your actual model name

% Create a report object
rpt = slreportgen.report.Report('OutputPath', 'FullArchitecture', ...
  'CompileModelBeforeReporting', false);

% Load the model
model = systemcomposer.loadModel(modelFileName);

% Check if the model is loaded successfully
if isempty(model)
  error('Model could not be loaded: %s', modelFileName);
end

% Get sequence diagrams from the model
seqDiagrams = model.getInteractions; 

% Check if there are any sequence diagrams
if isempty(seqDiagrams)
  warning('No sequence diagrams found in the model: %s', modelFileName);
  return; % Exit if there are no diagrams
end

% Create a chapter for sequence diagrams
seqChapter = Chapter("Title", "Sequence Diagrams");

try
  % Loop through each sequence diagram and add it to the report
  for i = 1:length(seqDiagrams)
      seqDiagram = seqDiagrams(i);
      % Create a SequenceDiagram reporter for each diagram
      seqReporter =     
systemcomposer.rptgen.report.SequenceDiagram("Name", ...
          seqDiagram.Name, "ModelName", model.Name);
      seqSect = Section("Title", seqDiagram.Name);
      add(seqSect, seqReporter);
      add(seqChapter, seqSect);
  end
  % Add the chapter to the report
  add(rpt, seqChapter);  
catch ME
  fprintf('Error encountered: %s\n', ME.message);
end

% Finally, close and view or save the report (depending on platform)
close(rpt);

Please see attached results of pdf file and modified version of code.