The following table describes the External Application Integration Configuration options.
This is a multi-record option group. Records can be added as necessary.
| Option name | Value | Default value | Description |
|---|---|---|---|
| External App cancel popup button text | An alphanumeric value from zero to 40 characters | (None) | Specifies the text that is displayed on the information message button when the third-party web application service is unavailable. |
| External App cancel popup text | An alphanumeric value from zero to 255 characters | (None) | Specifies the text that is displayed on the information message when the third-party web application service is unavailable. |
| External App Continue popup button text | An alphanumeric value from zero to 40 characters | (None) | Specifies the text that is displayed on the information message button on the mobile POS application to continue loading a third-party web application service. |
| External Application Id | An alphanumeric value from zero to 255 characters | Default | Specifies the unique identification of the third-party web application service. This parameter is the record's key. |
| External Application Plugin Data 1–4 | An alphanumeric value from zero to 255 characters | (None) | Specifies data elements used to configure the POS application plug-in. To run external applications in Chrome or Edge, retailers must specify the path to store the browser's user profile data. This path is defined in the External Application Plugin Data 3 parameter with the following browser argument: --user-data-dir=[path] |
| External Application Plugin Key | An alphanumeric value from zero to 255 characters | (None) | Defines the key that is used to run the external application. |
| POS Button Label Text | An alphanumeric value from zero to 40 characters | (None) | Specifies the text that is displayed on the POS button. |
| Release Peripherals From POS | Yes/No | No | Enables the POS to release peripheral devices so they can be used by an external application. When this parameter is enabled, the POS releases the peripheral devices before launching the external application. |
Sample data
The following table provides sample configuration for POS systems that are integrated with a loyalty web application and use the POS application to perform client lookup functions.
| Option name | Value |
|---|---|
| External Application Id | OrderAndShipMerchandise |
| External App cancel popup text | Loading Order and Ship Application - Please Wait |
| External App cancel popup button text | Cancel |
| External Application Plugin Key | ExternalWebApplicationClient |
| External Application Plugin Data 1 | webappurl=<website url> |
| External Application Plugin Data 2 | browserpath=%PROGRAMFILES%\Google\Chrome\Application\chrome.exe |
| External Application Plugin Data 3 | browserargs=--fullscreen -kiosk --new-window --user-data-dir=C:\temp |
| External Application Plugin Data 4 | sessionidprefix=OAS, sessionidqueryname=SessionID, languagequeryname=lang, trainingmodequeryname=trainingmode, EnableRelaunchWarning=yes |
| POS Button Label Text | Order & Ship Merchandise |
| Release Peripherals From POS | No |
The following table provides sample configuration for basket import returns. Setting this record creates a button on the Basket Import screen, which will launch the external web application and import the basket automatically. Records can be added for additional buttons with separate external web application URLs and names.
| Option name | Value |
|---|---|
| External Application Id | ReturnImport- Application1 |
| External App cancel popup text | Launching External Returns Application. Click cancel to stop the launch or add finished basket. |
| External App cancel popup button text | Cancel |
| External Application Plugin Key | ExternalWebApplicationClient |
| External Application Plugin Data 1 | webappurl=<website url> |
| External Application Plugin Data 2 | browserpath=%PROGRAMFILES%\Google\Chrome\Application\chrome.exe |
| External Application Plugin Data 3 | browserargs=--fullscreen -kiosk --new-window --user-data-dir=C:\temp |
| External Application Plugin Data 4 | sessionidprefix=RETURN, sessionidtimestamp=YES, testsessionid=BASKETIMPORT 1 |
| POS Button Label Text | Basket Import Returns |
| Release Peripherals From POS | Yes |
