Skip to content

Application Management in the Factory Manager

Johannes Heucher edited this page Oct 12, 2022 · 2 revisions

Applications are managed inside the Applications section of the Xyna Factory Manager.

Table of Contents

Build a New Application

Press the Add Application button at the top right and select a Workspace and an Application Definition inside the dialog. Then define a version number, which can be any string, and documentation for the new Application. Press the Create button to finally build it. The new Application then appears in the list of Applications. The different versions are displayed on the right.

Every Application has one of the following states:

  • RUNNING: The Order Entry points are active toward this Application
  • STOPPED: All Order Entry points toward this Application are disabled
  • WARNING: There are lighter problems, e.g. erroneous Order Entry
  • ERROR: There are critical problems, e.g. conflicts with required Runtime Contexts
If the Application is installed at another Xyna Factory instance in a cluster, the factory node is shown in brackets after the version.

Alternatively a new Application can be build from Workspaces inside the Workspaces section.

Show Application Details

Open the Application Details by selecting an Application Version in the list of Applications. The details provide following information:

  • Application: Name and version of the Application. The combination of name and version uniquely identifies a Application build. The name is also the name of the Application Definition, this Application was build from.
  • Documentation: Documentation about the Application
  • Version: Version of the Application
  • Requires: Shows the required Runtime Contexts.
  • Required by: Shows the Runtime Contexts directly or indirectly requiring this Application.
  • Content: Shows the content definitions of that Application Definition, this Runtime Context was build from. Press the Show Details button to show implicit and indirect content. In the following dialog enable Show Implicit to show content needed by assigned content and enable Show Indirect to show content from dependent Workspaces and Applications.
  • Order Entries: Lists possible Order Entry points, which can be used to start Xyna Orders in this Runtime Context.
    • Remote Method Invocation: This option allows the Application's Services to be executed on a Remote Destination. Remote Destinations can be applied on these Services during Modeling with the Xyna Process Modeller.
    • Command Line Interface: This option allows to start Xyna Orders via CLI.
  • Issues: Provides monitoring of problems, if the status of the Application is WARNING or ERROR.

Updating Required Runtime Contexts

The content of Applications is not supposed to change. However it is possible to change the required Runtime Contexts of a Application and thereby the behavior of its content. This could be usefull in runtime environments, if one of the required Applications has a bug and need to be updated to fix that problem. The setting of required Runtime Contexts is analogously to Workspace's Requirements.

Load Application Into Workspace

It is possible to import objects of a certain Application into an existing Workspace. The import operation will also create an Application Definition, which contains the imported objects. Again this Application Definition can be used to create a new version of the imported Application.

The import of objects of a certain Application can be done by following these steps:

  • Open the Application Details
  • Press Load into Workspace
  • Choose a Workspace
  • Define a description for the later created Application Definition
  • Select Overwrite existing content, if an already existing Application Definition should be replaced
  • Press Load to finally import the Application
After the import the new Application Definition can be found in the Workspaces section.

Alternatively a Application can be load into a Workspace inside the Workspaces section.

It is helpfull to create individual development Workspaces for each Application. Then, the Application can be load into dedicated Workspace, separating the Workflows, Datatypes, Trigger, Filter etc. completely from the other development. In case of problems or user mistakes the Workspace can be cleared and the Application reloaded into the Workspace again.

Remove Applications

An Application can be removed by doing the following steps:

  • Select an Application Version in the list of Applications
  • Confirm, that the selected Application is STOPPED. See below how to stop an Application.
  • Press the Delete Application button.
  • Select Stop running orders in the following dialog, if still running Xyna Orders should be stopped immediately. Otherwise the deleted Application will last until the last Xyna Order finishes.
  • Press the Delete button to finally remove this Application.

Export an Application

It is possible to export a whole Application as a ZIP file. Therefore select an Application and press the Export button. In the following dialog you can select whether a Stub Application to be used for Remote Calls should be created. Then press the 'Export' button and the download will be prepared in few seconds. Press the Download button in the following dialog and choose a download destination with the now following save file dialog.

Import an Application

An Application, which was exported as a ZIP file, can be imported to any other Xyna Factory instance by doing the following steps:

  • Press the Import Application button.
  • Press the Choose File button in the following dialog and upload the corresponding ZIP file. Application files are generted when an Application is exported either using the Export button in the Xyna Factory Manager, or via the CLI.
  • Select one or more Factory Nodes in the Target Nodes section. The Application can be imported on multiple nodes simultaniously. The local node is always present and refers to the current Xyna Factory instance.
  • The Import section defines what should be imported.
    • By default Application is selected. Disable Application to only import global settings like Xyna Properties or Capacities.
      • Check Overwrite existing, if an existing Application with the same name and version should be overwritten without warning.
      • If the Xyna Factory is prepared to manage a cluster of Xyna Factory instances, check On all Cluster Nodes to import the Application on all Cluster Nodes at once.
    • Enable Xnya Properties and Capacities to overwrite this global settings with those inside the Application. Default setting is to keep the global settings. This is usefull if the application to be imported is a new version of an existing application and both Xyna Properties and Capacities are already present.
  • Press the Import button to finally import this Application.
Please note: It is possible to migrate Cron-like Orders and Order Types from one Application to another.

Start an Application

After their import Applications have to be started in order to be used in a Xyna Factory instance. Therefore select the to be started Application and press the Start button. This will activate all of its Order Entry points. Typical Order Entry points are CLI, RMI interface and the Triggers and Filters belonging to an Application.

Stop an Application

Select an Application with RUNNING, WARNING or ERROR status and press the Stop button to stop them. This will disable all of its Order Entry points and Cron-like Orders.

Please note: Stopping an Application doesn't affect running Xyna Orders. It is safe to stop one version of an Application and start another version. If a new event reachs an Order Entry point, a new Xyna Order will run in the new version, while running Xyna Orders will continue in the old version's Runtime Context as if it was never stopped.

Manage an Application's Order Entry

The state of the CLI and the RMI interface belonging to an Application can be changed in the Application Details. They can be enabled or disabled. Only enabled Order Entry points will be able to start new Xyna Orders. If the Application is in the state STOPPED, all Order Entry points were disabled.

See Also

Clone this wiki locally