A Quick Guide to B2B XCM Configuration
Applies to: SAP CRM Web Channel. For more information, visit the Customer Relationship Management homepage.
Summary This paper details and covers the usage of all components within the XCM configuration of the B2B application. While there is detailed help documentation available within each of the application components of the XCM there was no one-stop-shop guide that covered each of the areas. This document can be used as a reference when configuring a B2B application. Author:
Mark Foley
Company: SAP Created on: 7 August 2011
Author Bio Mark Foley is a Senior Support Consultant, working in AGS Business Suite and Technology for the last 8 years. His main area of focus for the last 5 years has been the SAP CRM Web Channel.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 1
A Quick Guide to B2B XCM Configuration
Table of Contents Extended Configuration Management (XCM) Administration ............................................................................. 6 XCM SETTINGS ................................................................................................................................................. 6 Upload Configuration Data from file System ................................................................................................... 6 Download Configuration Data to file System .................................................................................................. 6 General Application Settings .............................................................................................................................. 7 Application Security......................................................................................................................................... 7 theme.core.name.filter ................................................................................................................................................. 7 EnableXSRFProtection ................................................................................................................................................ 8 session auth switch ...................................................................................................................................................... 8 Session auth passwd ................................................................................................................................................... 9 oci.core.url.list: ............................................................................................................................................................. 9
B2B (Business to Business) ............................................................................................................................ 9 b2bconfig: .................................................................................................................................................................... 9 SSLEnabled ................................................................................................................................................................. 9 http.port.core ................................................................................................................................................................ 9 https.port.core ............................................................................................................................................................ 10 Jarm ........................................................................................................................................................................... 10 Sat (Single Activity Trace) .......................................................................................................................................... 11 Appinfo ....................................................................................................................................................................... 11 logfiledownload .......................................................................................................................................................... 11 show.start.jsp ............................................................................................................................................................. 11 overwriteConProps .................................................................................................................................................... 12 ccmsLogPropertyFilename ........................................................................................................................................ 12 reloginurl.core ............................................................................................................................................................ 12
General.......................................................................................................................................................... 13 Lwc (Live Web collaboration) ........................................................................................................................ 13 Securemode............................................................................................................................................................... 13 mail.smtp.host ............................................................................................................................................................ 13 mail.smtp.port ............................................................................................................................................................ 13 cic.mail.to ................................................................................................................................................................... 13 isa.cic.jms.hostid ........................................................................................................................................................ 13 isa.cic.jms.port ........................................................................................................................................................... 14 isa.cic.chatTopicName ............................................................................................................................................... 14 isa.cic.requestManagerName .................................................................................................................................... 14 isa.cic.topicConnectionFactoryName ......................................................................................................................... 14 isa.cic.queueConnectionFactoryName ...................................................................................................................... 14 java.naming.provider.url ............................................................................................................................................. 15 java.naming.factory.initial ........................................................................................................................................... 15 java.naming.security.principal .................................................................................................................................... 15 java.naming.security.credentials ................................................................................................................................ 15 Name: isa.cic.spice.enabled ...................................................................................................................................... 15
Personalization .............................................................................................................................................. 15 enable.pers.isa.sap.com ............................................................................................................................................ 16 persistence................................................................................................................................................................. 16
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 2
A Quick Guide to B2B XCM Configuration
jndijdo ........................................................................................................................................................................ 16 filesystemlocation....................................................................................................................................................... 16 javax.jdo.PersistenceManagerFactoryClass .............................................................................................................. 16 javax.jdo.option.ConnectionDriverName .................................................................................................................... 17 javax.jdo.option.ConnectionURL ................................................................................................................................ 17 javax.jdo.option.ConnectionUserName ...................................................................................................................... 17 javax.jdo.option.ConnectionPassword ....................................................................................................................... 17 com.sap.personalization.runtime.autoupdate.mode ................................................................................................... 17 com.sap.personalization.runtime.autoupdate.enable ................................................................................................. 17 com.sap.personalization.runtime.autoupdate.interval ................................................................................................ 17
WEC (Web Event Capture)............................................................................................................................... 18 enable.BEventCapturing ............................................................................................................................................ 18 capturer-handler......................................................................................................................................................... 18 type ............................................................................................................................................................................ 18 app 18 eventPoolSize ............................................................................................................................................................ 19 searchservice.tealeaf ................................................................................................................................................. 19 Name: configfile.tealeaf ............................................................................................................................................. 19 Name: tealeaf.logdir ................................................................................................................................................... 19 tealeaf.server ............................................................................................................................................................. 20 Name: tealeaf.port ..................................................................................................................................................... 20 Name: tealeaf.user..................................................................................................................................................... 20 Name: tealeaf.password ............................................................................................................................................ 20
Application Configurations ................................................................................................................................ 21 SAP 21 Components ..................................................................................................................................................... 22 SAP Components.......................................................................................................................................... 23 Basket ........................................................................................................................................................... 23 Crmbasket.................................................................................................................................................................. 23 javabasket .................................................................................................................................................................. 23 usedatabaseBasket ................................................................................................................................................... 23 usedatabaseTemplate ............................................................................................................................................... 23 forceIPCPricing .......................................................................................................................................................... 23 preventIPCPricing ...................................................................................................................................................... 24 lineItemIncrement ...................................................................................................................................................... 24 freeGoodsEnable ....................................................................................................................................................... 24 freeGoodsShowWarningMessage ............................................................................................................................. 24
IMS(catalog engine, TREX) .......................................................................................................................... 25 useDynConnParams .................................................................................................................................................. 25 allowAdministeredProd .............................................................................................................................................. 25 enableFuzzySearch ................................................................................................................................................... 26 fuzzySimilarity ............................................................................................................................................................ 26 type ............................................................................................................................................................................ 26 gwhost ....................................................................................................................................................................... 27 gwserv ....................................................................................................................................................................... 27 tphost ......................................................................................................................................................................... 27
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 3
A Quick Guide to B2B XCM Configuration
tpname ....................................................................................................................................................................... 27
ipc
27
type ............................................................................................................................................................................ 27 scenario.basket .......................................................................................................................................................... 27 scenario.cat................................................................................................................................................................ 27
jco
28
Group connect ........................................................................................................................................................... 28 Server connect ........................................................................................................................................................... 28 Secure_group_connect .............................................................................................................................................. 28 Secure_server_connect ............................................................................................................................................. 28 Client .......................................................................................................................................................................... 28 lang ............................................................................................................................................................................ 28 group; ......................................................................................................................................................................... 28 r3name ....................................................................................................................................................................... 29 Mshost ....................................................................................................................................................................... 29 User ........................................................................................................................................................................... 29 Passwd ...................................................................................................................................................................... 29 Maxcon ...................................................................................................................................................................... 29
oci
29
Ocidefault ................................................................................................................................................................... 30 Ocicrmstandard.......................................................................................................................................................... 30 Ocir3standard ............................................................................................................................................................ 30 ociCatalogURL ........................................................................................................................................................... 30 ociTarget .................................................................................................................................................................... 30 ociVersion .................................................................................................................................................................. 30 ociForm ...................................................................................................................................................................... 30 ociEnable ................................................................................................................................................................... 30 ociReadAllProductData .............................................................................................................................................. 30 ociAllProductsInMaterialMaster.................................................................................................................................. 31
scenario_security .......................................................................................................................................... 31 Session auth switch ................................................................................................................................................... 31 session auth user ....................................................................................................................................................... 31 Session auth passwd ................................................................................................................................................. 31 isXsrfPortalScenario .................................................................................................................................................. 32
shop 32 shopscenario.............................................................................................................................................................. 33 documentsearch.name .............................................................................................................................................. 33 portal.enable.claiming.from.invoice ............................................................................................................................ 33 defaultShopId ............................................................................................................................................................. 33
UI (User Interface)........................................................................................................................................ 33 language .................................................................................................................................................................... 34 styledirection.core ...................................................................................................................................................... 34 enable.priceAnalysis .................................................................................................................................................. 34 configOnlineEvaluate ................................................................................................................................................. 35 configinfo.catalog.view ............................................................................................................................................... 35 exact.search.isacore .................................................................................................................................................. 35 maxhits.search.isacore .............................................................................................................................................. 35
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 4
A Quick Guide to B2B XCM Configuration
Catalog.ListView.MaxItems ........................................................................................................................................ 35 enablerelogincookie.core ........................................................................................................................................... 36 enable.nonCatalogProducts ....................................................................................................................................... 36 showstacktrace.isacore .............................................................................................................................................. 36 showmodulename.core .............................................................................................................................................. 37 showjspdebugmsg.core ............................................................................................................................................. 37 maxhits.search.action.businesspartner ...................................................................................................................... 37 theme.core ................................................................................................................................................................. 37 mimes.core ................................................................................................................................................................ 38 mimes.js.core ............................................................................................................................................................. 38 enable.orderdownload ............................................................................................................................................... 38 enable.pers ................................................................................................................................................................ 38 enable.userSettingsForGrid ....................................................................................................................................... 38 maxhits.search.store.locator ...................................................................................................................................... 39 maxhitsPerPage.search.store.locator ........................................................................................................................ 39 configinfo.order.view .................................................................................................................................................. 39 configinfo.orderdetail.view.......................................................................................................................................... 39 initial.newpos ............................................................................................................................................................. 39 ume.logon.schema..................................................................................................................................................... 40 Context.encodeContext ............................................................................................................................................. 40 ui.fields.order.deliveryPriority ..................................................................................................................................... 40 ui.fields.order.item.deliveryPriority ............................................................................................................................. 41 ui.fields.order.shippingCondition ................................................................................................................................ 41 ui.fields.order.bomExplosion ...................................................................................................................................... 41 ui.fields.order.subitemDetailView ............................................................................................................................... 41
user 42 enabled ...................................................................................................................................................................... 42
webcatalog .................................................................................................................................................... 42 Webcatdefault ............................................................................................................................................................ 42 imageserver ............................................................................................................................................................... 42 preventIPCPricing ...................................................................................................................................................... 42 maxSearchHits........................................................................................................................................................... 42 catalogstatus .............................................................................................................................................................. 43 priceDecimalPlace ..................................................................................................................................................... 43
Related Content ................................................................................................................................................ 44 Copyright........................................................................................................................................................... 45
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 5
A Quick Guide to B2B XCM Configuration
Extended Configuration Management (XCM) Administration You use the Extended Configuration Management (XCM) Administration tool to configure Web applications, once you have installed the Web components. You use it to make configuration settings needed at runtime for your chosen application. In this document the XCM components for a B2B application are explained. It should be noted that there is also an XCM configuration for the B2B, Shopadmin and Useradmin application Starting XCM 1.
You access the XCM tool at: http://://admin/xcm/init.do
2.
Provide a user and password. If you are logging on for the first time use the Administrator user.
For further information on the XCM please see help.sap.com.
XCM SETTINGS The XCM settings are general application settings that allow the import and export of the XCM configuration to and from another deployment. It would be advised to only import and export to another deployment that is on the same release level as there maybe changes in the database tables between release levels. There are two options available. Upload Configuration Data from file System The Upload Configuration option allows you to upload a XCM configuration to your database, this configuration could have been exported from another system.
Download Configuration Data to file System The Download Configuration Data to file system option allows you to download the XCM configuration to an XML file. There are two options available 1. Component configuration data
2. Application configuration data
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 6
A Quick Guide to B2B XCM Configuration
General Application Settings The General application Settings are available for the whole application. These will apply to all B2B applications and all XCM configurations that are created. Application Security The Application Security component has an XCM configuration called application_security_config which includes general configuration that is valid for all B2B application. This will mostly cover security aspects of the application and care should be taken with changes to this configuration.
theme.core.name.filter This filter is a regular expression that will be used to validate the theme name. Not allowed characters will be removed from the name. The filter is required to secure the application against cross side scripting at the theme parameter level. Therefore the following characters are initially allowed:
A-Z a-z space minus (-) plus (+) underscore (_) backslash (\) slash (/) point (.) comma (,)
Care should be taken when changing this value as this could cause security vulnerability. The theme is used to completely resolve the location of a Web resource (such as a script, or image). The location is an URL interpreted by the used browser. Not all browsers understand NON-ASCII characters like German characters such as Ö, Ä etc.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 7
A Quick Guide to B2B XCM Configuration
EnableXSRFProtection The enableXSRFProtection allows you to turn on/off XSSRF protection for the application. Cross-Site Request Forgery (CXRF/XSRF) is an attack that tricks a victim's browser to send a request to a vulnerable Web application, which then performs an undesired action on behalf of the victim.
To activate XSRF protection you also need to set J2EE engines flag xsrf.protection.enabled to true. session auth switch UME (User Management Engine) User for session authentication. Please note this setting is only used with non UME user types. The session auth user is used to authenticate the http(s) session on the application server. The session will run under the entered user after a successful login in the web shop. This user should not have any roles, because he does not need any. No actions on the J2EE will be taken with this user. It is only used to authenticate the session and let the application server secure it. This is the entry checked first; if no user has been maintained then application_security component of the application is used. So the logic is: 1. Check if a user is available in the scenario_security_data section of your configured XCM scenario. To find this login to the XCM and go to: a) Application Configuration b) SAP c) Customer (and select your Application Configuration
d) If no user is maintained then go to step 2. 2. Check if a user is available in the application_security component. To find this login to the XCM and go to a) General Application Setting b) Customer c) Application _Security_Config d) If no user is maintained then go to step 3.
3. Skip the authentication of the session with the user
4. Authenticate the session with the user from the XCM components
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 8
A Quick Guide to B2B XCM Configuration
Session auth passwd This setting is only used with non UME user types. This sets the password for the session auth user. See long text of the session auth user entry for more information about the user. The password itself will be encrypted and stored in XCM.
oci.core.url.list: Theses entries are a list of possible Call-Back URLs that will be used to validate the HOOK_URL. This will only be used in the case that B2B application is running as external catalog for an EBP system. The list is required to secure the applications that use the B2B shop as external catalog. Insert here a comma separated String of possible Call-Back URLs (e.g. http://server1-name:port, http://server2-name:port) which use the shop as external catalog. B2B (Business to Business) These are the parameters specific to the b2b application with the following component. b2bconfig: SSLEnabled Switch to SSL before Login will be performed Because of security reasons it is recommended to use SSL connections within the running application to protect sensitive data like password or credit card numbers. This parameter enables switch to a secure connection before login procedure will be performed for example.
True = The switch to SSL will be done False= the whole application runs without SSL (This would not be advised)
http.port.core This port is needed when the application switches from HTTPS to HTTP. Note: If you have the following infrastructure: Web Browser => HTTPS => Web Server => HTTP => J2EE Engine, specify the additional request parameter 'secure=true' when starting the application. e.g. https://host:port/b2b/b2b/init.do?secure=true. For example
In this case the HTTP port used by the B2B application would be 50000
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 9
A Quick Guide to B2B XCM Configuration
https.port.core This port is needed when the application switches from HTTP to HTTPS. Note: If you have the following infrastructure: Web Browser => HTTPS => Web Server => HTTP => J2EE Engine, specify the additional request parameter 'secure=true' when starting the application. e.g. https://host:port/b2b/b2b/init.do?secure=true. For example
In this case the HTTPS port used by the B2B application would be 500001 If you enter the text value "$AUTO" instead of a port number, the https port number will be calculated by adding 1 to the http port given by the request URL from the browser.
This is the standard for the Web AS Java Server. E.g. if the http port is 50000, the calculated https port will be 50001
Jarm Turns Java Application Response time Measurement (JARM) on/off JARM is a monitoring feature. It enables you to collect data about the runtime behavior of this web application. The runtime overhead of JARM is relatively small. It is therefore possible to turn JARM on for measurement of application behavior under heavy load. Nevertheless, it is not recommended to turn JARM on in production systems.
True = JARM is turned on False= JARM is turned off
When JARM is turned on, the following data is collected. => Request: duration of each HTTP request and duration of components called within the request. The following is considered as a component within a request: => Each Struts action => Each call using remote function call (RFC) => Each call to the IPC The results of the measurement can be viewed using the JARM viewer. The JARM viewer is part of the SAP J2EE Visual Administrator. See 'Performance Tracing' service of the J2EE Server. The JARM viewer enables you to see the gross and net time of the execution time of the various requests and components. It is very useful to find it which components consume how much execution time and how often it is called. In order to distinguish requests for different HTTP sessions, the application uses the HTTP session id as the user name when reporting data to the JARM service. It is therefore possible to filter data collected by JARM in the JARM viewer using the session id.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 10
A Quick Guide to B2B XCM Configuration
Sat (Single Activity Trace) Turns Java Single Activity Trace (SAT) on/off Single Activity Trace enables you to follow the actions triggered by a single request for services in the component writing the trace (usually this web application). It is intended to show which actions take up what amount of time. The Single Activity Trace of a component can be viewed with the Central Log Viewer by opening the trace file sat.trc. For further information refer to the Operations Guide
True = SAT is turned on False = SAT is turned off Note: The previously used switch 'sat' in the context parameter 'adminconfig.core.isa.sap.com' is no longer used Appinfo The appinfo parameter turns application info feature on/off. This feature is started by passing an additional request parameter appinfo=true when starting the application. e.g. b2b/b2b/init.do?appinfo=true. An additional page opens providing system information. Session trace is turned on and it is possible to download the session trace file using a web browser.
True = appinfo is turned on False = appinfo is turned off It is important to note that this feature MUST be turned off in a production system. This should only be used in test and development systems.
logfiledownload This is an important feature when it comes to resolving problems in your B2B application. When logging a customer message with SAP it will be required to provide an application session log. The downloading of session traces supported from 5.2 SP03 and CRM2007 SP01 Log files can be accessed from the admin area or by using the SAP WebAs Java Log Viewer. Please refer to the NetWeaver documentation on further information about the Log Viewer. On information on how to perform a single session trace please refer to the E-Commerce Development and Extension Guide.
Allowed Values Detail Name Description True= logfile download turned on False= logfile download turned off
show.start.jsp The Startup Page contains links to all XCM Application Configurations. This is especially useful on a test system where developer and tester can easily see all available application configurations and select the appropriate one. For a productive system this page might give an intruder more information about the infrastructure than necessary. It is therefore recommended to turn this start page off. See CRM Security Guide for further information. Allowed Values Detail Name Description
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 11
A Quick Guide to B2B XCM Configuration
True The Startup Page shows up False Instead of the Startup Page an error page is shown When this is enables on accessing the URL https://host:port/b2b/ you will receive an option to select the XCM configuration that you wish to access as below.
overwriteConProps Allow to pass the connection parameters from outside Because of security reasons it is recommended to read the connection parameters from XCM. This parameter enables to overwrite the JCO connection parameters server and sys-number.
Allowed Values Detail Name Description True = the connection parameters are read from request False = the connection parameters are read from XCM
ccmsLogPropertyFilename File name of the template of the CCMS logfile monitoring property file This template is used to create a property file for CCMS logfile monitoring during initialization of the application
reloginurl.core The reloginurl.core parameter sets the URL for a login to the application after the session is lost .See also enablerelogincookie.core. The URL is used, if the enablerelogincookie.core parameter is set to 'false' or if the cookie could not be found (User disabled cookies etc.).
When this parameter is set to the start.jsp and the B2B session has been lost. The reloginurl.core parameter will direct you back to the start.jsp page. It is possible to set this to any URL E.g. a homepage
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 12
A Quick Guide to B2B XCM Configuration
General The general configuration is now obsolete and no configuration of this area is required. Lwc (Live Web collaboration) The Lwc component refers to the configuration required for the Live Web Collaboration functionality. Further information on this functionality can be found at help.sap.com The configuration of this component is fairly complex and required configuration from both CIC and ICM components. The details configuration of this component can be found in the help section of the XCM.
Securemode Enables or disables security related features when set to true, LWC features related to security will be disabled. ActiveX controls and document push are the features which pose threat to security. By default, securemode is set to true. Allowed Values Detail Name Description
True = securemode is turned on
False = securemode is turned off mail.smtp.host This is where the SMTP mail server address will be set. For example
mail.smtp.port This is where the port on which SMTP server is running. Default port is set to 25 in standard.
cic.mail.to The Address to which the e-Mail should be sent delivered to. When the customer sends an email, the email is sent to this address. The agent has access to this mail account, and can answer customer queries. This should be in line with your business scenario and usually to the IC agent inbox.
isa.cic.jms.hostid Third party JMS server address, if different from the JMS shipped with SAP J2EE. JMS is java message service, used to exchange messages and requests (e.g. chat) between customer and agent applications of LWC. If you use SAP JMS implementation which comes with SAPJ2EE, then you can
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 13
A Quick Guide to B2B XCM Configuration
ignore this parameter. Specify the third party JMS server address, if you would like to use external JMS implementation. For this example we have used the localhost.
isa.cic.jms.port Third-party JMS server's port number. For more details please see isa.cic.jms.hostid For example in this case we have configured the port 4010.
isa.cic.requestQueueName JMS queue which maintains service requests For example jmsqueues/default/requestQueue.
isa.cic.chatTopicName For example mstopics/default/chatTopic
isa.cic.requestManagerName JNDI Name (SAP J2EE Engine Naming System) for the RequestManager that keeps information about the requests infrastructure
isa.cic.topicConnectionFactoryName JNDI Name for topic connection factory
isa.cic.queueConnectionFactoryName JNDI Name for queue connection factory
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 14
A Quick Guide to B2B XCM Configuration
java.naming.provider.url JNDI server address on which JMS is registered. Use localhost to use SAP J2EE implementation of JNDI. JNDI is used to access the JMS service. Simplest and the easiest scenario would be to use the JMS on the local J2EE. Values: localhost - for JMS registered on the local JNDI. Otherwise mention, IP address or the host name
java.naming.factory.initial Context factory of JNDI implementation
java.naming.security.principal For JMS on the same server, use the container authentication by leaving it blank User ID to connect to the JNDI server. Leave it blank for local JNDI. Provide the user id, if you are trying to connect to a remote JNDI. Also look at the parameter java.naming.security.credentials
java.naming.security.credentials For JMS on the same server, use the container authentcation by leaving it blank Password to connect to the JNDI server. Leave it blank for local JNDI. Provide the password id only if you are trying to connect to a remote JNDI. Also look at the parameter java.naming.security.principal.
Name: isa.cic.spice.enabled Enables the scenario of LWC with the IC Web Client when set to Yes In the LWC IC Web Client integrated scenario, the agent side is completely managed by the IC Web Client over the Integrated Communications Interface
Personalization Name: application.pers.isa.sap.com This parameter specifies the name of the application that the web-application is supposed to initialize. This application must be present in the database specified by the parameters for the database.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 15
A Quick Guide to B2B XCM Configuration
enable.pers.isa.sap.com Use this to enable initialization of the personalization component. To enable personalization for a scenario, please set the enable.pers parameter in the UI section to true. Allowed Values Detail Name Description
True = Personalization initialization is enabled
False = Personalization initialization is disabled
persistence The type of persistence that the personalization component is to use - database or file system. Allowed Values Detail Name Description
Database = Use the database for persistence. This requires DB parameters.
Filesystem = Use the file system for persistence. This requires a root directory that is accessible.
jndijdo This parameter specifies the JNDI name for JDO initialization. For example, a value is: jdo/defaultPMF. This needs to be configured in the J2EE Engine for correct persistence. Leave this blank for stand-alone persistence.
filesystemlocation The location of the data if persistence is filesystem This parameter specifies the root directory in which the persistence data is stored.
javax.jdo.PersistenceManagerFactoryClass This parameter specifies the persistence manager factory class and is used only in the case of stand-alone persistence when the JNDI name is blank. The default is: com.sap.jdo.sql.SQLPMF
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 16
A Quick Guide to B2B XCM Configuration
javax.jdo.option.ConnectionDriverName This parameter specifies the JDBC driver for stand-alone persistence. By default, this is: com.sap.sql.jdbc.common.CommonDriver for OpenSQL.
javax.jdo.option.ConnectionURL This parameter specifies the JDBC URL for stand-alone persistence.
javax.jdo.option.ConnectionUserName This parameter specifies the JDBC Database user name for stand-alone persistence.
javax.jdo.option.ConnectionPassword This parameter specifies the JDBC Database password for stand-alone persistence.
com.sap.personalization.runtime.autoupdate.mode This parameter specifies how auto-update should work. Allowed = Values Detail Name Description updatenew = Updates only the new sessions updateall Updates all sessions, including existing ones.
com.sap.personalization.runtime.autoupdate.enable This parameter specifies if auto-update is to be enabled.
Allowed Values Detail Name Description True= Do auto-updates False= Don't do auto-updates.
com.sap.personalization.runtime.autoupdate.interval This parameter specifies the interval, in minutes at which the auto-update thread runs. In case there is an error in specifying this parameter the time is defaulted to 60 minutes.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 17
A Quick Guide to B2B XCM Configuration
WEC (Web Event Capture) The Web Event Capture and Web Analysis Guide contain all the installation and configuration steps that are required to setup Web Event Capture in SAP E-Commerce and Web Analysis in SAP Business Information Warehouse (BW). Web Event Capture in SAP E-Commerce can be done by either using the DB Capturer (standard setting) or by using the third-party tool Tealeaf RealiTea. Data captured by either mode can then be uploaded to SAP BW for further analysis. For more information about Tealeaf RealiTea, see SAP Notes 1092365 (for SAP CRM 4.0) and 1026636 (for SAP CRM 5.0). Please also see help.sap.com enable.BEventCapturing Enable business event capturing in SAP WebChannel. Values: true or false
capturer-handler The Web event capturer handler.
Provide java class file that implements event capturing There are 3 SAP Delivered capturers: 1. Database based capturer(default) com.sap.isa.core.businessobject.event.capturer.db.BusinessEventDBCapturer 2. Tealeaf Capturer com.sap.isa.core.businessobject.event.capturer.tealeaf.BusinessEventTealeafCapturer 3. Flat file based capturer com.sap.isa.core.businessobject.event.capturer.file.BusinessEventFileCapturer
type The type of capturer. E.g. SAPJ2EE Indicates the type of capturer used to capture web event. E.g.: SAPJ2EE or APACHE
app Name of the web application for which Web event capturing is enabled. E.g.: SAP Internet Sales
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 18
A Quick Guide to B2B XCM Configuration
eventPoolSize Event pool collects the events. Event pool will be persisted when the number of events reaches the limit specified by this parameter. Note that the events will also be committed irrespective of the pool size when one of the two events LOGIN and PLACEORDER occurs due to their priority. This parameter will be used only when the capturer-handler is set to com.sap.isa.core.businessobject.event.capturer.db.BusinessEventDBCapturer
searchservice.tealeaf Search server URL. E.g. http://tealeafserver:19000/Session.tlc Tealeaf Search server URL, useful only for replaying captured customer sessions. This functionality is only for LiveWebCollaboration (LWC).
Name: configfile.tealeaf Tealeaf configuration files (TeaLeafJ2ee.xm) location. UNC path corresponding to TealeafJ2ee.xml file location. E.g.:\\server\share\TeaLeafJ2ee.xml or c:\tealeaf\TeaLeafJ2ee.xml NOTE This parameter should be maintained only when you would like to do advanced configuration in TeaLeafJ2EE.xml. Otherwise maintain the parameters tealeaf.server, tealeaf.port, tealeaf.user, tealeaf.password and tealeaf.logdir . System will generate the configuration file and use it to connect to Tealeaf. This parameter will be used only when the capturer-handler is set to com.sap.isa.core.businessobject.event.capturer.tealeaf.BusinessEventTealeafCapturer A sample TeaLeafJ2EE.xml is delivered with this application. It can be found in WEB-INF\cfg folder
Name: tealeaf.logdir Tealeaf log directory Specify the directory where the tealeaf logs are to be stored. NOTE: This parameter will be ignored, if a value is specified for the parameter configfile.tealeaf This parameter will be used only when the capturer-handler is set to com.sap.isa.core.businessobject.event.capturer.tealeaf.BusinessEventTealeafCapturer
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 19
A Quick Guide to B2B XCM Configuration
tealeaf.server Tealeaf Server host name or IP address. Default: localhost NOTE: This parameter will be ignored, if a value is specified for the parameter configfile.tealeaf This parameter will be used only when the capturer-handler is set to com.sap.isa.core.businessobject.event.capturer.tealeaf.BusinessEventTealeafCapturer
Name: tealeaf.port Tealeaf server socket port number. The default port is set to: 1966 NOTE: This parameter will be ignored, if a value is specified for the parameter configfile.tealeaf This parameter will be used only when the capturer-handler is set to com.sap.isa.core.businessobject.event.capturer.tealeaf.BusinessEventTealeafCapturer
Name: tealeaf.user Tealeaf user ID to be used to connect NOTE: This parameter will be ignored, if a value is specified for the parameter configfile.tealeaf This parameter will be used only when the capturer-handler is set to com.sap.isa.core.businessobject.event.capturer.tealeaf.BusinessEventTealeafCapturer
Name: tealeaf.password The password to connect to the tealeaf server. NOTE This parameter will be ignored, if a value is specified for the parameter configfile.tealeaf This parameter will be used only when the capturer-handler is set to com.sap.isa.core.businessobject.event.capturer.tealeaf.BusinessEventTealeafCapturer
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 20
A Quick Guide to B2B XCM Configuration
Application Configurations This will be the most used area of the XCM. Here you define the customizing and configuration of your B2B application. This is similar to transaction SPRO in CRM where the behavior of the B2B application can be tweaked and changed. Each application provides one or more pre-defined configurations. Pre-defined configurations can be found in the Application Configuration - SAP folder. By clicking on this you can access the description and default configuration. From there you create new configuration based on one of the configurations provided. Your new configuration will be placed in the Application Configuration – Customer folder. SAP SAP delivers Pre-defined configurations for customer. These configurations are based on specific business scenarios and can be customized according to customer needed. The main standard configurations are b2bWithUME
This is the standard delivers configuration that should be used when the B2B with UME(User Management Engine) is been used.
b2bcrmstandard
This is the Standard configuration that can be used when configuring B2B with CRM
erpcrmstandard
This is the Standard configuration that can be used when configuring B2B with and ERP system
homcrmstandard
This is the Standard configuration that is used when using the HOME scenario. This is Hosted Order Management scenario.
mcmstandard
This is the standard scenario when using mcm configuration with Plug-In 2003.1 and memory catalog implementation
ocicrmstandard
B2B configuration with CRM as backend system and external catalog support
oobcrmstandard
Order-on-behalf configuration
r3gridstandardpi
AFS (Apparel Footwear Solution) ERP 2005 standard configuration with memory catalog implementation.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 21
A Quick Guide to B2B XCM Configuration
r3gridstdpitrex
AFS ERP standard configuration and TREX catalog implementation
r3ocistandardpi
ERP standard configuration for external catalog support
r3standardpi
ERP standard configuration with memory catalog implementation r3standardpitrex
r3standardpitrex
ERP standard configuration with plug in 2003.1 and TREX catalog implementation
Components Components are parts of the application which can be configured independently. Each component has one or more pre-defined configurations which are delivered with the application. These configurations can be found in Components - SAP. In most cases you have to create your own component configurations based on the SAP component configurations. You do this in Components - Customer. Click on the component you want to configure and create your own configuration. Some components provide a configuration-test which helps to test your configuration. You should always use the test if it is available. You would like to create your own configuration for the 'jco' component. The 'jco' component is used to configure connection parameters to the SAP system. This component has pre-defined default configurations, however, without any connection parameters (e.g. user, password). You have to define your own 'jco' component configuration based on the configuration delivered and provide it with the connection parameters of your SAP system. You have also to provide a name for the configuration (e.g. Q31_700_TestSystem). The 'jco' component provides a 'ping' test which checks if it is possible to reach the SAP system. After creating the new component configuration and testing whether it is valid you can assign this particular component configuration to your web application configuration. 1. 2. 3. 4.
5. 6. 7. 8. 9.
Click on the 'jco' component in Start - Components - Customer - jco Click on the 'Edit' button to turn on the edit mode Enter the name of your configuration and press the create button Select the base configuration from the dropdown list box. e.g. group_connect (you get a description of the base configuration by choosing the '?'-Button or by pressing 'Component documentation' button) Provide the connection parameters to the SAP system Save your configuration by clicking on the 'Save Configuration' button Test your configuration by clicking the 'run test' button Switch back to display mode by clicking on the 'Display' button. Assign this component configuration to a web application configuration of your choice
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 22
A Quick Guide to B2B XCM Configuration
SAP Components This is the SAP standard delivers components that can be used to configure you XCM scenarios. Basket The Basket type controls that basket type that will be used in your application. It will control where data is stored and how the basket in the web shop will behave. There are two basket types available. Crmbasket Baskets are managed by CRM one order functionality in this case no further configuration is used. javabasket This sets the configuration for the Java-based basket management. Basket data is stored in the J2EE database.
usedatabaseBasket Defines whether a database should be used to store basket data. This is necessary for automated basket recovery. It is used for baskets, created via the DAOFactory backend.
Allowed Values Detail Name Description True= Basket recovery turned on. False= Basket recovery won't be possible.
usedatabaseTemplate Defines whether templates can be persisted on the database. This parameter determines if templates can be stored in the database. It is used for templates, created via the DAOFactory backend.
Allowed Values Detail Name Description True= Templates can be stored in the database. False= Templates cannot be stored in the database. Please make sure the shop property 'Order Templates Allowed' is disabled for all related shops in the shop management.
forceIPCPricing Defines whether IPC pricing should be used or not in the basket. This is an important area of consideration when deciding on how pricing will work in the web shop.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 23
A Quick Guide to B2B XCM Configuration
True= Prices are calculated by a dedicated IPC call. false The basket retrieves prices from the catalog
preventIPCPricing Defines whether IPC pricing should be prevented or not.
Allowed Values Detail Name Description True= the basket retrieves prices from the catalog. This flag should be set to true if only list prices should be used. It will prevent calling the IPC for pricing procedure and instead uses the list prices from the catalog to save performance. But the flag will only show any affect, when 'forceIPCPricing' is set to false! In case both flags are set to true 'preventIPCPricing' is disregarded. False= Prices are calculated according to the settings of forceIPCPrising.
lineItemIncrement The increment of the line items in the java basket by default is 10, any integer value can be assigned..
freeGoodsEnable Defines whether free good support is enabled or not. This setting is only relevant for the free good display in the java basket. Allowed Values Detail Name Description
True= the basket calls IPC for free good determination. The setting is taken into account only if ISA runs with CRM backend. For ISA R/3, free good determination is not supported in the basket. False= Free good determination is not performed in basket.
freeGoodsShowWarningMessage Defines whether free good related warning messages are displayed. This setting is only relevant for the free good display in the java basket. If it is set to 'true', a message indicating that an item's quantity is not sufficient will be displayed. Allowed Values Detail Name Description
True= When the item's quantity is not sufficient for getting a free good, a warning message is displayed. False= No warning message is displayed when the item's quantity is not sufficient
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 24
A Quick Guide to B2B XCM Configuration
IMS(catalog engine, TREX) The IMS configuration configures connectivity to the IMS Server (catalog engine). The Index Management Service(IMS)is used in the CRM-based Internet Sales scenarios for full-text searches in the CRM product catalog. The IMS is accessed by the Internet Sales web application via RFC connection. The "ims" component is used to configure the connection parameters of the RFC connection to the IMS server. The values of the RFC destination to the IMS server are normally retrieved automatically from the underlying backend CRM system (if value of parameter "useDynConnParams" is "true"). When choosing this setting, you do not have to specify any other parameter for this component. The other possibility is to specify the RFC destination information manually in the XCM tool(if value of parameter "useDynConnParams" is "false"). When choosing this setting, you have to specify the correct RFC connection parameters (gwhost, gwserv, tphost, and tpname) to the IMS server. You can manually specify the connection parameters where different IMS servers (on different machnines) serve the same indexes. Different web applications on one web server, or web applications on different web servers, are therefore able to access different IMS servers; thus implementing web load balancing or high availability. The distribution and update management of the indexes between such different IMS servers has to be performed by other mechanisms (Internet Sales does not provide support for this). useDynConnParams If this value is set to 'true', the logon parameters to access the IMS server are retrieved automatically from the CRM system. If the value is set to 'false', the RFC destination has to be manually defined.
Allowed Values Detail Name Description True= automatically retrieve RFC connection parameters for access to the IMS server The values of the RFC destination to the IMS server are automatically retrieved from the underlying backend CRM system. You do not have to specify any other parameter in this component. False= manually define the RFC connection parameters for access to the IMS server The values of the RFC destination to the IMS server have to be specified manually. The first three parameters denote the specification of the gateway destination. The parameter "type" must always be "E". The parameter "gwhost" must be the hostname where on which the gateway is running(normally this is the IMS server hostname). The parameter "gwserv" must be the service name on which the gateway is listening(normally this is 'sapgw47'). There are two possible RFC connection mechanisms to the IMS server: either the started-on-demand, or the registered RFC server. In the case of the started-on-demand RFC server: the parameter "tphost" must be the hostname where the IMS server is starting, and the parameter "tpname" must be the executable name of the IMS server (normally 'ims_server_admin.exe'). In the case of the registered RFC server: the parameter "tphost" must be left empty, and the parameter "tpname" must be the name which the IMS server has registered at the gateway (normally 'HOSTNAME'.rfc_sapretrieval' where 'HOSTNAME' is the hostname of the IMS server). allowAdministeredProd Here you can configure whether or not administered products can be maintained in catalog. Allowed Values Detail Name Description True= allow administered products functionality in catalog
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 25
A Quick Guide to B2B XCM Configuration
When this value is set to true, the field TEXT_0003 in the CRM catalog should be used to store search terms that will apply to the administered products. In this case this field in CRM Catalog cannot be used for any other purpose. Thus this field cannot be used for maintaining the subheading for the product in the catalog. False= do not allow administered products feature in product catalog. When this value is set to false, the field TEXT_0003 in the CRM catalog serves its normal purpose as a subheading. enableFuzzySearch Turn on Fuzzy Search for products in the web catalog.
Allowed Values Detail Name Description True= enable Fuzzy search on the search engine. Fuzzy Search only works if the search engine is TREX. Hence this value should be set to true only in this case. False= disable Fuzzy search on the search engine. Default search (exact) is enable on the search engine when this value is set to false.
fuzzySimilarity Degree of similarity required between a document and the search query for the document to be returned in the result set of a fuzzy search.
Allowed value is between 0 and 1. The higher the value, the less fault-tolerant the search is regarding typing errors in the search term (for example, "Protal" for "Portal"). fuzzySimilarity = 1 means no fault tolerance (exact search). By default fuzzySimilarity is set to 0.6 type Must always be 'E'
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 26
A Quick Guide to B2B XCM Configuration
gwhost Gateway-Host of the IMS server You only need this parameter when connecting to the IMS server via a manually defined RFC (Remote Function Call) destination. For recommended values refer to the long text description of parameter "useDynConnParams". gwserv Gateway-Service of the IMS server This parameter is only needed when connecting to IMS server via a statically defined RFC destination. For recommended values refer to the long text description of parameter "useDynConnParams". tphost Hostname of the IMS server This parameter is only needed when connecting to IMS server via a statically defined RFC destination. For recommended values please see the long text description of the parameter "useDynConnParams". tpname Program name of the IMS server You only need this parameter when connecting to the IMS server via a manually defined RFC destination. For recommended values please see the long text description of the parameter "useDynConnParams".
ipc The IPC component configuration controls the connection parameters to the IPC Server type
This is the IPC server type. The type is usually set to ISA and not changed.
scenario.basket The IPC has its own set of XCM configuration files. This parameter specifies the configuration for these configuration files, if called from the shopping basket.
scenario.cat The IPC has its own set of XCM configuration files. This parameter specifies the configuration for these configuration files, if called from the catalog.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 27
A Quick Guide to B2B XCM Configuration
jco The jco parameter configures connection parameters need to connect to the SAP system. This configuration is used by the SAP Java Connector (JFRC) for communication with the SAP system. This communication is based on the Remote Function Call (RFC) protocol. You can connect to an SAP system application server directly (direct connect) or using load balancing via a Message
Group connect Used for connection to SAP system with Message Server (Load balancing).
Server connect Used for direct connection to SAP Server (direct connect)
Secure_group_connect Used for connection to SAP system with Message Server using Secure Network Connection. For further information on SNC refer to the CRM Security guide.
Secure_server_connect Used for connection to SAP system with Message Server (Load balancing) using Secure Network Connection. For further information on SNC refer to the CRM Security guide. For each of the delivered configurations there are standard components to be configured. Client
The client used to log on to the SAP system e.g.800
lang The language that will be used for the Jco connection to the SAP system by default this is set to English. (e.g. en ).
group; This is group been used for the group connect. This is case sensitive.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 28
A Quick Guide to B2B XCM Configuration
r3name This refers to the System ID for example IDES or Q0M.
Mshost This is the connection to the Message server host name
User This is the user name for the Jco connection.
Passwd This is the Password for SAP system. This password is encrypted when it is stored.
Maxcon This is the maximum size of SAP Java Connector connection pool. jco.client.trace Turns JCo trace on/off.
Please note the following .This must be at least twice as big as the number of concurrent users of all application running on a single J2EE engine and sharing the same logon data. If you increase this value you then must also adjust (create) the CPIC_MAX_CONV in the system environment variable. This variable specifies the maximum number of RFC connections the application server can handle simultaneously (the physical server, not the J2EE Engine). If you run only one web application (e.g. B2B) this value of CPIC_MAX_CONV must be twice as big as the connection pool size. This is because for every user connected to the system 2 connections will be used from the pool for the duration of the session. If you run more than one application using RFC based connectivity, the value of CPIC_MAX_CONV must be increased accordingly. Important note: Pools for connections with the same connection data are used across the applications running on the same J2EE engine. If you have specified different poolsize in different applications the pool gets the size of the first application using it. After increasing the poolsize make sure that the increased value is really used. You can check in the 'Java Connector statistics' page in the administration area of the application.
oci Additional settings are necessary for using an external catalog based on Open Catalog Interface (OCI). There are 3 standard delivers SAP configurations.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 29
A Quick Guide to B2B XCM Configuration
Ocidefault The additional settings that is necessary to use an external catalog.
Ocicrmstandard Default configuration if an external catalog is used with ISA CRM.
Ocir3standard Default configuration if an external catalog is used with ISA R/3. Some basic OCI-settings are preconfigured here to allow ISA R/3 to interact with an external catalog, using the OCI interface. For ISA R/3, SAP does not recommend you change any OCI settings, except for the catalog URL (ociCatalogURL).
ociCatalogURL This configures the URL of the external OCI-catalog-engine.
ociTarget The target frame to return to.
ociVersion Version of the OCI-protocol that you are using. The current supports versions are 2.0 and 3.5.
ociForm The OCI-protocol type that is been used..
ociEnable Is the OCI enabled?
ociReadAllProductData Specifies whether all data should be retrieved from the external catalog or not.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 30
A Quick Guide to B2B XCM Configuration
ociAllProductsInMaterialMaster All products from the external catalog are available in the product master.
scenario_security Definitions for scenario security related settings. The security component contains all scenario security related settings that can be configured. Please be very careful when changing any of these settings!. Session auth switch The session auth switch turns on/off the session authentication feature. This setting is only used with non UME user types! Activation rules: Switch in Scenario yes no yes no Switch in Application Config no yes yes no Feature in scenario config: no no yes no In addition a fallback scenario is implemented for the usage of the maintained user. The application will check if a user is maintained in the scenario. If this is not the case, then the user from the application configuration is used. The feature will not be used when no user is maintained in either scenario or application configuration. Allowed Values Detail Name Description True= Turns on the session authentication feature. False= Turns off the session authentication feature.
session auth user UME User for session authentication (e.g. authsessionuser) This setting is only used with non UME user types! The session auth user is used to authenticate the http(s) session on the application server. The session will run under the entered user after a successful login in the web shop. This user should not have any roles, because he does not need any. No actions on the J2EE will be taken with this user. It is only used to authenticate the session and let the application server secure it. This is the entry checked first; if no user has been maintained then application_security component of the application is used.
Session auth passwd This is the password for the session auth user. This setting is only used with non UME user types!
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 31
A Quick Guide to B2B XCM Configuration
This is the password for the session auth user. See long text of the session auth user entry for more information about the user. The password itself will encrypted and stored in XCM.
isXsrfPortalScenario Flag to indicate if this scenario shall be treated as Portal scenario by XSRF protection If this flag is set to true, Actions marked with parameter="noXsrfPortalRequest", as well as all following actions in the same request, will be treated as not XSRF protected. If this flag is set to false, Actions with parameter="noXsrfPortalRequest" must be XSRF protected. Allowed Values Detail Name Description True=Treat his scenario as Portal scenario by XSRF protection. False= Don't treat his scenario as Portal scenario by XSRF protection.
shop Configures additional settings used by the selected shop-type The standard delivered configurations for this component are. crmshop_b2b Shop scenario is Business to Business (B2B) and backend system is CRM. crmshop_oob Shop scenario is Business on Behalf (BOB) and backend system is CRM. crmshop_hom Shop scenario is Hosted Order Management (HOM) and backend system is CRM. r3shop_b2b Shop scenario is Business to Business (B2B) and backend system is ERP or R/3. r3shop_bob Shop scenario is Business on Behalf (BOB) and backend system is ERP or R/3. r3shop_agent Shop scenario is Business to Business for Internal Users and backend system is ERP or R/3. erpcrmshop_b2b Shop maintenance for ISA ERP with CRM catalog
The delivered components are.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 32
A Quick Guide to B2B XCM Configuration
shopscenario Shop scenario, for example, B2B, B2C, OOB, HOM etc. Only those shops, whose scenario matches the entry given here, appear in the shop list and can be started.
documentsearch.name Define the name of the document search description according to file \xcm\sap\modification\genericsearchbackend-config.xml, which will be used for this application.
portal.enable.claiming.from.invoice Enable claim creation from invoice. If this parameter is set to true, and the Internet Sales web application is running in the Portal, and the web user is using the correct Portal role, a button will be offered on the invoice detail screen to allow creating a claim from that invoice. Allowed Values Detail Name Description False= No claim creation from invoice True= Claim creation from invoice
defaultShopId Shop Id for Default Shop for B2B, B2C and CCMS Heartbeat. If this parameter was set, this shop will be used as default as long no shop id will be provided via request parameter. The parameter is also used for the CCMS Heartbeat and the Availability Check for b2b and b2c can check whether the search engine is reachable by executing a query on the root of the catalog belonging to the shop given by the shopid.
UI (User Interface) The UI component configures behavior of the User interface of the web application. A customer version of this component needs to be implemented, if enhancements are required in an Application Configuration. E.g. The price analysis link should be displayed or if a stacktrace should shown. Otherwise, the default values of the SAP Component uidata will be use The Standard delivered UI components are.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 33
A Quick Guide to B2B XCM Configuration
default-hom Default configuration for the HOM (hosted order management) scenario. default Default basic behavior of the user interface of the application. default-r3lrd Default basic behavior of the user interface of the application in the R/3 application.
Parameter Detail
language Default Language for Userinterface and Backend communication If this parameter was set, it overwrites the parameter set in the XCM component "jco" for backend communication. On the other hand it can be overwritten by the request parameter 'language' in the URL. Example: You specify the language 'de' in this parameter. German is used when starting the application. You start the application passing the 'language' request parameter e.g. http://host:port/b2b/b2b/init.do?language=en. English is used in the application even if German is specified in this parameter.
styledirection.core ISO languages which requires style direction RTL Insert here a comma separated String of ISO languages abbreviations (e.g. he, ar) which require a screen alignment to the right.
enable.priceAnalysis Show or hide pricing conditions display This flag can be used, to links to a pricing conditions display, which shows how the IPC determines the prices for an item. Allowed Values Detail Name Description True= the link for priceAnalyis will be displayed in the web Shops False= the link for priceAnalyis will not be displayed in the web Shops
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 34
A Quick Guide to B2B XCM Configuration
configOnlineEvaluate Turn on IPC configuration online evaluation Turn on IPC configuration online evaluation, i.e. when changing any attribute in configuration, it is checked automatically. Allowed Values Detail Name Description True= Configuration is checked after each attribute update False= Configuration not checked after attribute updates
configinfo.catalog.view Determines the characteristics of the configured product to be shown in the catalog In the homepage view, product details and product comparison pages of the catalog the values of the characterics of the configured product can be displayed by setting the view parameter. The view of each product can be defined in the corresponding ERP system with transaction CL03. If you enter '*', all characteristics will be displayed.
exact.search.isacore Perform an exact or non-exact search in the product-list tab
Allowed Values Detail Name Description True= http session/request data will be traced False= http session/request data will not be traced
maxhits.search.isacore Determines the maximal number of hits for the product-search This parameter limits the maximum number of entries, shown in the result list of the quick search, to the given value. The quick search is the product search facility that is provided to the user in B2B outside the catalog view.
Catalog.ListView.MaxItems Maximal number of items rows to be displayed in the list oriented view of the catalog
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 35
A Quick Guide to B2B XCM Configuration
This parameter determines the maximal number of items to be displayed on one screen in the list oriented view for the catalog products, personal and global recommendations. Set this to 0 (=zero) to display all items on one screen.
enablerelogincookie.core If this parameter is enabled, a temporary cookie will store all relevant login parameter for a relogin. If you start the application with additional request parameter like language, configuration.xcm= etc. These values are stored in the session context and will be lost when the session is lost. So it is normally not possible to restart the application with the same values for an invalid session. To avoid the loss of the value it is possible to store the values additionally in a temporary cookie. This cookie could enable with this switch.
Allowed Values Detail Name Description True= A relogin cookie will be send to the browser False= No relogin cookie will be send to the browser
enable.nonCatalogProducts Activates or deactivates the ordering of products which are not in the catalog. The setting is taken into account only if ISA runs with CRM backend. For ISA R/3, products of the catalog only can be added to the basket. Allowed Values Detail Name Description True= Ordering of non catalog products is allowed False= Ordering of non catalog products is not allowed
showstacktrace.isacore If set to 'true' a stacktrace is shown if an application error occurs. The stacktrace is show on the application error page. It is useful when testing the application. For security reasons, the parameter should be set to false in a productive environment Allowed Values Detail Name Description True= Stacktrace will be shown False= An general error page will be shown
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 36
A Quick Guide to B2B XCM Configuration
showmodulename.core If set to 'true' the name of the JSP is shown when the JSP is displayed. This parameter is very useful when extending the web application. It is a way for quickly finding out the name of a JSP. For security reasons, the parameter should be set to false in a productive environment Allowed Values Detail Name Description True=the name of the jsp will be shown False= the name of the jsp will not be shown
showjspdebugmsg.core If set to 'true' the displaying of JSP debug messages is allowed on the JSP's. In some JSP's additional debugging information is included which can be displayed directly with the rendered HTML code. To see this information you must set this parameter to 'true'. Additionally the application must be started with the request parameter 'showjspdebugmsg' and value 'true' (i.e. http://://init.do?showjspdebugmsg=true). For security reasons, this parameter should be set to 'false' in a productive environment. Allowed Values Detail Name Description True= Display of JSP debugging messages is allowed False= Display of JSP debugging messages is not allowed
maxhits.search.action.businesspartner Determines the maximal number of hits for the customer-search This parameter limits the maximum number of entries shown in the result list of the customer search to the given value. The customer search is used in the Business-on-Behalf scenario.
theme.core Enable you to manage different records of Mime objects (e.g. pictures, stylesheets). The parameter specified here determines which record is to be used. The theme name is restricted by the application_security parameter theme.core.name.filter. Plese read long text for more information. The theme.core is used in conjunction with the mimes.core parameter. Due to security reasons the allowed characters are a-z, A-Z, 0-9, -, _ and spaces. Everything else will be removed from the value. The URL of a mime object will be constructed by appending value of the theme.core to the mime.core. Both parameters build the root of all mimes objects (css stylesheets, images).; If you leave both parameters empty, the context root of the application is used as the mimes root. Example: If the parameter have the following values: mimes.core=http://mimes.company.com theme.core=toys-shop, the image b2b/mimes/images/calendar.gif must be located at http://mimes.company.com/toysshop/b2b/mimes/images/calendar.gif If blank the standard configuration will be used.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 37
A Quick Guide to B2B XCM Configuration
mimes.core URL to mimes (e.g. pictures, stylesheets etc.) if placed on an external web server. Only needed, if mimes (gif, css, ...) of this web application are to be placed on an external web server. If this is the case, provide the path to these mimes; example: http://mimes.company.com/b2b. Please make sure that the URL does not end with a '/' If you leave this parameter and theme.core empty, the context root of the application is used as the mimes root. If blank the standard configuration will be used.
mimes.js.core This flag is used to indicate, if the mimes server should also be used for Java Script files. If this is the case, the mimes server must be in the same domain as the J2EE server. The flag is checked if the contentType in the isa:mimeUrl Tag or the WebUtil.getMimieUrl(...) method is set to js. Allowed Values Detail Name Description True= Use mimes server for JS files. False= Don't use mimes server for JS files. (Default)
enable.orderdownload Activates or deactivates the order download functionality. This parameter should only be used in HOM configurations. If this parameter is enabled, order download functionality will be available in the search results page for the orders and also in the order details page. Allowed Values Detail Name Description True= order download will be enabled False= order download will be disabled
enable.pers Enable personalization for the application configuration. There are some additional steps required to enable personalization. Please configure the component personalization to start personalization correctly. Allowed Values Detail Name Description True=Personalization is enabled
False= Personalization is disabled
enable.userSettingsForGrid Visibility and availability of checkboxes for grid display options in 'My Details'. Note: This field is only valid for grid products. In the 'My Details' option the user can set values for the different grid display options.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 38
A Quick Guide to B2B XCM Configuration
Allowed Values Detail Name Description Hidden= The screen element is not visible Editable= The screen element is visible and could be changed
maxhits.search.store.locator Determines the maximal number of hits for the store-locator search This parameter limits the maximum number of hits in the result list of the store-locator search to the given value in the CRM system. If there are more hits the customer gets a message to specify the search criteria.
maxhitsPerPage.search.store.locator Determines the maximal number of hits displayed per page for the store-locator search Limits the maximum number of hits displayed per page of the store-locator search to the given value. If there are more hits the customer could scroll in the result. If the user scrolls in the result list the additional address data were read for the next page.
configinfo.order.view Determines the characteristics of the configured product to be shown in the basket/order In the line items of the basket/order screens the values of characterics of the configured product can be displayed by setting the view parameter. The view of each product can be defined in the corresponding ERP system with transaction CL03. If you enter '*', all characteristics will be displayed.
configinfo.orderdetail.view Determines the characteristics of the configured product to be shown in the order confirmation In the line items of the order confirmation screens the values of characterics of the configured product can be displayed by setting the view parameter. The view of each product can be defined in the corresponding ERP system with transaction CL03. If you enter '*', all characteristics will be displayed. In this detail view the characteristic values are grouped by the related characteristics and characteristic groups.
initial.newpos Defines how many empty items are created for a new document initially.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 39
A Quick Guide to B2B XCM Configuration
This parameter defines how many empty items are initially created for a new document. This parameter might be over steered by the user during his session, via selecting a different value from the related dropdown boxes on the jsps. Allowed Values Detail Name Description 5 =5 empty items will be created initially. 10= 10 empty items will be created initially. 50= 50 empty items will be created initially.
ume.logon.schema UME schema allows different UI layout for UME logon procedure With this parameter it's possible to change the default layout of the logon screens in the area of the UME logon procedure. If this parameter will be maintained, it's possible to provide customer specific set of JSPs (and other UI-relevant files) within the UME logon application. Thus one gets the possibility to modify the standard layout of the UME logon application. For more details please see SAP Support note 805713.
Context.encodeContext Encodes context values in URL using Base64 encoding This setting allows to encode context values in URL using Base64 encoding scheme. Allowed Values Detail Name Description True= Context values in URL are encoded using Base64 False= Context values in URL are not encoded using Base64
ui.fields.order.deliveryPriority Visibility and availability of the header field delivery priority. Note: This field is not available in the Collaborative Showroom at all. Allowed Values Detail Name Description Hidden= the screen element is not visible Visible= the screen element is visible but could not be changed Editable= the screen element is visible and could be changed
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 40
A Quick Guide to B2B XCM Configuration
ui.fields.order.item.deliveryPriority Visibility and availability of the item field delivery priority. Note: This field is not available in the Collaborative Showroom at all. Allowed Values Detail Name Description Hidden= The screen element is not visible Visible= the screen element is visible but could not be changed Editable= the screen element is visible and could be changed
ui.fields.order.shippingCondition The parameter controls the visibility and availability of the field shipping condition. Allowed Values Detail Name Description Hidden= the screen element is not visible Visible= the screen element is visible but could not be changed Editable= the screen element is visible and could be changed
ui.fields.order.bomExplosion Enable display of bill of materials (BOM explosion) Controls the display bill of materials in the order screens. If hidden the sub items for the bill of material(BOM) are not displayed. Allowed Values Detail Name Description Hidden=the screen element is not visible. Visible=the screen element is visible.
ui.fields.order.subitemDetailView Controls the enabling of the sub items detail view Controls on the order screens if icon for the sub item detail view is displayed or not. If hidden is maintained, configuration sub items , bill of material sub items and free goods sub items will appear accordingly to the XCM settings. Please be aware of the fact that sub items caused by substitution/ supersession HAVE TO BE displayed due to the business process handling. Allowed Values Detail Name Description Hidden=the icon for the sub item details is not visible. Visible=the icon for the sub item details is visible.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 41
A Quick Guide to B2B XCM Configuration
user This setting defines whether SAP User Management Engine is enabled or not in the applications. enabled This parameter is necessary to support the SAP User Management Engine in future releases of Internet Sales. Currently this parameter has to be set to 'false'. Allowed Values Detail Name Description True= SAP User Management Engine turned on False=SAP User Management Engine turned off
webcatalog The webcatalog component provides to configuration needed to configure the product catalog setting in the web shop. The predefined component delivered is Webcatdefault This is the predefined entry that does not provide an imageserver and also sets the item page size to 5. The default configuration can be copied and changed to customizing the application to your needed.
imageserver This URL describes the server directory, to which images from the CRM system are published. In the application this URL will be concatenated with the content of each image attribute to build the full URL for the html 'img' tag. The value of this parameter must correspond to your settings in the CRM system, for the 'publishing' part of the catalog replication process.
preventIPCPricing Defines whether IPC pricing in the catalog should be prevented or not.
maxSearchHits Parameter to control the number of maximum search results to be retrieved.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 42
A Quick Guide to B2B XCM Configuration
catalogstatus This parameter specifies the status the catalogue should have, that is to be read. This parameter is only working with IMS (CRM) catalogues and catalogue staging replication. Two values are allowed. 1. Active which is the standard and where at most one catalogue with this status might exist. 2. Inactive which is only for testing purposes and where more than one catalogue with this status might exist.
priceDecimalPlace This parameter to display or hide decimal places for Prices in the WebCatalog
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 43
A Quick Guide to B2B XCM Configuration
Related Content XCM Configuration Development and Configuration guides SAP Support notes 1027725
Extended Configuration Management (XCM) for CRM user
1518208
Authorization error received when logging into XCM
For more information, visit the Customer Relationship Management homepage Printable Help There is a printable help function for the application configuration and components. You access it by selecting Help in the header area of the main XCM Admin window. Within the documentation hyperlinks provide links to more detailed information. The documentation displays the general settings separately. For more information, visit the Customer Relationship Management homepage
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 44
A Quick Guide to B2B XCM Configuration
Copyright © Copyright 2011 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Oracle Corporation. JavaScript is a registered trademark of Oracle Corporation, used under license for technology invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.
SAP COMMUNITY NETWORK © 2011 SAP AG
SDN - sdn.sap.com | BPX - bpx.sap.com | BA - boc.sap.com | UAC - uac.sap.com 45
