Exporting Pluggable Views or Libraries
Exporting pluggable views or custom, named libraries exports both configuration information and the file resources for those views or libraries from the MashZone NextGen Repository. The output of an export may be either:
A zipped archive suitable to use as the input to deploy those views or libraries to another
MashZone NextGen Repository. See the
Examples section for more information.
A directory with the fully expanded configuration and resource files suitable for editing to update the pluggable view or pluggable library.
See for instructions and an example.Important: If MashZone NextGen hosts several versions of pluggable views or libraries, only the default version of each view or library is exported.
Pluggable views and libraries typically consist of configuration information for
MashZone NextGen plus one or more JavaScript, CSS or image files. Pluggable views may also include a thumbnail image that displays in the View Gallery.
See Views and Libraries in
MashZone NextGen for more information.1. If it is not running, start the MashZone NextGen Server for the MashZone NextGen Repository that is the source for the pluggable views or shared libraries that you wish to export. See Start and Stop the
MashZone NextGen
Server for instructions. 2. Open a command window and move to the MashZoneNG-install/prestocli/bin folder.
3. Enter this command:
padmin exportLib -q filter [-s] [-f output-file]
[-d output-directory] [-o] [-l prestoURL]
-u username -w password [-v]
-q filter: defines which pluggable views or libraries to export. The filter can be:
"all" to export all pluggable views and pluggable libraries from this
MashZone NextGen Repository. You can also use
"ALL" or
"*".
"author=list-of-owner-ids", the user ID for a specific user or a list of comma-separated user IDs. This exports pluggable views and pluggable libraries registered by those users.
"mine", to export all pluggable views or libraries that were registered by the user identified by the credentials used to execute this command (in the
-u option).
"ids=list-of-library-ids", a specific ID for a pluggable view or library or a list of comma-separated IDs for views or libraries. This exports those specific views or libraries.
"name=list-of-library-names", a specific pluggable view or library name. ?list also?
"type=view", to export only pluggable views.
"subtype=view-category-name", to export only pluggable views that belong to the specified view category.
-s: an optional flag to also export any named libraries that are used by the pluggable views or libraries that are being exported.
-f output-file: is the path and name of the export file to hold both configuration and resource files for the export. The export file is always a ZIP archive, with
.zip extension, which is suitable to deploy the exported views and libraries to a different
MashZone NextGen Repository.
Note: This option is mutually exclusive with the -d option.
If you omit both the -f and -d options, the export produces a ZIP file named app-export-date-time.zip in the directory where you execute this command.
-d output-directory: is the path to the directory where export configuration plus resources for the exported pluggable views and libraries should be output. All resources are fully expanded, allowing you to update view and library resources. Use the
importLib command to upload these updates to
MashZone NextGen.
Note: This option is mutually exclusive with the -f option.
If you omit both the -f and -d options, the export produces a ZIP file named app-export-date-time.zip in the directory where you execute this command. This ZIP archive is suitable as the input for the importLib command to deploy the exported views and libraries to a different MashZone NextGen Repository.
-o: an optional flag to allow export information to overwrite an existing export file or directory. If you omit this option, the output file must not already exist or the output directory must be empty.
-l prestoUrl: an optional URL to the
MashZone NextGen Server to export views and libraries from. If you omit this option, this defaults to
http://localhost:8080/mashzone/edge/api.
Use this option if the MashZone NextGen Server is remote, if it is not running in Tomcat or if it not using the default Tomcat port.
-u username: the
MashZone NextGen username to use as credentials to execute this command. This account
must have
MashZone NextGen administrator permissions.
-w password: the
MashZone NextGen password to use as credentials to execute this command.
-v: an optional flag to turn on verbose logging.
General messages and errors from the export process are sent to the command window (stdout). Messages for specific library failures are included in the export file in <FailedExport> elements.
Examples
The following example from a Windows environment, exports all pluggable views and libraries from the local MashZone NextGen Server to a file named localCustomViews.zip that can then be used to deploy these libraries to another MashZone NextGen Server using the importLib command.
c:\MashZone NextGenversion\prestocli> padmin exportLib
-q "all" -f localCustomLibs -u Administrator -w manage
This next example, exports only pluggable views from a remote MashZone NextGen Server to a file named remoteCustomViews.zip that can then be used to deploy these libraries to the local MashZone NextGen Server using the importLib command.
c:\MashZone NextGenversion\prestocli> padmin exportLib
-q "type=view" -f remoteCustomViews
-l http://204.87.1.110:8080/mashzone/edge/api -u Administrator -w manage