Enportal/5.4/web integrations/applications and licenses: Difference between revisions

imported>Jason.nicholls
imported>Jason.nicholls
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:enPortal 5.4]]
[[Category:enPortal 5.4]]
{{DISPLAYTITLE:Manage Application Tools}}
{{DISPLAYTITLE:Applications & Licenses}}


__TOC__
__TOC__


Please note that it is recommended to understand the concepts relating to '''Channel Packages''' and '''Product Integration Modules (PIMs)''' before Managing Applications. Before proceeding, you may want to review the section [[enportal/5.4/Application_Management/creating_channels|Creating Application-Specific Channels]].
The ''Web Integrations'' -> ''Applications and Licenses'' administration page allows for the configuration of application servers, also referred to as ''targets'', and to view overall license usage.


The '''Manage Applications''' tool provides the following:
The ''Applications'' tab also allows for the creation of PIM / application specific ''channels'' except it's recommended to do this from the ''Provisioning'' -> ''Content Management'' administration page instead for channel content that is to be provisioned. Refer to the [[enportal/5.4/admin/user_administration/content_creation|Content Creation]] documentation.
:* Listing of currently registered Applications,
:* Registration of new Applications
:* Creation of product specific Channels for registered Applications


== Manage Application Tools Location ==
[[File:enportal-5.4-apps-and-lics.png]]


The '''Manage Applications''' tool is found in the virtual directory at <tt>/system/pim/Manage Applications</tt>. For most Administrators, it is also conveniently available as the '''Applications &amp; Licenses''' channel in the default view-set, under the ''Web Integrations'' tab.
== Applications ==


<!-- insert Application Management tool screenshot, and update the text in barkets in following section to match actual screenshot example (Reports_Dev and Services_Deploy above) plz /Mylene-->
The ''Applications'' tab will at a minimum list the set of loaded PIMs with "sample" targets that are ready to be configured.


== Manage Application Tools Layout ==
[[File:enportal-5.4-apps-and-lics.png|frame|Applications & Licenses administration page]]
<br>
 
This screen allows registration of new ''Applications'' by clicking the new button. Right-clicking on a registered ''Application'' displays a menu to modify or delete the application, and the list of helpers to create channels specific to this type of application.
 
Think of a registered application as an application ''target''. This combines the type of application, generic or PIM specific, along with the protocol, host, and port. Each ''target'' also has a name for convenience.
 
The columns shown are:


The initial screen displays all currently registered '''Applications''' <!--(Reports_Dev and Services_Deploy above)--> and allows registration of new '''Applications''' by clicking the new button. Right-clicking on a registered '''Application''' displays a menu to modify and delete '''Applications''' and a list of '''Channel Builders''' for creating Application specific Channels.
The central panel of the '''Manage Applications''' tool lists the currently registered applications. The columns are:
:*''Name'': The string name given to the Application upon creation.
:*''Name'': The string name given to the Application upon creation.
:*''PIM Package'': The PIM Package name. For instance, <tt>"compx.reports_pimA"</tt>.
:*''PIM Package'': The PIM Package name. For instance, <tt>"compx.reports_pimA"</tt>.
Line 30: Line 28:
:*''Port'': The port on which the Application is listening.
:*''Port'': The port on which the Application is listening.
:*''Enabled'': Whether or not the Application is enabled (Yes or No). This controls whether a license session should be currently provisioned for this application.
:*''Enabled'': Whether or not the Application is enabled (Yes or No). This controls whether a license session should be currently provisioned for this application.
== Managing Applications ==
Use the ''New'' button or right-click an existing registered application to ''Modify''.
=== General ===
The ''General'' tab contains the required information for this application target and consists of the following:
:*''Product'': The full name of the PIM corresponding to the product application running on the server. This is a drop-down selection based on the PIMs loaded on the system.
:*''Name'': The name by which this application target will be accessed. Each PIM ships with a "sample" target that can be modified, or additional targets can be created.
:*''Protocol'': The protocol is used to communicate with the Server (HTTP or HTTPS).
:*''Host'': The IP address or fully-qualified domain name of the server.
:*''Port'': The TCP port on which the server is listening for the specified protocol.
=== Proxy Settings ===
Some applications may only be accessible to the enPortal server via a proxy. It is possible to configure a proxy using the ''Proxy'' tab when Adding or Editing a Target.
=== Meta ===
Certain PIMs may require additional configuration parameters, or information specific to this target may be needed, and these name / value pairs can be entered here.
== License Usage ==
The ''License Usage'' tab can be used to keep track of overall PIM licenses. This page shows the following columns with an entry per PIM and for ''Generic'' for system provided generic proxy capability. Depending on the license file some licenses may be shared versus PIM specific.
:*''PIM Package'': The PIM Package name. For instance, <tt>"compx.reports_pimA"</tt>.
:*''Supported Applications'': The application(s) that a particular PIM Package supports.
:*''Licenses'': Total number of Licenses available
:*''Enabled'': How many licenses in use, this represents the number of enabled ''Targets'' for this PIM.

Latest revision as of 12:29, 27 June 2014


The Web Integrations -> Applications and Licenses administration page allows for the configuration of application servers, also referred to as targets, and to view overall license usage.

The Applications tab also allows for the creation of PIM / application specific channels except it's recommended to do this from the Provisioning -> Content Management administration page instead for channel content that is to be provisioned. Refer to the Content Creation documentation.


Applications

The Applications tab will at a minimum list the set of loaded PIMs with "sample" targets that are ready to be configured.

Applications & Licenses administration page

This screen allows registration of new Applications by clicking the new button. Right-clicking on a registered Application displays a menu to modify or delete the application, and the list of helpers to create channels specific to this type of application.

Think of a registered application as an application target. This combines the type of application, generic or PIM specific, along with the protocol, host, and port. Each target also has a name for convenience.

The columns shown are:

  • Name: The string name given to the Application upon creation.
  • PIM Package: The PIM Package name. For instance, "compx.reports_pimA".
  • PIM Version: The PIM version number.
  • Supported Applications: The application(s) that a particular PIM Package supports.
  • Host: The server address on which the Application is running.
  • Port: The port on which the Application is listening.
  • Enabled: Whether or not the Application is enabled (Yes or No). This controls whether a license session should be currently provisioned for this application.


Managing Applications

Use the New button or right-click an existing registered application to Modify.


General

The General tab contains the required information for this application target and consists of the following:

  • Product: The full name of the PIM corresponding to the product application running on the server. This is a drop-down selection based on the PIMs loaded on the system.
  • Name: The name by which this application target will be accessed. Each PIM ships with a "sample" target that can be modified, or additional targets can be created.
  • Protocol: The protocol is used to communicate with the Server (HTTP or HTTPS).
  • Host: The IP address or fully-qualified domain name of the server.
  • Port: The TCP port on which the server is listening for the specified protocol.

Proxy Settings

Some applications may only be accessible to the enPortal server via a proxy. It is possible to configure a proxy using the Proxy tab when Adding or Editing a Target.

Meta

Certain PIMs may require additional configuration parameters, or information specific to this target may be needed, and these name / value pairs can be entered here.

License Usage

The License Usage tab can be used to keep track of overall PIM licenses. This page shows the following columns with an entry per PIM and for Generic for system provided generic proxy capability. Depending on the license file some licenses may be shared versus PIM specific.

  • PIM Package: The PIM Package name. For instance, "compx.reports_pimA".
  • Supported Applications: The application(s) that a particular PIM Package supports.
  • Licenses: Total number of Licenses available
  • Enabled: How many licenses in use, this represents the number of enabled Targets for this PIM.
Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Enportal/5.4/web_integrations/applications_and_licenses&oldid=5492"