Application
This context lets you access and manage a single application.
Unique Actions
[?]
Configure
This action is used to edit Application properties.
 | Changing the Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
Pack
This action packages Application configuration and resources. The package can be downloaded via Web UI as a ZIP archive (.zip) or as a Iotellect Server plugin file (.jar), or saved on the Iotellect Server machine as a folder.
Operation Type. Select Save to Server Folder in order to save the Application to the specified folder in the Iotellect Server machine. Select Download as ZIP Archive in order to prepare the application for download as a ZIP archive. Select Download as JAR Archive in order to prepare the application for download as a JAR archive.
Application Folder Path. Path to Iotellect Server folder into which Application and its resources will be exported if Operation Type is set to Save to Server Folder.
Action Name: | pack |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Deploy
Creates or updates all the resources associated with the application. If all resources are created or updated successfully, the Application will enter the Deployed state. If any errors occur during the Deploy action which prevent all resources from being created or updated, the application enters the Deployed with Errors state.
Deployment User Mode. Choose whether the resources created by Application deployment should be owned by the Application owner, the current user, or a different user.
Deployment User Context. Indicates the user that will own the resources created when the Application is deployed. Available when Deployment User Mode is set to “different user”.
Remove Orphans. Orphan resources can be created when a new version of an Application is deployed and does not include one or more resources created by a previous version. If
TRUE, orphaned resources will be removed.
Action Name: | deploy |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Rollback
This action removes resources created during the Application deployment and changes the Application state according to the following logic:
If the Application context is in Deployed or Deployed with Errors state, the rollback returns the Application to the Installed state.
If the Application context is Editable, the context state does not change. The rollback only removes the deployed resources.
This action is available only when the Application context is in one of the following states: Editable, Deployed, or Deployed with Errors.
Action Name: | rollback |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Export
This action saves the Application configuration and resources into a folder on Iotellect Server machine, or prepares the Application for download via Web UI.
Operation Type. Select Save to Server Folder in order to save the Application to the specified folder in the Iotellect Server machine. Select Download as ZIP Archive in order to prepare the application for download as a ZIP archive.
Application Folder Path. Path to Iotellect Server folder into which Application and its resources will be exported if Operation Type is set to Save to Server Folder.
Depersonalize Exported Data. Deletes information about owners of exported resources.
Add IDE Project Files. Adds files needed to build Iotellect Server plugin from Application using an IDE (Eclipse or Intellij Idea).
Application/Plugin ID. Application identifier. Used to manage dependencies. Iotellect Server plugin built from Application using IDE will have the same identifier.
Package. Java class package into which Application classes and resources will be placed in IDE project.
Action Name: | export |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Update
This action updates the Application from a server folder or zip archive. The update is only possible if the current Application ID matches the ID of the Application in the selected source (ZIP archive or server folder). There are a number of options to be defined during the update process:
Operation Type. Indicate the source files to use to update the application. Upload as ZIP Archive indicates that the uploaded ZIP archive will be used, and Load from Server Folder indicates that files from the indicated Application Folder Path will be used.
ZIP Archive. Upload an application that has been exported as a ZIP archive.
Application Folder Path. Path to Iotellect Server folder that contains a previously exported application. One normally gets to this folder from a Version Control System repository.
Handling Existing Contexts. Skip, Replace or Update existing application resources from previously imported versions of the application.
Error Handling. If an error occurred during the import process, the process can be either continued (Ignore option) or reverted (Revert option).
Delete Not Listed Contexts. This option will cause removal of resources that were included to current version of Application but do not exist in the imported version.
Action Name: | update |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Open
Opens the Dashboard specified in the Application Configuration property Application Home Dashboard.
Action Name: | open |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Add Resources
This action allows multiple resources to be added to an application by selecting them from a context tree.
Action Name: | multipleResourceAddingAction |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Drag and Drop Resources
This action allows multiple resources to be added to an application by drag and drop.
Action Name: | dndResourceAddingAction |
Action Icon: | |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Common Actions
[?]
Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status, Export
Context States
This context has the following states:
Status Name | Status Description |
Editable | Application is available to be deleted and modified. |
Installed | Application was installed from an external source and cannot be modified. Application resources have not been created on the server. |
Deployed | All Application resources were successfully created on the server. |
Deployed with Errors | Application resources were deployed with some errors. |
Advanced Information |
Context Information
Context Type: application
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.applications.APPLICATION_NAME
Context Mask: users.*.applications.*
Context Permissions
[?]
Level | Description |
None | No access allowed. |
Observer | Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | Resource packing, configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
[?]
Common Variables: groupMembership (Group Membership), validity (Validity), activeAlerts (Active Alerts)
Properties
See description of the variable and its fields here.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | 1 - 50 characters (Should start with a letter) |
description | String | 1 - 50 characters |
applicationFolderPath | String |
|
comment | String |
|
Resources
See description of the variable and its fields here.
Variable Name: | resources |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
resource | String |
|
description | String |
|
contextDescription | String |
|
category | String |
|
subcategory | String |
|
groupName | String |
|
groupDescription | String |
|
version | Integer |
|
dependencies | Data Table |
|
createOnFirstServerLaunch | Boolean |
|
protected | Boolean |
|
Localization
See description of the variable and its fields here.
Variable Name: | textResources |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
languages | Data Table |
|
textResourceBundle | Data Table |
|
Context Variables
See description of the variable and its fields here.
Variable Name: | contextVariables |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
context | String |
|
variable | String |
|
Dependencies
See description of the variable and its fields here.
Variable Name: | applicationDependencies |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
id | String |
|
Public Functions
[?]
Common Functions: makeCopy (Make Copy), delete (Delete)
Deploy
Creates or updates all the resources associated with the Application. Application moves to the Deployed or Deployed with Errors state.
Function Name: | deploy | ||
Permissions: | Accessible at Manager permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
deploymentUserMode | String | Deployment User Mode | |
deploymentUser | String | Deployment User Context | |
deploymentRemoveOrphans | Boolean | Remove Orphans | |
Output Records: | 0…unlimited | ||
Output Format: | Name | Type | Description |
target | String | Target | |
successfully | Boolean | Successfully | |
contextType | String | Context Type | |
modificationType | String | Modification Type | |
status | String | Status/Error | |
Rollback
Removes resources associated with the Application. If the Application is in Deployed or Deployed with Errors state, it also changes the state to Installed.
Function Name: | rollback | ||
Permissions: | Accessible at Manager permission level | ||
Input Records: | 0 | ||
Input Format: | None | ||
Output Records: | 0…unlimited | ||
Output Format: | Name | Type | Description |
target | String | Target | |
successfully | Boolean | Successfully | |
contextType | String | Context Type | |
modificationType | String | Modification Type | |
status | String | Status/Error | |
Public Events
[?]
Common Events: info (Information)
Was this page helpful?