compiler.build.productionServerArchive

Create an archive for deployment to MATLAB Production Server or Docker

Since R2020b

Syntax

compiler.build.productionServerArchive(FunctionFiles)

compiler.build.productionServerArchive(FunctionFiles,Name,Value)

compiler.build.productionServerArchive(opts)

results = compiler.build.productionServerArchive(___)

Description

compiler.build.productionServerArchive(FunctionFiles) creates a deployable archive using the MATLAB^® functions specified by FunctionFiles.

compiler.build.productionServerArchive(FunctionFiles,Name,Value) creates a deployable archive with additional options specified using one or more name-value arguments. Options include the archive name, JSON function signatures, and output directory.

compiler.build.productionServerArchive(opts) creates a deployable archive with options specified using a compiler.build.ProductionServerArchiveOptions object opts. You cannot specify any other options using name-value arguments.

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

Examples

Create MATLAB Production Server Archive

Create a deployable server archive.

In MATLAB, locate the MATLAB function that you want to deploy as an archive. For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');

Build a production server archive using the compiler.build.productionServerArchive command.

compiler.build.productionServerArchive(appFile);

This syntax generates the following files within a folder named mymagicproductionServerArchive in your current working directory:

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

• mymagic.ctf — Deployable production server archive file.

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

• readme.txt — Readme file that contains information on deployment prerequisites and the list of files to package for deployment.

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

Customize Production Server Archive

Create a production server archive and customize it using name-value arguments.

For this example, use the files addmatrix.m and subtractmatrix.mat located in matlabroot\extern\examples\compiler.

addFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
subFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','subtractmatrix.m');

Build a production server archive using the compiler.build.productionServerArchive command. Use name-value arguments to specify the archive name and enable verbose output.

compiler.build.productionServerArchive({addFile,subFile},...
    'ArchiveName','MatrixArchive',...
    'Verbose','on');

This syntax generates the following files within a folder named MatrixArchiveproductionServerArchive in your current working directory:

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

• MatrixArchive.ctf — Deployable production server archive file.

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

• readme.txt — Readme file that contains information on deployment prerequisites and the list of files to package for deployment.

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

Create Multiple Production Server Archives Using Options Object

Customize multiple production server archives using a compiler.build.ProductionServerArchiveOptions (MATLAB Production Server) object.

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

functionFile = fullfile(matlabroot,'extern','examples','compiler','hello.m');

Create a ProductionServerArchiveOptions object. Use name-value arguments to specify a common output directory, disable the automatic inclusion of data files, and enable verbose output.

opts = compiler.build.ProductionServerArchiveOptions(functionFile,...    
    'OutputDir','D:\Documents\MATLAB\work\ProductionServerBatch',...
    'AutoDetectDataFiles','off',...
    'Verbose','on')

opts = 

  ProductionServerArchiveOptions with properties:

            ArchiveName: 'hello'
          FunctionFiles: {'C:\Program Files\MATLAB\R2023a\extern\examples\compiler\hello.m'}
     FunctionSignatures: ''
        AdditionalFiles: {}
    AutoDetectDataFiles: off
        SupportPackages: {'autodetect'}
                Verbose: on
              OutputDir: 'D:\Documents\MATLAB\work\ProductionServerBatch'

Build the production server archive using the ProductionServerArchiveOptions object.

compiler.build.productionServerArchive(opts);

To compile using the function file houdini.m with the same options, use dot notation to modify the FunctionFiles of the existing ProductionServerArchiveOptions object before running the build function again.

opts.FunctionFiles = 'houdini.m';
compiler.build.productionServerArchive(opts);

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

Create Microservice Docker Image Using Results

Create a microservice Docker^® image using the results from building a production server archive on a Linux^® system.

Install and configure Docker on your system.

Create a production server archive using magicsquare.m and save the build results to a compiler.build.Results object.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
buildResults = compiler.build.productionServerArchive(appFile);

Pass the Results object as an input to the compiler.package.microserviceDockerImage function to build the Docker image.

compiler.package.microserviceDockerImage(buildResults);

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

• applicationFilesForMATLABCompiler/magicsquare.ctf — Deployable archive file.

• Dockerfile — Docker file that specifies Docker run time options.

• GettingStarted.txt — Text file that contains deployment information.

For more details, see Create Microservice Docker Image.

Get Build Information from Production Server Archive

Create a production server 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 magicsquare.m.

results = compiler.build.productionServerArchive(magicsquare.m')

results = 

  Results with properties:

                  BuildType: 'productionServerArchive'
                      Files: {'D:\Documents\MATLAB\work\magicsquareproductionServerArchive\magicsquare.ctf'}
    IncludedSupportPackages: {}
                    Options: [1×1 compiler.build.ProductionServerArchiveOptions]

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

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 a .m extension.

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

Data Types: char | string | cell

opts — Production server options object

compiler.build.ProductionServerArchiveOptions object

Production server archive build options, specified as a compiler.build.ProductionServerArchiveOptions (MATLAB Production Server) object.

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'

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

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'

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

results — Build results

compiler.build.Results object

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

• The build type, which is 'productionServerArchive'

• Path to the deployable archive file

• A list of included support packages

• Build options, specified as a ProductionServerArchiveOptions object

Version History

Introduced in R2020b