Configuring Web Services

Web Services allow users to extract data from SUMMIT Application by providing Input Data and Mandatory Fields. You can use either pre defined web services which comes with SUMMIT application or build Custom Services based on your organization's requirement.

To Preview a Web Service:

1. Select Admin > Basic > Infrastructure > Web Services.
2. Select a URL from the drop-down list.
3. Select a service from the Custom Services list.
4. Fill in all the mandatory fields and then click SUBMIT. The Output Data is displayed.

Figure: Web Services Preview page

Field Description

The following table describes the fields on the WEB SERVICES PREVIEW page:

Fields	Description
Custom Services/Predefined Services	Displays the list of services available. Select a service from the list to extract data from the application through the Web services. Type in the name of the services to search from the list. Click Filters icon to filter the services according to modules. See Screen Shot.   Figure: Web Services Filter
View Custom Services	Click View Custom Services (highlighted in red color in the above image) to display the list of Custom Services created by the users.
View Predefined Services	Click View Predefined Services (highlighted in green color in the above image) to display list of services already defined in the SUMMIT application.
Refresh	Click to Refresh the list.
URL	Select Input URL format from the drop-down list, either JSON Object or JSON String or XML. Click EDIT to edit the existing URL. See Screen Shot.   Figure: Edit Service URL   Service URL example: http://<webserviceurl>/REST/Summit_RESTWCF.svc Replace <webserviceurl> with base URL.
Mandatory Fields	Displays Mandatory Fields for the selected service.
Input Data	Displays Input parameter for the selected URL Type.
Output Data	Displays Output for the selected URL Type.

To Create New Custom Services:

1. Click CREATE NEW. The WEB SERVICE DESIGNER page is displayed.

Figure: Web Services Designer page

2. Type in the web service name and specify the number of records to be displayed.
3. Click icon to view, hide or customize the web service properties. See Screen Shot.

    

   

   Figure:Web Service Properties

   Field Description

   The following table describes the fields on the PAGE PROPERTIES section:

   Fields	Description
   Module Name	Select a Module for the Web Service.
   Edit Query	If selected, the User can edit the SQL Query.
   Active	If selected, the Web Service Configuration becomes active.

4. Select check box to select DATA SOURCE from the list. You can scroll down to see all the available Data Sources or type in the Data Source name in the search box to search a particular Data Source.

• Create Relationship

  To create relationship, select a Data source. Fill in all the required details and click ADD RELATIONSHIP. New Relationship is added. See Screen Shot.

   

  

  Figure: Relationship section

  Field Description

  The following table describes the fields on the RELATIONSHIP section:

  Fields	Description
  Join Type	Select a Join Type from the list.
  Data Source	If multiple Data Sources are selected then Select a Data Source from the list to create a relationship with it.
  Table Alias	Select the alias name for Data Source.
  Join Field	Select a field from the drop-down list for selected Data Source.
  Foreign Data Source	Select a Foreign Data Source from the drop-down list to create relationship with the selected Data Source.
  Join Field	Select a field foreign Data Source from the drop-down list.

• Add Fields to the Web Service

  To add fields to the Web Service:

  1. Drag and drop the attributes from the list to FIELDS and FILTERS section to define the mandatory fields and Filter attributes. You can configure the properties of the attributes in the FIELDS and FILTERS section.

   

  

  Figure: Fields Section.

  2. Upon selecting attributes, PROPERTIES section is displayed (if not displayed then click icon and configure Properties. Select an attribute on FIELDS/FILTERS column, FIELD/FILTERS PROPERTIES is displayed. If not then click the PROPERTIES icon.

   

  

  Figure: Page Properties for Fields

  Field Description

  The following table describes the fields on the PAGE PROPERTIES section:

  Fields	Description
  Source Name	Displays the Source Name of the attribute.
  Field Name	Displays the Field Name.
  Field Alias	If required, change the Field name
  Sort	Select the sort order from the drop-down list.
  Function	Select the function of the attribute from the drop-down menu.
  Custom Expression	Specify the custom expression such as SQL calculations.

5. Click GENERATE SQL to Generate SQL Query. See Screen Shot.

    

   

   Figure: GENERATE SQL (when Edit Query check box is not selected)

    

   

   Figure: GENERATE SQL (when Edit Query check box is selected)

    

   Note: The string IDs should be entered in two single quotes only. Example: ''Username''. Data Manipulation Language (DML) is not allowed in the SQL query. Example : Insert, Delete, Update, Truncate, Create, Alter, Drop, Comment, Rename, Merge, Grant, Revoke, Commit, Savepoint, Rollback and Set.

    

6. Click PREVIEW to view the Output the ongoing Web Service. See Screen Shot.

    

   

   Figure: Output Preview pop-up page

7. Click SAVE. The Web Service is added to the WEB SERVICE PREVIEW list.