This SDK Readme contains important information about the Microsoft® Commerce Server 2007 SDK.  

CatalogCycleCop.exe

The Commerce Server Catalog System provides a great deal of flexibility by letting products and categories have multiple parent categories in the catalog hierarchy. Together with this flexibility comes the potential for circular references, or cycles, in the hierarchy. It is not practical for the Catalog System to perform cycle detection with every catalog management operation.

You can use the CatalogCycleCop.exe tool to detect whether any catalog in the system contains a circular reference.

Usage

CatalogCycleCop <SiteName> [/c CatalogName]

Where
  • SiteName refers to an existing Commerce Server site.

  • CatalogName refers to a catalog that you want to analyze. If you do not provide this option, the tool analyzes all catalogs for the site.

Error Level

The tool sets the ERRORLEVEL on exit as follows:

  • 0 – Success; no cycles detected.

  • 1 – One or more cycles were detected.

  • 2 – The tool failed to analyze the product catalogs for cycles, for example, failed to connect to the SQL database or permission denied error.

Output

If a connection failure or other critical failure occurs, the tool outputs a message to STDERR.

If the tool does not detect a cycle, the tool outputs "No cycles detected" to STDOUT.

The ExportCatalog.exe is a command-line tool that lets you export one or more Commerce Server Catalogs. ExportCatalog supports exporting multiple catalogs, Individual properties, Products and Categories, Descendants, Catalog Sets, Languages and Empty Values. Several Schema Export options are also available with this tool including the whole Schema, None of the schema, Relevant schema (based on other filtering options), and the ability to export the schema as XSD. Virtual Catalogs can also be exported as Base catalogs, and an XML namespace may be specified for the export.

CreateCatalogAuthorizationStore.exe

The Commerce Server Catalog System uses scopes within an Authorization Manager XML policy file to enable access control for the catalogs and properties within the Catalog System. Typically, when you import, create, or manage a catalog through the Commerce Server 2007 Catalog Manager, the scopes for the catalogs and catalog properties are created and maintained in the Authorization policy automatically. That is why the IIS Worker Process for the Catalog Web service must have write permission on the Catalog Authorization Policy XML file (typically, you do this by granting the IIS_WPG group write permission on the XML policy file after the Site Packager tool creates it).

In some cases, the Catalog Authorization Policy may become out of sync with the catalogs and properties that exist in the Catalog System database. This may occur if you import or manage catalogs without an authorization policy in effect. In these cases, you can use the CreateCatalogAuthorizationStore tool to resynchronize the authorization policy with the current state of the Catalog System database.

Usage

CreateCatalogAuthorizationStore <SiteName> <FileName.xml>

Where
  • SiteName refers to an existing Commerce Server site.

  • FileName.xml. The tool creates the file FileName.xml if it does not already exist. If it already exists, the tool creates any missing scopes in the file. This tool does not remove any scopes.

    Note
    This tool creates scopes that do not already exist in the policy file, but it will not remove any orphaned scopes that are no longer required. To get a "clean" policy file without unnecessary scopes, delete the old authorization policy file and run this tool, or point it to a new file location. Be aware that this will delete any role assignments that you may have made in the policy file.

Security Requirements

Requires that the user have read access to the MSCS_Admin database, the Catalog site database, and permission to create or modify the XML authorization policy file.

If the tool detects cycles, the tool outputs the nodes involved in each cycle in a tabular format to STDOUT.

CreateProfilesAuthorizationStore.exe

The Commerce Server Profiles System uses scopes within an Authorization Manager XML policy file to enable access control at the granularity of profile definitions. A default installation of Commerce Server includes scopes for each of the built-in Commerce Server profile definition.

You can use the CreateProfilesAuthorizationStore tool to synchronize the Profiles Authorization Policy with the profile definitions associated with a site profiles resource. This is useful if you create custom profile definitions.

Usage

CreateProfilesAuthorizationStore <SiteName> <FileName.xml>

Where
  • SiteName refers to an existing Commerce Server site.

  • FileName.xml. The tool creates the file FileName.xml if it does not already exist. If the policy file already exists, the tool adds any missing scopes. This tool does not remove any scopes.

Error Level

The tool sets the ERRORLEVEL on exit as follows:

  • 0 – Success.

  • 1 – Failure, for example, failed to connect to the SQL database or permission denied error.

Output

If a connection failure or other critical failure occurs, the tool outputs a message to STDERR.

If the tool completes successfully, it outputs "success" to STDOUT.

Note
This tool creates scopes that do not already exist in the policy file, but it does not remove any orphaned scopes that are no longer required. To get a "clean" policy file without unnecessary scopes, delete the old authorization policy file and run this tool, or point it to a new file location. Be aware that this will delete any role assignments that you may have made in the policy file.

Security Requirements

Requires that the user have read access to the MSCS_Admin database, the Profiles (BizDataStore) database for the site, and permission to create or modify the XML authorization policy file.

This tool creates the following roles:

Role Scope Tasks assigned

ProfileAdministrator

Application

Profile Advanced Authoring

ProfileWriter_Adapter

<Profile Name>

Profile Advanced Authoring

ProfileWriter_BusinessManager

<Profile Name>

Profile Authoring

ProfileWriter_CSR

<Profile Name>

Profile Authoring

ExportCatalog.exe

The ExportCatalog.exe is a command-line tool that you can use to export one or more Commerce Server catalogs. The ExportCatalog tool supports exporting multiple catalogs, properties, categories, products, descendants of categories and products, catalog sets, languages, and empty values. Several schema export options are also available with this tool, including exporting the whole schema, none of the schema, relevant schema based on filtering options, and exporting the schema as XSD. With this tool, you can also export virtual catalogs as base catalogs, and you can specify an XML namespace for the export.

Usage

ExportCatalog [/S:siteName|/W:url] [Options] FileName

Connection Options

Option Description

/Site:[SiteName] (/S)

Use the site name to connect to the catalog.

/WebService:[Url] (/W)

Use the URL name to connect to the Web service.

/AzMan:[file]

Use to select an authorization file when in local mode in order to update the scopes in that policy with the newly imported data.

Filtering Options

Option Description

/Catalogs:[CatalogNames]

Specify the catalogs to export.

/PropertiesToExport:[PropertyNames]

Specify the properties to export.

/ProductsAndCategories:[Clause]

Specify the ProductsAndCategoriesClause.

/Descendants

Specify the descendents to export:

  • All. All descendants.

  • ImmediateChildren. Immediate children.

  • None. No descendants (default).

/FilterDescendants:[Clause]

Specify the FilterDescendantsClause.

/CatalogSetsToExport:[CatalogSets]

Specify the catalog sets to export.

/Language:[Language]

Specify the language for export.

/EmptyValues

Specify to export empty values.

Schema Options

Option Description

/Schema

Specify the schema export type:

  • All. Exports all schema.

  • Relevant. Exports the relevant schema.

  • None. Exports no schema (default).

/Xsd

Export the XSD schema.

Advanced Options

Option Description

/VCasBC

Specify to export virtual catalogs as base catalogs.

/Namespace:[Namespace]

Specify the XML namespace.

InventoryConsistencyChecker.exe

The Catalog Inventory Consistency Checker tool examines the consistency between the Commerce Server product catalogs and inventory catalogs, has the option to automatically repair any consistencies, and writes the results to a log file.

Usage

InventoryConsistencyChecker [-S SiteName] [-L LogFileName] [-F]

Where
  • SiteName refers to an existing Commerce Server site.

  • LogFileName refers to the log file path and name for the tool to write the log file.

  • F (optional flag) refers to the option of automatically fixing inconsistencies between the inventory catalog and product catalog.

Output

The InventoryConsistencyChecker tool writes its output to the log file, and to the console.

If the tool does not detect any inconsistencies, the tool outputs "There were no inconsistencies found" to the console.

PurgeCommerceData.exe

The PurgeCommerceData tool purges expired Commerce Server data. You can schedule this tool to run periodically as a scheduled task to help with ongoing data management as part of your Commerce Server site operations.

You can use this tool to do the following:

  • Purge shopping baskets or purchase orders that were last accessed some number of days in the past.

  • Purge deleted marketing campaigns, discounts, advertisements, and promotion codes associated with expired discounts.

  • Purge deleted catalog entities from the Catalog System.

Usage

PurgeCommerceData.exe <sitename> <-b | -p | -m | -c> [options]

-b -d <age_in_days> [-n name]

Purges all baskets that have not changed for the last d days. If you specify name, the tool deletes only baskets with the specified basket name.

-p -d <age_in_days> [-s status]

Purges all purchase orders that have not changed for the last d days. If you specify status, the tool deletes only purchase orders with the specified order status value.

-m -d <age_in_days> [-o]

Purges all Marketing System entities (customers, campaigns, campaign items, and promotion codes) that were deleted at least d days in the past. If you specify the -o option, the tool deletes promotion codes for old discounts (those that are associated with discounts that expired at least d days in the past) from the database.

-c

Purges records of all deleted products, categories, and inventory SKUs from the Catalog and Inventory System.

Error Level

The tool sets the ERRORLEVEL on exit as follows:

  • 0 – Success

  • 1 – Failure, for example, failed to connect to the SQL database or permission denied error

Output

If a connection failure or other critical failure occurs, the tools outputs a message to STDERR.

If the tool completes successfully, the tool outputs "success" to STDOUT.

Security Requirements

Requires that the user have read access to the MSCS_Admin database, and read and write access to the site databases.
Note
The -d option is required when applicable. You can specify an age of zero; it purges all records of the specified type.

OrderTemplates are not purged by this tool. We recommend that you use named baskets instead of OrderTemplates.

This tool does not purge expired DirectMailer jobs. You can use the dmlrun.exe command with the /del_old option to purge DirectMailer jobs.

This tool does not use Web services or Authorization Manager authorization. It uses the Commerce Server APIs in INPROC mode; therefore, the user must have the appropriate permissions to the Commerce Server SQL Server databases.

As a best practice, do not purge Commerce Server data until you import it into the Commerce Server Data Warehouse.

See Commerce Server 2007 Help for information about the following SDK tools:

  • Dumporder.vbs

  • ExpirePromoCodeReservations.exe

  • ExportProfileXsd.exe

  • OrderMapping.exe

  • PipeReg.exe

  • ProfileKeyManager.exe

  • RCXml2Resx.exe

  • ReportInstaller.exe

-----------------------------------------------------------------------------------------------

Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in examples herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.

© 2006 Microsoft Corporation. All rights reserved.

Microsoft, MS-DOS, Windows, Windows Server, Windows Vista, are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

The names of actual companies and products mentioned herein may be the trademarks of their respective owners.