Infrastructure: Configuration Noun
The Configuration noun is used to model extensions to the store and other global configurations.
Here is the list of supported UniqueIDs:
- com.ibm.commerce.foundation.defaultLanguage
- com.ibm.commerce.foundation.supportedLanguages
- com.ibm.commerce.foundation.defaultCurrency
- com.ibm.commerce.foundation.supportedCurrencies
- com.ibm.commerce.foundation.fulfillmentCenter
- com.ibm.commerce.foundation.staticContent
- com.ibm.commerce.foundation.inventorySystem
- com.ibm.commerce.foundation.shippingMode
- com.ibm.commerce.foundation.analytics
- com.ibm.commerce.foundation.unitOfMeasure
- com.ibm.commerce.foundation.availableIdentifiers
- com.ibm.commerce.foundation.emailActivities
- com.ibm.commerce.foundation.paymentType
- com.ibm.commerce.foundation.country
- com.ibm.commerce.foundation.stateProvince
Each UniqueID returns the following information:
- UniqueID starting with prefix "com.ibm.commerce.foundation." [Number of ConfigurationAttribute entries]
ConfigurationValue (Name, Sample Values**)
- defaultLanguage [1]
(languageDescription*, French)
(languageId, -2)
(localeName, fr_FR)
(language, fr)
(country, FR)
(variant, )
(encoding, UTF-8)
(mimeCharSet, iso-8859-15)
- supportedLanguages [number of all supported languages with default language being the first one in the list]
(same as defaultLanguage, same as defaultLanguage)
- defaultCurrency [1]
(currencyDescription*, Euro)
(currencyCode, EUR)
- supportedCurrencies [number of all supported currencies with default currency being the first one in the list]
(same as defaultCurrency, same as defaultCurrency)
- fulfillmentCenter [number of all available fulfillment centers for this store with default fulfillment center being the first
one in the list]
(fulfillmentCenterName*, ConsumerDirect Home)
(fulfillmentCenterId, 10001)
(defaultShipOffset, 86400)
(dropShip, N)
(extFFMStoreNum, )
(inventoryOpFlag, 0)
(memberId, 7000000000000000002)
(maxNumPick, 25)
(pickDelayInMin, 5)
(shipArrangeId, 10001)
(shippingModeId, )
(startDate, 1970-06-22 23:00:00.0)
(endDate, 2008-06-22 23:00:00.0)
(trackingNumber, 0.0)
(precedence, )
(flags, 0)
(field1, )
(field2, )
- staticContent [1]
(urlPrefix*, http://localhost:80/wcsstore/ConsumerDirect/)
(secureURLPrefix, https://localhost:443/wcsstore/ConsumerDirect/)
(directory, ConsumerDirect)
(webServerHostName, localhost)
(webServerPort, 80)
(webServerSSLPort, 443)
(uriPrefix, /wcsstore/ConsumerDirect/)
(contextRoot, /wcsstore/)
(contextPath, /webapp/wcs/stores)
(urlMappingPath, /servlet)
(storeLevel, )
- inventorySystem [1]
(inventorySystem*, ATP)
- shippingMode [number of allowed shipping modes for this store with default shipping mode being the first one in the list]
(shippingModeDescription*, Express mail)
(shippngModeId, 10002)
(code, No Shipping)
(carrier, XYZ Carrier)
(field1, )
(field2, )
- analytics [1]
(provider*, coremetrics)
(isEnabled, true)
- unitOfMeasure [number of available units for the whole site]
(quantityUnitId*, 2U)
(quantityUnitDescription, megagram)
(field1, 0)
- emailActivities [1]
(isConfigured*, true)
(outboundTime, 16:35)
(outboundReplyTo, webmaster@examplestore.com)
- paymentType [number of payment types configured]
(name*, VISA)
(identifier, 1001)
(shortDescription, VISA credit card)
(longDescription, VISA credit card accepted world-wide)
- country [number of countries configured]
(countryAbbr*, US)
(name, United States)
- stateProvince [number of states and provinces configured]
(stateProvAbbr*, NY)
(name, New York)
- availableIdentifiers [number of available identifiers]
(com.ibm.commerce.foundation.availableIdentifiers*, store configuration: available identifier unquie Ids)
(com.ibm.commerce.foundation.supportedLanguages, store configuration: supported languages)
(com.ibm.commerce.foundation.defaultLanguage, store configuration: default language)
(com.ibm.commerce.foundation.supportedCurrencies, store configuration: supported currencies)
(com.ibm.commerce.foundation.defaultCurrency, store configuration: default currency)
(com.ibm.commerce.foundation.fulfillmentCenter, store configuration: fulfillment center)
(com.ibm.commerce.foundation.inventorySystem, store configuration: inventory system)
(com.ibm.commerce.foundation.shippingMode, store configuration: shipping mode)
(com.ibm.commerce.foundation.staticContent, store configuration: static content information)
(com.ibm.commerce.foundation.analytics, store configuration: analytics)
(com.ibm.commerce.foundation.unitOfMeasure, store configuration: unit of measure)
(com.ibm.commerce.foundation.emailActivities, store configuration: e-mail activities)
(com.ibm.commerce.foundation.paymentType, store configuration: payment type)
(com.ibm.commerce.foundation.country, store configuration: country)
(com.ibm.commerce.foundation.stateProvince, store configuration: state and province)
* The PrimaryValue of ConfigurationAttribute element.
** Sample Values are user language preference sensitive. Values being shown assumed English as the language preference.
BOD Summary
Access Profile and Expression Builder columns are for Get BOD only.
| BOD |
Action Code / Access Profile |
Action Expression |
Service Provided |
Sample XML Message |
Client Library / Expression Builder |
| GetConfiguration |
|
/Configuration[ConfigurationIdentifier[(UniqueID='$uniqueId$')]]
|
Find the configurations of supported languages, default languages, countries etc for the store in the current context.
|
Request
Response
|
InfrastructureFacadeClient.getConfiguration(String, String)
InfrastructureFacadeClient.findConfigurationById(String)
InfrastructureFacadeClient.getConfigurationValue(String, String)
InfrastructureFacadeClient.getConfigurationValues(String, String)
/ findByUniqueID
|
|
/Configuration
|
Find all configurations using all available UniqueIDs for the current store in context.
|
Request
Response
|
InfrastructureFacadeClient.getConfiguration(String, String)
/ findAll
|
Access Profile
Some sample XML request and response web service messages are provided for each noun.
These sample messages might not include all properties or attributes.
To view a sample message that includes other properties or attributes,
enable logging and tracing for the appropriate component and then call the web service to set or change the
properties or attributes. Review the corresponding log file to see the request or response information.
| Access Profile |
Data Returned |
XSD files