Service– X Designer

Component overview

Glossary

Basics of using Ramco Enterprise series web page

Using online help

This page allows you to design the extension service for the ILBO. The extension includes adding the method and mapping the method parameter to the service.  In "Integ. Service-DataItem Mapping” tab, you are facilitated to integrate another service to the caller service. On clicking the generate button, the system generates the application layer deliverables.

The “Service– X Designer” page appears.

The system displays the following in the header.

Component Name

The description of the component name.

Component Description

The name of the component.

Service Name

The description of the service name to which the extension design has to be done.

Service Description

The name of the service.

Base Service

The system indicates that whether the service is base service or extension service.

The Service-X Designer page has 4 tabs.

The system generates the application layer deliverables.

To proceed, carry out the following

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Tab: Add Section

Note: Add Section tab is used to add process section only for newly created services.

The system displays the following in the multiline.

Seq. No.                   

The sequence number for the section.

Section Name

The name of the section.

Processing Type

Use the drop-down list box to select the processing type for the section. The combo is loaded with “Default” and “Alternate”. The system displays “Default” by default on launch of the page.

The system displays the following in the multiline.

Is Populated

This field is enabled if the method pattern based generation used in service/method.

Note: “Is Populated” check box cannot be modified when the service is base artifact.

Base Artifact

The system indicates whether the section is base section or extension section.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Tab: Add Method                                  

Process Section Name                                   

Use the drop-down list box to select the process section name for adding the method to the service. The combo is loaded with all process section names defined for the service.

The system displays the following in the header.

PS Seq. No.

The number that indicates the sequence number of the process section name.

Seq. No.

Use the drop-down list box to select the sequence number for the method.

Execute

Use the drop-down list box to select the execute mode for the method. The combo is loaded with “Before”, “After” and “Blank”. The system displays “Blank” by default on launch of the page.

Current Seq. No.

The new sequence number for the extension method.

Seq. No.

The sequence number for the extension method.

Method Name

Use the drop-down list box to select the method name to be added with the service. The combo is loaded with all method names defined across the components.

Method ID

The unique identification number for the method defined in the component. Auto Generated.

Integ. Service Name

Use the drop-down list box to select the integrated service name for adding the method. The combo is loaded with all service names defined across the components.

The system displays the following in the multiline.

Is EDK Service

Indicates that the selected service is the Extension Development Kit (EDK) service or not.

Is Populated

This field is enabled if the method pattern based generation used in service/method.

Note: “Is Populated” check box cannot be modified when the service is base artifact.

Base Artifact

Indicates that the method is the base method or extension method.

Disable

Select the check box, to disable the base methods, if necessary.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Tab: Method Parameter Mapping

Process Section Name                                   

Use the drop-down list box to select the process section name for mapping the method parameter to the segment dataitem. The combo is loaded with the process section name defined for the service.

Method Name

Use the drop-down list box to select the method name for mapping the method parameter to the segment dataitem name. The combo is loaded with methods defined for the selected process section name.

Segment Name

Use the drop-down list box to select the segment name for mapping the method parameter to the segment dataitem. The combo is loaded with segments mapped to the service.

The system displays the following details in the header.

Seq. No.

The sequence number of the method.

Execution Mode

The number that identified the execution mode for the method. The execution mode can be as,

  • 0 – Current, executes in the current method.

  • 1 – Before, executes before the method.

  • 2 – After, executes after the method.

Current Seq. No.

The new sequence number for the extension method.

The system displays the following details in the multiline.

Parameter Name  

The parameter name of the method.

Note: The values of Parameter Name are defaulted based on the selected method name.

Mapped Segment Name

The segment name which is mapped with the method parameter.

Mapped Dataitem Name

The dataitem name which is mapped with the method parameter.

Dataitem Name

Use the drop-down list box to select the dataitem name for mapping the method parameter. The combo is loaded with the values based on the selected segment name in the header.

Map

Select the check box, to map the segment dataitem to the method parameter.

The system displays the following details in the multiline.

Base Artifact

Indicates that the parameter is base parameter or extension parameter.

Note: On “Save”, the system displays the values in “Mapped Segment Name” and “Mapped Data Item Name” fields.

Note: The Business Term (BT) synonym like data type, length, etc. should be same for Parameter Name and Dataitem Name.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Tab: Integ. Service-DataItem Mapping

Process Section Name                                   

Use the drop-down list box to select the process section name for mapping the caller segment dataitem to the integrated segment dataitem. The combo is loaded with the process section name defined for the service.

Integ. Service Name

Use the drop-down list box to select the integrated service name for mapping the caller segment dataitem to the integrated segment dataitem. The combo is loaded with the service name defined for the selected process section name.

The system displays the following details.

Seq. No.

The sequence number of the integrated service name.

Execution Mode

The number that identified the execution mode for the integrated service name.

Current Seq. No.

The new sequence number for the integrated service name.

Integ. Segment

Use the drop-down list box to select the integrated segment for mapping the integrated segment dataitem to the caller segment dataitem. The combo is loaded with the segment name defined for the selected integrated service.

Caller Segment

Use the drop-down list box to select the caller segment for mapping the integrated segment dataitem to the caller segment dataitem. The combo is loaded with the segment name defined for the selected integrated service.

The system displays the following details in the multiline.

Mapped Integ. Segment Name                       

The integrated segment name mapped to the service.

Mapped Integ. DataItem Name

The integrated segment dataitem name mapped to the service.

Note: The values of Mapped Integ. Segment Name and Mapped Integ. Dataitem Name is defaulted based on the selected Integrated Segment Name.

Mapped Caller Segment Name

The caller segment name mapped to the service.

Mapped Caller Data Item Name

The caller dataitem name mapped to the service.

Caller Data Item Name

Use the drop-down list box to select the caller dataitem name to be mapped with the integrated segment dataitem name. The combo is loaded with dataitem mapped to the selected caller segment.

Map

Select the check box, to map the caller dataitem to the integrated dataitem.

Note: On “Save”, the system displays the values in “Mapped Caller Segment Name” and “Mapped Caller Data Item Name”.

Note: The Business Term (BT) synonym like data type, length, etc. should be same for Integrated Dataitem and Caller Dataitem.