Configuring Templates

You can open the repository folder on your local machine to check the setup.

Warning:

A new folder named node_modules is created. You should never modify anything in the node_modules folder. This folder is not part of the repository. All the third-party dependencies get installed in this folder. Whenever you run an npm command, the dependencies are overridden in this folder.

Configuration Parameters

During the npm install phase, a configuration file named environment.ts is automatically created. This is a runtime configuration for the application. The environment.ts file contains runtime specific variables that help the application to operate. You must set it up with the following parameters:


Name	Type	Required	Default Value	Description
production	Boolean	Yes	-	Specify the environment where you want the application to run.
defaultImageSrc	String	Yes	-	Specify the URL of the default image to use when no image is found.
defaultCountry	String	No	US	The default country code is "US".
defaultLanguage	String	No	en-US	The default locale is "en-US".
defaultCurrency	String	No	USD	The default currency to use for guest users. Defaults to "USD".
productIdentifier	String	No	Id	The API name of the field on the product to use as the unique identifier in the application.
proxy	String	No	-	The login proxy to use to bypass CORS restrictions on login.
storefrontId	String	No	Null	Specify the ID of the storefront record.
storefrontName	String	No	Null	Specify the name of the storefront record.
hashRouting	Boolean	No	False	To support the hash URL path, set it to true.
endpoint	String	Yes	-	Specify the Conga Platform instance where your tenant is onboarded. For example: `https://test.congacloud.com`
authenticationEndpoint	String
loginEndpoint	String	Yes		It is the authentication endpoint for the Guest User functionality. For example: https://login-test.congacloud.com Note: This parameter is only required if you use the Guest User functionality.
userId	String	Yes		It is a string identifier that corresponds to the Guest User ID for the Guest User created on the Conga Platform. For more information on how to create a guest user, see Adding and Activating Users. Note: This parameter is only required if you use the Guest User functionality.
cartRetryLimit	number	No	5	Specify the number of retry attempts for fetching the active cart's status until pricing completes. Note: The application first considers the PricingCircuitMaxRetries value for fetching the active cart's status. For more information, see Configuring Cart Pricing Status Retry Settings.
cartRetryDelay	number	No	500	Specify the delay in milliseconds between each retry attempt until pricing completes. Note: The application first considers the PricingCircuitDelay value for delay in milliseconds between each retry attempt. For more information, see Configuring Cart Pricing Status Retry Settings.
captchaSiteKey?	String	No	-	reCAPTCHA keys represent how reCAPTCHA Enterprise is configured for a website. For more information on how to create keys, see Create reCAPTCHA keys.
translationModule	String	No	Null	Specify the translation module name. If you do not pass the module name, the application by default considers the local translation file. If you want to use the translation defined at the Conga Platform level, then pass the module name created on the Conga Platform. For more information on how to create module and translation and about local translation files, see Setting Up Multi-Language. Note: If you provide the module name on the Conga Platform but no translation data is available, the system will not show an error and will display the content in English. If a translation module is mentioned in environment.ts but does not exist, the system will show a "<translation module name> does not exist" error when trying to load it. You can use both nested and flat key formats. If you are using flat keys, do not try to access the whole group (like `stream('PAGINATION')`). Instead, access each item separately (like `stream('PAGINATION.FIRST')`). The translation feature supports multilingual static labels across the E-Commerce application. Labels automatically reflect the user's locale and configured language settings.
clientId	String	Yes	Null	This is used for OAuth handshake.
authority	String	Yes	Null	To redirect the UI app to the login screen for authentication and authorization.
assetActionLables	String	No	-	Set a custom label name (key and value pair) for the asset action(s). If you want to display your asset actions Renew and Amend as Custom_Renew and Custom_Amend, refer to the sample below. Here, the key (Renew and Amend) represents the asset action specified in your code. `assetActionLables: {` `'Renew':'Custom_Renew',` `'Amend':'Custom_Amend'` `}` Note: Ensure that the `configuration.model.ts` file has `assetActionLabels?: Object` entry to use the custom label for the asset feature. For more information on Asset-based ordering (ABO), see Managing Assets.

Note:

Both storefrontId and storefrontName parameters are optional. If both are provided, the application prioritizes storefrontId. If neither is specified, the default storefront (ecom for E-Commerce) is used, which is configured during storefront creation.
If you want to use the Storefront Name, make sure "StorefrontName" is queryable/indexable in Admin UI. For more information, see To create a new field for a custom/standard objectno.

Import App Module

CommerceModule.forRoot - In the forRoot method of the CommerceModule declare the storefront that you want to use. For example, CommerceModule.forRoot('Tier 1')

This defines the Storefront for your application.

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Configuring Templates

Configuration Parameters

Import App Module

Footer Section

Explore