Environment

Environment setup

You must request at least one environment for each currency where the retailer does business. You can request additional environments by contacting us.

The first time you log in, some information for your environment will already be populated. The Environment page is where you select global settings for parameters and receipts that will apply by default to all locations in the current environment. These can be overridden later for one or more locations.

Access environment settings

1. If you have received more than one environment, click Settings (gear icon) > Switch Environment to verify you're in the correct environment. If you're not, select the environment and click Switch.

2. Within the InStore Center, access the Environment menu option.

General tab

The general tab on the Environment page is where you assign basic identifying information, some of which may be used on receipts or may influence settings at the location and workstation levels.

1. You can assign the following:

   • Label: optionally, rename the default label to a short name. Only administrators see this label, which is used for switching among environments.
   • Name: assign a unique name for the environment, such as "Wales-All."
   • Description: provide a description that identifies the intended purpose and users of the environment, such as "Test Environment for All Wales Locations."
   • TaxId: provide the tax ID or VAT identifier to print on receipts, if the retailer prints this information. Use sample information for test environments.
   • Locale: select a locale (geography-specific language) to apply by default to locations in this environment. InStore uses ISO notation to identify the locale. For example, en-US indicates English as spoken in the USA. This field lists all locales that InStore supports.
   • Currency: select a currency to apply to this environment. After saving this environment as active, you cannot change this selection. InStore assumes a single currency. If the retailer's business covers multiple currencies, you'll need to request additional environments.
   • Parameter Set: select the parameter set to apply by default to locations in this environment. This can be overridden later for individual locations and workstations. See Parameter sets.
   • Template Set: select the receipt template set to apply by default to locations in this environment. This can be overridden later for individual locations. See Receipt templates.

2. Click Save Changes.

Payment Processors tab

The Payment Processors tab on the Environment page is where you add, edit, or delete the payment processors that handle payment and refund transactions at workstations within the environment.

1. View the processors that have been registered for this retailer.

2. Optionally, click the icon to edit or delete a processor.

3. Optionally, click Add Payment Processor and complete these fields for a new processor:

   • Processor: select from among the available options. Note that Simulator is the commercetools simulator for use in testing. If you select Custom, the retailer's development team must define a connection for each payment type to be processed. See Payment extensions.

   • Custom Processor Name: displayed only if the processor is Custom. Provide the name to display to administrators during location setup.

   • Supported Payment Types: select from among Credit Card, Gift Card, Wallet, Pay by Link, and Pay on Account as available.

   • Processor Key: displayed only if the custom processor is Adyen, Stripe, or Citcon. Enter a valid test key that was provided by the processor vendor.

   • Merchant ID: displayed only if the custom processor is Adyen. Provide the retailer's Adyen credential.

   • Test/Production: displayed only if the custom processor is Adyen. Toggle to indicate whether you are setting up a test or production environment.

     Never use production credentials for testing.

4. Click Add.

5. Click Save Changes & Activate Environment. If this option is not available for a new environment, verify that you have at least one processor listed and at least one Store role set up.

Project settings tab

The values on the Project settings tab of the Environment page are required for InStore to connect to the retailer's Composable Commerce project.

1. Complete these fields:

   • Project Key: this value was generated during self-serve Composable Commerce project creation. Retrieve the value that you saved then.
   • Client Secret: Click the icon to input the identifier. Save this in a secure location as you cannot access it again from the InStore Center.
   • Client ID: this value was generated during self-serve Composable Commerce project creation.
   • Auth URL: this value was generated during self-serve Composable Commerce project creation.
   • Host: this was called API URL in your project.
   • Scopes: the list of scopes was generated during self-serve Composable Commerce project creation. Paste the entire list into the field, with values separated by a space. Do not insert a comma-delimited list.
   • InStore Order Type: the key that identifies this type that you defined in your API.
   • InStore Lineitem Type: the key that identifies this type that you defined in your API.
   • Customer Type: the key that identifies this type that you defined in your API.
   • InStore Payment Type: the key that identifies this type that you defined in your API.
   • Transaction Type: the key that identifies this type that you defined in your API.

2. Click Save Changes.

Custom Fields tab

1. Enter the names of the Product Attributes that will be used for Barcode Array and Receipt Text fields. Ensure that these attributes exist on all Product Types and values are included on all Product Variants to be used in InStore implementations.
2. In the next pane, review the list of required attributes derived from your Composable Commerce project.
3. In the Custom Field column for each, verify or correct the corresponding field name as it exists in your implementation of InStore. The options are pre-populated from your Composable Commerce project. See List of Custom Fields.
4. Click Save Changes in the top pane.

Integration settings tab

The Integrations settings tab contains important information for connecting your environment.

The value in the Tenant ID field uniquely identifies this environment. It is not available for editing.

The value in the Connection Key field authorizes your store application and digital retail platform to communicate with InStore.

If the connection key ever becomes lost or compromised, you will be directed to generate a replacement key for the retailer's developer to insert into the InStore colleague app code.

To generate a new key, complete these actions:

1. Access the Environment menu option.

2. On the Integration Settings panel, click Generate New Connection Key.

3. Click Copy Key to Clipboard.

4. Click Save Changes to activate the new key. If you didn’t mean to generate a new key, navigate away from the page without saving.

5. Paste the key into a safe location.

6. Complete the settings as shown below, substituting * with a unique, assigned integration-server URL. Webhook URL is the fully specified internet location where the InStore server will provide responses for your store application to retrieve.

   Setting name	Value you type after the URL
   Webhook URL	*/webhooktest
   Webhook Verification Key	(Request from commercetools)
   Cart Retrieval URL	*/commercetools/checkout/
   Return Cart Retrieval URL	*/commercetools/refund/

7. Complete the following settings, substituting * with the URL of your store application followed by the suffixes shown. The format should be similar to https://store.nebulaterra.com/*.

   Setting name	Value you type after the URL
   Token Retrieval URL	*/usertoken/
   Callback API Key	(Request from commercetools)
   Key Sync URL	*/tenant
   Sync API Key	(Request from commercetools)

Allowed URLs tab

This tab is a place to add external domains that are allowed to interact with this retailer's instance of InStore.

1. Enter an allowed URL in the field.
2. Click Add Allowed URL.
3. Optionally, use the Actions icons to edit or delete a listed URL.

Theme tab

The Theme tab contains information about making changes to the Responsive Material UI theme that determines application interface details. You can brand the interface and make InStore better match the fonts, buttons, icons, and colors in your store application. To modify the appearance of InStore, complete these actions:

1. In the Logo field, specify a file to display in the InStore interface that users will see. It is best to use files with a PNG or JPG extension and avoid BMP files.
2. In the Font Family field, select a font that is supported by the retailer's application.
3. Toggle the Header Visible on or off. Toggle it on to include a page title on components that are retrieved when needed by the retailer's mobile calling app or mobile or fixed clienteling app. To avoid duplicate headers, toggle this off if the retailer runs InStore as a federated component in a point-of-sale context.
4. In the Colors fields, select main and secondary colors for online display, expressed as industry-standard RGB hex color codes.
5. Click Save. The changes are visible the next time a user logs into InStore.