Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Download the plugin JAR file from the Joget Marketplace. 
  2. Go to Settings > Manage Plugins > Upload Plugin. 
  3. Once uploaded, the plugin will be available in your Joget environment. 

How to use 

API Connector Builder 

...

  1. In a new app or an existing app, navigate to the App Composer. 
  2. Under API Connector Builder, click the ADD NEW button to create a new API connector.
    Image Added

  3. Provide an IDName, and Description for the API connector, and click Save.
    Image Added

  4. For Select OAS document, upload the OAS document.
    Image Added
  5. Under API Server, for Select API Server, select the API server from the drop-down list.
  6. For region, select the SAP Subscription Billing Region from the drop-down list. 
    Image Added
  7. Under Security, for Select Authentication method, select an authentication method from the drop-down list. In this example, it is oauth2.
  8. Configure the fields in the Authenticators section depending on the authentication method selected.
    Image Added
  9. Click the Design tab.
  10. In API Connector Builder, drag and drop an API request template to the canvas.
    Image Added

  11. Click the template to configure it. 
  12. Click SAVE.
    Image Added

List Builder 

  1. In List Builder, in the DATA tab, for Select Source of Data, select API Connector from from the drop-down list.
  2. For For API Connector, select the API Connector created. 
  3. For For Select Operation, select the operation created in API Connector Builder. Depending on the operation type, cofigureconfigure:
    • id
    • Payload
  4. For Base JSON Object Name for Multirow Data, configure configure the name of the base JSON object (e.g., data).
  5. For For Total Record Count JSON Object Name, configure configure the total number of records in the JSON object (e.g., data.total).
  6. For For Primary Key, configure the Unique Identifier of the JSON object (e.g., data.id). Mandatory field.
  7. In the the DESIGN tab tab, drag and drop the API Connector to the list or canvas.
  8. Click the API Connector to configure the following properties:
    Image Added
    • Label: Select a display label.
    • API Connector: Select the created API connector.
    • Select Operation: Select an operation created in the API Connector Builder. Depending on the operation selected, configure:
      • id
      • Payload
  9. Click Apply Change and click SAVE.

...

Properties Configuration 

Operations 

Image Added
POST/allowance-templates

Parameters:  

...

  • Name: Name of the PUT operation 
  • Description: A description of the PUT operation
  • Request Body Input Type: 
    • Payload:
      • Request Body
    • Input FIelds:
      • Field Label
      • Default Value
      • Mode: 
        • Default
        • Force Mandatory
        • Hide Field

SET/allowance-templates 

Parameters: 

...