How to Create and Publish Web Services to CA API Gateway › Create an Interface

Create an Interface

Create an interface from a procedure step of a business system. Later, you can edit the interface to customize its details.

Follow these steps:

1. Open a model in Gen Studio in the PStep Interface Designer perspective.
2. Expand the model to show all the Business Systems.
3. Expand the Business System for which you want to create an Interface.

   The Procedure Steps of the Business System are displayed.

4. Right-click the Procedure Step and click Create Interface.

   

5. Accept the suggested name or type a new name for the Interface.

   Note:

   • The Interface name can include alphanumeric characters and special characters. It does not accept spaces and converts a space to an underscore character.
   • You cannot create duplicate Interfaces.
   • You cannot name an interface after the procedure step it is originating from, or after any other procedure step in the model.
6. Specify the initial mapping style of the parameters.

   The mapping style determines which attributes are included as part of the interface and which attributes to exclude. System attributes are not included. After the interface is created, you can change individual attribute mapping styles within the editor.

   Default: <None>

   <None>

   Specifies that no attributes of the interface are exposed to the end user.

   <Variable>

   Specifies that all the attributes of the interface are exposed to the end user and allows the end user to enter data into this parameter. You can rename this parameter to add a user-friendly name.

   Note: If you want to expose only a few attributes of the interface, specify the Mapping Style as <Variable>. You can modify the attribute details later while customizing the interface.

7. Select the Views to Set.

   This option is available only when you specify the Mapping Style as <Variable>.

   Both

   Indicates that attributes in both import and export views are mapped according to the mapping style set in the previous step.

   Import

   Indicates that only attributes in the import view are mapped according to the mapping style set in the previous step.

   Export

   Indicates that only attributes in the export view are mapped according to the mapping style set in the previous step.

8. Click Finish.

   The interface is added under the procedure step in the Interfaces view.