Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
# PathCheck GAEN Mobile Configuration

### In App Supported Configuration Values

These configs define the in app functionality which HAs can/should define

‼️ **REQUIRED** ‼️

```
PRIVACY_POLICY_URL
a valid url, required - the location of the privacy policy, this link will be
displayed only on the Terms of Service/EULA screen

DISPLAY_NAME
a string, required - the user facing name of the app

GAEN_AUTHORITY_NAME
a string, required - the name of HA that provides the app

MEASUREMENT_SYSTEM
metric or imperial - the unit system used in the app, defaults to imperial

SUPPORTED_LOCALES
a list of valid locales, separated by comma, required

DISPLAY_SELF_ASSESSMENT
boolean string, true or false - defines if the self assessment is shown

DISPLAY_ACCEPT_TERMS_OF_SERVICE
true or false - defines if the accept terms of service screen is shown during
the onboardig process. This screen displays a confirmation screen prompting the
user to accept the terms of service before continuing.

EMERGENCY_PHONE_NUMBER
a valid phone number pertaining to the emergencies services for the given
jurisdiction. This is the number where the user will dial when they press the
`Emergency Contact` call to action on the connect screen. If the value is not
present the link will not be displayed

By default is interpreted as 'false' if not provided

DISPLAY_CALLBACK_FORM
true or false, required - whether or not the callback form is shown
if provided we must also provide all the server config:
CALLBACK_FORM_URL=
CALLBACK_OAUTH_URL=
CALLBACK_USERNAME=
CALLBACK_PASSWORD=
CALLBACK_CLIENT_ID=
CALLBACK_CLIENT_SECRET=

```

☑️ **OPTIONAL** ☑️

```
SHARE_APP_LINK
a valid url, optional - the link that is used for sharing the app
If not present the share functionality won't be available

AUTHORITY_ADVICE_URL=
a valid url, optional - the link that NextSteps goes to
By default, the next steps action is not shown if it is not present

EULA_URL
a valid url, optional - the location of the eula for the product, if it is not
provided, then the link won't appear on the onboarding flow.

LEGAL_PRIVACY_POLICY_URL
a valid url, optional - the location of the privacy policy to be displayed on
the legal screen, if it is not provided, then the link won't appear on the legal
screen, this one is not related to the policy url that shows on the eula/terms
of service screen

```

### Server and Distribution Configuration Values

These configuration variables are defined by PathCheck and cannot be defined by
the HA

‼️ **REQUIRED** ‼️

```
IOS_BUNDLE_ID
Bundle identifier for the ios application, should be unique per HA

ANDROID_APPLICATION_ID
Application identifier for the Android application, should be unique per HA

DOWNLOAD_BASE_URL
url from where the TEK's should be downloaded

DOWNLOAD_PATH
relative path to request the download of temporary exposure keys, dependent on
the DOWNLOAD_BASE_URL

REGION_CODES
code that represents the region to where the HA belongs(US, PR, GR ...)

POST_DIAGNOSIS_KEYS_URL
url used to publish exposure keys during the affected user flow after a
verification code has been provided

EXPOSURE_CONFIGURATION_URL
url from where to obtain the base configuration for determining exposure
settings i., PCF available: https://cdn.projectaurora.cloud/cfg

GAEN_VERIFY_URL
url for the verification server, where the verification code provided by the HA
will be sent for validation and for generating the certificate/JWT to be used to
post exposure keys

GAEN_VERIFY_API_TOKEN
token used to authorize the submissionon of verification codes to the verification
server on the GAEN_VERIFY_URL variable

EN_DEVELOPER_REGION
more granular region to avoid duplication for all the US based one
https://developer.apple.com/documentation/bundleresources/information_property_list/endeveloperregion

EN_API_VERSION
api version used by the exposure notifications framework
currently 2 - https://developer.apple.com/documentation/bundleresources/information_property_list/enapiversion
```

☑️ **OPTIONAL** ☑️

```
STAGING
boolean string indicates if this is a STAGING specific build or not,
turns on debugging
```

...