compiler.build.webAppArchive

Create an archive for deployment to MATLAB Web App Server

Since R2020b

collapse all in page

Syntax

compiler.build.webAppArchive(AppFile)
compiler.build.webAppArchive(AppFile,Name,Value)
compiler.build.webAppArchive(opts)
results = compiler.build.webAppArchive(___)

Description

compiler.build.webAppArchive(AppFile) creates a web app archive using a MATLAB® app specified by AppFile.

example

compiler.build.webAppArchive(AppFile,Name,Value) creates a web app archive with options specified using one or more name-value arguments. Options include the archive name, additional files to include, and the output directory.

example

compiler.build.webAppArchive(opts) creates a web app archive with options specified using a compiler.build.WebAppArchiveOptions object opts. You cannot specify any other options using name-value arguments.

example

results = compiler.build.webAppArchive(___) returns build information as a compiler.build.Results object using any of the argument combinations in previous syntaxes. The build information consists of the build type, the path to the compiled archive, and build options.

example

Examples

collapse all

Create a web app archive from a MATLAB app named Mortgage.mlapp.

For this example, use the MATLAB app named Mortgage.mlapp.

setupExample("matlab/MortgageCalculatorExample",pwd)
appFile = "Mortgage.mlapp";

Build a web app archive using the compiler.build.webAppArchive command.

compiler.build.webAppArchive(appFile);

The build function generates the following files within a folder named MortgagewebAppArchive in your current working directory:

  • includedSupportPackages.txt — Text file that lists all support files included in the archive.

  • Mortgage.ctf — Component technology file that contains the deployable archive.

  • mccExcludedFiles.log — Log file that contains a list of any toolbox functions that were not included in the web app. For more information on non-supported functions, see MATLAB Compiler Limitations.

  • requiredMCRProducts.txt — Text file that contains product IDs of products required by MATLAB Runtime to run the web app.

  • unresolvedSymbols.txt — Text file that contains information on unresolved symbols.

For information on deploying web apps, see Deploy Web App.

Create a web app archive and customize it using name-value arguments.

For this example, use the app Mortgage.mlapp. Use name-value arguments to specify the archive name and output directory, and display progress information during the build process.

setupExample("matlab/MortgageCalculatorExample",pwd)
appFile = "Mortgage.mlapp";
compiler.build.webAppArchive(appFile, ...
'ArchiveName','MyWebApp', ...
'OutputDir','D:\Documents\MATLAB\work\WebApps', ...
'Verbose','on')

The function generates the following files within a folder named WebApps in your current working directory:

  • includedSupportPackages.txt

  • Mortgage.ctf

  • mccExcludedFiles.log

  • requiredMCRProducts.txt

  • unresolvedSymbols.txt

Create multiple web app archives using a compiler.build.WebAppArchiveOptions object.

Create a WebAppArchiveOptions object using the file Mortgage.mlapp. Use name-value arguments to specify a common output directory and disable automatic detection of data files.

setupExample("matlab/MortgageCalculatorExample",pwd)
appFile = "Mortgage.mlapp";
opts = compiler.build.WebAppArchiveOptions(appFile, ...
'OutputDir','D:\Documents\MATLAB\work\WebAppBatch', ...
'AutoDetectDataFiles','off')
opts = 
  WebAppArchiveOptions with properties:

                  AppFile: 'D:\Documents\MATLAB\work\Mortgage.mlapp'
              ArchiveName: 'Mortgage'
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\WebAppBatch'

Build the web app archive using the WebAppArchiveOptions object.

compiler.build.webAppArchive(opts);

To compile using the file ExampleApp2.mlapp with the same options, use dot notation to modify the AppFile of the existing WebAppArchiveOptions object before running the build function again.

opts.AppFile = 'ExampleApp2.m';

By modifying the AppFile argument and recompiling, you can compile multiple archives using the same options object.

Create a web app archive and save information about the build type, archive file, included support packages, and build options to a compiler.build.Results object.

Compile using the file Mortgage.mlapp.

results = compiler.build.webAppArchive('Mortgage.mlapp')
results = 

  Results with properties:

              BuildType: 'webAppArchive'
                  Files: {'D:\Documents\MATLAB\work\MortgagewebAppArchive\Mortgage.ctf'}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.WebAppArchiveOptions]
    RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

The Files property contains the path to the deployable archive file Mortgage.ctf.

Input Arguments

collapse all

Path to the main file, specified as a row character vector or a string scalar. The file must be a MATLAB app with the .mlapp extension. The path can be relative to the current working directory or absolute.

Example: 'mywebapp.mlapp'

Data Types: char | string

Web app build options, specified as a compiler.build.WebAppArchiveOptions object.

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Verbose','on'

Additional files and folders to include in the web app archive, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.

Example: 'AdditionalFiles',["myvars.mat","myfunc.m"]

Data Types: char | string | cell

Name of the web app archive, specified as a character vector or a string scalar. The default value is the file name of AppFile.

Example: 'ArchiveName','MyWebApp'

Data Types: char | string

Flag to automatically include data files, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • If you set this property to 'on', then data files that you provide as inputs to certain functions (such as load and fopen) are automatically included in the web app archive.

  • If you set this property to 'off', then you must add data files to the archive using the AdditionalFiles property.

Example: 'AutoDetectDataFiles','Off'

Data Types: logical

Since R2024b

Paths to the external AES encryption key and MEX key loader files, specified as a scalar struct with exactly two row char vector or string scalar fields named EncryptionKeyFile and RuntimeKeyLoaderFile, respectively. Both struct fields are required. File paths can be relative to the current working directory or absolute.

For example, specify the encryption key as encrypt.key and loader file as loader.mexw64 using struct keyValueStruct.

keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'

The encryption key file must be in one of the following supported formats:

  • Binary 256-bit AES key, with a 32 byte file size

  • Hex encoded AES key, with a 64 byte file size

The MEX file loader retrieves the decryption key at runtime and must be an interface with the following arguments:

  • prhs[0] — Input, char array specified as the static value 'get'

  • prhs[1] — Input, char array specified as the CTF component UUID

  • plhs[0] — Output, 32 byte UINT8 numeric array or 64 byte hex encoded char array, depending on the key format

Avoid sharing the same key across multiple CTFs.

Example: 'ExternalEncryptionKey',keyValueStruct

Data Types: struct

Flag to obfuscate the deployable archive, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • If you set this property to 'on', then folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in MATLAB files are placed into a user package within the archive. Additionally, all .m files are converted to P-files before packaging. This option is equivalent to using mcc with -j and -s specified.

  • If you set this property to 'off', then the deployable archive is not obfuscated. This is the default behavior.

Example: 'ObfuscateArchive','on'

Data Types: logical

Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

The default name of the build folder is the archive name appended with webAppArchive.

Example: 'OutputDir','D:\Documents\MATLAB\work\mymagicwebAppArchive'

Data Types: char | string

Since R2024b

Path to a secret manifest JSON file that specifies the secret keys to be embedded in the deployable archive, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

If your MATLAB code calls the getSecret, getSecretMetadata, or isSecret function, you must specify the secret keys to embed in the deployable archive in a JSON secret manifest file. If your code calls getSecret and you do not specify the SecretsManifest option, MATLAB Compiler™ issues a warning and generates a template JSON file in the output folder named <component_name>_secrets_manifest.json. Modify this file by specifying the secret key names in the Embedded field.

The setSecret function is not deployable. To embed secret keys in a deployable archive, you must call setSecret in MATLAB before you build the archive.

For more information on deployment using secrets, see Handle Sensitive Information in Deployed Applications.

Example: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'

Data Types: char | string

Support packages to include, specified as one of the following options:

  • 'autodetect' (default) — The dependency analysis process detects and includes the required support packages automatically.

  • 'none' — No support packages are included. Using this option can cause runtime errors.

  • A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see compiler.codetools.deployableSupportPackages.

Example: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

Data Types: char | string | cell

Flag to control build verbosity, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • If you set this property to 'on', then the MATLAB command window displays progress information indicating compiler output during the build process.

  • If you set this property to 'off', then the command window does not display progress information.

Example: 'Verbose','on'

Data Types: logical

Output Arguments

collapse all

Build results, returned as a compiler.build.Results object. The Results object contains:

  • The build type, which is 'webAppArchive'

  • Path to the compiled web app archive file

  • A list of included support packages

  • Build options, specified as a WebAppArchiveOptions object

Version History

Introduced in R2020b

expand all

See Also

| |

Topics