RAML Adapter

To integrate a RAML service in Quantum Fabric, a RAML file or Zip (with all dependent files) must be created, which defines all the API definitions and schemas with properties in the project. When a Quantum Fabric user creates a service from Quantum Fabric Console, the system retrieves metadata from a RAML file and displays all APIs of a RAML file.

Quantum Fabric parses a RAML file and exposes all the endpoints through the integration service.

Configure RAML Endpoint Adapter

To configure RAML service in the Integration Service Definition tab, follow these steps:

  1. In the Name field, provide a unique name for your service.
  2. From the Service Type list, select RAML.
  3. Provide the following details to create the RAML service:
  4. Field Property
    Connection Parameters Click Upload and select a RAML file from your local machine.

    The system adds your main RAML file to the console. The system displays the added RAML file's name under the Connection Parameters section.

    Authentication

    Select an identity provider from the list to link your service.

    NOTE: For more information on Externalizing Identity Services, refer to Replace the Identity Service references in a Fabric app.

    Web Service Authentication
  5. NOTE: All options in the Advanced section are optional.

  6. In the Description field, provide a suitable description for the service.
  7. To enable the proxy, select the Use proxy from settings check box. By default, the check box is cleared. The Use proxy from settings check box dims when no proxy is configured under the Settings > Proxy.

  8. Click Save to save your service definition.

Create Operations for RAML

The Operations List tab appears only after the service definition is saved.

NOTE: Click Operations List tab > Configure Operation. The Configured Operations list appears.

To create an operation, follow these steps:

  1. Click SAVE & ADD OPERATION in your service definition page to save your service definition and display the NewOperation tab for adding operations.
                        OR
    Click Add Operation to add a new operation or from the tree in the left pane, click Add > Add New Operation.

  2. Under Operations List tab, Please Select drop-down lists all the supported operations based on the uploaded RAML file..
    1. Expand an operation.
    2. Under Objects and Services, select the required check boxes.
  3. Click ADD OPERATION. The system adds your operation to the Operations List page.
  4. To configure an operation, click on the required service under Operations List and provide the following details:
  5. Field Description
    Name It is prepopulated with the operation name. You can change the name if required.
    Operation Security Level

    It specifies how a client must authenticate to invoke this operation.


  6. NOTE: All options in the Advanced section are optional.

Configure Request Operation for RAML

  1. In the Request Input tab, provide the following details:

    NOTE: Input and Output must be defined in the RAML file only.

    FieldDescription
    NameIt Contains a Unique Identifier. Change the name if required.
    Test ValueEnter a value. A test value is used for testing the service.
    Default ValueEnter the value, if required. The default value will be used if the test value is empty.
    Scope

    Select Request or Session. It is set to Request by default.

    • Request indicates that the value must be retrieved from the HTTP request received from the mobile device.
    • Session indicates that the value must be retrieved from the HTTP session stored on Quantum Fabric.
    Data Type
    Record ID

    Enter an ID.

    DescriptionProvide a suitable description.
  2. To validate the operation details, click Save and Test. For more details, refer to Test a Service Operation.

Configure Response Operation for RAML

  1. Click the Response Output tab to view the output test values, such as name, scope, data type.

    NOTE: If you define parameters inside a record as the session, the session scope will not get reflected for the parameters.

  2. To validate the operation details, click Save and Test. For more details, refer to Test a Service Operation.

  3. Click SAVE OPERATION.

    NOTE: You can view the service in the Data Panel feature of Quantum Visualizer. By using the Data Panel, you can link back-end data services to your application UI elements seamlessly with low-code to no code. For more information on Data Panel, click here.