Skip to main content
Kinetic Community

Export Catalog

This command will export KURL definition files for the entire specified catalog.

Details

The command exports the catalog and service item definitions to a directory named like the catalog.  The directory name will be the catalog name with the non-alpha-numeric characters removed.

The output can also be written as a zip file, in this case the directory structure within the zip file will be exactly the same as the non-zipped directory.

There are also several ways to filter which service items are exported during execution.  Service items can be filtered by their names or by values of configured attributes.  The arguments table below describes each argument that can be used to filter the resulting service items.

Arguments

catalog Specifies the catalog to be exported.  This argument is required.
directory Specifies the directory where the catalog definition directory/zip will be written.  Defaults to the current directory.
overwrite If used an existing directory/zip file with the same name as the resulting definition directory/zip will be overwritten during execution.
zip If used the catalog definition will be written as a zip file.  The directory structure within the zip file will be the same.
start_at Specifies a service item to start exporting at, service items that sort before this item will not be exported.
stop_at Specifies a service item to stop exporting at, service items that sort after this item will not be exported.
name_pattern Specifies a regular expression that will filter the service items to be exported, service items with names that match will be exported.
attribute_name Specifies an attribute name that will be used to filter the exported service items.
attribute_value Specifies an attribute value that will be used to filter the exported service items.  If the service item has the specified attribute value it will be exported.
attribute_value_pattern Specifies an attribute value regular expression that will be used to filter the exported service items.  If the service item has an attribute value that matches the regular expression it will be exported.

Examples

java -jar kurl.jar -action=retrieve_catalog -catalog="Service Catalog"

This command exports the catalog named Service Catalog definition to the current directory.

java -jar kurl.jar -action=retrieve_catalog -catalog="Service Catalog" -stop_at="Laptop Request"

This command exports service items up to and including Laptop Request.

java -jar kurl.jar -action=retrieve_catalog -catalog="Service Catalog" -attribute_name="Keyword" -attribute_value="Most Popular"

This command exports service items with the Keyword attribute set to Most Popular.