service-cloud-voice / ServiceCloudVoiceLambdas

This application provides a set of Lambda functions, which are available within your Amazon Connect instance after provisioning the instance with your Service Cloud Voice contact center. You can use these Lambdas in Amazon Connect contact flows.
BSD 3-Clause "New" or "Revised" License
14 stars 18 forks source link

Configuration documentation is wrong/confusing + environment variable naming - AUDIENCE #40

Open vgw-chriskruger opened 1 year ago

vgw-chriskruger commented 1 year ago

If I understand correctly the associated documentation for configuring this software is this document.

Within the document is the instructions for configuring the InvokeSalesforceRestAPIFunction lambda function environment variables. See image below.

Screenshot 2023-06-14 at 4 47 00 pm

With reference to the AUDIENCE environment variable the documentation states that one must enter one of the following values:

However upon code inspection it becomes clear that this environment variable is in fact more accurately described as the audience SSM parameter name and one should not enter either of these values directly into the lambda environment variable. The environment variable is the name of the SSM parameter, where one should enter the audience value.

The documentation is wrong and the name of the environment variable is less than ideal. I would argue, it would more accurately reflect reality if it were titled AUDIENCE_PARAM_NAME. The documentation should be updated to reflect the need to edit a parameter in SSM.

jinalkathiara commented 1 year ago

Thanks for pointing this out. We will update this in the documentations.

vgw-chriskruger commented 10 months ago

Just noting this is still confusing in Winter `24 documentation

jinalkathiara commented 4 months ago

Apologies for the inconsistencies. I will take a look one more time.