Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Managing the Product Characteristics

The step “Manage business properties” allows you to:

  • Associate business property sets with the products or collections in your catalog
  • Open each individual business property set and update the values for each product or collection
  • Check the integrity of the updated data with respect to business rules positioned on the business property set
  • Dissociate business property sets from the products or collections in your catalog

In order to create business property sets, please refer to Design Business Property Sets.

Adding a business property set

In order to add a business property set to a set of products or to a set of collections:

How To:

[Via the “Explore structure” explorer]

  • Open a collection by selecting its name or description
    • In this case, you will be able to assign business properties to its products but also to its child collections (if any)

      or

      [Via the “Explore labels” explorer]

  • Open a label by selecting its name or description
  • In this case, you will be able to assign business properties to products only

    [Via the “Filter objects” explorer]

  • Search for a business property set by optionally expressing
    • A workspace
      • A name
    • A description
    • A user type

      [Via the “Filter Objects” explorer]

  • Drag & drop the icon of business property set of interest to the map under the product table

In order to add a business property set to a single product:

How to

[In the product table]

  • Select the product(s) to be opened

[Via the table toolbar]

  • Execute the Add to selection function

[Via the "Selection" explorer]

  • Open the product by clicking on its name or description.

[Via the "Filter objects" explorer]

  • Search for a business property set by optionally expressing
    • A workspace
    • A name
    • A description
    • A user type

[Via the "Filter Objects" explorer]

  • Drag & drop the icon of business property set of interest to the "Business Properties" section in the working section.

Opening a business property set

In order to open a business property set for a set of products and/or collections:

How to

[Via the business property set “map”]

  • Click on the business property set you would like to “open”

    [Via the popup]

  • Select “Open business property set”
    • A column will be added to the product table for each business property in the business property set
    • As of release 8, the table is opened in “edit” mode by default meaning that all values can be updated immediately.

In order to open a business property set for a single product:

How to

[In the product table]

  • Select the product(s) to be opened

    [Via the table toolbar]

  • Execute the Add to selection function

    [Via the “Selection” explorer]

  • Open the product by clicking on its name or description.

    [In the working section]

  • Expand the necessary business property set by clicking on its header.

Editing business properties for products

In order to edit business properties for a set of products, ensure that the business property set is opened. Once it is opened:

How to

[Via the table navigator]

  • Navigate to the correct page

    [In the product table]

  • Enter values for the necessary business properties.

    [Via the menu toolbar]

  • Save

In order to edit a business property set for one particular product:

How to

[In the product table]

  • Select the product(s) to be opened

[Via the table toolbar]

  • Execute the Add to selection function

[Via the explorer]

  • Select the "Explore Selection" explorer (if not selected already)

[In the "Selection" explorer]

  • Open the product by clicking on its name or description.

[In the working section]

  • Update the business properties for the product.

[Via the menu toolbar]

  • Save

In order to import all business property values for a business property set for a set of products:

How To

[Via the menu toolbar]

  • Click on the “import” button.

    [In the “popup”]

  • Indicate the CSV delimiter used in the import file. Default value = “;”
  • Indicate the list delimiter used in the import file. Default value = “~”
  • Indicate the decimal separator used in the import file.
  • Indicate the import file encoding format.
  • Choose the CSV file to be imported.
  • Click “ok”.
    • The import process starts. This is an asynchronous process and you can continue to model. The Designer will inform you automatically when the process is completed.

      [Via the menu toolbar]

  • Save.
    Tip: The import file should have the following heading: Wks;Class;Name;Description;Class;Wks;bpName1;bpName2;…;bpNameN

    The codes “bpNameX” should be replaced by the exact business property names in the order that they reside in the business property set.

Removing business property sets

In order to remove a business property set from a complete set of products:

How To

[Via the “Explore structure” explorer]

  • Choose a collection by selecting its name or description

    or

    [Via the “Explore labels” explorer]

  • Choose a label by selecting its name or description

    [Via the “map of business property sets”]

  • Click on the business property set you would like to remove

    [In the popup]

  • Select “Remove business property set”

    [In the menu toolbar]

  • Save

In order to remove a business property set from a single product:

How To

[In the product table]

  • Select the product(s) to be opened

[Via the table toolbar]

  • Execute the Add to selection function

[Via the "Selection" explorer]

  • Open the product by clicking on its name or description.

[In the menu toolbar]

  • Execute the function "Remove business property set" after having selected a business property set.

[In the menu toolbar]

  • Save

Checking Item Integrity

The Designer can now execute integrity checks on products inside the catalog.

Integrity Checks are interesting in order to validate the correctness of Business Property values in the context of products in a collection. The Designer allows:

  • Defining value domains for products (lists of possible values) characteristics
  • Calculate some characteristics automatically
  • Empty the values of some characteristics automatically
  • Propose default values for characteristics
  • Showing the characteristics which have conflicting values with respect to the business rules

In order to initiate a “mass” integrity check, proceed as follows:

How To

[In the explorer]

  • Select the collection or the label of interest

    [In the Business Property Set map]

  • Select the Business Property Set of interest

    [In the table toolbar]

  • Execute the function “Check Integrity”
  • The integrity check is running
    Note: When the mass integrity check is running, any users accessing the same catalog items on the same business property set will not be able to save values. Each user however is capable of seeing the progress of the integrity check by clicking on the function “Show status”.

When the mass check has finished, the following information will be displayed:

  • Current progress (in terms of number of treated items/total number of items)
  • Number of “completed” items : items which present no conflicts with respect to the business rules
  • Number of “errors” : items which present conflicts
  • Number of still to be processed items

Moreover, when accessing whatever collection or item, the Designer will automatically show, for the item or the page shown, the latest statuses with the following bullets:

  • Green: the value in the database is still the same and the integrity was ok.
  • Red: the value in the database is still the same; however the value was not valid.
  • Grey: the value in the database has been changed since the last integrity check.

In order to see the results of the latest integrity check for a given collection and business property set, proceed as follows:

How To

[In the explorer]

  • Select the collection or the label of interest

    [In the Business Property Set map]

  • Select the Business Property Set of interest

    [In the menu toolbar]

  • Execute the function “Download results”
    • A CSV-file will be downloaded with all items presenting conflicts. This file can be updated and imported again in order to correct the conflicts.

In order to check the integrity whilst updating product characteristics for a selected collection in the Designer, proceed as follows:

How To

[In the explorer]

  • Select the collection or the label of interest

[In the Business Property Set map]

  • Select the Business Property Set of interest

[In the menu toolbar]

  • Activate the function "Assist"
  • All items on the current page will be checked immediately. Moreover, each time the value for a characteristic changes, the integrity check will be re-executed for the current item.

Tip: When entering values for product characteristics, the Designer will automatically identify whether to use a text field, a combobox or a popup.

In case of a text field, data validation has to be done using the "Enter" button.

In order to check the integrity whilst updating product characteristics for an individual item, proceed as follows:

How To

[In the “Explore Selection” explorer tab]

  • Select the item of interest
  • The item is shown along with all its associated business property sets

    [In the menu toolbar]

  • Activate the function “Assist”
    • Each value change will lead to a complete integrity check for the given item (meaning: taking into account all its business properties)