| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Components
Like there are Similar to packages in other programming languages (e.g., Java), which allow to group for the grouping of related classes into a folder, the Components group various configuration entities into a folder in a similar waymanner. Those folders represent a unit that logically belong together (such as dashboard, groovy Groovy library, price list type, quote type, etc.).
...
Better structure the delivered functionalities by categorizing them into folders.
Deliver solutions more efficiently by reusing existing configuration packages.
Provide an overview of common implementations to solution architects.
Ideally, from now and on, all project deliverables should now be categorized using Components. Instead of throwing all entities in the root folder (which was the only way till until now), each entity should belong to a Component folder.
...
Right click on your project’s root folder.
Navigate to the Pricefx menu and click Create Component.
Enter the name of the Component you want to create and click Create.
The folder with the specified name is created within the .PfxComponents folder in your project. Also, the documentation template (README.md markdown file, Documentation folder, and the Screenshots subfolder) is created to help you to document the solution for publishing. If you don’t plan to publish the component, you can simply delete the README.md file and the Documentation folder.
Add a logic or any other entity to the Component.
When you have all the information about your new Component and you want to publish the Component in the Components Marketplace, complete the required information in the README.md file.
It should contain:Overview: Describe what the Component does from the end-user’s point of view. Consider adding a screenshot. Remember that this is the first section the user sees in the Marketplace.
Prerequisites: Requirements or conditions that should be met in order to use this Component.
How to adopt: Describe all steps that need to be followed just after importing to the local drive.
Dependencies: Specify all required dependencies on other components (typically libraries) or accelerators.
After you are done with the adoption, you can deploy the whole Component (or its part) to the desired partition.
...
Components Marketplace serves as a collaboration tool between among different teams (e.g., Demo Team, Project Teams, Industry Catalogue Team, Education Team, …) allowing enabling them to reuse the solutions that they have built.
...
Please vote every time you use the Component in real project or if the component did save you time. You will appraise the author and help to identify the most valuable components. See How to Give a Star.
PfxComponents allows you to filter desired Components using the Search field.
...
Name of the Component
Name of the Component in the Pricefx Gitlab repository (hyperlink)
Author
Date of the creation
Version: e.g. 0.1.0 – a draft (a concept only), 0.9.0 – almost ready to use, 1.0.0 and higher – ready to use in a real project
Contributor names
Topics (tags)
Tabs:
Overview – the The content of the component’s readme file README.md. See the Step 6 in the How to Create a Component in Studio above.
Provides – an An overview of all entities the Component provides. This content is auto-generated based on the inner folder structure.
Table Schema – if If the Component contains tables (for example, Data Sources, Company Parameters, Product Extensions tables, etc.), the generated Table Schema displays the structure of these tables.
What’s New – A version history. Retrieves information from CHANGELOG.md, if provided.
...
Select a Component from the List of Available Components.
Click the Import button in the Component Detail view.
The Component (including all files and sub-folders) is immediately imported to your local .PfxComponents folder.
Perform the instructions described in the How to adopt section (individual for each component).
Deploy the component to the partition, see: How to Deploy a Component.
How to Give a Star
| Info |
|---|
This functionality is right now limited only for to the configuration engineers and solution architects Configuration Engineers and Solution Architects having access to Pricefx Gitlab. |
...
Open the repository in Gitlab by clicking the hyperlink below the name.
Click the Star button.
...
How to Contribute to the
...
Marketplace
Right nowCurrently, contribution is only possible for internal stuff, only Pricefx staff can contribute; here is the guide: https://gitlab.pricefx.eu/components
If you are a partner or even a customer willing to contribute, please let us know, we definitely want to gather all useful stuff components to expand our platform.