Data IO Extension App Reference Implementation

Introduction

This reference implementation models the implementation of data input and output functionalities in an extension app.

To test a read-only data IO extension app, modify one of the ReadOnlyManifest.json files.

To test a data IO extension app with both read and write capabilities, modify one of the ReadWriteManifest.json files.

Authentication

This reference implementation supports two authentication flows:

• Authorization Code Grant – required for public extension apps
• Client Credentials Grant – available to private extension apps. See Choosing private distribution instead of public

Private extension apps can use either authentication method, but public extension apps must use Authorization Code Grant.

manifests/
  ├── authorizationCode/
  │   ├── ReadOnlyManifest.json
  │   └── ReadWriteManifest.json
  ├── clientCredentials/
  │   ├── ReadOnlyManifest.json
  │   └── ReadWriteManifest.json
  └── hosted/
      ├── authorizationCode.ReadOnlyManifest.json
      └── authorizationCode.ReadWriteManifest.json
      └── clientCredentials.ReadOnlyManifest.json
      └── clientCredentials.ReadWriteManifest.json

Hosted Version (no setup required)

You can use the hosted version of this reference implementation by directly uploading the appropriate manifest file located in the manifests/hosted/ folder to the Docusign Developer Console. See Upload your manifest and create the data IO app.

Note: The provided manifests include clientId and clientSecret values used in the sample authentication connection. These do not authenticate to a real system, but the hosted reference implementation requires these exact values.

Choose your setup: local or cloud deployment

If you want to run the app locally using Node.js and ngrok, follow the Local setup instructions below.

If you want to deploy the app to the cloud using Docker and Terraform, see Deploying an extension app to the cloud with Terraform. This includes cloud-specific setup instructions for the following cloud providers:

• Amazon Web Services
• Microsoft Azure
• Google Cloud Platform

Local setup instructions

Video Walkthrough

1. Clone the repository

Run the following command to clone the repository:

git clone https://github.com/docusign/extension-app-data-io-reference-implementation.git

2. Generate secret values

• If you already have values for JWT_SECRET_KEY, OAUTH_CLIENT_ID, OAUTH_CLIENT_SECRET, and AUTHORIZATION_CODE, you may skip this step.

The easiest way to generate a secret value is to run the following command:

node -e "console.log(require('crypto').randomBytes(64).toString('hex'));"

You will need values for JWT_SECRET_KEY, OAUTH_CLIENT_ID, OAUTH_CLIENT_SECRET, and AUTHORIZATION_CODE.

3. Set the environment variables for the cloned repository

• If you're running this in a development environment, create a copy of example.development.env and save it as development.env.
• If you're running this in a production environment, create a copy of example.production.env and save it as production.env.
• Replace JWT_SECRET_KEY, OAUTH_CLIENT_ID, OAUTH_CLIENT_SECRET, and AUTHORIZATION_CODE in development.env or production.env with your generated values. These values will be used to configure the sample proxy's mock authentication server.
• Set the clientId value in the manifest file to the same value as OAUTH_CLIENT_ID.
• Set the clientSecret value in the manifest file to the same value as OAUTH_CLIENT_SECRET.

4. Install and configure Node.js and npm on your machine.

5. Install dependencies

Run the following command to install the necessary dependencies:

npm install

6. Running the proxy server

Development mode:

Start the proxy server in development mode by running the command:

npm run dev

This will create a local server on the port in the development.env file (port 3000 by default) that listens for local changes that trigger a rebuild.

Production mode:

Start the proxy server in production mode by running the following commands:

npm run build
npm run start

This will start a production build on the port in the production.env file (port 3000 by default).

Setting up ngrok

1. Install and configure ngrok for your machine.

2. Start ngrok

Run the following command to create a public accessible tunnel to your localhost:

ngrok http <PORT>

Replace <PORT> with the port number in the development.env or production.env file.

3. Save the forwarding address

Copy the Forwarding address from the response. You’ll need this address in your manifest file.

ngrok                                                    

Send your ngrok traffic logs to Datadog: https://ngrok.com/blog-post/datadog-log

Session Status                online
Account                       email@domain.com (Plan: Free)
Update                        update available (version 3.3.1, Ctrl-U to update)
Version                       3.3.0
Region                        United States (us)
Latency                       60ms
Web Interface                 http://127.0.0.1:4040
Forwarding                    https://bbd7-12-202-171-35.ngrok-free.app -> http:

Connections                   ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00

In this example, the Forwarding address to copy is https://bbd7-12-202-171-35.ngrok-free.app.

Create an extension app

1. Prepare your app manifest

Replace <PROXY_BASE_URL> in your manifest file with the ngrok forwarding address in the following sections:

• connections.params.customConfig.profile.url
• connections.params.customConfig.tokenUrl
• connections.params.customConfig.authorizationUrl
• actions.params.uri
  • Replace this value for all of the actions.

2. Navigate to the Developer Console

Log in with your Docusign developer credentials and create a new app.

3. Upload your manifest and create the data IO app

To create your extension app, open the Developer Console and select +New App. In the app manifest editor that opens, upload your manifest file or paste into the editor itself; then select Validate. Once the editor validates your manifest, select Create App.

4. Test the extension app

This reference implementation uses mock data to simulate how data can be verified against a database. Test your extension using the sample data in fileDB.ts. Extension app tests include integration tests (connection tests and extension tests), functional tests, and App Center preview.

Extension tests

The Developer Console offers five extension tests to verify that a data IO extension app can connect to and exchange data with third-party APIs (or an API proxy that in turn connects with those APIs).

Note: These instructions only apply if you use the mock data in the reference implementation. If you use your own database, you’ll need to construct your requests based on your own schema. Queries for extension tests in the Developer Console are built using IQuery structure.

CreateRecord extension test

To begin the extension test process, run the CreateRecord test using the sample query below. The test should return a response containing the record ID.

{
  "typeName": "Account",
  "idempotencyKey": "NOT_USED_CURRENTLY",
  "data": {
    "Name": "Test Account",
    "ShippingLatitude": 10,
    "PushCount": 6      
  }
}

All record types are located in the /src/db/ folder of this repository.

Open the Account.json file in the /src/db/ folder and check that the records were created.

SearchRecords extension test

This query searches the records that have been created. You don’t have to use the same sample values used here; the search should work with a valid attribute in Account.json.

Open the SearchRecords test and create a new query based on the Account.json file:

• The from attribute maps to the value of typeName in the CreateRecord query; in this case, Account.
• The data array from the CreateRecord query maps to the attributesToSelect array; in this case, Name.
• The name property of the leftOperand object should be the value of Name; in this case, Test Account.
• The operator value should be EQUALS.
• The name property of the rightOperand object should be the same as what's in attributesToSelect array; in this case, Name.

The query below has been updated based on the directions above. You can copy and paste this into the SearchRecords test input box.

{
    "query": {
        "$class": "com.docusign.connected.data.queries@1.0.0.Query",
        "attributesToSelect": [
            "Name"
        ],
        "from": "Account",
        "queryFilter": {
            "$class": "com.docusign.connected.data.queries@1.0.0.QueryFilter",
            "operation": {
                "$class": "com.docusign.connected.data.queries@1.0.0.ComparisonOperation",
                "leftOperand": {
                    "$class": "com.docusign.connected.data.queries@1.0.0.Operand",
                    "name": "Test Account",
                    "type": "STRING",
                    "isLiteral": true
                },
                "operator": "EQUALS",
                "rightOperand": {
                    "$class": "com.docusign.connected.data.queries@1.0.0.Operand",
                    "name": "Name",
                    "type": "INTEGER",
                    "isLiteral": false
                }
            }
        }
    },
    "pagination": {
        "limit": 10,
        "skip": 10
    }
}

Running the test will return the record you queried.

PatchRecord extension test

The recordId property in the sample input maps to an Id in the Account.json file. Any valid record ID can be used in this field.

In the data array, include any attributes and values to be added to the record. In this query, a new property will be added, and the original data in the record will be updated.

{
  "recordId": "2",
  "typeName": "Account",
  "idempotencyKey": "NOT_USED_CURRENTLY",
  "data": {
    "Name": "updatedTestAccount",
    "ShippingLatitude": 11,
    "PushCount": 7,
    "MasterRecordId": "ABCD"
  }
}

Running the test should return the response "success": true.

Rerun the SearchRecords extension test to search for the new patched values.

Input query:

{
    "query": {
        "$class": "com.docusign.connected.data.queries@1.0.0.Query",
        "attributesToSelect": [
            "Name"
        ],
        "from": "Account",
        "queryFilter": {
            "$class": "com.docusign.connected.data.queries@1.0.0.QueryFilter",
            "operation": {
                "$class": "com.docusign.connected.data.queries@1.0.0.ComparisonOperation",
                "leftOperand": {
                    "$class": "com.docusign.connected.data.queries@1.0.0.Operand",
                    "name": "updatedTestAccount",
                    "type": "STRING",
                    "isLiteral": true
                },
                "operator": "EQUALS",
                "rightOperand": {
                    "$class": "com.docusign.connected.data.queries@1.0.0.Operand",
                    "name": "Name",
                    "type": "INTEGER",
                    "isLiteral": false
                }
            }
        }
    },
    "pagination": {
        "limit": 10,
        "skip": 10
    }
}

Results:

Alternatively, the Account.json file will contain the updated records.