Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
minLevel2
outlinetrue
stylenone


Overview

Application Management component is using to store, deploy, undeploy  Applications (Locally or Remotely) over different A-Stack (Edge/Device). This also maintains states of Deployed Applications on Edge/Device.

Models

Code Block
languagexml
titleModels
   <!-- A-Stack Model -->
        <DataModel name="AStackDetail">
            <Sid name="sysId" />
            <String name="Type" />
            <String name="Name" />
            <String name="AStackId" />
            <String name="URL" />
        </DataModel>
        <!--Application Model -->
        <DataModel Name="Application" Documentation="Application Model">
            <Sid Name="AppId" />
            <String Name="Name" />
            <String Name="Version" />
            <String Name="AppDownloadURL" />
            <String Name="AppShortName" />
            <String Name="tqlFacetName"/>
            <Boolean Name="IsTargetSchemaApplication"/>
            <Boolean Name="IsAppConfigurable" default="True" cardinality="1"/>
        </DataModel>
        <!--Application Deploy mapping Model -->
        <DataModel Name="DeployedApp" Documentation="Application mapping with A-Stack">
            <Sid Name="sysId" />
            <String Name="AppId" />
            <String Name="AStackId" />
            <String Name="State" />                      
            <DateTime Name="InstalledDate" Cardinality="1" Format="$SimpleDateFormat(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')"/>
            <DateTime Name="LastActivated" Cardinality="1" Format="$SimpleDateFormat(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')"/>
            <DateTime Name="LastStopped" Cardinality="1" Format="$SimpleDateFormat(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')"/>
        </DataModel>

Features

...

Register Application

Code Block
languagexml
titleRequest
collapsetrue
<RegisterApplication>
    <Application>
        <Name>HelloTQL</Name>
        <Version>1.0</Version>
        <AppDownloadURL>http://builds.atomiton.com:443/fid-downloads/HelloTQL.zip</AppDownloadURL>        
    </Application>
</RegisterApplication>

Register A-Stack

Code Block
languagexml
titleRequest
collapsetrue
<RegisterAStack>
    <AStackDetail>
        <Name>Device1</Name>
        <Type>Neuron</Type>
        <AStackId>MY4PCYVYAAAKYHYE4EBRZMOT</AStackId>
        <URL>http://<IP_ADDRESS_OF_Device/Edge>:<PORT/fid-AppManagement</URL>
    </AStackDetail>
</RegisterAStack>

Mapping of Application with A-Stack

Code Block
languagexml
titleRequest
collapsetrue
<AttachAppWithAstack>
<DeployedApp>
<AStackId>MY4PCYVYAAAKYHYE4EBRZMOT</AStackId>
<AppId>MY4PMDADAAAKYHYE4F4FB6RU</AppId>
</DeployedApp>
</AttachAppWithAstack>

Deploy Application on Registered A-Stack

Code Block
languagexml
titleRequest
collapsetrue
<DeployAppRemotely>
    <AppId>MY4PMDADAAAKYHYE4F4FB6RU</AppId>
    <AStackId>MY4PCYVYAAAKYHYE4EBRZMOT</AStackId>
</DeployAppRemotely>

UnDeploy Application on Registered A-Stack

Code Block
languagexml
titleRequest
collapsetrue
<UnDeployAppRemotely>
    <AppId>MY4PMDADAAAKYHYE4F4FB6RU</AppId>
    <AStackId>MY4PCYVYAAAKYHYE4EBRZMOT</AStackId>
</UnDeployAppRemotely>

Find Deployed Applications Details by A-Stack 

Code Block
languagexml
titleRequest
collapsetrue
<FindAppsByAStackId>
	<AStackId>SADWQD3423DW342D</AStackId>
</FindAppsByAStackId>

Find A-Stacks Details by DeployedApplication

Code Block
languagexml
titleRequest
collapsetrue
<FindAStacksByApp>
    <AppName>HelloTQL</AppName>
    <Version>1.0</Version>
</FindAStacksByApp>

Deploy Application Locally

Code Block
languagexml
titleRequest
collapsetrue
<DeployApplication>
    <AppDownloadURL>http://builds.atomiton.com:443/fid-downloads/HelloTQL.zip</AppDownloadURL>
    <AppShortName>hellotql</AppShortName><!-- Get it from Find Registered Application -->
</DeployApplication>

UnDeploy Application Locally

Code Block
languagexml
titleRequest
collapsetrue
<UnDeployApplication>
    <AppShortName>hellotql</AppShortName>
    <tqlFacetName>MYH7I7M4AAAAUCYMFA24EIQB</tqlFacetName><!-- Get it from Find Registered Application -->
</UnDeployApplication>

Delete Application from AStack

Code Block
languagexml
titleRequest
collapsetrue
<DeleteAppFromAStack>
    <AppId>MY4PMDADAAAKYHYE4F4FB6RU</AppId>
    <AStackId>MY4PCYVYAAAKYHYE4EBRZMOT</AStackId>
</DeleteAppFromAStack>

Delete AllApplications from AStack

Code Block
languagexml
titleRequest
collapsetrue
<DeleteAllAppsFromAStack>
    <AStackId>MY4PCYVYAAAKYHYE4EBRZMOT</AStackId>
</DeleteAllAppsFromAStack>

Get Application List

Code Block
languagexml
titleRequest
collapsetrue
<GetApplicationList/>

Get Application config Parameters (from resources/<APP_FOLDER>/config/<APP_SHORT_NAME>.config.xml, if present)

Code Block
languagexml
titleRequest
collapsetrue
<GetAppConfigParmaeters>
    <AppLabel><!-- Application Short Name --></AppLabel>
    <Version><!-- Application Version --></Version>
</GetAppConfigParmaeters>

Update Application config Parameters (in resources/<APP_FOLDER>/config/<APP_SHORT_NAME>.config.xml, if present)

Code Block
languagexml
titleRequest
collapsetrue
<UpdateAppConfigParmaeters>
    <ConfigProperties>
        <!-- All parameters received from above query -->
    </ConfigProperties>
    <AppLabel><!-- Application Short Name --></AppLabel>
</UpdateAppConfigParmaeters>

Installation Prerequisites

This component requires sff.bundle.tqlconsole.jar in sff.auto.launch folder.

Installation

...

Information Model

Gliffy
imageAttachmentIdatt1053556753
baseUrlhttps://atomiton.atlassian.net/wiki
migration1
nameUser Management Information Model
diagramAttachmentIdatt1053884433
containerId1053818881
timestamp1548791532693