---
title: "Configuring Web Services"
slug: "configuring-web-services"
updated: 2026-03-03T04:55:19Z
published: 2026-03-03T04:55:19Z
canonical: "help.symphonysummitai.com/configuring-web-services"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuring Web Services

### What is a Web Service?

A Web Service is a method of communication between two applications or electronic devices over web. You can either use pre-defined web services that come along with the application or build Custom Services based on your organization's requirement.

Web Services are of two types:

1. Simple Object Access Protocol (SOAP)
2. Representational State Transfer (REST)

SOAP defines a standard communication protocol (set of rules) specification for XML-based message exchange. SOAP uses different transport protocols, such as HTTP and SMTP.

The standard protocol HTTP makes it easier for SOAP model to tunnel across firewalls and proxies without any modifications to the SOAP protocol. SOAP can sometimes be slower than middleware technologies like CORBA or ICE due to its verbose XML format.

REST describes a set of architectural principles by which data can be transmitted over a standardized interface (such as HTTP). REST does not contain an additional messaging layer and focuses on design rules for creating stateless services. A client can access the resource using the unique URL and a representation of the resource is returned. With each new resource representation, the client is said to transfer state.

While accessing RESTful resources with HTTP protocol, the URL of the resource serves as the resource identifier and GET, PUT, DELETE, POST and HEAD are the standard HTTP operations to be performed on that resource.

Provide the Service URL to create a Web Service.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS0.jpg)Figure: Edit Service URL

**Service URL Example**: http://<webserviceurl>/REST/Summit_RESTWCF.svc

Replace <webserviceurl> with base URL.

### Web Service Authentication

The default Token-based API authentication is implemented for Web Service from the Sierra HF01 Release onwards. If you upgraded to the Sierra HF01 and want the User ID and Password-based authentication for Web Service, you can enable it.

#### Configuration

You can enable the User id and Password-based authentication by adding the following key in the web.config file:

```plaintext
<add key="IsAPIKeyDisabled" value="true" />
```

> [!NOTE]
> Note:
> 
> If the key is not added in the web.config file or if the value of this key is set as false, by default, the Token-based API based authentication is enabled to log into the application.

To preview a Web Service, perform the following steps:

1. Navigate to **Admin** > **Infrastructure** > **General** > **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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS1.jpg) Figure: Web Services Preview page

##### Field Description

The following table describes the fields on the **Web Services Explorer** 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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS2.jpg) 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 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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS3.jpg) 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. |
| Search Bar | You can search for the web services, based on their properties. For example, if you specify table in the search bar, all the existing tables will be displayed. |

To create Custom Services, perform the following steps:

1. Click **Create New**. The **Web Service Designer** page is displayed. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS4.jpg) Figure: Web Service Designer page
2. Type in the Web Service Name and specify the number of records to be displayed.

> [!NOTE]
> Note:
> 
> You can also create SQL Views, SQL Table, and SQL Procedure and modify the created fields.
> 
> 
> 
> ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS5.jpg)
> 
> Figure: Web Service Designer page

1. Click ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-mvuvt4uo.png) icon to view, hide, or customize the Web Service properties.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-my8p7sdc.png) Figure: Web Service Properties

**Field Description**

The following table describes the fields on the right **Page** **Properties** panel:

| **Fields** | **Description** |
| --- | --- |
| Module Name | Select a Module for the Web Service. |
| Active | If selected, the Web Service configuration becomes active. |
| User Access | Type in the name of a user to whom you want to provide access to the Web Service. |
| View Only | If selected, the user will have read-only access to the Web Service and cannot do any modifications to it. |
| Report Description | Specify the description of the Web Service. |

1. Select the 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.

> [!NOTE]
> Note:
> 
> Create Relationship between the Data Sources if you want to use multiple Data Sources.

****Create Relationship****

To create relationship, select a Data Source. Fill in all the required details and click **Add Relationship**. A new Relationship is added.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS6.jpg) Figure: Relationship section

**Field Description**

The following table describes the fields under 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 the 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 Web Services:**

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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS7.jpg) Figure: Fields Section

> [!NOTE]
> Note:
> 
> 1. Click ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS9.jpg) icon to copy all the fields.
> 2. Click ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS8.jpg) icon to remove all the copied field.

1. Upon selecting attributes, **Properties** section is displayed (if not displayed, click ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS10.jpg)icon) and configure Properties. Select an attribute on **Fields**/**Filters** column, **Field**/**Filters** **Properties** is displayed. If not, click the **Properties** icon. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS11.jpg) 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. |
| Mandatory | If selected, the corresponding field becomes mandatory. |

1. Click **Generate SQL** to generate SQL Query.

****See Screen Shot****

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS12.jpg) Figure: Generate SQL (when **Edit Query** check box is not selected)

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS13.jpg) Figure: Generate SQL (when **Edit Query** check box is selected)

> [!NOTE]
> Note:
> 
> 1. The string values should be entered within double quotes. Example: ''Username''.
> 2. Data Manipulation Language (DML) is not allowed in the SQL query. Example: Delete, Truncate, Drop, Comment, Rename, Merge, Grant, Revoke, Commit, Savepoint, Rollback, Exec, and Execute.
> 3. If you want to pass any parameters, enter # before and after the respective Field name.

1. Click **Preview** to view the Output of the ongoing Web Service.

****See Screen Shot****

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS14.jpg) Figure: Output Preview pop-up page

1. Click **Save**. The Web Service is added to the **Web Service Preview** list.

**Creating Custom Tables in Web Services:**

To Create a New Custom Table, perform the following steps:

1. Navigate to **Admin** > **Infrastructure** > **General** > **Web Services.** The **Web Service Explorer** page is displayed.
2. On the **Web Service Explorer** page, click **Create New**. The **Web Service Designer** page is displayed.
3. On the **Web Service Designer** page, select **Create SQL Table** from drop-down list.
4. Specify the **SQL Table** **Name**. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS15.jpg) Figure: Web Service Designer page: Create SQL Table: SQL Table Name
5. Click ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS16.jpg)icon in **Fields** section to view **Field Properties**. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS17.jpg)Figure: Web Service Designer page: Field Properties
6. Type in **Field Name** (or Column Name) and select the **Data Type** value from drop-down list. For more information about the fields on the **Field Properties**, see Field Description.
7. Click **Add New Field** to add a new field (or Column).

| **Field** | **Description** |
| --- | --- |
| Field Name | Specify the name for the field (or column). |
| Data Type | Select the required data type for the field (or column) from the drop-down list. Following are the available data types: - - nvarchar: Select the data type as nvarchar to store variable characters (letters and numbers) in the field (or column). **Note**: In the **size** parameter, specify the maximum column length in characters. - int: Select the data type as int to store a whole number (not a fraction) in the field (or column). - numeric: Select the data type as numeric to store numbers that have fixed precision and scale. - decimal: Select the data type as decimal to store numbers that have fixed scale. - *bit:* Select the data type as bit to store a single bit with a value of 0,1, or NULL - datetime: Select the data type as datatime to store date and time combination in the field (or column). - text: Select the data type as text to store text or combinations of text and numbers in the field (or column). |
| Auto Identity | Select this check box to define a field (or column) as auto increment field. > [!NOTE] > Note: > > This field is displayed only for int, numeric, and decimal data types. |
| Primary Key | Select this check box to define a field (or column) as Primary Key. > [!NOTE] > Note: > > Primary keys should contain unique values and cannot have NULL values. |

1. Click **Generate SQL** to generate the SQL Query. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS18.jpg)Figure: Generate SQL (sample screenshot)

1. Click **Save** to successfully create the SQL Table. Click **Yes** if you want to redirect to the Web Service Explorer page. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS19.jpg)

****Example 1: Create a Custom Table to Store Location-wise Approver Details****

**Scenario:** Consider that the user wants to create a Custom Table with the following fields to store Location-wise Approver details.

| **Column Name** | **Data Type** |
| --- | --- |
| Country | varchar |
| State | varchar |
| City | varchar |
| EmailID | varchar |
| Approver | int |

To create a New Custom Table, perform the following steps:

1. Navigate to **Admin** > **Infrastructure** > **General** > **Web Services.** The **Web Service Explorer** page is displayed.
2. On the **Web Service Explorer** page, click **Create New**. The **Web Service Designer** page is displayed.
3. On the **Web Service Designer** page, select **Create SQL Table** from drop-down list.
4. Specify the **SQL Table** **Name** (Ex: Location_Table). ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS20.jpg)Figure: Web Service Designer page: Create SQL Table: SQL Table Name
5. Click ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS16(1).jpg)icon in **Fields** section to view **Field Properties**.
6. Type in **Field Name (or Column Name)** and select the **Data Type** value from drop-down list (Refer the above table for column names and data types).
7. Click **Add New Field** to add a new field (or Column). For more information about the fields on the **Field Properties**, see Field Description.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS21.jpg)Figure: Web Service Designer: Field Properties

##### **Field Description**

The following table describes the fields on the **Field Properties** section:

| **Field** | **Description** |
| --- | --- |
| Field Name | Specify the name for the field (or column). |
| Data Type | Select the required data type for the field (or column) from the drop-down list. Following are the available data types: - - nvarchar: Select the data type as nvarchar to store variable characters (letters and numbers) in the field (or column). **Note**: In the **size** parameter, specify the maximum column length in characters. - int: Select the data type as int to store a whole number (not a fraction) in the field (or column). - numeric: Select the data type as numeric to store numbers that have fixed precision and scale. - decimal: Select the data type as decimal to store numbers that have fixed scale. - *bit:* Select the data type as bit to store a single bit with a value of 0,1, or NULL - datetime: Select the data type as datatime to store date and time combination in the field (or column). - text: Select the data type as text to store text or combinations of text and numbers in the field (or column). |
| Auto Identity | Select this check box to define a field (or column) as auto increment field. |
| Primary Key | Select this check box to define a field (or column) as Primary Key. Note: Primary keys should contain unique values and cannot have NULL values. |

1. Click **Generate SQL** to generate the SQL Query.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS22.jpg) Figure: Generate SQL (when **Edit Query** check box is not selected)

1. Click **Save** to generate a new SQL Table successfully. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS19(1).jpg)

> [!NOTE]
> Note:
> 
> To view the Custom Table, type in select * from **Location_Table** in the SQL Server Management Studio.
> 
> ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-inr3u6b3.png)

****Example 2: Create a Custom Table to Store Workgroup-wise Approver Details****

**Scenario:** Consider that the user wants to create a Custom Table with the following fields to store Workgroup-wise Approver details.

| **Fields** | **Data Type** |
| --- | --- |
| Workgroup | varchar |
| Workgroup Owner | int |
| Additional Owner | int |

To Create a New Custom Table, perform the following steps:

1. Navigate to **Admin** > **Infrastructure** > **General** > **Web Services.** The **Web Service Explore** page is displayed.
2. On the **Web Service Explore** page, click **Create New**. The **Web Service Designer** page is displayed.
3. On the **Web Service Designer** page, select **Create SQL Table** from drop-down list.
4. Specify the **SQL Table** **Name** (Ex: Workgroup_Table).
5. Click icon in **Fields** section to view **Field Properties**.
6. Type in **Field Name (or Column Name)** and select the **Data Type** value from drop-down list (Refer the above table for column names and data types).
7. Click **Add New Field** to add a new field (or Column). For more information about the fields on the **Field Properties**, see Field Description.

##### **Field Description**

The following table describes the fields on the **Field Properties** section:

| **Field** | **Description** |
| --- | --- |
| Field Name | Specify the name for the field (or column). |
| Data Type | Select the required data type for the field (or column) from the drop-down list. Following are the available data types: - - nvarchar: Select the data type as nvarchar to store variable characters (letters and numbers) in the field (or column). **Note**: In the **size** parameter, specify the maximum column length in characters. - int: Select the data type as int to store a whole number (not a fraction) in the field (or column). - numeric: Select the data type as numeric to store numbers that have fixed precision and scale. - decimal: Select the data type as decimal to store numbers that have fixed scale. - *bit:* Select the data type as bit to store a single bit with a value of 0,1, or NULL - datetime: Select the data type as datatime to store date and time combination in the field (or column). - text: Select the data type as text to store text or combinations of text and numbers in the field (or column). |
| Auto Identity | Select this check box to define a field (or column) as auto increment field. |
| Primary Key | Select this check box to define a field (or column) as Primary Key. Note: Primary keys should contain unique values and cannot have NULL values. |

1. Click **Generate SQL** to generate the **SQL Query**.
2. Click **Save** to generate a new SQL Table successfully and the following pop-up page is displayed.
3. Click **Yes**. The **Web Service Explore** page displayed.

> [!NOTE]
> Note:
> 
> To view the Custom Table, type in select * from Workgroup_Table in the SQL Server Management Studio.
> 
> ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-me2fggtr.png)

#### **Creating Table via Excel in Web Services**

You will be able to create a new table in webservices using excel. You can also view or modify the created table. You can view the table along with the records unlike creating table with SQL where you can view only SQL queries in the Web Service Explorer. You can also import and export the records in the excel.

****Example****

ACME requires the app designer, Sam who has no SQL knowledge, to create a table to keep a track of the leaves of all of the employees from an already existing excel sheet named Leave_History_Excel, which has the details about employee's leaves history. Now, Sam has the following requirements:

- To create a table from an already existing excel sheet
- To view the created table
- To edit the created table by adding more records or overriding the existing ones
- To download only the template of the excel sheet without any records, if required

Following are the columns available in the Leave_History_Excel

- Leave Type
- From Date
- To Date
- No of Days
- Status
- Remarks
- Approval Status

For the above requirement, Sam can create the table named Leave_History_Table easily from the Leave_History_Excel excel sheet with the help of ***Generate Table*** button available for ***Create SQL Table*** drop-down option on the ***Web Service Designer*** page.

Sam can view and edit the table from the View Data and Modify Data which are available on ***Table*** list page ***(Admin*** > ***Web Service Designer*** page > ***Actions*** > ***Table List)***.

Sam can import the same records mentioned in the Leave_History_Excel by choosing the option ***Continue With This Data***.

Sam can add more records or override the existing ones with the option ***Edit.***

Sam can download the only template of Leave_History_Excel without any records with option Download Master.

#### **Creating New Table using Excel**

The following section provides information on how to create a table using Excel.

To Create a New Table using Excel, perform the following steps:

1. Navigate to **Admin** > **Infrastructure** > **General** > **Web Services.** The **Web Service Explorer** page is displayed. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS23.jpg)Figure: Web Service Explorer page
2. On the **Web Service Explorer** page, click **Create New**. The **Web Service Designer** page is displayed. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS24.jpg)Figure: Web Service Designer page
3. On the **Web Service Designer** page, select **Create SQL Table** from the drop-down list.![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS25.jpg)Figure: Web Service Designer page: Create SQL Table
4. Specify the **SQL Table** **Name**. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS26.jpg)Figure: Web Service Designer page: Create SQL Table: SQL Table Name
5. Click **Generate Table** to create a table using excel import. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS27.jpg)Figure: Web Service Designer page The **Master Import** page is displayed with the following three tabs: 1. Upload Excel 2. Map Columns 3. Upload Master ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS28.jpg)Figure: Master Import page
6. Specify the required fields on **General** tab. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS29.jpg)Figure: General
7. Click on the download icon ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS30.jpg)and it will open your file browser window to select the required Excel file from the location. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-fi2ienr3.png)Figure: Browser Window
8. Click **Submit** to import the selected excel sheet as source. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS31.jpg)Figure: General
9. The uploaded excel file will display all of the available sheets inside it and you can choose the required sheet for mapping which needs to be uploaded if the uploaded excel sheet has more than one sheets. Select the required record and click on **Select** hyperlink. The **Mapping** page under the **Map Columns** tab is displayed: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS32.jpg)Figure: Mapping

##### Field Description

The following table describes the fields on the **Mapping** page:

| **Fields** | **Description** |
| --- | --- |
| Column Name | Displays all the columns name mentioned in the uploaded excel sheet. For Example in the above *screenshot*, LeaveHistory Excel displays the columns such as Leave Type, FromDate, ToDate,NoofDays, Status, Remarks and ApprovalStatus. |
| Data Type | Data Type defines which type of value can be provided for the respective column. Respective column input value should be in same data format. For Example: If ***Data Type*** for column name ***NoofDays*** is defined as an Integer, then the input value in this column should be an integer only. Select the required data type for the field (or column) from the drop-down list. Following are the available data types: - Number - Select the data type as **Number** to store numbers that have fixed precision and scale. - Integer - Select the data type as **Integer** to store a whole number (not a fraction) in the field (or column).String - Select the data type as **String** to store variable characters (letters and numbers) in the field (or column). - Bool - Select the data type as **Bool** to store a single bit with a value of 0,1, or NULL. - Date - Select the data type as **Date** to store a date in the field (or column). > [!NOTE] > Note: > > Format of Date must be DD:MM:YYYY - Date Time - Select the data type as **Date Time** to store date and time combination in the field (or column). - Time - Select the data type as **Time** to store a date in the field (or column). > [!NOTE] > Note: > > Format of time must be HH:MM:SS By default, it displays the data type related to the column name. You may modify it as per the requirement. For Example: If the ***Column Name*** is mentioned as Priority then by default, the ***Data Type*** will be displayed as **Number.** |
| Primary Key | Select this check box to define a field (or column) as Primary Key. > [!NOTE] > Note: > > Primary keys should contain unique values and cannot have NULL values. If Primary Key has duplicate values it will be highlighted during validation checks. |
| Mandatory | Select the **Mandatory** checkbox to indicate if the associated column is the mandatory column. > [!NOTE] > Note: > > If Mandatory Key has null value or left empty then it will be highlighted during validation checks. |
| Autogenerate? | **Autogenerate?** field is displayed only if **Data Type** is **Number** or **Integer.** If **Autogenerate?** checkbox is selected it indicates that the value for the column will be populated automatically as the records are entered and in the series of the existing series. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS33.jpg) Figure: Autogenerate? For example: If a new table is created and 5 records are being uploaded. The auto-generate column will get automatically populated from 1 to 5. If there is an already existing table with 10 records and 5 more records have to be added. Then the auto-generate column will automatically take the subsequent series i.e. 1 to 10 serial no. already exists. 5 new records will take 11 to 15. |
| Previous | Click **Previous** button to go back to the previous screen. |
| Next | Click **Next** button to proceed further. |
| Cancel | Click **Cancel** button to cancel the immediate action. It will redirects you to **Web Service Designer** page. |

1. Click **Next.** The following popup is displayed: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS34.jpg)Figure: Popup page
2. The popup page is displayed with two options: 1. **Continue With This Data** - Click this option if you want to continue with the already existing data from the excel. 2. **Download Master** - Click this option if you want to download the excel template having the defined columns with the configured data types, and add the records in the excel template.
3. If you click **Continue with this Data,** then the **Preview** page under the **Upload Master** tab is displayed: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-4timjopa.png) Figure: Preview

The **Preview** page displays all of the records which are imported via excel. There will be a few validation checks before you do bulk upload. The following table describes a few validation checks while bulk uploading.

| **Symbol** | **Meaning** |
| --- | --- |
| ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-cg8o8zul.png) | If the data in the field does not match the data type mapped against that field, then it displays the data mismatch. For Example: If you have defined Data Type for a column name ***NoofDays*** as an integer but the input value is Five (text string) then it's a data mismatch. |
| ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-7kx848hh.png) | Mandatory columns can not be left blank. For Example: If you have defined Data Type for a column name ***Employee ID*** as mandatory then this column can not be left blank. |
| ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-ga64ptdq.png) | In Excel data set if a single column which is mentioned as Primary Key has same values then that record is duplicate. If a column is selected as **Primary Key**, then that column will become a unique identifier. This column can not have duplicate entries and will be identified during validation checks. For Example: If you have defined Data Type for a column name ***Employee ID*** as primary then this column can not have duplicate entries. |

**Field Description**

The following table describes the fields on the **Preview** page:

| **Fields** | **Description** |
| --- | --- |
| Discard | Select the **Discard** checkbox to indicate that the selected record will not be included while upload. |
| Column | Displays all columns names which are imported via excel. |
| Previous | Click **Previous** button to go back to the previous screen. |
| Bulk Upload | Click **Bulk Upload** button to upload all the records displayed on **Preview** tab. |
| Cancel | Click **Cancel** button to cancel the immediate action. It will redirects you to **Web Service Designer** page. |

1. Click **Bulk Upload.** The following popup is displayed with total count of records, count of uploaded records and count of failed records. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-61sgnjj9.png) Figure: Bulk Upload popup **Download failed records** - Click **Download failed records** to download the excel with failed records which were failed to upload. You can make corrections to the records and upload again. **OK & Proceed** - Click **OK** & **Proceed** button will direct to the Table List Screen with the table having the records which are uploaded. A sample screenshot is as follows: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-5rm00ios.png)

> [!NOTE]
> Note:
> 
> - Ensure that the Excel file being uploaded is not the Excel file downloaded from the Report.
> - Ensure that first row of Excel file to be uploaded is the column name (A1 Cell). Uploading data values should start from the second row onwards (A2 Cell).
> 
> ****Example****
> 
> ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/6da659b8-effa-4863-8125-dd6e7bf7c46e.png)
> 
> 
> 
> - To achieve optimal performance, keep number of rows/entries under 2000 for the Excel file being uploaded.
> - In a scenario to update an existing table, ensure that number of columns in Excel file being uploaded, matches the same number of columns in the existing table.
> - Ensure data mapping is done accurately for the respective columns under **Mapping** tab. Special attention must be given for **Date**, **DateTime** and **Time** data types.
> - Re-upload the Excel file if you get the following error message: “Failed to get Worksheet Information” It might be due to Excel file corruption during upload.
> - Ensure the Excel file being uploaded does not have duplicate Primary Key while appending new entries to an existing table with pre-defined Primary Key. Doing so, will prevent data from being uploaded.
> - Ensure that Excel file being uploaded is a simple file without any formatting such as date format, merge cells, cell hyperlink etc.

#### Various Methods to Import Data into Custom Table

The Administrators can use the following methods to import data into the Custom Table:

- Import the data form source systems (such as: AD, SAP or HR) via API
- Backend Import: You can import a file (.csv,.txt, etc.) into your database using SQL Server Management Studio.
- SQL Query or Stored Procedure

#### Importing Custom Data into Custom Table U**sing Stored Procedure**:

To Import Data into Custom Table using Stored Procedure, perform the following steps:

1. On the **Web Service Explore** page, click **Create New**. The **Web Service Designer** page is displayed.
2. On the **Web Service Designer** page, select **Create SQL Procedure** from drop-down list.
3. Specify the **SQL Stored Procedure Name**.
4. Select **Edit Query** check box.
5. Type in the stored procedure to insert new records in a table.
6. Click **Save** to insert values into table.

****Example 1: Import Custom Data into Custom Table (Location_Table)****

Consider that you want to import data into Custom Table (Location_table)

To Import Data Into Custom Table using Stored Procedure, perform the following steps:

1. On the **Web Service Explore** page, click **Create New**. The **Web Service Designer** page is displayed.
2. On the **Web Service Designer** page, select **Create SQL Procedure** from drop-down list.
3. Specify the **SQL Stored Procedure Name** (Ex: Location_table procedure).
4. Select **Edit Query** check box. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS35.jpg)Figure: Edit SQL Query
5. Type in the Stored Procedure to insert new records in the table.

****Sample Stored Procedure****

CREATE PROCEDURE [dbo].[Location_table procedure]

AS

BEGIN

insert into Location_table(Country,State,City,EmailID,Approver) values(''USA'',''Alaska'',''Fairbanks '',''james@xyz.com'',''206'')

insert into Location_table(Country,State,City, EmailID,Approver) values(''USA'',''California'',''Los Angeles'',''michael@xyz.com'',''207'')

insert into Location_table(Country,State,City,EmailID,Approver)

values(''Canada'',''Ontario'',''Toronto'',''david@[xyz.com](http://xyz.com)'',''208'')

END

1. Click **Save** to insert values into the table.

****Example 2: Import Custom Data into Custom Table (Workgroup_Table)****

Consider that you want to import data into Custom Table (Workgroup_Table)

To Import Data into Custom Table using Stored Procedure, perform the following steps:

1. On the **Web Service Explore** page, click **Create New**. The **Web Service Designer** page is displayed.
2. On the **Web Service Designer** page, select **Create SQL Procedure** from drop-down list.
3. Specify the **SQL Stored Procedure Name** (EX: Workgroup_Table).
4. Select **Edit Query** check box. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS36.jpg)Figure: Edit SQL Query
5. Type in the Stored Procedure to insert new records into the table.

****Sample Stored Procedure****

CREATE PROCEDURE [dbo].[Workgroup_Table]

AS BEGIN insert into Workgroup_Table (Workgroup,[Workgroup Owner],[Additional Owner]) values(''Server Team'',''4494'',''1'') insert into Workgroup_Table (Workgroup,[Workgroup Owner],[Additional Owner]) values(''Wintel Team'',''4486'',''4488'') insert into Workgroup_Table (Workgroup,[Workgroup Owner],[Additional Owner]) values(''Server Team'',''4494'',''2'') END

1. Click **Save** to insert values into the table.

##### Actions

This section explains all the icons displayed on the **Actions** panel of the **Web Service Explorer** page.

**Table List**

Click **Table List** to display the list of all tables which are created using **Create SQL Table** option on **Web Service Designer** page. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS37.jpg)Figure: Table List page

**Field Description**

The following table describes the fields on the **Table** page:

| **Fields** | **Description** |
| --- | --- |
| Table Id | Displays the ID of the table. |
| Table Name | Displays the name of the table. |
| No. of Records | Displays the number of records of a specific table. |
| View Data | Click on **Download Excel** hyperlink to view all of the records of the table. It will download the excel sheet with all record details of the table. |
| Modify Data | Click **Edit** hyperlink to modify any record details of the table. It displays the **Master Import** page. |
| Last Updated | Displays the date and time the table was last updated. |
| Cancel | Click **Cancel** to go back to the **Web Service Explorer** screen. |

**To View the Table**

Perform the following steps to view the table:

1. Navigate to **Admin** > **Infrastructure** > **General** > **Web Services.** The **Web Service Explorer** page is displayed: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS38.jpg)Figure: Table List
2. Click **Table List** under **Actions** panel. The Table List page is displayed: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS37(1).jpg)Figure: Table List page
3. Click **Download Excel** hyperlink under the **View Data** column. The following popup is displayed: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS39.jpg)Figure: Download Excel Popup
4. Click **Download Excel.** The excel file is downloaded at the bottom-left of the page.

**To Modify the Table**

Perform the following steps to edit the table:

1. Navigate to **Admin** > **Infrastructure** > **General** > **Web Services.** The **Web Service Explorer** page is displayed:
2. Click **Table List** under **Actions** panel. The Table List page is displayed:
3. Click **Edit** hyperlink under the **Modify Data** column. The following popup is displayed:
4. Click on the one of the following options:

**Override Existing Records** - Select this option to replace all the table records with new records when updated excel is uploaded. By this, records can be deleted or edited, or new records can also be added.

**Add New Record** - Select this option to add new records to the already existing records. The new records will be appended at the end of the table. The Master Import page is displayed: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/WS29(1).jpg)Figure: Master Import

**Field Description**

The following table describes the fields on the **Master Import** page:

| **Fields** | **Description** |
| --- | --- |
| Table Name | Displays the name of the table whose records are getting modified. |
| Mode | Displays the mode based on the selection in the above popup. **Override** - Displays the **Mode** as **Override** if **Override the Table Records** is selected in the popup. **Add new record** - Displays the **Mode** as **Add new record** if **Add New Records** is selected in the popup. |
| Source | Download the excel which needs to be modified. |
| Download Excel | Click **Download Excel** to download to excel sheet with all previous records. |
| Download Master | Click **Download Master** to download excel template without any records. It will only display the column names with appropriate validations associated with columns. |

1. Click on Download icon to browse the excel file which needs to be uploaded.

> [!NOTE]
> Note:
> 
> Only the Excel file can be uploaded, and data types and column names cannot be changed while editing the table.

1. Click **Submit.** You can view the imported sheets under **General** tab.
2. Click Select hyperlink and it moves to the **Mapping** tab.

The following table describes the fields on the **Mapping** tab.

| **Fields** | **Description** |
| --- | --- |
| Destination | Displays the name of the destination columns |
| Data Type | Displays the data type of the Destination column. |
| Source | Select the required column from the drop-down list. Available options are as per the imported excel. |

1. Click **Next.** The **Preview** tab is displayed. **i. Add New Records**: The records will be imported as per the Primary Key. If Primary Key matches, then as per the Primary Key, the new records gets replaced with the previous records. If new Primary Keys are fetched, then the new records will be entered at the end of already existing records. **ii. Override Existing Records**: The imported records override the already existing records i.e. all the existing records will be deleted and only new imported records are available in the table. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-b1ujvn0q.png)Figure: Import - Preview

You can discard the records and do the validation checks before Bulk Upload.

**Filters**

This section explains all the icons displayed on the **Filters** section. Filters provide easy and simplified search criteria to search for a table based on Table Name or Table ID from a list of tables. Click on **Filters,** the following popup page is displayed.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/configuring-web-services-image-k746hmt0.png)Figure: Filters popup page

> [!NOTE]
> Note:
> 
> Filters are applicable only to **Table Id** and **Table Name** field.

**Field Description**

The following table describes the fields on the **Filter** popup page:

| **Fields** | **Description** |
| --- | --- |
| Field | The fields related to the Table List are populated in the drop-down list. Select the required option. Available options are as follows: - Table ID - Table Name |
| Operator | Based on the selected field value, the operators are displayed. Select the required operator from the drop-down list. Available options for the TABLE ID field are as follows: - = - >= - <= - > - < - IN - Between Available options for the TABLE Name field are as follows: - Contains |
| Values | Specify the respective values in **Values** field based on the selected **Field** type and **Operator**. |
| Apply | Click **Apply** to save and to apply the above-mentioned filters. |
| Clear | Click **Clear** to cancel any selected filters. |