compiler.build.ProductionServerArchiveOptions

Options for building deployable archives

Since R2020b

Syntax

opts = compiler.build.ProductionServerArchiveOptions(FunctionFiles)

opts = compiler.build.ProductionServerArchiveOptions(FunctionFiles,Name,Value)

Description

opts = compiler.build.ProductionServerArchiveOptions(FunctionFiles) creates a ProductionServerArchiveOptions object using the MATLAB^® functions specified by FunctionFiles. Use the ProductionServerArchiveOptions object as an input to the compiler.build.productionServerArchive function.

opts = compiler.build.ProductionServerArchiveOptions(FunctionFiles,Name,Value) creates a ProductionServerArchiveOptions object with options specified using one or more name-value arguments. Options include the archive name, output directory, and additional files to include.

Examples

Create Deployable Archive Options Object

Create a ProductionServerArchiveOptions object from a function file.

For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler.

appFile = which('magicsquare.m');
opts = compiler.build.ProductionServerArchiveOptions(appFile)

opts = 

  ProductionServerArchiveOptions with properties:

              ArchiveName: 'magicsquare'
            FunctionFiles: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}
       FunctionSignatures: ''
               RoutesFile: ''
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\magicsquareproductionServerArchive'

You can modify the property values of an existing ProductionServerArchiveOptions object using dot notation. For example, enable verbose output.

opts.Verbose = 'on';

Use the DotNETAssemblyOptions object as an input to the compiler.build.productionServerArchive function to build a production server archive.

compiler.build.productionServerArchive(opts);

Customize Deployable Archive Options Object

Create a production server archive using a ProductionServerArchiveOptions object.

Create a ProductionServerArchiveOptions object using the function files hello.m and houdini.m. Use name-value arguments to specify the output directory, enable verbose output, and disable automatic detection of data files.

opts = compiler.build.ProductionServerArchiveOptions([{which('hello.m')}, ...
{which('houdini.m')}], 'ArchiveName','MyServer', ...
'OutputDir','D:\Documents\MATLAB\work\ProductionServer', ...
'AutoDetectDataFiles','off')

opts = 

  ProductionServerArchiveOptions with properties:

              ArchiveName: 'MyServer'
            FunctionFiles: {2×1 cell}
       FunctionSignatures: ''
               RoutesFile: ''
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\ProductionServer'

You can modify the property values of an existing ProductionServerArchiveOptions object using dot notation. For example, enable verbose output.

opts.Verbose = 'on';

Use the ProductionServerArchiveOptions object as an input to the compiler.build.productionServerArchive function to build a production server archive.

buildResults = compiler.build.productionServerArchive(opts);

Input Arguments

FunctionFiles — Files implementing MATLAB functions

character vector | string scalar | cell array of character vectors | string array

Files implementing MATLAB functions, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute. Files must have one of the following extensions: .m, .p, .mlx, or .mexa64.

Example: ["myfunc1.m","myfunc2.m"]

Data Types: char | string | cell

Name-Value Arguments

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'

AdditionalFiles — Files and folders to be included with the deployable archive

character vector | string scalar

A list of files and folders to be included within the production server archive.

Example: 'AdditionalFiles','MyFile.txt'

Data Types: char | string | cellstr vector

ArchiveName — Name of deployable archive

character vector | string scalar

Name of the deployable archive, specified as a character vector or a string scalar. The default name of the generated archive is the first entry of the FunctionFiles argument.

Example: 'ArchiveName','MyMagic'

Data Types: char | string

AutoDetectDataFiles — Flag to automatically include data files

'on' (default) | on/off logical value

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 production server 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

ExternalEncryptionKey — Paths to encryption key and loader files

scalar struct

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

FunctionSignatures — Path to JSON file

character vector | string scalar

Path to a JSON file that details the signatures of all functions listed in FunctionFiles, specified as a character vector or a string scalar. For information on specifying function signatures, see MATLAB Function Signatures in JSON (MATLAB Production Server).

Example: 'FunctionSignatures','D:\Documents\MATLAB\work\magicapp\signatures.json'

Data Types: char | string

ObfuscateArchive — Flag to obfuscate deployable archive

'off' (default) | on/off logical value

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

OutputDir — Path to output directory

character vector | string scalar

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 productionServerArchive.

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

RoutesFile — Path to JSON file

'' (default) | character vector | string scalar

Since R2024a

Path to a JSON file that specifies custom URL routes on the server, specified as a character vector or a string scalar.

Example: RoutesFile,'routes.json'

Data Types: char | string

SecretsManifest — Path to JSON manifest file

character vector | string scalar

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

SupportPackages — Support packages

'autodetect' (default) | 'none' | string scalar | cell array of character vectors | string array

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

Verbose — Build verbosity

'off' (default) | on/off logical value

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','off'

Data Types: logical

Output Arguments

opts — Production server archive build options

ProductionServerArchiveOptions object

Production server archive build options, returned as a ProductionServerArchiveOptions object.

Version History

Introduced in R2020b