Extracting Schemas as a Non-GUI Client Application

You can use the JadeBatchExtract application in the jadclient non-GUI client application to automate the extraction of your user-defined schemas, passing command line arguments after the startAppParameters parameter to specify your extract requirements. For details about:

The jadclient non-GUI client application, see "Running a Non-GUI Client Application using jadclient", in Chapter 1 of the Runtime Application Guide.
Extracting schemas in sections (for example, to store schemas in Subversion or any other suitable version control system in smaller chunks than complete schema files), see "Extracting Schemas in Sections", in the following subsection.
Extracting a specified class from the current or latest schema context, see "Extracting Classes as a Non‑GUI Application", later in this chapter.
Extracting and loading a patch history, see "Extracting and Loading a Patch History", in Chapter 3 of the Development Environment Administration Guide.

To extract schemas as a non-GUI application, specify the following parameters in the jadclient program.

jadclient path=database-path
          ini=jade-initialization-file
          schema=JadeSchema
          app=JadeBatchExtract
          startAppParameters
          extract-arguments

The arguments that you can specify after the startAppParameters parameter are listed in the following table.

Argument	Format	Description
Class	schema‑file‑name forms‑file‑name schema‑name class‑name	Extract a class from the current schema context of the specified schema and type
CL	schema‑file‑name forms‑file‑name schema‑name class‑name	Extract a class from the latest schema context of the specified schema and type
Multiple	multiple-schema-file-name schema-name-list	Multiple schema extract from the current schema context for the listed schemas
ML	multiple-schema-file-name schema-name-list	Multiple schema extract from the latest schema context for the listed schemas
Patch	schema-file-name forms-file-name patch‑number schema‑name	Extract a patch from the current schema context of all changes made against the patch number for the specified schema
PL	schema-file-name forms-file-name patch-number schema-name	Extract a patch from the latest schema context of all changes made against the patch number for the specified schema
Version	multiple-schema-file-name patch-version-number	Extract a patch from the current schema context of all changes made to all schemas against the patch number
VL	multiple-schema-file-name patch-version-number	Extract a patch from the latest schema context of all changes made to all schemas against the patch number
Single	schema-file-name forms-file-name schema-name	Extract from the current schema context of the specified schema
SL	schema-file-name forms-file-name schema-name	Extract from the latest schema context of the specified schema
File	schema-file-name forms-file-name parameter‑file‑name schema-name	Extract from the current schema context using a parameter file
EL	multiple-schema-file-name	Multiple schema extract from the latest schema context of every user-defined schema
B	schema-file-name forms-file-name schema-name	Extract a stub version of a schema from the current schema context of a schema containing a package
BL	schema-file-name forms-file-name schema-name	Extract a stub version of a schema from the latest schema context of a schema containing a package
<encrypt>	"<encrypt>"	Encrypted schema source files
delta	delta-identifier	Extract a specific delta when extracting a schema from a parameter file
<compactddx>	<compactddx>	Optionally extract a compact DDX (XML) file

For details about extracting:

Multiple schemas or extracting selected classes and methods to a parameter file, see "Extracting Multiple Schemas" or "Specifying Your Parameter File Options", earlier in this chapter.
Patch versions, see "Extracting a Patch Version", in Chapter 3 of the Development Environment Administration Guide.
A version of the schema that contains only stub versions of each package, see "Stub Packages", in Chapter 8 of the Developer's Reference.

When specifying extract arguments:

When extracting a patch, you must specify a valid patch number.

When performing a batch extract by patch number (for single or multiple schemas), the Jade command file (JCF) is always created.
For all types of batch extract other than an extract by patch number, the command file is not created by default. If you want the command file to be created, you must specify this on the command line; for example:
```
jadclient path=c:\jade\system ini=c:\jade\system\jade.ini server=singleUser schema=JadeSchema app=JadeBatchExtract startAppParameters Single c:\temp\myTest.scm c:\temp\myTest.ddb Test "<jcf>"
```
The <jcf> value indicates that you want the command file created. As you can specify more than one option between the < and > characters, you must separate each one with a comma; for example, if you want to encrypt the source and create the command file, your command would look similar to the following.
```
jadclient path=c:\jade\system ini=c:\jade\system\jade.ini server=singleUser schema=JadeSchema app=JadeBatchExtract startAppParameters Single c:\temp\myTest.scm c:\temp\myTest.ddx Test "<encrypt,jcf>"
```
The <compactddx> option enables you to extract compact DDX files; for example:
```
jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters CL "c:\temp\WidgetForm.cls" "c:\temp\WidgetForm.ddx" Sales Widget "<ddxFormat,compactddx>"
```
Compact DDX files exclude properties with null values for applications, forms, standard controls, and RPS mappings. Compact DDX files reduce the size of the extracted file and improve loading performance.

The <compactddx> option has no effect when extracting DDB (legacy) format files.

Compact DDX files extracted in Jade 2022.0.02 and higher will not load into Jade 2022.0.01 or any earlier Jade releases.
Separate the argument and its associated values with a space.
Specify the fully qualified schema file and forms file names.
Enclose command line arguments that contain spaces in double ("") or single ('') quotation marks.
The jadclient program treats processing arguments enclosed in double ("") or single ('') quotation marks after the startAppParameters parameter as single-string entries in the HugeStringArray. The handling of strings in this HugeStringArray is application-specific. For example, dir=program files is treated as a two‑string entry and dir="program files" is treated as a one-string entry. How these entries are handled is determined by your application.
Because the < and > characters have special significance in Windows when you extract encrypted schema sources, you must enclose the <encrypt> argument within double quotation marks (that is, "<encrypt>"). In addition, the <encrypt> argument must be the last argument after the startAppParameters parameter.
The extract arguments and the associated parameters are case-sensitive (that is, Multiple is a valid argument but multiple is not).
If the multiple schema file name for the extraction of multiple schemas does not exist, the file is created.

The schema names specified in the schema names list is the name of the schema itself, which may differ from the name of the schema metadata (.scm) and form and data definition (.ddb or .ddx) files. For example, if your Test schema is contained in ProdTest.scm and ProdTest.ddb files, specify Test following the schema file name in the command line for a multiple schema extraction. The Test schema is then extracted to Test.scm and Test.ddb files during the non‑GUI client extract process.
You can extract (and load) form and data definition files in the legacy DDB format instead of the default XML DDX format that does not include Jade oids. All entities in the XML (DDX) format are identified by name and by their position in the XML object hierarchy. You can compare the DDX file to another version of the file, to identify what has changed between the two versions.
When extracting classes or methods of a specific schema to a parameter file using the File argument, the .unl file containing the elements defined in the specified schema file name must already exist. If you do not specify the path and name of a valid parameter file, an error is output.
You can specify a delta code when extracting a schema from a parameter file, which enables you to automate the checking in of a delta at run time so that you can create the release of a change for testing purposes. To set a delta for a batch extract, the last command line parameter must be delta=delta-identifier; for example, if the delta identifier is DeltaTwo, the command line is as follows.
```
jadclient path=e:\jadesystems\jade6211\system ini=c:\jade\system\jade.ini app=JadeBatchExtract schema=JadeSchema server=singleUser startAppParameters File d:\temp\delta.scm d:\temp\delta.ddb|ddx d:\temp\param.unl ErewhonInvestmentsViewSchema delta=DeltaTwo
```

You cannot use the jadclient program to automate the extraction of schemas from a deployed environment, as the internal system‑only JadeSchema schema from which batch extractions are run is not present in deployed databases.

The following examples show the use of the jadclient program to extract schemas.

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters Every c:\temp\myschemas.mul
// The EL argument is a synonym of the Every argument

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters File c:\jade\test\Sales.scm c:\jade\test\Sales.ddb|ddx c:\SalesBits.unl Sales

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters SL "c:\temp\Sales.scm" "c:\temp\Sales.ddx" Sales

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters Version c:\temp\versionchgs.mul 4

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters Multiple c:\temp\selected.mul Sales Accounts Orders

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters Single "c:\dir with space\Sales.scm" "c:\dir with space\Sales.ddb|ddx" Sales

jadclient path=r:\jade\system ini=r:\jade\system\myjade.ini server=multiUser host=127.0.0.1 port=6005 schema=JadeSchema app=JadeBatchExtract startAppParameters Single Sales.scm Sales.ddb|ddx Sales

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini server=singleUser schema=JadeSchema app=JadeBatchExtract startAppParameters Single c:\temp\myTest.scm c:\temp\myTest.ddb|ddx Test "<encrypt>"

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters Patch c:\jade\Test\Sales.scm c:\jade\test\Sales.ddx 2 Sales

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters B c:\temp\S1Stub.scm c:\temp\scmS1.ddb|ddx S1

jadclient path=c:\jade\system ini=c:\jade\system\jade.ini schema=JadeSchema app=JadeBatchExtract startAppParameters PL c:\Extracts\SpeedSend.scm c:\Extracts\SpeedSend.ddb|ddx 5 SpeedSend