Configuring Register Sets

In this section:

Register sets are an existing feature within iWay Service Manager. They are very similar to registers, but they are not global by default. A register set contains a pool of one or more Special Registers (SREGs). Register sets can be configured in the Registers pane of the iWay Service Manger Administration Console. Register sets work the same way in iWay Enable, however, additional functionality has been provided. For instance, iWay Enable allows you to use register sets to document parameters and enable metadata. For more information on registers and register sets, see the iWay Service Manager User’s Guide.
Top of page
x
Using Register Sets to Document Service Parameters

Within the iWay Enable framework, register sets can be used to document a set of parameters associated with a given process flow. Since a process flow can be exposed as a deployed service that is bound to the Representational State Transfer (REST) style transport protocol and can be made available through a URI, it can accept a set of parameters on the URL request string as input. The parameters associated with a service can be documented as a register set and will be linked internally based on the naming convention.

A register name within the register set must be prepended with the parm prefix to indicate that this register will be used to document a parameter for the process flow, for example, parm.registername. A register set name must match the name of the process flow to be associated with the given process flow. In addition, if the process flow contains namespace naming conventions, such as, SetName.ProcessFlowName, the register set name can be the SetName portion of the namespace. This will allow the register set to be associated with all process flows within a given group.

In the following example, the registers within the SalesProcess register set will be associated with the SaleProcess service:

In the following example, the registers within the Sales register set will be associated with the Sales.Domestic and Sales.International services:
x
Procedure: How to Configure a Register Set

To configure a new register set:

  1. Click Registry in the top pane of the iWay Service Manager Administration Console.

    The iWay Service Manager Registry pane opens.

  2. In the left pane, select Registers under the Variables section.

    The Registers pane opens, as shown in the following image.

    The table that is provided lists any existing register sets and a short description for each.

  3. Click Add.

    The following Register name/value pane opens.

    This pane allows you to specify the registers that will be contained in a register set. Since a register set can be used to document parameters for iWay Enable services, the register name must be prefixed by the parm namespace. For example, you can define two parameters, parm.region and parm.transaction, that can be passed on the URL string to run the REST style service call.

  4. The name of the register set must correspond to the namespace of the process flow group or to the process flow name itself. If the register set is sales, then the parameters within this register set will be associated with any process flow that is within the sales group namespace.

  5. Click Finish.

    Once the register set has been created, it is dynamically available for the deployed REST enabled services. These services can be viewed in the new iWay Enable facility of the iWay Service Manager Administrative Console.

  6. Click Tools in the top pane of the iWay Service Manager Administration Console.

    The iWay Service Manager Tools pane opens.

  7. In the left pane, select Services under the Real-time section.

    The Service pane opens where two sales registers are listed (sales.domestic and sales.international).

    In this example, there are two process flows within the sales group namespace. Both of them will be associated with the sales register set.

  8. Right-click the sales.domestic service and select Run from the context menu.

    The sales.domestic Service Parameters dialog box opens.

    This dialog box contains the associated parameters as indicated by the parm prefix in the corresponding register set. You can override the default values for test purposes and run this service.

    For more information on how to construct and run services, see Services.
Top of page
x
Enabling Metadata Notation for Register Sets

The notation for documenting registers within a register set has been expanded to provide support for documenting feed and event metadata for iWay Enable components. The format of this notation can be seen after the ccc register set is imported, which contains various metadata for the Century Cellular Corporation (CCC) demo application. Viewing the ccc register set provides an inside look into the underlying events and feeds used by the CCC demo application.

The imported register sets are not meant to be modified as they represent a completed application. As a result, the actual value of the metadata is set to enable to indicate that the value has been automatically generated based on the preconfigured application. The description however, exposes the actual underlying configuration for the given register.

Feed Notation 

f[FeedName].t[FeedType]

where:

FeedName

Is the name of the feed.

FeedType

Is the type of the feed.

As FeedType is not used by Web applications, it is set as default to indicate a string of information containing data.

Event Notation

e[EventName].t[EventType]

where:

EventName

Is the name of the event.

EventType

Is the type of the event which can be any simple data type.

Tap Notation

t[TapName]

where:

TapName

Is the name of the tap.
Top of page
x
Importing and Exporting Register Sets

Register sets can be used store valuable information for iWay Enable metadata, such as predefined feed and event information. It is useful to be able to move this metadata easily between configurations to ensure the reusability of existing components. As a result, importing and exporting register sets is supported by iWay Enable.
x
Importing a Register Set

Available register sets within the system can be imported using the import facility on the configuration section for iWay Enable.
x
Procedure: How to Import a Register Set

To import a register set:

  1. Click Tools in the top pane of the iWay Service Manager Administration Console.

    The iWay Service Manager Tools pane opens.

  2. In the left pane, select Views under the Real-time section.

    The Views pane opens, as shown in the following image.

  3. Click the Configuration tab.

    Under the Import section, a register set can be selected and imported into the configuration. There are several default register sets that are packaged with iWay Enable, such as enable, which is used by the enable components. The ccc register set used by the CCC demo application. The javadoc default register set is used for the Java documentation.

    For example, importing the ccc register set is required to run the CCC demo application.

  4. Select the ccc register set from the drop-down list.

  5. Click import.

    The following confirmation message is displayed.

  6. Click OK.

    The selected register set is now imported.

    Once the register set is imported, it can be viewed under the Registers section of the iWay Service Manager Administration Console. The ccc register set contains a set of metadata registers which are associated with the ccc components, such as process flows and are used by the CCC demo application. For more information on deploying and using the CCC demo application, see Deploying the Century Cellular Corporation Demo Application.
x
Exporting a Register Set

Exporting a register set is useful function, which allows you to export a register set artifact documenting the corresponding piece of iWay Enable metadata.
x
Procedure: How to Export a Register Set

To export a register set:

  1. Click Tools in the top pane of the iWay Service Manager Administration Console.

    The iWay Service Manager Tools pane opens.

  2. In the left pane, select Views under the Real-time section.

    The Views pane opens, as shown in the following image.

  3. Click the Configuration tab.

    The Export section allows you to specify what special registers (SREGs) should be exported into a defined register set. Leaving the string field blank will export all registers into the register set.

  4. Enter sales as the string and SalesMetaData as the name of the exported register set.

    This example exports all artifacts containing the sales string into the SalesMetaData register set.

  5. Click export.

    The following Register sets pane opens.

  6. Click SalesMetaData.

    The contents of the SalesMetaData register set are displayed.

    Notice that all the feeds, taps, and events containing sales as part of the component name have been exported into the SalesMetaData register set.

iWay Software