System tools for PIM

  • Updated

System tools are built-in features that help Optimizely Opal take action. Each tool performs a specific task, such as creating a campaign, uploading files, or generating images. Think of tools like attachments on a Swiss Army knife. Each one has a distinct purpose that helps you get work done.

In addition to the system tools available in Opal, Optimizely Product Information Management (PIM) includes tools, such as retrieving general statistics from the Dashboard. See Get started with PIM for more information.

You can ask Opal what tools it has at any time. For example, enter "Please list the tools you have with a brief description of what they do and the parameters" into Opal Chat.

Click a tool's name to expand it and learn when to use it, its required and optional parameters, and example prompts to calling the tool. If you do not provide a required parameter, Opal prompts you for it.

pim_get_asset_by_name – Retrieves an asset from PIM by its name.
  • When to use
    • Retrieve an asset from the PIM to view its metadata.
    • Verify if a specific asset exists in the PIM catalog.
    • Obtain asset details to link the asset to a product or variant.
  • Parameters
    • AssetName – The name of the asset to retrieve.
  • Example prompts
    • Find the asset named "Spring Collection Hero Image" in the PIM.
    • Retrieve the asset named "logo-dark-mode.png" to verify its metadata.
    • Get the details for the asset named "Product Diagram 2026".
pim_get_category_by_name – Retrieves a specific category from PIM by its name.
  • When to use
    • Retrieve category details to map products to the correct taxonomy.
    • Verify if a specific product category exists within PIM before updating a catalog.
    • Fetch category metadata using a known category name for content synchronization.
  • Parameters
    • CategoryName – The name of the category to retrieve.
  • Example prompts
    • Fetch the category named "Summer Apparel" from the PIM taxonomy.
    • Get the details for the "Electronics" category.
    • Check if a category called "Power Tools" exists in PIM.
pim_get_general_statistics – Retrieves all items from the General Statistics section on the Dashboard.
  • When to use
    • Use this tool when you want to get an overview of the general statistics available on the Dashboard, such as key performance indicators or summary data.
  • Parameters
    • This tool does not require parameters.
  • Example prompts
    • Show me the general statistics.
    • What are the general statistics on the dashboard?
    • Get the general statistics.
pim_get_product_template_by_name – Retrieves a product template from PIM by its name.
  • When to use
    • Review a specific product template by its exact name to understand its underlying attribute structure.
    • Verify product template requirements and available fields before you create a new product in the PIM.
    • Map external product data accurately into the PIM by fetching the necessary template details.
  • Parameters
    • TemplateName – The name of the product template to retrieve.
  • Example prompts
    • Get the product template named "Apparel - T-Shirts".
    • Retrieve the details for the "Electronics Master" product template.
    • Show the attributes included in the "Basic Furniture" product template.
pim_get_property_by_name – Retrieves a property from PIM by its name.
  • When to use
    • Retrieve specific property details, such as data types or validations, to configure a product template.
    • Verify the existence of a property within PIM before mapping product import data.
    • Fetch localized labels for a specific property to display in a downstream commerce storefront.
  • Parameters
    • PropertyName – The name of the property to retrieve.
  • Example prompts
    • Retrieve the property named "Material" from the PIM to review its accepted values.
    • Get the "Brand" property details to map it correctly during a product import.
    • Check the PIM for a property called "Warranty Period" and return its data type.
pim_get_variant_type_by_name – Retrieves a specific variant type by its name from PIM.
  • When to use
    • Retrieve the configuration details of a specific variant type before creating new product variants.
    • Verify the properties and dimensions associated with a variant type by its assigned name.
  • Parameters
    • VariantTypeName – The name of the variant type to retrieve.
  • Example prompts
    • Get the variant type details for "Color and Size".
    • Find the properties of the "Shoe Size" variant type.
    • Retrieve the variant type named "Apparel Fit" from PIM.

If you use Opti ID, administrators can turn off generative AI in the Opti ID Admin Center. See Turn generative AI off across Optimizely applications.