Workspaces

Concept

The process “Administer Workspaces” is used to setup the shared resources of all projects belonging to the same workspace.

The following actions can be conducted from within this process:

Manage Parameters
The step “Parameters” will allow you to define all parameters which are used by different objects/projects inside the current workspace. You will be able to define:
- Classifications of objects, by assigning them a user-type.
  - Different types of product links, enabling you to define new relationships between products in the CPQ repository.
- New method names that will enable you to define price lists, custom data, etc.
Manage the Rich Media Gallery
The “Gallery” step will allow you to create and manage a multimedia collection, which holds files and images.
Manage the workspace dictionary
The “Object Dictionary” will allow you to perform basic actions on all objects in the workspace repository:
- Filter on the object class and view all corresponding objects
- Execute a “where used” search on an object
- Execute a “is used by” search on an object
- Manage “forced objects”
Manage the runtime files
The “Manage Files” step will allow you to change files on the server, like settings, trace files or themes.
Manufacturing resources
The step “Manufacturing Resources” will allow you to create, update or delete basic manufacturing resources like work centers, operators, machines and subcontractors.

Managing global parameters

DEFINE OBJECT CLASSIFICATIONS

Definition: An object parameter allows you to create a classification for a certain type of object. Object parameters are also called user types.

These classifications will allow you to specialize certain behavior. Two typical examples are:

Limiting the amount of data exported by filtering the export to one or multiple user types
Changing the rich media objects displayed in a certain theme based on the rich media classification

DEFINE METHODS

The Designer uses the notion of methods throughout the application.

Definition: A Method is an object that owns all the logic and data concerning a specific calculation.

The following methods can be setup for different purposes:

Sales Method:

A Sales Method will define how the sales breakdown is calculated, in order to create a quote for the end-user.
Reference: For more information about sales methods, please refer to Defining the Sales Method.

Pricing Method:

The Pricing Method holds all logic and individual data in order to calculate pricing for the items and options in a multi-currency environment.
Reference: For more information about pricing, please refer to Managing Product Prices and Defining the Pricing Method.

Discount Method:

The Discount Method holds all logic and individual data in order to calculate discounts for Catalog items in a multi-currency environment.
Reference: For more information about discount methods, please refer to Managing Discount Information.

DEFINE LINK PARAMETERS

Definition: A Product Link represents a relationship between 2 items. A Link Parameter will define the explicit nature of such a relationship.

In the Designer, you can define relationship between products. These relationships are categorized using the Link Parameters. In particular, you can specify as many Product Links as necessary to define the explicit relationships between your products.

Some Product Links have been predefined:

Cross-selling

Cross-selling links define that 2 products “belong together”, and are used to encourage customers to buy additional products.

Example: a bed is associated with pillows, with blankets, etc.

Up-selling

Up-selling links define that a product is considered as “superior” or “better” compared to another product. They are meant to encourage the customer to buy higher quality or more expensive products.

Example: a hardcover book is superior then a paperback book.

Breakdown

Breakdown links define the relationship between a product and the products it is composed of.
Example: a leg is a part of a table.
Warning: A SP can be parent of a SI via a Breakdown type of link. However, the other way around is not possible.

Replacement

This link replaces the parent product with the child product. This link provides an option to the customer, even if the product they were looking for is no longer sold.
Example: automatically redirect the customer to the iPod Touch if they were looking for the iPod Photo
Do not: A product has to be linked to only 1 single product via the replacement type of link. The Qty associated to the link has to be 1 ( which is the only supported qty value for replacements)

Spare Parts

Spare Parts links define the relationship between a product and its spare parts.
Example: a desk is associated with its spare parts: the tabletop, drawers, screws, etc.
Warning: A SI and a SP or CP cannot be linked via a SparePart type of link.

Generated item

This link identifies that a Standard Item has been generated from a certain Configuration Process, and ties both products together.

You can also create Custom Links in order to extend the predefined Product Links. E.g. you might want to add an Incompatibility Link to indicate that 2 products cannot be sold together.

information: Items associated together by a product link can be targeted in a BRC through a CPE. It is then possible to access child objects from their parent.

For instance, a standard item named “siA” is the parent of two standard items “siB” and “siC” via a product link.

The syntax to get the value of “siB” from “siA” would be:

CPE.workspace/SI/siA.PL/ProductLinkName[1].item.value:

The syntax to get the description of “siC” from “siA” would be:

CPE.workspace/SI/siA.PL/ProductLinkName[2].item.descr
Here are a few syntax examples to use the PL keyword:
- CPE.workspace/SI/siA.PL/ProductLinkName[1].item.workspace/BPS/bpsName.BP/bpName.valu e
- CPE.workspace/SI/siA.PL/ProductLinkName.having(item.name,siB)[1].BPS/bpsName.BP/bpNa me.value
  The product links can also be used in the reverse way to access parent from their children. In the above example, the syntax to access to the “Name” attribute of “siA” from “siB” would be:
CPE.workspace/SI/siB.RPL/ProductLinkName[1].item.name
Here are a few syntax examples to use the RPL keyword:
CPE.workspace/SI/siB.RPL/ProductLinkName[1].item.workspace/BPS/BPSName.descr
CPE.workspace/SI/siB.RPL/ProductLinkName[1].workspace/BPS/bpsName.BP/bpName.value

HOW TO CREATE A NEW PARAMETER

How-To:

[Via the Toolbar in the related table]
- Click on the ‘Add Object’ or ‘Add Method’ or ‘Add Link’
[In the popup]
- Via the combo box, choose the class for which you want to add a parameter.
- Enter the Name and the Description of the parameter.
Save.
- The new Object Parameter is inserted in the corresponding table.
  information: Currently, user types can be positioned on Standard Items, Sales Products, Configuration Processes, Forms, Form Properties, BRC and Rich Media Objects.

Define Product Link methods

In addition to the notion of method and link parameter described above, some usecases require the definition of a Product Link Method.

Definition: When the link between products is computed dynamically, a Product Link Method is an object that owns all the logic and data concerning this dynamic link.

Some Product Links Methods have been predefined:

Dynamic Cross-sell

Cross-selling links define that 2 products “belong together”, and are used to encourage customers to buy additional products. On the contrary of static Cross-sell links, the dynamic Cross-Sell link are retrieved dynamically at runtime. The recommendations linked to a given product are computed from customer transaction data processed by a smart PROS algorithm.

Reference: For more information about dynamic cross-sell, please refer to Configuring Dynamic Cross-Sell.

To define a product link method, proceed as follows:

How-To:

[In the Parameter tab of the Workspace Administration menu]
- Go in the “Define Link Method” section and click on “Add Link Method”
[In the popup]
- Via the combo box, choose the class for which you want to add a method. For instance, “Dynamic Cross-Sell”
- Enter the Name and the Description of the method.
Save.
- The new Product Link Method is inserted in the corresponding table.

Managing the RMO Gallery

Rich Media Objects (RMO) may be added to projects to facilitate the buying and selling process.

Definition: A Rich Media Object is an entity that holds images, text and files in order to make objects visually more appealing, to explain certain options and to document certain features.

In order to add Rich Media Objects to your project, you will first have to build the Rich Media Gallery, which is the central step in which you will add all images and files which are relevant for the current workspace.

ADDING IMAGES

You can define image compositions in the workspace. Each image composition is identified by a name, which will point to a directory of images stored on your server.

Tip: Currently, the supported image types are GIF, JPG/JPEG, PNG and BMP.

To ensure that pages load quickly we recommend limiting the size of your images to 200ko. You can reduce your file's size by reducing the number of pixels or optimizing the image.

An image composition holds up to 7 images. Each one of those images corresponds to a specific type:

Current: this type of image will be displayed when the item to which the image composition is associated is “current” (meaning: is selected).
On: this type of image will be displayed when the item to which the image composition is associated is “active” (meaning: is enabled).
Off: this type of image will be displayed when the item to which the image composition is associated is “inactive” (meaning: is disabled).
OnMouseOver: this type of image will be displayed when the end-user hovers the mouse over the item to which the image composition is associated.
OnClick: this type of image will be displayed when the end-user clicks (using the mouse) the item to which the image composition is associated. It will be shown only during the time of the “click”.
Zoom: this type of image will be displayed when the user asks for a larger display of the image. If this image is not provided, the zoom capability will not be present.
3D: this type of image will replace the current image in the image viewer and in the gallery viewer. The end-user will be able to interact with the model (rotate, translate, zoom …)

How-To

Via the 'Explore Gallery' explorer]
- Click on the 'image' node in the tree (or a folder under the 'image' node)
[Via the Explorer Toolbar]
- Click on the 'Add image' function.
In the popup, give a Name (identifier) to your image composition and click on 'OK'.
- A line is inserted in the working area (in the table of the section corresponding to the folder you have selected)
Click on the cell corresponding to the type of image you want to associate.
In the popup, click on the radio button 'Upload Image'.
Click on the icon to browse your disks, select the image and validate.
Click on 'OK'.
- The image path appears in the table cell.
Save.
Warning: Use of 3D resources for Catalogs
In a Catalog context (as opposed to 3D Configuration) supported formats are the following:
- .obj files are supported. See notes below.
- .wrl files (VRML) are supported for version VRML 2.0+. See notes below.
- .3ds files are not supported as is. As a workaround, a common workflow is to export file from 3DSMax as .obj file, or go through a converter
When uploading a model in the RMO Gallery, you can either upload a model only, in the 3D image column. In that case, the model will be rendered, if compatible, at runtime with a default texture applied automatically. You can also deploy your model in a ZIP archive containing the model and a texture file. By doing so, the content of the ZIP file will be automatically extracted, storing the model in the 3D image column, and the texture to apply, if any, in the 3D texture column.
If no texture is provided in the Gallery, 3D models uploaded in the Designer have to be formatted in a way that supports the automated appliance of a default texture.
The 3D viewer is a WebGL technology. It might not be supported by your browser if it's not recent enough.

ADDING FILES / PLUG-INSYou can also add documents in your workspace. These documents are identified by a name, and will point to a file stored on your server.To add a file, please proceed as for images by creating a document name and associating the physical file to the document name.

information: Although the Designer allows you to add plug-ins, these are not yet operational.

Tip: Currently, the supported file types are .txt, .info, .jpg, .jpeg, .gif, .png, .swf, .jrxml, .zip, .pdf,

.doc, .docx, .ppt, .pptx, .xls, .xlsx, .rtf, .csv, .dae, .obj, .json, .wrl, and .jasper.

MANAGING FOLDERS

You can manage and group your Rich Media Objects by classifying those using folders.

How-To::

[Via the ‘Explore Gallery’ explorer]

Select an icon associated to the folder under which you want to create another folder.

[Via the ExplorerToolbar]

In the text area associated to the ‘Add folder’ function, enter a Name for the new folder.

Click on the ‘Add folder’ function.

Save

In order to delete a folder

How-To::

[Via the ‘Explore Gallery’ explorer]

Select the icon associated to the folder node you want to delete.

Via the Explorer Toolbar]

Click on the ‘Remove folder’ function.

Save

Warning: Removing the folder physically deletes the resources stored in that folder on a server.

UPLOADING REPORTS

Reports can be used to dynamically generate a jasper report in the catalog for your products.

Warning: Reports should be uploaded in the .zip format

Managing the workspace dictionary

The step “Manage dictionary” allows you to execute basic actions concerning the objects in the workspace repository. It allows you to:

View all objects for the given workspace, and sort them by name or description
See which objects are orphans (meaning: not referenced by any other object anymore) or forced (meaning: which have been automatically created by the import process)
Recursively delete the complete workspace or high-level projects
Delete orphan or forced objects
See which objects reference a given object or which are referenced by a certain object

How-To:

In order to see all objects for a given project:

[In the “Explore Structure” explorer]
- Choose the workspace or a specific project by clicking on its name or description
(Optionally) [In the dictionary]
- Filter on the type of object in order to browse specific objects
(Optionally) [In the dictionary]
- Sort by Name and Description by ascending or descending order

How-To:

In order delete a complete workspace or a specific project:

[In the “Explore Structure” explorer]
- Choose the workspace or a specific project by clicking on its icon
[In the Explorer toolbar]
- Execute the “delete” function
  - A popup window will ask for confirmation
[In the popup]
- Click on “OK”
  Do not: When deleting a complete workspace, you will have to restart the CPQ server before re-creating a new workspace with the same name (whatever it is created manually or automatically via an import process):

How-To:

In order to delete orphan objects:

[In the “Explore Structure” explorer]
- Choose the workspace by clicking on its name or description
(Optionally) [In the dictionary]
- In the “is used” column, filter on the value “no”
[In the table]
- Check all lines which correspond to orphan objects that you want to delete and execute the Delete Object function
[In the menu toolbar]
- Save

How-To:

In order to see which all the references for a specific object, proceed as follows:

[In the “Explore Structure” explorer]
- Choose the workspace or a specific project by clicking on its name or description
(Optionally) [In the dictionary]
- Filter on the type of object in order to browse specific objects
[In the table]
- Check the line corresponding to the object for which you want to verify the references and execute the View Dependencies function
  - A popup shows all “parents” and all “children” of the selected object.
    - If Parents and children on the same screen have the same workspace, this workspace is not mentioned on each line
[In the popup]
- In order to browse through the dependencies of the selected object, select a given parent or
  child and execute the “Select Parent” or “Select Child” function.
  - The dependencies table is updated and now shows the objects related to the selected parent or child.

How-To:

In order to unforce forced objects:

Choose the workspace and go edit it
Open the “Object Dictionary” tab
(Optional) [In the Explore structure]
- Select the product or collection in which you want to search or select nothing to search in the whole workspace.
[In the Object Dictionary grid]
- Click on the “Show forced” button or filter on the isForced column the object with a “yes” value. All the forced objects for the scope of your search are displayed.
To unforce all forced objects in one click, just press the “Unforce all forced objects” button
- To unforce forced objects one by one, select the corresponding objects in the grid and change the value of heir isForced attribute from “yes” to “no”.
Save

Managing files

When running Configuration or Catalog Processes, it might be that some server access is required. For instance:

The configuration settings need to be changed, or a new configuration file needs to be added
The theme does not seem optimal and some changes need to be made to the css files.
A macro-BRC did not execute correctly and the macro traces need to be viewed
An image in the Rich Media Gallery needs to be updated
The CPQ log file(s) need to be retrieved for support or analytics reasons

In order to access these server files, “Manage Files” step offers the following functions:

MANAGE FILES FUNCTIONS
Global functions
Fileset properties	Shows the properties of the explorer section in terms of allocated space and security.
Reload content	Refreshes the view with respect to the file system.
Functions available for a given folder
Upload	Uploads a file from the client in the opened folder
Import	Uploads a compressed file from the client and decompresses it in the opened folder
New file	Creates a new file in the opened folder
New folder	Creates a new folder in the opened folder

MANAGE FILES FUNCTIONS
Functions available for a given folder content
Cut	Cuts the selected file(s)/folder(s)
Copy	Copies the selected file(s)/folder(s)
Paste	Pastes the cut/copied line(s) in the opened folder
Delete	Deletes the selected file(s)/folder(s) recursively
Download	Downloads the selected file or folder (in case of a folder, it will be compressed).
Editor functions
Go to line	Jumps to the line having the number entered by the user
Reload	Reload the content of the file being edited since the last save (thus removing any change that has not been saved)
Undo	Undo the last action
Redo	Redo the "undone" actions.
Search	Search for a character string.
Replace	Replace all occurrences of a character string by another one.

MANAGE FILES FUNCTIONS
Increase font size	Increase the font size to make the file more easily readable.
Decrease font size	Decreases the font size.
Wrap	Allows wrapping the text automatically (visually breaking the line and continuing on the next line when it is larger then the editor width) or not.
Expand/collapse	For XML-documents, allows expanding (opening) or collapsing (closing) XML tags.

The following views are accessible in the “Runtime” step:

Settings

This view holds all the configuration.xml files and the catalog.xml files.

Traces

This view holds all information necessary for “debugging” the Configuration Processes and consult analytics on the usage of CPQ by end-users.
- The JBoss server log file
- The cameleon log file
- The macro language traces
- The Analytics log file

Rich Media

This view holds every rich media gallery, per workspace.

Themes

This view holds all information necessary to graphically build and view the Configuration or Catalog process layout:
- The layout.xml files
- The configurationUI theme folders, holding images and css files
- The external components

How-To:

In order to browse a certain view, proceed as follows:

[In the menu toolbar
- Click on the step “Runtime”
[In the explorer]
- Click on the tab “Manage Files”
[In the explorer tab “Manage Files”]
- Select the section of interest (e.g. Traces)
- Expand the folders
- Click on the name of the folder of interest

How-To:

In order to open a file, proceed as follows:

[Using the “Manage Files” explorer]
- Choose the folder of interest
[In folder view]
- Click on the name of the file of interest.
  - If the file can be edited, a file editor will be opened. If not, the Designer will propose to download it.

Manage Manufacturing Resources

How-To:

In order to add a manufacturing resource, proceed as follows:

[In the menu toolbar]
- Execute the “New Resource” function
- In the popup:
  - Choose the class of interest (work center, machine, operator, subcontractor)
  - Enter a name
  - Provide a description
  - Hit “Add”
  - If all resources have been defined, hit “Close”
[In the menu toolbar]
- Save.

How-To:

In order to delete a manufacturing resource, proceed as follows:

[In the table]
- Select the line(s) of interest
[In the menu toolbar]
- Execute the function “delete line”
- In the popup:
  - Hit “OK” to confirm or “Cancel” to abandon
[In the menu toolbar]
- Save

Trademarks

All other brands and their products are trademarks or registered trademarks of their respective holders and should be noted as such. This product includes software developed by the Apache Software Foundation https://www.apache.org/

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.

Workspaces

Concept

Managing global parameters

Sales Method:

Pricing Method:

Discount Method:

Cross-selling

Up-selling

Breakdown

Replacement

Spare Parts

Generated item

How-To:

Define Product Link methods

Dynamic Cross-sell

How-To:

Managing the RMO Gallery

How-To

MANAGING FOLDERS

In order to delete a folder

Managing the workspace dictionary

How-To:

How-To:

How-To:

How-To:

How-To:

Managing files

Settings

Traces

Rich Media

Themes

How-To:

How-To:

Manage Manufacturing Resources

How-To:

How-To:

Trademarks

Footer Section

Explore