Understanding Excel-based Exports & Imports
Structure of the Excel-based export
The CPQ repository, or a subset of it, can be exported using the Excel format. This export outputs a single Excel file made with several sheets describe in the table below:
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| Home | Contains general information about the export: export date, workspace, default language, version details, bject scope, filter options, as well as the output options | Synthesis of the export Define Scope, Select Content and Apply filters steps | Synthesis of the export Define Scope, Select Content and Apply filters steps |
| Table of content | Contains the exhaustive list of the objects having being exported, an hyperlink allows to access directly to the sheet containing the targeted object | None | None |
| Parameters | Contains the definition of the parameters: object user-types, method names and link user-types | Admin Workspace | Manage Parameters |
| Business Properties | Contains the definition of the business property sets (BPS) | Design Business Property Set | Structure, Controls, Constraints |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| Products | Contains the definition of the following products: root Configuration Processes (CP), Standard Items (SI) and Sales Products (SP). Note: The products can be split per user type resulting several grids which can be output on separate sheets | Standard Items and Sales Products are created from the step “Structure” of the catalog and manufacturing processes whereas root configurable product are directly created from the dashboard | Standard Items and Sales Products are created from the step “Structure” of the catalog and manufacturing processes whereas root configurable product are directly created from the dashboard |
| Product Labels | Contains for each label, its definition as well as the products belonging to it | Design Catalog | Structure – Apply label/Explore Labels |
| Product Relations | Contains the relation parent-children between products. Each relation belongs to link-type parameter. Note: The product relations can be split per parent product user-type resulting several grids which can be output on separate sheets | Design Catalog | Product Links |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| Product Pricing | Contains the pricing records of each pricing method – Records are made with the products (sales product or standard item), their optional combinations of criteria and for each currency, the pricing values expressed for different periods and split into several ranges. Note: Product pricing records are split per pricing method and thus they are output on several sheets. The pricing ranges, currencies and periods to be exported are chosen in the filter options | Design Catalog | Pricing |
| Product Discounts | Contains the discount records of each discount method – Records are made with the products (sales product or standard item), their optional combinations of criteria and for each currency, the discount values expressed for different periods and split into several ranges. Note: Product discount records are split per discount method and thus they are output on several sheets. The discount ranges, currencies and periods to be exported are the same than ones defined for the product pricing | Design Catalog | Discount |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| Catalog Objects | Contains the definition of all objects (except products) that a catalog might contain: node and root collections (CL), teasers (TEA) and needs analysis processes (GS). Note: For collections (only) additional business properties can be associated. | Design Catalog | On-line store |
| Catalog Structure | Defines for each root catalog its hierarchy of collections as well as the products (SI, SP, CP), teasers (TEA), and needs analysis process (GS) contained into each collection Note: For needs analysis process (GS only) the scope of search must be specified | Design Catalog | Structure, On-line store |
| Catalog Access Rights | Contains for each root catalog, the definition of the access rights logic that applies at runtime | Design Catalog | Access Rights |
| GS Objects | Contains the definition of all forms structuring the needs analysis dialog (GS) | Design Guided Selling | Structure |
| GS Forms | Contains the sequence and properties of the questions/calculations (form properties - FP) that structure the forms used in the need analysis dialog | Design Guided Selling | Structure |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| GS Structure | Contains for each need analysis process, the sequence and properties of the forms that structure the dialog | Design Guided Selling | Structure, Controls |
| GS Constraints | Contains the association with the constraints (BRC) used to filter the domains of form properties belonging to the forms used in the needs analysis dialog | Design Guided Selling | Constraints |
| GS Access Rights | Contains for each needs analysis process, the definition of the access rights logic that applies at run-time | Design Guided Selling | Access Rights |
| GS Event Logic | Contains for each needs analysis process, the definition of the event logic that applies at run-time | Design Guided Selling | Event Logic |
| GS Filter Method | Contains for each need analysis process, the definition of the filter logic that applies at runtime to retrieve the products matching the information gathered along the dialog steps | Design Guided Selling | Filter Method |
| CP Objects | Contains the definition of all objects that a configuration process might contain: node and configuration process (CP and forms (FO) | Design Configuration Process | Structure |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| CP Templates | Contains the definition of all templates (set of rules BRC, attached to given CPEs) associated with the configuration steps (CP) or dialogs forms (FO) | Design Configuration Process | Explore Templates |
| CP Forms | Contains the sequence and properties of the questions/calculations (form properties - FP) that structure the forms used in the configuration processes | Design Configuration Process | Structure |
| CP Structure | Contains for each root configuration process, its multi-level hierarchy made with configuration steps (CP node) and forms (FO) as well as their associated sequence and properties | Desing Configuration Process | Structure |
| CP Constraints | Contains the association with the constraints (BRC) used to filter the domains of form properties belonging to the forms used in the configuration dialog | Design Configuration Process | Constraints |
| CP Access Rights | Contains for each root configuration process, the definition of the access rights logic that applies at run-time | Design Configuration Process | Access Rights |
| CP Event Logic | Contains for each root configuration process, the definition of the event logic that applies at run-time | Design Configuration Process | Event Logic |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| CP Sales Method | Contains for each root configuration process, its hierarchy of sales breakdown lines and their associated sequence and properties | Design Configuration Process | Sales Method |
| CP Sales Breakdown | Contains for each root configuration process and each sales breakdown line, the definition of their associated generative logic (partial/complete matching, codification rules and sales information grid) | Design Configuration Process | Sales Breakdown |
| CP Pricing Method | Contains for each pricing method and each root configuration process, their associated pricing logic. Note: Each pricing method is output in a separate sheet | Design Configuration Process | Pricing Method |
| CP Pricing Grid | Contains the structure and the records of the pricing grids used in the pricing logic of each configuration process | Design Configuration Process | Pricing Method |
| CP Factor Grid | Contains the structure and the records of the factor grids used in the pricing logic of each configuration process | Design Configuration Process | Pricing Method |
| CP Drawing Method | Contains for each root configuration process and each sales breakdown line, the definition of their associated drawing logic | Design Configuration Process | Drawing Method |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| CP Drawing Grid | Contains the structure and the records of the drawing grids used in the drawing logic of each configuration process | Design Configuration Process | Drawing Method |
| Business Drawings | Contains the the svg source and parameter definition of all drawing objects used in the drawing logic of each root configuration process | Design Configuration Process | Drawing Dictionary |
| MP Resources | Contains the definition of the manufacturing resources: work centers (WKC), subcontractors (SCT), machines (MCH) and operators (OPR) | Admin Workspace | Manufacturing Resources |
| MP Objects | Contains the definition of all objects (except standard items) that a manufacturing process might contain: node and root manufacturing processes (MP), routings (RTG) | Design Manufacturing Process | BOM Structure, Routing |
| MP Bill of Materials | Contains for each root manufacturing process its multi-level hierarchy made with manufacturing process nodes (MP node) and standard items (SI) as well as their associated sequence and properties | Design Manufacturing Process | BOM Structure |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| MP Matching | Contains for each manufacturing process the definition of their associated generative logic (matching and codification rules) | Design Manufacturing Process | Matching |
| MP Routings | Contains for each routing attached in the manufacturing processes, its sequence of operations as well as their associated properties (existence) | Design Manufacturing Process | Routing |
| MP Operations | Contains the definition of each operation that structure the routings attached to the manufacturing processes | Design Manufacturing Process | Routing |
| MP Information Grid | Contains the definition of the business information grids attached to the manufacturing processes, the standard items, bill of material links and the operations | Design Catalog, Design Manufacturing Process | Business Information |
| BRC Matrix | Contains the definition, the combinatory records as well as the explanation details of all BRCs of type matrix | Design Catalog, Design Conf & Mfg Processes | BRC dictionary |
| BRC Product Filter | Contains the definition as well as the filter logic of all BRCs of type product filter | Design Catalog, Design Conf & Mfg Processes | BRC dictionary |
| BRC Formula | Contains the definition as well as the formula statement of all BRCs of type formula | Design Catalog, Design Conf & Mfg Processes | BRC dictionary |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| BRC Macro | Contains the definition, the association with the business child macro and data tables as well as the explanation details of all BRCs of type macro | Design Catalog, Design Conf & Mfg Processes | BRC dictionary |
| Business Macro | Contains the source code of all business macro | Design Catalog, Design Conf & Mfg Processes | BRC dictionary |
| Business Data | Contains the structure and the records of all business data table (BDT) associated with the BRC of type macro | Design Catalog, Design Conf & Mfg Processes | BRC dictionary |
| Rich Media Object | Contains the RMO content of all objects having being exported | Design Catalog, Design Configuration Process | Rich Media |
| Translations | Contains a translation table on the descriptions of all objects having being exported. The table is made with the object identifiers, the default language and one destination language. Note: This sheet is output for each language chosen in the filter options | All processes | Translations |
| SHEET NAME | CONTENT | DESIGNER CORRESPONDENCE: MODELING PROCESS | DESIGNER CORRESPONDENCE: MODELING STEP |
|---|---|---|---|
| RMO Translations | Contains a translation table of the rich media object attached to all objects having being exported. | All processes | Translations |
| Note: This sheet is output for each language chosen in the filter options |
Excel update guidelines
Users are free to update cells, add/delete columns and rows of any Excel sheet. Nervertheless, when the goal is to reimport the Excel with the updated information; guidelines detailed in the paragraphs below must be strictly respected.
GLOBAL CONVENTIONS
An export sheet (whatever its content) is made with the following elements:
A header part which contains: the CPQ logo, the title of the sheet as well as a dark row with a hyperlink to the “table of content” sheet:
- A header part which contains: the CPQ logo, the title of the sheet as well as a dark row with a hyperlink to the “table of content” sheet:information: Nothing at this level will be taken into account by the import function and thus it is recommended to not change it
One or several tables which are designed as follows:
- A parent part which is made with one or several rows, each row containing a label colored in orange and a value:information: Only the creation of a new table (by copy and paste) should induce the update of the cells composing the parent identification
- A title part which is made with several columns and one or several rows containing labels colored in blue:information: Titles of table and more generally cells colored in blue cannot be updated
- A content part which is made with several columns and rows containing various types of cells:information: More generally “white” cells can be updated with the respect of the expected format. Refer to paragraph “cell formats” below in this chapter.
UPDATE CONVENTIONS
As the import function has been optimized in order to treat only the changes, the following convention has been established in order to identify the information having being created/updated/deleted.
Excel sheets are made with tables of data, in each table one or several “Action” cells colored in yellow can be found according to the following cases:
Action referencing the entire table:
How-To:
- Put a “* ” (star/asterisk character) in case any cell of the table has been changed and thus must be treated by the import function
- Put a “x” (cross character in lower case) in case of the object(s) referenced in the table must be deleted by the import function
Action referencing a given line:
How-To:
- Put a “* ” (star/asterisk character) in case of a new line has been inserted or any cell of the line has been changed and thus must be treated by the import function
- Put a “x” (cross character) in case of the object referenced in the line must be deleted by the import function
Action referencing a given column:
How-To:
- Put a “* ” (star/asterisk character) in case of a new column has been inserted or any cell of the column has been changed and thus must be treated by the import function
- Put a “x” (cross character) in case of the object referenced in the column must be deleted by the import function
CELL FORMATS
The format of the cells depends on their expected type of value.
| VALUE TYPE | CELL DESCRIPTION | CELL FORMAT |
|---|---|---|
| Boolean | - | Yes, No |
| Date | - | yyyy/MM/dd HH:mm:ss |
| Integer, decimal, double | Put the value as string and use the Excel separator for the decimal part | 9999999.99999 or 9999999,99999 |
| Primary key | When the workspace is not the default one, or for cell that could contain a primary key or a constant value | workspace/PKType/name |
| Primary key | When the workspace is the default one | PKType/name |
| Primary key | When the cell type is known (for example a cell that always contains BRC), only the object name could be given | name |
| VALUE TYPE | CELL DESCRIPTION | CELL FORMAT |
|---|---|---|
| Workspace/class | When the workspace is not the default one | workspace/PKType |
| Workspace/class | When the workspace is the default one | PKType |
| Parameter object | When the workspace is not the default one | workspace/paramType/paramClass |
| Parameter object | When the workspace is the default one | paramType/paramClass |
| Form property, business property, BRC explanation | For these 3 special objects, in the translation sheets, the format of the value must be | parentName.name |
| Locale | Declared in the international settings | language_country or language |
| Business data table column size | The column size format must be one of these three | length,nbDecimal length.nbDecimal length |
| List of ranks | The separator in the list of ranks is the ; Up to 15 rank can be listed | example: 1;2;3;4 |
ENUMERATED VALUES
Cells referring to an enumerated list of values are detailed in the table below:
| VALUE TYPE | ENUMERATED VALUES |
|---|---|
| Alias Type, Form property Type | text, long_text, numeric, monetary, integer, Boolean, date, file, url, object |
| Valuation mode | simple, list |
| PKType | BDT - Business Data Table |
| PKType | DW - Business Drawing |
| PKType | BIG - Business Information Grid |
| PKType | BMAC - Business Macro |
| PKType | BP - Business Property |
| PKType | BPS - Business Property Set |
| PKType | BRC - Business Rules and Constraints |
| PKType | BVAL - Business Value |
| PKType | BVAR - Business Variable |
| PKType | CL - Catalog Collection |
| PKType | CP - Configuration Process |
| PKType | DSCM - Discount Method |
| VALUE TYPE | ENUMERATED VALUES |
|---|---|
| PKType | DWM - Drawing Method |
| PKType | FO - Form |
| PKType | FP - Form property |
| PKType | LA - Label |
| PKType | MCH - Machine |
| PKType | MP - Manufacturing Process |
| PKType | OPN - Operation |
| PKType | OPR - Operator |
| PKType | PARAM - Parameter |
| PKType | PRGM - Pricing Method |
| PKType | RMO - Rich Media Object |
| PKType | RTG - Routing |
| PKType | SP - Sales Product |
| PKType | SI - Standard Item |
| PKType | SCT - Subcontractor |
| VALUE TYPE | ENUMERATED VALUES |
|---|---|
| PKType | TEA - Teaser |
| PKType | TPL - Template |
| PKType | WKC - Work center |
| Parameter Type | MethodType, ObjectType, LinkType |
| Parameter Class | ObjectType: Refer to PKType MethodType: PricingMethod, DrawingMethod, SalesMethod, ScoringMethod, DiscountMethod LinkType: ProductLink |
| BRC Result Type | Exclude, Include |
| Value Operator | =, <>, <, >, <=, >=, IN, NOTIN, BETWEEN, LBETWEEN, RBETWEEN, OBETWEEN, NOTBETWEEN, LIKE, NOTLIKE, CONTAINS_ALL, NOT_CONTAINS_ALL, CONTAINS_ANY, CONTAINS_NONE |
| Column Data Type | CHARACTER, INTEGER, LONG, FLOAT, BOOLEAN, DATE |
| Filter Method scope | currentCollection, currentSubTree |
| Manufacturing use factor | Constant, Multiplier |
| Event logic – parameter | The possible values are the same as in the Designer |
| Event logic –action name | The possible values are the same as in the Designer |
| VALUE TYPE | ENUMERATED VALUES |
|---|---|
| Event logic – event | OnChange, OnComplete, OnAnswer, OnError, OnActivate, OnCustomeEvent, OnDelete, OnReload, OnInsert, OnPaste, OnExists, OnSave, OnBeforeSave |
| Disocunt line type | The possible values are the same as in the Designer |
| BPS sorting method | The possible values are the same as in the Designer |
| Drawing field types and properties | The possible values are the same as in the Designer |
| Product link relation | parent_of, child_of |
| RMO report format | Pdf, html, rtf, xls, doc, docx, csv |
UPDATING THE DEFAULT DESCRIPTION
The default description of the objects can be edited/updated in the sheet where they are respectively declared as well as in the translation sheets but this latter will override the preceding one in case of a double update.
UPDATING A CELL WITH DUAL FORMAT
Several cells have a dual format consisting of either a fixed value or a reference to the BRC name.
- Fixed values must be entered with the respect of their value type
- BRC names must be entered using the Primary Key (PK) format : “wks/BRC/BrcName”
ADDING A NEW BPSET
The new BPSet will be added as new columns filled-in with the identifiers of the business property set and its properties as shown in the example below (focus on the information colored in red):
How-To:
- Do not forget to point out the added BPSet with an “*” character in its associated “Action” cell
- Business properties can be filled-in for all existing products in the table or a sub set of them :
- Each update must be also pointed out with an ”*” in the left “Action” cell
- Additional products can be also inserted by adding new rows
- Each new row must be pointed out with an ”*” in the left “Action” cell
ADDING A NEW PRICING/DISCOUNT PERIOD
The new period will be added as new columns with the identifiers of the new period as shown in the example below (focus on the information colored in red):
How-To:
- Do not foget to point out the added period with an “*” character in its associated “Action” cell as well as in the cell “Action” located in the top of the table
- Pricing information can be filled-in for all existing products or a sub set of them
- Each update must be also pointed out with an ”*” in the “Action” cell of the period records
- Additional products can be also inserted by adding new rows
- Each new row must be pointed out with an ”*” in the “Action” cell of the product records
- In case of a new range is added in the table, the cell ”ranges” located in the top of the table must be consequently adjusted
ADDING A NEW RICH MEDIA OBJECT
A rich media object is split into several business types and each of them in several lines containing optional Image, Text, File, Plug-in, Report information. A new rich media object will be added with new rows in the table as shown in the example below (focus on the information colored in red):
How-To:
- Do not foget to point out the added rows with an “*” character in the “Action” cell
- The cell « business type » is optional – empty cell refers to the default one
- The cells “RMO name” and “RMO description” are optional on creation – they will be automatically computed by the import function
- The cells “#” are mandatory, the number is a unique sequence for each element whatever the business type which it belongs to
- The cell “text id” is indicative
Warning:
The Rich Media Object is an object which is updated all at once even if you use the update action only on 1 line.
For example, when you use the ‘*’ action on 1 line, you not only modify the content of the businessType corresponding to the line but the full RMO object. The resulting updated RMO object will only contain the data contained in the updated lines (all other information will be removed).
