Receive Gateway API-token

Provide your PDX contact with a company name you want to use for this test-adapter, and ask them to provide you with the following:

1. a test-adapter
2. API-token, adapterId, and channelId

Add your IDs + company name

Inside the Getting Started project, locate the channel setup inside the class:

src/main/java/sdk/getting/started/generator/examples/channels/NoAuthenticationChannel.java

and replace the parameters of the ChannelBuilder.defaultChannel as follows:

• channelId (the provided channelId without the ending "-channel")
• adapterApplicationName (the provided adapterId)
• channelName (a human readable name for your channel)

Run code

Generate the channel configuration by running:

./gradlew runExtractor

This runs YourChannelGenerator and produces five JSON files in the project root
directory: the channel configuration, the data standard version, the business
rules version, the generator info version, and a seed file.

Why a dedicated task?
The Getting Started project ships two @AdapterApplication main classes
(YourChannelAdapter and YourChannelGenerator), so a plain ./gradlew bootRun
fails with "Unable to find a single main class …". The runExtractor task pins
the generator's main class (sdk.getting.started.generator.YourChannelGenerator);
its counterpart runAdapter runs the adapter. Both are defined in build.gradle.

Verify that the following files are generated in the root directory of the project:

[company-name]-channel.businessrulesversion.json
[company-name]-channel.channel.json
[company-name]-channel.generatorinfoversion.json
[company-name]-channel.seed.json
[company-name]-channel.version.json

Seed via Gateway API

Once you have done this, put this channel into your PDX UI by running the seed script found in the root of the project.

bash seed.sh API-token ENVIRONMENT

where API-token is the token you received above, and ENVIRONMENT is one of preprod or prod. The script targets:

• preprod → https://pdx-preprod.stibosystems.com
• prod → https://pdx.stibosystems.com

Verify channel found in API

Verify that your channel was created by using the following link using the channelId you received:

LINK: Preprod Gateway API

And perform the following steps:

1. choose adapter-gateway from the "select a definition"-menu
2. provide your API-token by clicking the lock-symbol to the right of the call
3. run GET-method /external/channels/{channelId} and provide the channel ID

If your channel was correctly created, you should receive a response similar to the [your-company]-channel.json:

{
  "id": "your-company-channel",
  "name": "Your Company [SDK-Channel]",
  "visibility": "Private",
  "externalChannelAttributes": {
    "submitTopic": "Publish-adapter-gateway",
    "channelAdapterServiceName": "adapter-gateway",
    "channelAdapterSupportsAuthentication": false,
    "legacyDownloadSupported": false,
    "enableAccountsValidation": false,
    "invitationOnly": false,
    "channelAuthenticationMethod": "SYNCHRONOUS"
  },
  "currentDatastandardVersionId": "your-company-channel_v2023-10-23T16:29:18",
  "currentBusinessRulesVersionId": "your-company-channel_v2023-10-23T16:29:18",
  "logoURL": "https://pdx-channel-api-resources.s3.amazonaws.com/SDK_Channel.svg",
  "allowMultipleAccounts": false,
  "requiredClientAttributes": [],
  "hierarchy": {
    "isHierarchical": false,
    "levels": []
  },
  "parameters": {}
}

Verify channel found in PDX

Use or create user on PDX preprod:

LINK: PDX preprod

Next, make sure that Private Channels are enabled for your account by contacting PDX representative. Finally:

1. go to Channels>Channels Management
2. search for your channel and add it

Please ask your contact at PDX if any of the steps above are not working!