Creating a Graph QL Data Source

Owned by Rojer Benny CTOO
Last updated: Nov 27, 2024
4 min read

You can easily create a GraphQL data source in Sigma Studio with feasible configurations. The GraphQL data source paves way for fetching the data from the GraphQL endpoint by passing the query in the request.

Note: You can also create datasource for REST webservice endpoint in this screen.

To create a GraphQL data source, perform the following steps:

  1. On the home page of the Studio, click Connections on the left pane.

  1. The connections created will be available in the Connections list on the right pane.

  1. Click the Data Source icon on an existing Graph QL Web Service connection.

The Create new Data Source screen appears.

The Connection Name is a non- editable field and displays the unique name provided by you for the connection in the Connection screen, e.g. GRAPHQL_CONNECTION.

  1. Enter a unique data source name in the Data Source Name field, e.g. GRAPHQL_DS.

  1. Select the mode of the Data Source in the Mode section. In this screen user can create datasource for both GraphQL and other web services like REST API.

Note: By default GraphQL is selected as mode. If GraphQL is the mode, you can enter the data query in the Data query field.
If it is REST webservice you can input the request payload in JSON format in the data query field.

  1. Select the request type in the Method Type field. The available method types are:

    1. POST, If request type is POST method proceed to step 8.

    2. GET, If request type is GET method proceed to step 7.

  1. If request method type is GET, enter the relative path of the GraphQL endpoint in the Relative URL field to fetch the required data.

  1. If the request method type is POST, enter the request query in the Data Query field, so that the data can be fetched from the GraphQL endpoint respect to the query provided.

a. Make sure to add ‘#’ symbol in front of the parameter, when using bind parameters in the request query.

b. Click the Parameter Configuration icon to configure the parameter settings.

c. Select the access category for the parameter on Category field. You can also set a default parameter value on the Default Value field if required.

Note: The available parameter categories are System and User.

  • System is the default parameter configuration present in the system.
    The available default parameters are:
    INPUT_LANGUAGE_ID
    INPUT_GCIF
    INPUT_USER_NO
    the above parameters can be used in the Data Query field as a bind parameter.

  • User parameter configurations are fetched from the user in the end application (Sigma Application). The user have to provide a value for this parameter which should match with the response value to get the required output.

d. Click outside the window to save the parameter values.

  1. Click Save to save the configured Data Source.

  1. Click OK to the Success Message.