1. Home
  2. /
  3. API Services
  4. /
  5. Aperio View

Aperio View

Introduction

Aperio view  is used to extend the functionality of XT panels. It receives input from XT panels and opens a new panel called Aperio view with additional information on the currently accessed file. 

Prerequisites for Aperio view functionality

Installation

  •  XT UI version must be v4.3.0 or higher.
  • Aperio and the APIs used by Aperio view functions must be installed on the IBMi server.
  • The forms used by Aperio view and the Aperio view links file must exist on XT Server. 
  • The Aperio view must be open in the XT Client workbench.
Aperio view configuration

Update Aperio view forms links

  1. Place the configuration file (AperioViewLinksIP1.xml) on IP1 XT Server in folder \XTBM\bin\config on the IP1 XT server. This config file contains links between layout fields and AperioView in XML format.

The configuration file can be environment dependent if required. Currently we have one configuration file for all IP1 environments.

AperioViewLinksIP1.xml

 

Field Description
view id = part.AperioView – this is fixed.= part.AperioView – this is fixed.
path This is the active aperio app for XTView. XTView being a standalone Aperio application with its own definitions requires this app to be specified in the XT Dispatcher configuration as well as in the UI Server configuration. 
aperioform JSON form to be executed for the linked form and event type.
link form XT Display panel linked to the JSON form.
param id Input parameter ID for the form as specified on the JSON form.
field RPG fieldname or the subfile ID in the subform.
event type

These are actions that will trigger AperioView:

onfocusout = when you exit from a field after entering a value.

onselection = when you select a subform line.

 

Note To extend functionality, you can modify this file or provide your own file with additional configuration. The extension file is expected to be in the same XML format as the Iptor standard configuration file.
XT dispatcher configuration

Configure XT dispatcher for Aperio view

  1. Goto XT Admin

  1. Select and stop the XT Dispatcher for the required environment.
  2. Click configure.
  3. Page down to Aperio properties.

  1. Enter the path/file name in the XT dispatcher configuration in field ‘Aperio view links extension file’ as shown on the panel above.
  2. Update the Active Aperio app.
  3. Restart the XT dispatcher.
XTUI server configuration

Configure the XTUI server

  1. Goto XT Admin.
  2. Select and stop the required UI server.
  3. Click configure.

  1. Update JVM arguments field to:

-Daperio.app.metadata

Refer to the XT folder name where aperio (tool) can find the methods (synchronized with methods on IBMi)

-Daperio.apps

Apps for which the UI server will start folder watcher to generate the aperio forms (JSON to html & js)

Xtview application must have xtview folder in on XT server::

XTBM\aperio\apps folder (app definition and menu)

XTBM\aperio\mods folder (forms)

  1. Ensure JSON forms for AperioView are on the XT server:

Aperio view on XT

To see Aperio view on XT , open Aperio view:

  1. Drop down main menu.
  2. Select ‘Views’ and then “Aperio”.

Aperio view opens:

Trans by customer inquiry example:

  1. Run Transaction Inquiry by Customer/Item (DSI045).
  2. Enter the Customer number and tab to the next field. The customer number input is passed as a parameter to Aperio view. Aperio view is refreshed with the customer information. The information displayed is based on the output parameters defined in the JSON form.