padv.builtin.task.GenerateSimulinkWebView Class
Namespace: padv.builtin.task
Superclasses: padv.Task
Task for creating web views for models
Description
This class requires CI/CD Automation for Simulink Check.
The padv.builtin.task.GenerateSimulinkWebView
class provides a task that
can create web views for your models using Simulink®
Report Generator™. You can view, navigate, and share a web view without a Simulink license.
You can add the task to your process model by using the
method addTask
. After you add the task to your process model, you can run the
task from the Process Advisor app or by using the function
runprocess
.
To view the source code for this built-in task, in the MATLAB® Command Window, enter:
open padv.builtin.task.GenerateSimulinkWebView
The padv.builtin.task.GenerateSimulinkWebView
class is a handle
class.
Creation
Description
creates a task for creating web views using Simulink
Report Generator.task
= padv.builtin.task.GenerateSimulinkWebView()
sets certain properties using one or more name-value arguments. For
example, task
= padv.builtin.task.GenerateSimulinkWebView(Name=Value
)task = padv.builtin.task.GenerateSimulinkWebView(Name =
"MyWebViewTask")
creates a task with the specified name.
You can use this syntax to set property values for InputQueries
,
Name
, IterationQuery
,
InputDependencyQuery
, Licenses
,
LaunchToolAction
, and LaunchToolText
.
The padv.builtin.task.GenerateSimulinkWebView
class also has other properties, but you cannot set
those properties during task creation.
Properties
The GenerateSimulinkWebView
class inherits properties from padv.Task
. The properties listed in
Specialized Inherited Properties are padv.Task
properties that the GenerateSimulinkWebView
task overrides.
The task also has properties for specifying Web View Options for exporting Simulink models to web views by using slwebview
.
Name
— Unique identifier for task in process
"padv.builtin.task.GenerateSimulinkWebView"
(default) | string
Unique identifier for task in process, specified as a string.
Example: "MyWebViewTask"
Data Types: string
Title
— Human-readable name that appears in Process Advisor app
"Generate Simulink Web View"
(default) | string
Human-readable name that appears in Process Advisor app, specified as a string.
Example: "My Web View Task"
Data Types: string
DescriptionText
— Task description
"This task uses Simulink Report Generator to create a web
view for your models."
(default) | string
Task description, specified as a string.
When you point to a task in Process Advisor and click the information icon, the tooltip shows the task description.
Example: "This task uses Simulink Report Generator to create a web view for
your models."
Data Types: string
DescriptionCSH
— Path to task documentation
path to GenerateSimulinkWebView
documentation (default) | string
Path to task documentation, specified as a string.
When you point to a task in Process Advisor, click the ellipsis (...), and click Help, Process Advisor opens the task documentation.
Example: fullfile(pwd,"taskHelpFiles","myTaskDocumentation.pdf")
Data Types: string
RequiredIterationArtifactType
— Artifact type that task can run on
"sl_model_file"
(default) | ...
Type of artifact, specified as one or more of the values listed in this table. To specify multiple values, use an array.
Category | Artifact Type | Description |
---|---|---|
MATLAB | "m_class" | MATLAB class |
"m_file" | MATLAB file | |
"m_func" | MATLAB function | |
"m_method" | MATLAB class method | |
"m_property" | MATLAB class property | |
Model Advisor | "ma_config_file" | Model Advisor configuration file |
"ma_justification_file" | Model Advisor justification file | |
Process Advisor | "padv_dep_artifacts" | Related artifacts that current artifact depends on |
"padv_output_file" | Process Advisor output file | |
Project | "project" | Current project file |
Requirements | "mwreq_item" | Requirement (since R2024b) |
| Requirement (for R2024a and earlier) | |
"sl_req_file" | Requirement file | |
"sl_req_table" | Requirements Table | |
Stateflow® | "sf_chart" | Stateflow chart |
"sf_graphical_fcn" | Stateflow graphical function | |
"sf_group" | Stateflow group | |
"sf_state" | Stateflow state | |
"sf_state_transition_chart" | Stateflow state transition chart | |
"sf_truth_table" | Stateflow truth table | |
Simulink | "sl_block_diagram" | Block diagram |
"sl_data_dictionary_file" | Data dictionary file | |
"sl_embedded_matlab_fcn" | MATLAB function | |
"sl_block_diagram" | Block diagram | |
"sl_library_file" | Library file | |
"sl_model_file" | Simulink model file | |
"sl_protected_model_file" | Protected Simulink model file | |
"sl_subsystem" | Subsystem | |
"sl_subsystem_file" | Subsystem file | |
System Composer™ | "zc_block_diagram" | System Composer architecture |
"zc_component" | System Composer architecture component | |
"zc_file" | System Composer architecture file | |
Tests | "harness_info_file" | Harness info file |
"sl_harness_block_diagram" | Harness block diagram | |
"sl_harness_file" | Test harness file | |
"sl_test_case" | Simulink Test™ case | |
"sl_test_case_result" | Simulink Test case result | |
"sl_test_file" | Simulink Test file | |
"sl_test_iteration" | Simulink Test iteration | |
"sl_test_iteration_result" | Simulink Test iteration result | |
"sl_test_report_file" | Simulink Test result report | |
"sl_test_result_file" | Simulink Test result file | |
"sl_test_resultset" | Simulink Test result set | |
"sl_test_seq" | Test Sequence | |
"sl_test_suite" | Simulink Test suite | |
"sl_test_suite_result" | Simulink Test suite result |
Example: "sl_model_file"
Example: ["sl_model_file "zc_file"]
IterationQuery
— Find artifacts that task iterates over
padv.builtin.query.FindModels
(default) | padv.Query
object | name of padv.Query
object
Query that finds the artifacts that the task iterates over, specified as a
padv.Query
object or the name of a padv.Query
object. When you specify IterationQuery
, the task runs one time
for each artifact returned by the query. In the Process
Advisor app, the artifacts returned by IterationQuery
appear under task title.
For more information about task iterations, see Overview of Process Model.
InputDependencyQuery
— Finds artifact dependencies for task inputs
padv.Query
object | name of padv.Query
object
Query that finds artifact dependencies for task inputs, specified as a
padv.Query
object or the name of a padv.Query
object.
The build system runs the query specified by
InputDependencyQuery
to find the dependencies for the task
inputs, since those dependencies can impact if task results are up-to-date.
For more information about task inputs, see Overview of Process Model.
Example: padv.builtin.query.GetDependentArtifacts
Licenses
— List of licenses that task requires
["matlab_report_gen"
"simulink_report_gen"]
(default) | string
List of licenses that the task requires, specified as a string.
Data Types: string
LaunchToolAction
— Function that launches tool
@launchToolAction
(default) | function handle
Function that launches a tool, specified as the function handle.
When you point to a task in the Process Advisor app, you can click the ellipsis (...) to see more options. For built-in tasks, you have the option to launch a tool associated with the task.
For the task GenerateSimulinkWebView
, you can launch a web view
options dialog.
Data Types: function_handle
LaunchToolText
— Description of action that LaunchToolAction
property performs
"Open Web View Options"
(default) | string
Description of the action that the LaunchToolAction
property
performs, specified as a string.
Data Types: string
InputQueries
— Inputs to task
padv.Query
object | name of padv.Query
object | array of padv.Query
objects
Inputs to the task, specified as:
a
padv.Query
objectthe name of
padv.Query
objectan array of
padv.Query
objectsan array of names of
padv.Query
objects
By default, the task GenerateSimulinkWebView
gets the current model
that the task is iterating over by using the built-in query
padv.builtin.query.GetIterationArtifact
.
OutputDirectory
— Location for standard task outputs
fullfile('$DEFAULTOUTPUTDIR$', '$ITERATIONARTIFACT$',
'webview')
(default) | string
Location for standard task outputs, specified as a string.
The built-in tasks use tokens, like $DEFAULTOUTPUTDIR$
, as
placeholders for dynamic path resolution during run-time. For more information, see
Dynamically Resolve Paths with Tokens.
Data Types: string
FollowLinks
— Follow links into library blocks
1
(default) | 0
Follow links into library blocks, specified as either:
0
— Does not allow you to follow links into library blocks in a web view1
— Allows you to follow links into library blocks in a web view
Example: 0
FollowModelReference
— Access referenced models in web view
1
(default) | 0
Access referenced models in a web view, specified as either:
0
— Does not allow you to access referenced models in a web view1
— Allows you to access referenced models in a web view
Example: 0
IncludeNotes
— Include user notes in web view
true
or 1
(default) | false
or 0
Include user notes in web view, specified as a numeric or logical
1
(true
) or 0
(false
).
Example: false
Data Types: logical
IncrementalExport
— Export models incrementally
false
or 0
(default) | true
or 1
Export models incrementally, specified as a numeric or logical 1
(true
) or 0
(false
).
Example: true
Data Types: logical
LookUnderMasks
— Export ability to interact with masked blocks
"All"
(default) | "None"
Export the ability to interact with masked blocks, specified as either
"None"
or "All"
.
Example: "None"
PackagingType
— Type of web view output package
"unzipped"
(default) | "zipped"
| "both"
Type of web view output package, specified as "zipped"
,
"unzipped"
, or "both"
.
Example: "zipped"
RecurseFolder
— Export models in subfolders
false
or 0
(default) | true
or 1
Export models in subfolders, specified as a numeric or logical 1
(true
) or 0
(false
).
Example: true
Data Types: logical
ReportName
— File name for generated report
"$ITERATIONARTIFACT$_webview"
(default) | string
File name for the generated report, specified as a string.
The built-in tasks use tokens, like $ITERATIONARTIFACT$
, as
placeholders for dynamic path resolution during run-time. For more information, see
Dynamically Resolve Paths with Tokens.
Example: "myModel_webview"
Data Types: string
ReportPath
— Path to generated report
fullfile('$DEFAULTOUTPUTDIR$', '$ITERATIONARTIFACT$',
'webview')
(default) | string
Path to the generated report, specified as a string.
Data Types: string
SearchScope
— Systems to export
"All"
(default) | "CurrentAndBelow"
| "CurrentAndAbove"
| "Current"
Systems to export, relative to the system_name
system, specified
as "All"
, "CurrentAndBelow"
,
"CurrentAndAbove"
, or "Current"
.
Example: "Current"
ShowProgressBar
— Display status bar when exporting web view
false
or 0
(default) | true
or 1
Display the status bar when you export a web view, specified as a numeric or logical
1
(true
) or 0
(false
).
Example: true
Data Types: logical
ViewFile
— Display exported web view in web browser
false
or 0
(default) | true
or 1
Display the web view in a web browser when you export the web view, specified as a
numeric or logical 1
(true
) or
0
(false
).
Example: true
Data Types: logical
Methods
Specialized Public Methods
This class overrides the following inherited methods.
run | Create web views using Simulink Report Generator Note You do not need to manually invoke this method. When you run a task using
the Process Advisor app or the
The function taskResult = run(obj, input) ... end |
dryRun |
Dry run the task to validate task inputs and generate
representative task outputs without actually running the task. The function taskResult = dryRun(obj, input) ... end |
launchToolAction | Launch web view options dialog. Process Advisor uses this method when you open the tool associated with a task. |
Examples
Add Web View Task to Process
Add a task that can create web views for the models in your project.
Open the process model for your project. If you do not have a process model, open the Process Advisor app to automatically create a process model.
In the process model file, add the GenerateSimulinkWebView
task to
your process model by using the addTask
method.
slwebTask = pm.addTask(padv.builtin.task.GenerateSimulinkWebView);
You can reconfigure the task behavior by using the task properties. For example, to have the task not follow links into library blocks:
slwebTask.FollowLinks = false;
Tips
If you run MATLAB using the
-nodisplay
option or you use a machine that does not have a display (like many CI runners and Docker® containers), you should set up a virtual display server before you include this task in your process model. For information, see Set Up Virtual Display Machines Without Displays.
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)