- Open source project repository: https://github.com/MyPureCloud/knowledge-connector-app
- Project documentation: https://github.com/MyPureCloud/knowledge-connector-app/wiki
- Knowledge HTML Converter library: https://github.com/MyPureCloud/knowledge-html-converter
- Node.js (Version 18.x or higher)
The app needs configuration for source and destination adapters as well.
The source adapter section contains configuration for API requests used to retrieve data from an external knowledge base.
Based on the type of the source adapter the number and the name of variables can differ.
The destination adapter section contains configuration for sending data to your Genesys Cloud Organization.
The configuration can be set either as Environment Variables or in a .env
file.
Documentation for using dotenv: https://github.com/motdotla/dotenv#%EF%B8%8F-usage
The CONFIGURER
variable defines in which folder should the app find the configurer method.
Each adapter has its own configurer method which adds to the pipe all the necessary tasks for that specific adapter.
CONFIGURER=zendesk
# The base url for Zendesk API (eg. https://<company>.zendesk.com)
ZENDESK_BASE_URL=
# Username and password for API authentication
ZENDESK_USERNAME=
ZENDESK_PASSWORD=
# The articles language to be synced
ZENDESK_LOCALE=
CONFIGURER=genesys
GENESYS_SOURCE_LOGIN_URL=https://login.mypurecloud.com
GENESYS_SOURCE_BASE_URL=https://api.mypurecloud.com
GENESYS_SOURCE_CLIENT_ID=
GENESYS_SOURCE_CLIENT_SECRET=
GENESYS_SOURCE_KNOWLEDGE_BASE_ID=
GENESYS_LOGIN_URL=https://login.mypurecloud.com
GENESYS_BASE_URL=https://api.mypurecloud.com
GENESYS_CLIENT_ID=
GENESYS_CLIENT_SECRET=
GENESYS_KNOWLEDGE_BASE_ID=
# Base url for relative image urls
RELATIVE_IMAGE_BASE_URL=
# Terminates the application after the set timeout in seconds has been reached. Optional
KILL_AFTER_LONG_RUNNING_SECONDS=
- Install dependencies
npm install
- Build the project
npm run build
- Run
npm start