/backend/index.htmlChapter 6 Aperio Backend Reference Aperio backend software is responsible for comunication betwen IBMi and XT dispatcher. It also provides various helpers for RPG developers. This reference describes installation and upgrade Aperio backend software. Explains details about configuration Aperio backend and best practice. There is also chapter about “Work With Metadata” and “Work With Control” programs. There is also detail documentation of all commands supported by Aperio backend software.Hugoen-usFri, 07 Aug 2020 12:47:07 +0200/backend/aperio_naming/index.htmlTue, 14 Jul 2020 15:01:31 +0200/backend/aperio_naming/index.htmlThis section describes naming rules for all objects and names used to build APerio framework. Iptor API framework The API framework was built as separate product which can be installed as stand alone. There is no need to have DC1 installation. Following rules were used to name objects in Iptor API Framework: IAF100AP - API framework production library/backend/apidoc/index.htmlFri, 07 Aug 2020 12:47:07 +0200/backend/apidoc/index.htmlThe Aperio reads RPG source code and tries to determine the interface to program. What are the input parameters, what is the output data etc… Most of the work is done automatically but sometimes it is needed to put some documentation tags to preciselly tell the framework how the program interface looks like. This chapter describes how Aperio reads RPG source. Aperio tries to determine program interface mainly based on original source code. For example: respAddElement('data');tells Aperio framework that output JSON will contain “data” field. Command reqExist('params':'warehouse'); tells that program has input parameter warehouse. Similar for reqGetValue('params':'warehouse'); command. Based on commands (procedure calls) Aperio can only determine the names of input and output parameters. The second step of analysing source is the analyse of parameter and data names. Based on parameter name Aperio can look into DC1 fref files and retrieve more descriptive attributes like “length”, “label”, “scale”, “type”. Aperio uses parameter name and searches it inside fref files using alias field. In case field name do not exists in any fref alias programmer has two options./backend/upgapi/index.htmlMon, 27 Jul 2020 11:27:59 +0200/backend/upgapi/index.htmlUpgrade API data command automates upgrade API process. During the process API framework library is upgraded with objects extracted from the save file containing entire Aperio framework saved. The command also changes owner of all objects in framework library (by default to the owner already set for Framework library) and updates data in Metadata, Control, Configuration and Notification libraries (calling necessary conversion program(s)). Following parameters are available for this command:/backend/dspapidtav/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/dspapidtav/index.htmlThe Display API Data Versions (DSPAPIDTAV) command shows all API elements installed on entire IBMi. It shows actual location of elements together with their versions. NOTE: There are no parameters for this command. Aperio backend framework can be installed as several parallel instantions on IBMi. For example, there can be separate instantion of framework per each environment. Administrator may decide to keep metadata info in separate libraries. In this case the number if Aperio backend libraries can grow. To help administrator maintain Apeio backend installation, command DSPAPIDTAV was created. Administrator can see all elements of aperio installed on IBMi together with their version./backend/expapidta/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/expapidta/index.htmlThe Export API data command exports API data into library or save file. Aperio backend consist following elements: Element Description Framework Consist set of programs, commands and objects required to process communication to dispatcher. It contains also set of tools for RPG programmer. Config Consists set of files witch store configuration of framework. For example definition of exit programs. Metadata Consists set of files and objects required to save program interface (API metadata). Keeps also statistics or requrests. Control Consists set of files which store security infirmation about metadata. Notifications Not used. Consists set of files which are used to keep notifications messages, subscribed servers and all data required to send notification to the browser. The exporting process etracts chossen elements of Aperio and puts them into destnation library or destination save file./backend/fixapimtd/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/fixapimtd/index.htmlThs command either prints or delete metadata methods if corresponding program does not exist. This is strict administrator commands to quick clean metadata with entries which no longer exists in IBMi. Administrator can decide to print list of methods which are “suspicious”. Then run this command once again with different parameter to delete them. Following parameters are available for this command: Parameter Mandatory Description ACTION Y *PRINT Print only the method list for which the corresponding program does not exist. *DELETE Print and delete methods from metadata if the corresponding program does not exist./backend/impapidta/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/impapidta/index.htmlThe Import API data command imports API data from library or save file. Aperio backend consist following elements: Element Description Framework Consist set of programs, commands and objects required to process communication to dispatcher. It contains also set of tools for RPG programmer. Config Consists set of files witch store configuration of framework. For example definition of exit programs. Metadata Consists set of files and objects required to save program interface (API metadata). Keeps also statistics or requrests. Control Consists set of files which store security infirmation about metadata. Notifications Not used. Consists set of files which are used to keep notifications messages, subscribed servers and all data required to send notification to the browser. The importing process load chosen elements to the destination library. During importing process data are upgraded to destination version of aperio./backend/inzapidta/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/inzapidta/index.htmlThe Initialize API data command pre-sets of all necesary API data in the destination library. Aperio backend consist following elements: Element Description Framework Consist set of programs, commands and objects required to process communication to dispatcher. It contains also set of tools for RPG programmer. Config Consists set of files witch store configuration of framework. For example definition of exit programs. Metadata Consists set of files and objects required to save program interface (API metadata). Keeps also statistics or requrests. Control Consists set of files which store security infirmation about metadata. Notifications Not used. Consists set of files which are used to keep notifications messages, subscribed servers and all data required to send notification to the browser. Following parameters are available for this command:/backend/inzapif/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/inzapif/index.htmlThe Initialize API framework command initializes metadata, control, configuration or notifications files. This command also initializes API framework. Creates necesarry stored procedures. Element Description Framework Consist set of programs, commands and objects required to process communication to dispatcher. It contains also set of tools for RPG programmer. Config Consists set of files witch store configuration of framework. For example definition of exit programs. Metadata Consists set of files and objects required to save program interface (API metadata). Keeps also statistics or requrests. Control Consists set of files which store security infirmation about metadata. Notifications Not used. Consists set of files which are used to keep notifications messages, subscribed servers and all data required to send notification to the browser. Following parameters are available for this command:/backend/rbdapimth/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/rbdapimth/index.htmlThe Rebuild entire metadata command run process of retrieveal API interface for each method in metadata. This command do not require any parameters. NOTE: The rebuild process may take several minutes! Since Aperio backend version 2.2.0.0 run this command is not necessary./backend/updapimth/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/updapimth/index.htmlThe Update API Method (UPDAPIMTH) command allows you add or update method into API metadata. This command retrieves also program interface from source file and update method level attributes. Following parameters are available for this command: Parameter Mandatory Description PGM Y API method RPG program. METHOD Y Method name. SUBSET Y Method subset. See subsets description Subsets Subset Sequence Description *CUSTLOCAL 1 Customer dev, single sites *CUSTCORP 2 Customer dev, multiple sites *IBSLOCAL 3 Iptor dev, signle site (Reserved for Iptor development) *IBSCORP 4 Iptor dev, multiple sites (Reserved for Iptor development) *COUNDELTA 5 Country dev, delta release (Reserved for Iptor development) *COUNTRY 6 Country dev, base release (Reserved for Iptor development) *INTDEV 7 International development (Reserved for Iptor development) *STDDELTA 8 Iptor standard, delta release (Reserved for Iptor development) *STANDARD 9 Iptor standard, base release (Reserved for Iptor development) *APIBASE 99 Base API level (Reserved only for internal Aperio API methods)/backend/wrkapicfg/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/wrkapicfg/index.htmlThe Work with API Configuration (WRKAPICFG) command allows you to work with various API framework configuration files. NOTE: There are no parameters for this command. NOTE: The (DSPAPICFG) Display API Configuration command shows the same data as WRKAPICFG command but only with ability to display data. No possobility to maintain data. Following general congiguration groups are available: Confoguration group Description Exit points This group allows You co configure exit points. See exit points configuration Exit points Aperio has several exit points. They can be used to inject own code inside process of aperio./backend/wrkapictl/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/wrkapictl/index.htmlThe Work with API Control (DSPAPICTL) allows You to maintain API control information. In API control panel You can see basic authority se up in Aperio. The security is defined by attributes. Attributes can be defined either on general or method level. NOTE: There are no parameters for this command. NOTE: The (DSPAPICTL) Display API Control command shows the same data as WRKAPICTL command but only with ability to display data. No possobility to maintain data./backend/wrkapimth/index.htmlMon, 13 Jul 2020 17:13:07 +0200/backend/wrkapimth/index.htmlThe Work With API Mathods (WRKPAPIMTH) command is used to maintani API metadata. In API matadata panel You can describe API program interface. Attributes can be defined either on general or method level. NOTE: The (DSPAPIMTH) Display API Methods command shows the same data as WRKAPIMTH command but only with ability to display data. No possobility to maintain data. NOTE: There is one parameter to this command: Subset selection (SUBSET). Following values are suported: