@axa-ch/alt-pod-chatbot

ADA - Pod Chatbot

For our customers. Plug ADA on any content page on axa.ch with no configuration

• ADA - Pod Chatbot
• Configuration
• Release management
  • Prepare a release
    • 1. Set POD version
    • 2. Publish POD pod as NPM package
    • 3. Create a Draft Release on GitHub
  • Release
    • 1. Build: open webhub-dx_module-build and click "Build with Parameters" from the menu.
    • 2. Deploy: open webhub-dx_module-deploy and click "Build with Parameters" from the menu.
    • 3. ⚠️ Promote: Required for production
• Google Analytics
• Usage
• Configure ADA to run on different pages
• Start ADA a specific start intent via a link
• Start ADA with a direct link to start an intent
• Appendix
  • Manually publish POD Node package (release or pre-release)

Configuration

all ADA configurations are in podproperties.json

Property	stage dependent	language dependent	comment
type	-	-	default = on-dom-loaded
async	-	-	flag that ADA is loaded async
contactIntent	-	x	returns an object { name, intent } - you can define what happens on the 'contact' icon
apiBaseUrl	x	-	URL for bot endpoint to generate token
directLineBaseUrl	x		direct line endpoint
stage	x		auto generated by FE team
language		x	auto generated by FE team
podversion			auto generated by FE team

Read more about podproperties POD Properties page.

Release management

Prepare a release

These steps only need to be done once per version, no matter to which stage you are deploying later on.

1. Set POD version

Update package.json in the "version": "1.x.yz" field and push/merge it to the develop branch. Please follow semver best practices.

This version will be used to select the version to build and deploy in the next steps.

2. Publish POD pod as NPM package

To deploy the POD to the NPM registry, merge the develop branch to the main branch.

The CI/CD pipeline on Azure DevOps is automatically building and publishing the latest version of this POD to https://www.npmjs.com/package/@axa-ch/pod-chatbot.

Manual option: see Appendix

3. Create a Draft Release on GitHub

For documentary purposes, create a draft release on GitHub.

Field	Value
Tag version	Version from step 1
Target	main
Title	AXA - {VERSION} {TITLE}
Description	Summarize all changes

Save it as draft as long you didn't released this version to Production. As soon as you released the version pro production, publish it as release (so it will be set to the latest commit).

Release

Go to Jenkins to start the relevant jobs.

1. Build: open webhub-dx_module-build and click "Build with Parameters" from the menu.

Do this just once, no mater to which stages you are deploying.

Field	Value
webhubModuleName	pod-chatbot
webhubModuleVersion	Version of the published npm package (only the version), like "1.10.3"
releaseVersion	Same version as above, like "1.10.3".
branchTobuild	Always set to "develop" (has nothing to do with the pod github source)

Press "Build"

2. Deploy: open webhub-dx_module-deploy and click "Build with Parameters" from the menu.

Do this just once, no mater to which stages you are deploying.

Field	Value
webhubModuleName	pod-chatbot
webhubModuleVersion	Version of the published npm package (only the version), like "1.10.3"
targetStage	Select desired target stage DEV, ACC or RELEASE
(checkboxes)	Keep them as they are.

Press "Build"

Observer the build process.

⚠️ PROD: When deploying to production, there is a step where you manually have to confirm you really want to deploy. Don't miss out on this, otherwise the build will be aborted.

Repeat this step 2 & 3 for every stage you want to release

3. ⚠️ Promote: Required for production

After deploying to production, the just built POD needs to be promoted to be available.

Open webhub-dx_module-promote and click "Build with Parameters" from the menu.

Field	Value
webhubModuleName	pod-chatbot
webhubModuleVersion	Version of the published npm package (only the version), like "1.10.3"

Press "Build"

Google Analytics

We have added google analytics support to the bot with docuemntation from https://confluence.axa.com/confluence/x/975VCg and https://confluence.axa.com/confluence/x/LNEXC

Usage

Add the following tag into your page:

<article
   class="o-pod-chatbot js-podchatbot-mount podchatbot">
</article>

No additional data properties must be set. All is done by the POD framework.

Configure ADA to run on different pages

• we are using the name of the page as an convention for the start

• example

  • page: https://www.axa.ch/de/privatkunden.html

    • intent: i_privatkunden

  • page: https://www.axa.ch/de/privatkunden/schaden.html

    • intent: i_schaden

• you have to create in ADA a new Intent and QNA entry with the name "i_schaden"

Start ADA a specific start intent via a link

• Pass to any page where ADA is on it a hashtag with the follwing structure
• ADA will welcome you if not already done with a short text and the intent

#adastart=i_start_claims

https://www.axa.ch/de/privatkunden.html#adastart=i_start_claims

Start ADA with a direct link to start an intent

• Pass to any page where ADA is on it a hashtag with the follwing structure
• Use the same principle as above but add additionally the command ",direct" to it

#adastart=i_greencard,direct

https://www.axa.ch/de/privatkunden.html#adastart=i_greencard,direct

Appendix

Manually publish POD Node package (release or pre-release)

The manual process would be:

• Be sure to be sure to be logged in with as timoteamims (NOTE: password is in KeePass)
• Check with npm whoami
• If needed change with npm logout, npm login
• Run npm run release or npm run pre-release for a pre-release. Soon you will be able to also set a tagged pre-release version in package.json like 1.11.0-alpha.0. As of February 2021, it's not supported by WebHub bot it's on their backlog). Using pre-release tags, allows you to test the pod in the context of the WebHub without to bump the SemVer without a reason (fast build/test cycles).