WRKAPIMTH (DSPAPIMTH) - Work With API Methods

The 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:

On the main panel the API method, sequence and program are displayed. The sequence is the numeric equivalent of subset. Following subsets are by default preloaded to Aperio:

Note: Only *CUSTLOCAL and *CUSTCORP can be used by customers to define their own methods.

Form the main panel You can maintain the API method definition. Api method (program) parameters. It actualy describes the program interface. There is also possibility to maintain atributes defined on header level of method. Function keys leads You to the additional panels.

The Work with API Methods commands shows the datail description of RPG program interface. The program interface is retrieven on the fly dirrectly from RPG source code of program. There is general rule of showing data on WRKAPIMTH panels. The values can be displayed normaly or highlithed. If the value is highlited it means is retrieven from metadata files. Then it can be deleted or manualy changed. If the value is not highlited then it comes dirrctly from RPG source…. It still can be overwritten but can not be deleted. The main reccomendation is to not overwrite data which comes form RPG source. The best way is to change RPG source if needed. There are sometimes some cases where You have to overwite ptogram definition manually in metadata. It is allowed but not reccomended. Following options are available:

Work with method attributes

The attributes defined on method level are used in runtime. For this reason all attributes on method header level are kept in metadata in files even it hey orginates from RPG source. Note, all attributes on method header level are highlited. Following attributes are supported:

Pseudo source

This functionality allows You to generate pseudo source of your RPG program. The pseudo source will contain only metadata information (no any source code). This option is helpfull if You want to deliver Your API to the customer installation without source of program. Then you can generate pseudo source and deliver it. The other option is to speed up the metadata retcrievel process. It may happen that RPG program is long and fetch all information about interface of program dirrectly from source code will take long time. To speed up this process You can generate pseudo source and then use it one as reference to retrieve metadata informaton. The third case is, when You keep sources in format which can’t be for some reason analysed by Aperio metadata retrieval program. You can generate pseudo source and manually store there all description (parameters/attriutes) which are required.

NOTE: The generation of pseudo source will first clear current pseudo source then write information based on original program source. If You can’t access to original source, then do not use this option because it may clear your current pseudo source.

There is Exit program (id = R0034001) which is used to locate RPG program source. The following search order in included in this exit program:

1. Try to locate program in the same library as RPG object in source file QMETASRC. If exist then leave.
2. Try to locate program in the same library as RPG object in source file QRPGLESRC. If exist then leave.
3. Try to retrieve RPG object information form IBMi operating system. If there is information about source file try to locate it. If exist then leave.

NOTE: The first source file searched is QMETASRC. It means if there is pseudo source generated, then it wil be taken into consideration instead of original source.

You can write Your own exit program which will follow your rules of finding RPG program source.

The pseudo source can be generated to any destination location. Before generation the panel is shown where user can choose destination location. The pseudo source can be generated only for documentaton reason.

Export chosen methods

By this opion You can export chosen methods. On the first panel You must confirm Your choice of method list to export. Then window will apear to provide the destination place for exported objects. The methods can be exported in two ways:

NOTE: The exporting process may take some time.

Work with parameters

On this view you can see what are the input parameters and output data suported by RPG program. The information on this panel is retrieven on the fly from RPG program source. If any field is highlited it means tha value was overwitten by user. The overwritten value is stored inside metadata files. Following informatin is presented on main panel:

Define structure of response

Aperio is prepared to handle all kind of structures of json response. But there is reccomendation to follow strict structure to be able to use methods to generate mobile applications. The recomended structure of response should be chosen from following proposales:

• simple response: The returned information is set of simple values inside “data” object. Example:

 {
     "data":{"warehouse":"MKO", "availableQuntity": 5, "batchControlled":true}
 }

• array (table) response: In this case all array records are returned as an json array whic is named “items”. The “items” object is put inside “data” object in json response. Example:

{
    "data":{
        "items":[
            {"warehouse":"MKO", "availableQuntity": 5, "batchControlled":true},
            {"warehouse":"MK1", "availableQuntity": 6, "batchControlled":true},
            {"warehouse":"MK2", "availableQuntity": 7, "batchControlled":true}
        ]
    } 
}

In first case, (simple response) all simple values are represented in metadata as parameters which has parent parameter “data”

In second case all columns in array are represented as parameters with parent parameter “items”. Additionaly there is one entry in metadata parameters:

• parent parameter = “data”, parameter “items”. This definition has one attribute “structure” = “array”. This indicates to mobile application generator that “items” it is an array, and the table should be generated for mobile application panel.

Note: If the response of method do not follow one of two reccomended structures then generator of JForm panels may produce unexpected results.

Parameter attributes

The attributes defined on parameter level are used to generate panels by jforms generator. They are retrieved dirrectly from the source. There is possibility to overwrite the values but it is not reccomended. If something must be adjusted it is better to do it inside RPG program source. Following attributes are supported:

Note: All attributes can be overwtritten in JForm definiton. The attributes provided in metadata describe the default value/behavior of field. Off course some attributes are strictly connected to field type coded in RPG program. It is pointless to change them. For example, manipulating attributes “type” or “lenght” in JForms is useless as this change do not have corresponding change in RPG source code.

Common parameters

Following common parameters are supported by mobile application generator: