Batch Services

These services facilitate catalog updates in batch mode. All batch services can be run on demand or in scheduled mode. The batch mode services are:

Each service keeps in memory a history of all information, warning and error level messages. The messages are exposed through a set of API methods: getWarningMessages, getErrorMessages, getInfoMessages and getCurrentMessage. They can be viewed using the View Status option on the Commerce Administration Page. For more information see Running Catalog Maintenance Services.

Each service creates a global lock at the start of execution and releases it upon completion. This prevents services that use the same lock name from executing simultaneously on the same server, or other servers in the cluster.

All services have the following configurable properties, in addition to their own unique properties:

Property

Description

schedule

Schedule on which the service will execute. If this property is valued, the service will schedule itself accordingly when it is first instantiated.

availableFunctions

A list of function names that the service can perform. Function names identify specific processes that can be performed by the service, such as AGS_GENCATALOGS to generate ancestor catalogs.

functionsToPerformByDefault

This property configures a default set of function names that are executed if none are explicitly provided, which may be the case if the services is running in schedule mode, or through the Java API. It can include any of the functions exposed by the availableFunctions property.

saveMessages

If true, the info, error, and warning messages from the last execution of the service are retained in memory. These messages are used for the maintenance log display on the Dynamo Admin UI. The default is true.

maxItemsPerTransaction

The number of repository items that are updated in a single transaction. This can be used in the case of very large catalogs to spread updates across several transactions.

jobName

The scheduler job name used when the service is scheduled.

jobDescription

The scheduled job description.

lockTimeOut

Time in milliseconds before a timeout when acquiring the global lock.

lockName

The name used for the global lock.

The AncestorGeneratorService, CatalogVerificationService, and CatalogUpdateService all include a catalogProperties property. The catalogProperties property points to the /atg/commerce/catalog/custom/CatalogProperties component, which includes the following properties:

Property

Description

categoryItemName

The name of the item type that functions as a category in the catalog. If the catalog has multiple category item types related by inheritance, set this property to the name of the parent type; the service will generate ancestor categories for the subtypes as well as the parent type.

Default: category

productItemName

The name of the item type that functions as a product in the catalog. If the catalog has multiple product item types related by inheritance, set this property to the name of the parent type; the service will generate ancestor categories for the subtypes as well as the parent type.

Default: product

ancestorCategoriesPropertyName

The name of the property used to store the Set of ancestor categories of the item; this must be a property of the item types specified by categoryItemName and productItemName.

Default: ancestorCategories

childCategoriesPropertyName

The name of the property used to store the Set of categories that the item is the parent category of; this must be a property of the item type specified by categoryItemName.

Default: fixedChildCategories

childProductsPropertyName

The name of the property used to store the Set of products that the item is the parent category of; this must be a property of the item type specified by categoryItemName.

Default: fixedChildProducts

catalogIds

An array of the IDs of the Repository objects that make up the catalog. If your sites use only a single repository for its product catalog, this property can be null.

Default: null

includDynamicChildren

If true, AncestorGeneratorService generates properties for both fixed and dynamic children; if false, it generates properties only for fixed children. The default is false.