To ensure that Intrexx application templates can be loaded and processed correctly, you must create and configure a JSON file.
The JSON file must be saved in the same directory as the application templates.
Any number of application templates can be managed using a JSON file.
Key information in the JSON file pertains to the text and icons that are to be displayed in Intrexx.
In addition, there is information on, among other things, the language, versioning, and storage location of the application templates.
In simple terms, the structure of the JSON file looks like this:
JSON file
Below is an example of a JSON file, which you'll need to make your own application templates available in Intrexx.
{
"version": "1.0.0",
"guid": "6ED8ABC408A32A45B74D8DC3F1A042A54D24A30B",
"titles": {
"de": "Meine Applikationsvorlagen",
"en": "My application templates"
},
"packages": [
{
"guid": "6F82FC780FFCB19C511E30E3DD2D1013185A1D1C",
"icon": "myapplication/icon.png",
"licenseRequired": true,
"deprecatedIntrexxVersion": 9050003,
"application": true,
"workflow": false,
"layout": false,
"titles": {
"de": "Meine Applikation",
"en": "My application"
},
"descriptions": {
"de": "Beschreibung meiner Applikation",
"en": "Description of my application"
},
"ixversions": [
{
"since": 100000000,
"paths": [
{
"version": "1.0.0",
"languages": [
"de",
"en"
],
"dataLanguage": "de",
"dataLanguageDefault": true,
"path": "myapplication/app_de.zip",
"detailsUrl": "https://www.example.org"
},
{
"version": "1.0.0",
"languages": [
"de",
"en"
],
"dataLanguage": "en",
"path": "myapplication/app_en.zip",
"detailsUrl": "https://www.example.org"
}
]
}
]
}
]
}
Description of the JSON File Parameters
Below is a description of the individual parameters in the JSON file.
|
Name |
Description |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| version |
Enter the version of the application repository here. The only valid version number at the time of the release of Intrexx 21.03 is 1.0.0. The permitted version numbers are specified by Intrexx. |
||||||||||||
| guid |
Enter the GUID of the repository here. You can generate a GUID in Intrexx by selecting "Tools > Generate GUID." |
||||||||||||
| titles |
Enter the title of the repository here. You can enter the title in multiple languages. Prefix the title with the respective language code. The title appears in the "Title" column of the "Templates" dialog box. |
||||||||||||
| de | |||||||||||||
| en | |||||||||||||
|
packages |
The application templates are listed under "packages." You can add any number of application templates to a JSON file. |
||||||||||||
|
guid |
Enter a GUID for the application template here. You can generate a GUID in Intrexx by selecting "Tools > Create GUID." |
||||||||||||
|
icon |
You can define an icon for each application template. This is displayed in the "Applications > Templates" dialog box. Enter the path to the icon. Possible icon formats: png, jpg, gif Icon size: 60 x 60 pixels |
||||||||||||
|
licenseRequired |
This parameter applies only to application templates provided by Intrexx. You can specify whether a license is required for the application template here. "true" - A license is required "false" - No license required If this value is set to "true," the user will be prompted to enter a license key when importing the application template. He receives it from the Intrexx. Alternatively, the user can skip entering the license key and test the application template for 30 days. |
||||||||||||
|
deprecatedIntrexxVersion |
You can determine up to which Intrexx version the application template can be used here. The specification of the Intrexx version must have the following pattern:
|
||||||||||||
|
application |
You can define which Intrexx module the application template can be used in. "true" - The application template is available in the module "false" - The application template is not available in the module. application - "Applications" module |
||||||||||||
|
titles |
Provide the application template with a title. An appropriate title helps the user to decide whether the application template is suitable for his/her purposes. You can enter the title in multiple languages. Prefix the title with the respective language code. The title is displayed in the "Applications > Templates" dialog box. |
||||||||||||
|
de |
|||||||||||||
|
en |
|||||||||||||
|
descriptions |
Provide the application template with a description. The description should help the user to understand the main function of the application template. Based on the description, the user can decide whether the application template is suitable for his/her purposes. You can enter the description in multiple languages. Prefix the description with the respective language code. This is displayed in the "Applications > Templates" dialog box. You can enter the title in German and English. |
||||||||||||
|
de |
|||||||||||||
|
en |
|||||||||||||
|
ixversions |
You can determine which Intrexx version the application template can be used with here. The specification of the Intrexx version must have the following pattern:
|
||||||||||||
|
since |
|||||||||||||
|
paths |
Additional information about the application template is entered under "paths." |
||||||||||||
|
version |
Provide the application template with a title. This version is relevant for updating the application templates. If the version stored here is more recent than the one available in the "Application > Templates" dialog, the more recent version will be downloaded automatically. The version specification must follow the following semantic version pattern:
For information on semantic versioning, see the following link: https://semver.org/lang/de/ |
||||||||||||
|
languages |
Add the languages that the element titles in the applications, such as for labels, buttons, etc., will be displayed in the Portal Manager and browser. |
||||||||||||
|
de |
|||||||||||||
|
en |
|||||||||||||
|
dataLanguage |
Enter the language codes for the languages the sample data is available in. You can use the language shortcuts supported by the java.util.Locale class. More information about this is available here: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html |
||||||||||||
|
dataLanguageDefault |
Several export packages with different languages for the sample data (dataLanguage) can be defined as part of a paths block. A default language (dataLanguageDefault) can be defined for an application template. Double-clicking this application in the Open dialog box imports this application template. The "dataLanguageDefault" setting should only be set to true for an application template. |
||||||||||||
|
path |
Enter the path to the application template here. The path must be defined for each language that the application template is available in. Absolute URLs with the protocol http, https, file or relative URLs are supported as path specifications. |
||||||||||||
|
detailsUrl |
Optional: Here you can enter a link to a website where details about the application template can be found. For example, it is possible to link to a German website if the application template contains German sample data, or to an English website for English sample data. |
||||||||||||
Custom Process and Layout Templates
To make your own process or layout templates available in Intrexx, modify the "Packages" block in the JSON file as follows—here, for example, for a process template:
...
"packages": [
{
"guid": "6F82FC780FFCB19C511E30E3DD2D1013185A1D1C",
"icon": "myworkflow/icon.png",
"licenseRequired": true,
"deprecatedIntrexxVersion": 9050003,
"application": false,
"workflow": true,
"layout": false,
"titles": {
"de": "Mein Prozess",
"en": "My workflow"
},
...
Your Next Steps
In Intrexx, specify the path to the JSON file or the application directory.