Create deployment license
Historique
| Release | Modifications |
|---|---|
| 20 R10 | New autoLicenseTarget parameter |
| 20 | Ajout |
Create deployment license ( mergedApp ; autoLicenseTarget ) : Object
Create deployment license ( mergedApp ; buildLicense {; oemLicense} ) : Object
| Paramètres | Type | Description | |
|---|---|---|---|
| mergedApp | 4D.Folder | → | Folder containing the merged application |
| autoLicenseTarget | Integer | → | Target license for automatic license embedding |
| buildLicense | 4D.File | → | License required to generate the embedded license |
| oemLicense | 4D.File | → | 4D OEM XML Key license if server license |
| Résultat | Object | ← | Statut |
Description
The Create deployment license command creates an embedded license file in the Licenses folder of the mergedApp built application. If the Licenses folder does not exist in the mergedApp folder, it is created by the command.
In mergedApp, pass a 4D.Folder object containing a reference to the folder containing the built application in which you want to embed a license.
Depending on the second parameter, you let 4D select automatically the license to use for the target or designate the license(s) to use.
Automatic license selection
If you pass the autoLicenseTarget parameter, you let 4D find and use the most appropriate license for the specified target. For more information on the automatic license selection, please refer to the Build application section.
The following constants are supported in the autoLicenseTarget parameter:
| Constante | Valeur | Description |
|---|---|---|
| 4D Volume Desktop | 1 | Create automatically a license for a 4D single-user application |
| 4D Server | 5 | Create automatically a license for a 4D Server application |
If no valid license is found, an error is generated.
Designating the license(s) to use
In license, pass a 4D.File object containing a reference to the license file used to generate the embedded license.
In the non-automatic mode, if the build requires a specific OEM license (4D OEM XML Keys) and if no such license is already installed in the Licenses folder of the building machine, you need to pass it using the oemLicense parameter. This parameter is useful if you dedicate a machine to build your applications.
Résultat
The command returns a status object containing the following properties:
| Propriété | Type | Description |
|---|---|---|
| success | Boolean | True if the license file has been generated |
| file | 4D.File | The generated license file |
| statusText | Text | Description of the error if any |
| errors | Collection | Collection d'objets erreur |
| [].message | Text | Message d'erreur |
| [].errCode | Number | Numéro de l'erreur |
| standalone | Object | (only in automatic mode Description attributes for 4D Volume Desktop license |
| oemServer | Object | (only in automatic mode Description attributes for 4D Server OEM license |
| oemXMLKey | Object | (only in automatic mode Description attributes for 4D Server XML Key license |
Description attributes are:
| Propriété | Type | Description |
|---|---|---|
| absolutePlatformPath | Text | Path to the original license file retained |
| offerName | Text | Commercial name of the license retained |
| productNumber | Number | Serial number of the license retained |
- The generated license must be used only with the application referenced by mergedApp.
- It is necessary to regenerate the license each time the application is rebuilt.
Exemple 1
Use the automatic syntax to create a single-user 4D application:
var $status : Object
var $application : 4D.File
$application:=Folder(fk desktop folder).folder("myApp.app")
$status:=Create deployment license($application;4D Volume Desktop)
Exemple 2
Designate a license to use:
var $status : Object
var $application : 4D.File
var $license : 4D.File
$license:=Folder(fk licenses folder).file("4UUD200-xxx.license4D")
$application:=Folder(fk desktop folder).folder("myApp.app")
$status:=Create deployment license($application;$license)
Voir également
Blog post - Finalize an application with 4D commands
Propriétés
| Numéro de commande | 1811 |
| Thread safe | ✗ |