Home
Reference
Utilities
Utilities help you to accomplish administrative or configuration tasks, for example, loading data, publishing a store.
txttransform
This utility transforms data between a character-delimited variable format and an XML format.

Reference
- WebSphere Commerce API reference
  WebSphere Commerce exposes two main programming APIs. The first and newest API is a REST interface, and most new classes are exposed here. The legacy Java API also contains new classes not suitable for REST, and can be browsed in Javadoc format.
- Cross-reference of data beans, EJB beans, and tables
  Data beans are grouped into several component groups.
- Cross-reference of commands, tasks, and tables
  URL commands, controller commands, task commands, view commands and tables are related to each other.
- Cross reference: Commands to beans to database tables
  Use this information when you are customizing a command and you want to know which tables are affected. You should also use this topic if you are modifying a table and want to know which commands and beans are affected.
- API changes between WebSphere Commerce Version 7.0.0.9 and WebSphere Commerce Version 8.0.0.0
  If you are migrating version 7.0 of WebSphere Commerce, review the API changes between releases.
- WebSphere Commerce database schema
  The WebSphere Commerce database model was designed for data integrity and optimal performance. WebSphere Commerce provides several hundred tables that store WebSphere Commerce instance data. To maintain data integrity, and to ease maintenance referential integrity, constraints are widely used in the database model. Indexes are used carefully on tables to avoid over-indexing and to provide a good balance between data retrieval and data manipulation activities (insert and update). The business rules are implemented at the application level rather than by using database trigger. Triggers, however, are used to facilitate data staging and optimistic locking. A limited number of SQL-based database stored procedures are used for data intensive activities.
- Payments subsystem
  In WebSphere Commerce, payment processing uses the Payments subsystem.
- Dynamic caching
  In general, caching improves response time and reduces system load. Caching techniques are used to improve the performance of World Wide Web Internet applications. Most techniques cache static content (content that rarely changes) such as graphic and text files. However, many websites serve dynamic content, containing personalized information or data that changes more frequently. Caching dynamic content requires more sophisticated caching techniques, such as those provided by the WebSphere Application Server dynamic cache, a built-in service for caching and serving dynamic content.
- Data Load utility configuration file schema
  The Data Load utility contains several configuration files. You can use the configuration file schema to understand and customize the data load configuration files.
- WebSphere Commerce web services
  WebSphere Commerce provides many web services.
- Utilities
  Utilities help you to accomplish administrative or configuration tasks, for example, loading data, publishing a store.
  - acpextract
    The acpextract utility extracts the access control policy and access group information in the database and generates files that capture the information in XML format. It uses an input filter XML file to specify the data to extract from the database.
  - acpload
    The acpload utility loads the XML files that contain the main access control policies into the appropriate databases.
  - acpnlsload
    The acpnlsload utility loads the XML files containing the display names and descriptions, into the appropriate databases.
  - acugload
    The acugload utility loads the XML files containing the user (access) group definitions into the appropriate databases.
  - biEventFileGen
    This stand-alone Java application is run on the command line by using a shell or batch script. It provides an alternative means to obtain the transformed Common Business Event XML file, suitable for external systems if you choose to disable automatic transmission.
  - CleanSEOURL scheduler
    Use the CleanSEOURL utility to clean up any tables that are related to search engine optimization (SEO) URL redirects and SEO URL keywords from a command line.
  - config_ant
    The config_ant utility is a front end to the Apache Ant tool.
  - config_server
    This utility starts the Configuration Manager server. The Configuration Manager server must be started before starting the Configuration Manager client.
  - configSearchReplication
    Use the configSearchReplication utility to replicate your search index data on both your source and target servers to help improve reliability, fault-tolerance, and performance. Replicating WebSphere Commerce Search maintains your search index data in more than one location, and involves copying designated changes for one location to another and synchronizing the data in both locations.
  - crawler
    You can use the crawler utility to crawl HTML and other site files from WebSphere Commerce starter stores to help populate the site content search index.
  - dataload (Server)
    This utility loads data from a source file into a target database. Loading the file populates and updates the WebSphere Commerce database. You can also use the Data Load utility to delete data from a database.
  - dataextract
    The Data Extract utility, which uses the Data Load utility framework, extracts data from the WebSphere Commerce database into an output file.
  - dbclean
    The Database Cleanup utility (dbclean) removes unused or obsolete objects from the database.
  - di-buildindex
    The di-buildindex utility is a wrapping utility that updates the information in the Master Index with the Data Import Handler (DIH) service to build the index. The information is updated either partially through delta index updates or completely through full index builds.
  - di-calculateprice
    The di-calculateprice utility updates the information in the price index based on the pricing model your store uses. For example, for a B2B starter store, the price index is built to display contract prices in the storefront.
  - di-parallel-process
    The di-parallel-process utility indexes preprocessed shards based on a configured input properties file.
  - di-preprocess
    The di-preprocess utility extracts and flattens WebSphere Commerce data and then outputs the data into a set of temporary tables inside the WebSphere Commerce database. The data in the temporary tables is then used by the index building utility to populate the data into search indexes with the Data Import Handler (DIH).
  - Deprecated feature: dtdgen utility
    The dtdgen utility creates document type definition (DTD) file and (optionally) XML schema definition (XSD) files for use with the loading utilities based on the target database to which your data must conform. The DTD specifies structural elements and markup definitions that can be used within the XML data document and the DTD describes the tables and columns into which the massload utility imports data. For example, a DTD can list elements to be used in a document and specify the attributes that each element can take.
  - enableContentManagement
    The development environment is not meant to be an authoring environment. Support is provided in the environment for customization purposes only. For example, to test changes to the content management functionality. The ability to propagate changes is not available. If you want to change the content management workspaces, you cannot publish the changes out to another database.
  - encryptChallengeAnswer
    The encryptChallengeAnswer utility encrypts plain text data that is stored in the database column USERREG.CHALLENGEANSWER.
  - exportstats
    This utility exports marketing statistics to an XML file.
  - fileloader
    The fileloader utility loads managed files into a WebSphere Commerce database. Once the files are loaded into the database, the ScheduledContentManagedFileEARUpdate scheduled job copies the files from the database to the WebSphere Commerce EAR file.
  - fileprop
    The fileprop utility sends all new and changed files to the administration node of the federated WebSphere Application Server environment, which later pushes them into the managed nodes, which include the production server. The staging server must be federated using the same deployment manager as the production server. Otherwise, the managed files are not propagated into the production EAR because the deployment manager is not aware of the production node.
  - historyInfo
    The historyInfo command shows feature pack, fix pack and APAR history, which includes installation and uninstallation history for the WebSphere Commerce product.
  - idresgen (Server)
    The idresgen utility generates identifiers for XML elements with their associated identifiers. The XML files must have identifiers because the XML files map directly to the target database schema when you massload the files.
  - idresgen (Developer)
    The idresgen utility generates identifiers for XML elements with their associated identifiers. The XML files must have identifiers because the XML files map directly to the target database schema.
  - importstats
    This utility imports marketing statistics from a source XML file.
  - indexprop
    The indexprop utility propagates the WebSphere Commerce search index. It is used by IT administrators to issue an HTTP request to the search index repeater to start replicating with the staging search index. This replication ensures that your catalog changes are populated into the WebSphere Commerce search index in production.
  - invalidSearchCache
    The invalidSearchCache utility can be used from the command line to invalidate the contents of the specified cache.
  - massextract
    The massextract utility uses a query against a database to extract selected subsets of data from the database into an XML document. The data to be extracted from the database is specified in an extraction-filter XML document. The function of the massextract utility is opposite that of the mass load utility. Use the massextract utility to extract selective subsets of data from the WebSphere Commerce database in the form of XML files. For example, you can extract data on products that are related to an upcoming holiday. You can also extract information from a consolidated database for use with other systems.
  - massload utility (Server environment)
    This utility loads an XML input file into a target database. Loading the XML file updates the WebSphere Commerce database. The massload utility allows column-level updates to a table. You can also use this utility to delete data from a database.
  - massload utility (Developer)
    This utility loads an XML input file into a target database. Loading the XML file for populate and updates the WebSphere Commerce database. The massload utility allows column-level updates to a table. It also allows you to delete data from a database.
  - MigrateEncryptedFiles
    The MigrateEncryptedFiles utility updates the encrypted information in configuration files from 3DES encryption to AES encryption, and sets the encryption mechanism to AES.
  - MigrateEncryptedInfo
    MigrateEncryptedInfo is a utility for changing the merchant key and re-encrypting all encrypted data in the database.
  - Running the list price migration utility
    By running the list price migration utility, you migrate your existing list price data from the LISTPRICE table to different database tables (OFFER, OFFERPRICE, and OFFERDESC). The migration utility uses the Data Load utility to perform the migration.
  - migrateLOBTools
    You can use the migrateLOBTools utility to migrate your customized WebSphere Commerce Version 7.0 Management Center to WebSphere Commerce Version 8.0
  - Migrating promotions built on default promotion types: complete migration
    The migratePromotions utility migrates promotions created with WebSphere Commerce Accelerator or Management Center Version 6 Feature Pack 3 or 3.01 to WebSphere Commerce Version 7 Management Center.
  - migrateSearchFacet
    Use the migrateSearchFacet utility to migrate your existing attribute dictionary facetable attributes to the latest version of WebSphere Commerce Search. Typically, you run this utility while migrating WebSphere Commerce Search from a BOD-based search deployment.
  - migrateSolrSearch
    The migrateSolrSearch utility enables you to migrate the existing search cores and configuration files to the latest version of WebSphere Commerce Search.
  - publishstore
    Use the publishstore utility to publish store archives from a command line.
  - resetdb
    The reset database (resetdb) utility resets the WebSphere Commerce Developer database to its original state. The reset database is equivalent to a newly created database instance within the development environment. By running the utility, all data that is stored within the database is deleted and replaced with default data.
  - resetstores
    The Reset Stores (resetstores) utility resets the Stores web module in your workspace to its original configuration. This configuration is equivalent to a newly created instance in the production environment. All of the published (and pre-published) store assets are deleted from the workspace.
  - restClassicSampleGen
    The restClassicSampleGen utility automates the creation of mapping files with the configuration-based controller command and data bean mapping framework.
  - restoreDefault
    Restoring the development environment to its default setup is accomplished by using a convenient command called restoreDefault.bat.
  - seourlkeywordgen
    When you are installing the search engine optimization feature to create shorter SEO friendly URLs, WebSphere Commerce needs SEO keywords for the product and category pages of the store. The seourlkeywordgen utility creates these SEO keywords that are based on the object name.
  - Changing the development database type by using the setdbtype command
    After you install WebSphere Commerce Developer, the environment is configured to use the Apache Derby database. If your restored database type is Oracle or DB2, you must run the setdbtype command to point your WebSphere Commerce Developer Version 8.0 environment to your restored database. Ensure that the database that you are switching to exists in your network.
  - setupSearchIndex
    The setupSearchIndex utility configures the Solr cores by creating all core instances for the specified master catalog.
  - stagingcopy
    The stagingcopy utility copies data from the production database to the production-ready data on a staging or authoring server. You cannot use this command if RFQs are on your production system.
  - Stagingprop
    The stagingprop utility propagates staged data and managed files from the production-ready data to the production server. It consolidates the changed data from the production-ready database, and then it propagates the necessary changed data into the production database if the connection is available.
  - startWCServer
    The startWCServer utility starts the WebSphere Commerce test server (server1) that is used for WebSphere Commerce Developer.
  - startWCToolkit
    The Start WebSphere Commerce Developer (startWCToolkit) utility starts WebSphere Commerce Developer.
  - stopWCServer
    The stopWCServer utility stops the WebSphere Commerce test server (server1) that is used for WebSphere Commerce Developer.
  - txttransform
    This utility transforms data between a character-delimited variable format and an XML format.
  - updatedb
    You can use the updatedb utility to update the WebSphere Commerce database to the latest fix pack level that is installed for your system.
  - updateDB2configuration
    The updateDB2configuration utility sets your DB2 database configurations to the minimum requirements for WebSphere Commerce Version 8.0. You might need to run this utility if you are migrating from WebSphere Commerce Version 7, or if you changed WebSphere Commerce Developer to use a DB2 database.
  - updateua
    You can use the updateua utility to update the database user authorizations for a user or schema on a WebSphere Commerce database. You can use this utility in any environment to update user authorizations to grant or revoke authorization for any database object that you own.
  - updateVersionSchema
    The UpdateVersionSchema utility identifies which tables to be versioned, and then creates the tables in your version schema. This utility replicates newly added tables marked to be versioned from the base schema into the version schema.
  - CM_updateWorkspacesSchema script
    Use the update workspaces schema script when you change your base schema and need to update your workspaces schema to include the changes.
  - CM_updateWorkspacesTable script
    Use the update workspaces table script when you make schema changes to a table and need to update your workspaces schema to include the changes.
  - versionInfo utility
    The versionInfo utility displays WebSphere Commerce maintenance and component versions that are installed on your system.
  - Running the database connection validation utility
    If you encounter errors when you run a WebSphere Commerce utility or process that involves database-related operations, use the database connection validation utility to ensure that a database connection can be established. By default, this validation utility runs as part of the process for some utilities and processes. You can run this utility by itself to validate that a database connection can be properly established with the parameters that are configured for your WebSphere Commerce instance.
  - wcs_encrypt
    The wcs_encrypt utility encrypts sensitive information with a merchant key. The value of the merchant key is specified through command-line arguments or retrieved from calling out to the Key Locator Framework by using the -k parameter. If the merchant key is not specified and the parameter -k is not used, the utility encrypts the sensitive data with an internal encryption key.
  - wcs_password
    The wcs_password utility is used for encrypting user passwords to be stored in the WebSphere Commerce database.
  - xmlfMig
    The xmlfMig utility updates the contents of the xmlfFileList.txt file and changes the file extensions of the listed XML files to XMLF. It also creates a backup of the existing file by appending a BAK extension.
  - xmltransform
    The xmltransform utility changes, aggregates, and remaps the data in an XML document to alternative XML formats for use by other users or systems as needed.
  - wcs_xpathkey
    The XPath key generator command-line utility, wcs_xpathkey.bat, takes an XPath expression as input and generates an XPath key. This key is used to locate the XPATH_TO_SQL_STATEMENT template in the query template file.
  - webFeedLoad
    The webFeedLoad utility facilitates the integration of a web feed with WebSphere Commerce. You can run the utility from the command line, or by scheduling a site-level job.
- Shopping flow URLs
  WebSphere Commerce shopping flow URLs are organized by subsystem.
- Ant targets
  A WebSphere Commerce instance can be created from the command line. The command-line utility uses Apache Ant to create the objects required. The targets are divided into several high-level groups that correspond to the environment that is to be configured.
- Glossary

Deprecated feature: txttransform utility

This utility transforms data between a character-delimited variable format and an XML format.

Before you run this utility configure the loading utilities.

File names that are specified as parameters for this utility can be preceded by relative or absolute paths. Relative paths must be relative to the directory from which you run the txttransform utility.

This utility produces the following log file:

WC_installdir/logs/txttransfrom.db2.log
WC_installdir/logs/txttransform.oracle.log
WCDE_installdir/logs/txttransform.log

Linux AIX Run this utility as the non-root WebSphere Commerce user ID. Do not run this command as root.

txttransform utility syntax diagram. See the list that is called Parameter values for the applicable parameters.

Utility command

The txttransform utility has the following file name:

txttransform.sh
txttransform.cmd
txttransform.bat

Parameter values

The following required values are specified and separated by commas in a parameter file (parameter.txt):

Input file

The name of the character-delimited variable format file to transform.

Schema file

The name of the XML schema file to use for the transformation.

Output file

The name for the output XML file in which the transformed data is stored.

Transformation method

Create: Create an XML file from the text file.
Append: Append new XML data to an existing XML file.

Encoding

The character encoding scheme of the input file. Any character encoding scheme that is supported by Java can be specified. This parameter is optional. The default character encoding scheme is UTF-8, and is used if a value for this parameter is not specified.

All of these parameters are required, except for Encoding parameter, which is optional. The parameters must be specified in the order listed. If the order of parameters in the parameter file does not match the order of parameters that are listed, the txttransform utility fails.

The following code snippet shows how to create an XML file (catalog.xml) from a UTF-8 encoded comma-separated value (CSV) file (sample.csv) by using the schema that is defined in an XML schema file (sample_schema.xml).

sample.csv,sample_schema.xml,catalog.xml,Create,UTF8