{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Configuration Package is a set of folders and files, which represent the configuration of the partition. The configuration package contains Logics and their groovy code, definitions of tables and their fields, etc.","type":"text"}]},{"type":"paragraph","content":[{"text":"This package structure is used across several Pricefx tools, which deal with partition configuration - Studio, Packaging Tool and Platform Manager.","type":"text"}]},{"type":"paragraph","content":[{"text":"The Design Principles as described at the end of the article.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"Below is the complete structure of folders and files, which can be found in the Configuration Package.","type":"text"}]},{"type":"paragraph","content":[{"text":"Legend: Names are constant or use brackets from ","type":"text"},{"text":"Utility Conventions","type":"text","marks":[{"type":"link","attrs":{"href":"http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap12.html"}}]},{"text":": square brackets [optional], angle brackets , curly brackets {default values}, parenthesis (miscellaneous info).","type":"text"}]},{"type":"codeBlock","content":[{"text":"AdvancedConfiguration\n .txt\nCalculatedFieldSet\n [+].json\nCalculationFlow\n +.json\nCalculationLogic\n +[+]\n elements (directory)\n elem1.groovy (.groovy files for groovy FUNCTION expressions)\n elem2.formula (formula expression)\n logic.json (entity JSON with formula expression)\nContractTermType\n [.json]\nContractTermTypeAttribute\n [attribute1-30.json]\n [formulaName.json]\n [label.json]\n [waterfallElement.json]\nCustomerAttribute\n [attribute1-30.json]\n [customerId.json]\n [isParent.json]\n [name.json]\n [parentId.json]\nCustomerExtension\n \n attributes (directory)\n [.json]\n extension.json\nDashboard\n .json\nDataLoad\n ++\n dataload.json\n schedules.csv\nDataMart\n \n fields\n .json\n .json\n datamart.json\n ranks.csv\nDataSource\n \n fields\n .json\n .json\n source.json\n ranks.csv\nMessageTemplate\n [languagesForMsgTemplates.json]\n [_.html]\n [_.txt]\nPreference\n \n .json\nPriceRecordAttribute\n [.json]\nPricingParameter\n +[+]\n parameter.json (entity JSON)\n matrix (directory of matrix column definitions) \n .json (matrix field definitions)\n data_simple.csv (data of simple type, requires -withData option)\n data_range.csv (data of range type, requires -withData option)\n data_matrix.csv (data of matrix type with 1 key, requires -withData option)\n data_matrix<2|3|4|5|6>key.csv (data of matrix type with 2-6 keys, requires -withData option)\n tree.csv (structure of the tree)\nProductAttribute\n [attribute1-30.json]\n [currency.json]\n [label.json]\n [sku.json]\n [unitOfMeasure.json]\nProductExtension\n \n attributes (directory)\n [.json]\n extension.json\nRebateAgreementTemplate\n [.json]\nRebateAgreementTemplateAttribute\n [attribute1-30.json]\n [formulaName.json]\n [label.json]\n [lastUpdateDate.json]\n [uniqueName.json]\nRebateRecordAttribute\n (usually Default)\n [.json]\nRebateType\n [.json]\nRebateTypeAttribute\n [attribute1-30.json]\n [formulaName.json]\n [label.json]\n [waterfallElement.json]\nSavedChart\n [chartDefinition.json]\nSecurity\n BusinessRole\n [.json]\n User\n [.json]\n users.csv (use to import passwords, CSV header line is then \"loginName,password\", more columns for user fields can be added as well)\n userGroups.csv \nWorkflowFormula\n +\n elements (directory)\n .groovy (.groovy files for groovy FUNCTION expressions)\n logic.json (entity JSON with formula expression) \n.info (information about export version and possibly more)","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Design Principles","type":"text"}]},{"type":"paragraph","content":[{"text":"Naming Conventions for Folders and files:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Singular and camel case are used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Files have extensions, directories do not.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Folder Structure Convention:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The first level directories represent particular configuration type, the directory name is self-describing.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Data and metadata are stored in these directories; data are always optional.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For simple types, the directory contains only files with metadata.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For more complex structures, nested directories are created. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Nested files/directories are named after the entity business key whenever possible.","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Exported files:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"JSON files are created:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pretty printed with indentation of 2 spaces.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"With canonical serialization (the JSON tree is fully sorted in alphabetical order).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"UNIX LF","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CSV files when created:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Always have a header line.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sorted by the business key (depends on the exported data).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"UNIX LF, comma-separated fields.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"References to other entities used in files are expressed with a business key, database ID is never used.","type":"text"}]}]}]}],"version":1}

Browser not supported