Version 9.6
 —  Adapter Services Wrapper for Natural  —

Using the Adapter Services Wrapper for Natural

This document describes how to use the Adapter Services Wrapper for Natural. It covers the following topics:


Prerequisites

  1. webMethods Integration Server with connections and services generated.

  2. The Service Development feature in Software AG Designer. This is installed with Software AG Installer into Software AG Designer.

  3. The Natural subprograms in source or object form available through a Natural RPC server or as local files.

Top of page

Generating an Adapter Service from a New Natural RPC Environment

This section covers the following topics:

Step 1: Start the Adapter Services Wrapper for Natural Wizard

Usually, the wizard is started from the context menu of a folder in the Package Navigator. This view opens when the Service Development perspective opens:

graphics/ServiceDeployment.png

As an alternative, you can start the wizard with one of the following options:

graphics/SelectNatWizzard.png

Choose Next and continue with Step 2: Create a New RPC Environment.

Step 2: Create a New RPC Environment

If no RPC environments are defined, you only have the option to Create a New RPC Environment. The RPC environments are managed in the Preferences.

graphics/nat_createNewEnv.png

Choose Create a new RPC Environment and press Next to create a new RPC environment. Continue with Step 3: Edit RPC Environment.

Note:
The folder File and the RPC environment localhost@NATSRV2800 (default RPC server for NaturalONE) are available only if NaturalONE plugins are installed.

Step 3: Edit RPC Environment

graphics/nat_editEnv.png

Define the new RPC environment on this page. Required fields are Broker ID, Server Address and the Environment Name. The timeout value must be in the range 1-9999 seconds (default: 60).

The EntireX Authentication fields apply to the broker.

The RPC Server Authentication fields apply to the RPC server. If the Natural RPC Server operates under Natural Security,

Note:
Users who do not have access rights to the Natural system library SYSIDL are not allowed to extract IDL from your Natural environment.

With Extractor Settings, specify the Natural library and program name from which you want to extract. You have the following options to select a range of Natural libraries and programs:

Any Natural RPC Server can be used. Only Natural libraries that reside in the FUSER system file of the Natural RPC Server can be accessed. Special configuration is required only for operating system IBM i; see Natural RPC Server Configuration for the IDL Extractor for Natural.

Press Next to continue.

Step 4: Select Natural Library from RPC Environment (Optional)

All Natural libraries that reside in the FUSER system file of the Natural RPC Server and that match the specification in the Extractor Settings are listed here. See Step 3: Edit RPC Environment. This step is skipped if exactly one Natural library matches the specification. In this case continue with Step 5: Select Natural Subprograms from RPC Environment under Extracting Software AG IDL File from a New Natural RPC Environment in the IDL Extractor for Natural documentation.

graphics/nat_selectLib.png

Only Natural libraries from the Natural User System file (FUSER) are displayed. If the Natural RPC server operates under Natural Security, Natural libraries are displayed only if you are allowed to access the library. This means that if a library is people-protected and you do not have access rights, it is not displayed. See also RPC Server Authentication under Step 3: Edit RPC Environment.

Select the Natural library from the list and choose Next to continue with Step 5: Select Natural Subprogram from RPC Environment.

Step 5: Select Natural Subprogram from RPC Environment

All Natural subprograms that match the specification in the Extractor Settings are listed here. See Step 3: Edit RPC Environment.

graphics/nat_selectNatSubprogs.png

In the Source pane select at least one program from the list of Natural subprograms (CALLNATs). You can also choose Select All or Deselect All.

In the Extraction Settings pane, specify whether the IDL is to be extracted from Natural subprogram sources or compiled objects. The following restrictions apply:

Check Redesign the interfaces if you want to design the extracted interfaces to the Natural subprograms. The Next button will be enabled. See Redesigning the Extracted Interface in the IDL Extractor for Natural documentation. If you do not check Redesign the interfaces, refer to Natural to IDL Mapping in the IDL Extractor for Natural documentation for default mappings.

Check Replace special characters in parameter names with underscore to substitute the special characters '$', '#', '&', '@', '/' by underscores. See also Extracting IDL Parameter Names in the IDL Extractor for Natural documentation in Natural to IDL Mapping in the IDL Extractor for Natural documentation.

If multiple Natural subprograms have been selected in the Natural subprogram selection step, redesign the next interface. The amount of subprograms extracted so far is indicated by the fraction next to the title (current/total).

If only one Natural subprogram has been selected or no further one has to be redesigned, continue with Step 7: Create New Adapter Services.

Step 6: Redesign the Interface for Natural Subprograms (Optional)

In this step, you can redesign the interface. This includes:

graphics/mapNat_subprog.png

Use this page for the following tasks:

This page consists of the following main parts:

Tips:

Use the quick navigation or choose Next to continue. If multiple Natural subprograms have been selected in the Natural subprogram selection step, redesign the next interface. The amount of subprograms extracted so far is indicated by the fraction next to the title (current/total).

If multiple Natural subprograms have been selected in the Natural subprogram selection step, redesign the next interface. The amount of subprograms extracted so far is indicated by the fraction next to the title (current/total).

If only one Natural subprogram has been selected or no further one has to be redesigned, continue with Step 7: Create New Adapter Services.

Step 7: Create New Adapter Services

After you have defined the interfaces for the selected Natural subprograms, the wizard asks for the webMethods ESB, the package and the namespace (folder) for the new connection and the services.

The Connection Name default is <library name>Connection. Adapter services have the same name as the corresponding Natural subprograms. You cannot change the services names within this wizard.

The default Connection Type RPC Connection. If there are inbound parameters only, you can also specify connection type Reliable RPC Connection.

If the connection or adapter services already exist in this webMethods ESB, you can overwrite them by checking Overwrite existing Objects in Integration Server.

graphics/new_selectAdapterServices.png

The result of the generation step is visible in the Package Navigator:

graphics/new_PackageNavigator.png

Top of page

Generating an Adapter Service from an Existing Natural RPC Environment

Step 1: Start the Adapter Services Wrapper for Natural Wizard

Usually, the wizard is started from the context menu of a folder in the Package Navigator. This view opens when the Service Development perspective opens:

graphics/ServiceDeployment.png

As an alternative, you can start the wizard with one of the following options:

graphics/SelectNatWizzard.png

Choose Next and continue with Step 2: Select an RPC Environment.

Step 2: Select an RPC Environment

If RPC environments are defined, you can select an existing one. RPC environments are managed in the Preferences.

graphics/nat_selectRpcEnv.png

Select Use existing RPC environment and select the appropriate RPC environment from the list below.

If Modify the selected RPC environment is checked, the selected RPC environment can be modified before extraction starts.

Press Next to continue.

Note:
The folder File and the RPC environment localhost@NATSRV2800 (default RPC server for NaturalONE) are available only if NaturalONE plugins are installed.

Top of page

Preferences

Use the RPC Environment Manager in the IDL Extractor for Natural documentation to manage RPC environments.

Use the preference page for the IDL Extractor for Natural to manage the default values relevant for Step 5: Select Natural Subprogram from RPC Environment. See Preferences under Using the Software AG IDL Extractor for Natural.

Top of page