Know How Modeler Description & Customization |
Technical Article |
This article presents the Know How modeler, and explains how to customize it. |
This section first presents the objects representing the Know How modeler. Then it describes how this object model view has been translated towards PLM objects based on PLM Core Modeler objects. You will see the description of each PLM package defining these PLM objects.
The Know How modeler enables the definition of rules and checks. It also allows to model structures of those elements in rule sets.
This is summarized in the following UML schema:
![]() |
The Know How model is implemented with PLM Core Object as follows:
KnowHow is described through 5 modeler PLM packages :
The reason of the split in several packages is due to implementation constraints. Not for a particular objective.
Contains the definition of the rule reference (PLMRule) and its corresponding instance (PLMRuleInstance) |
Contains the definition of the check reference (PLMRule) and its corresponding instance (PLMRuleInstance) |
Contains the definition of the rule set reference (PLMRuleSet) and its corresponding instance (PLMRuleSetInstance) |
Contains the base class of rule sets, rules and checks. Both the reference (PLMGenericRuleBaseComponent) and the instance (PLMGenericRuleBaseComponentInstance) |
Contains the base class of rules and checks. Both the reference (PLMRuleBaseComponent) and the instance (PLMRuleBaseComponentInstance) |
<Insert a picture showing the PLM classes (using internal name) of the package; distinct the class to customize from the instantiable one.>
<Below the picture explains the relationship between the modeler's object and the PLM classes>
PLM Core Class | Specialized as | API name |
---|---|---|
PLMCoreReference | ExternalClassName1 | Classname1 |
PLMCoreInstance | ExternalClassName2 | Classname2 |
PLMCoreRepReference | ExternalClassName3 | Classname3 |
PLMCoreRepInstance | ExternalClassName4 | Classname4 |
PLMPort | ExternalClassName5 | Classname5 |
PLMConnection | ExternalClassName6 | Classname6 |
<Remove the useless lines; this table is useful to find the PLM Classes names through the Search ; Name inside picture are not usable for the Search... >
<if the package contains PLM extensions, describe them too; but do not list the extended PLM classes, except it it a public inform>
Refer to the modeler PLM package documentation [1] for a complete view of its contents included 3DXML support.
This section lists and describes the PLM Opening ID implemented by the following PLM classes of the Know How modeler.
PLM Opening ID | Script Contents |
---|---|
ID1 | script description per operation |
ID2 | script description per operation |
<Explanations:
Customization first deals with the modeler PLM package customization [2]. It consists in to create a new package containing new PLM classes for each "Customizable" PLM class of the modeler PLM package. Then, you should take into account the UI masks creation to create either a new security mask file, or to update the default one [3]. Finally, you can integrate your own business logic on each new PLM classes by implementing provided PLM opening ID [4].
This part consist in to create a new package when the modeler PLM package must be customized.
<if the modeler contains only one package remove the bullets; add an header4 title when the package must be customized>
PackageExternalName3 must be partially (or fully) customized.
PLM Class Name | To Be Customized | Remarks |
---|---|---|
ExternalNameClass1 | Yes / No | |
Class2 | Yes / No | |
Class3 | Yes / No | |
Class4 | Yes / No | |
Class5 | Yes / No | |
Class6 | Yes / No |
<Remove the useless lines - Choose Yes or No - Remarks column specifies all deviations from the generic customization process- if any deviation remove the column>
When a PLM attribute is defined (inside modeler PLM package) some features like its editability criteria, mandatory /optional option, can be overwritten by UI mask. You can say this PLM attribute is not writable in Query context, this PLM attribute is mandatory in Create context, this user PLM attribute is not never visible and so one. A set of UI masks form a security mask file. We say security mask because it is associated with these files security information. For a people, and a given context can be associated a security mask.
<if your modeler contains at least one package to customize add these sentences:
For each customized Modeler PLM package, at least one UI mask file must be created (for the default security mask ), since it must contain the new PLM Attributes. When you use the tool to create a customization, a default UI mask file is provided taken into account the added PLM attributes. You can modify the default file to introduce your change.>
< in all cases add the following sentence>
If you want create a new security mask file, you should provide a UI mask for all the "AsIs" modeler PLM packages and for each customization of the "Customizable" modeler PLM package.
No specific rule to customize UI mask file.
<or> To create a UI mask you should respect the following rules :
<here list the specific rules; add bullet if the rules are package specific>
You can yourself integrate your business logic for each customization of:
PLM Opening ID | Remarks |
---|---|
ID1 | |
ID2 |
<IDx : name of the PLM OpeningID : The ones of INFRA + the ones provided by this modeler ; add a link to the article describing how to implement it : CAABusinessLogicInfra.doc for INFRA ; CAABusinessLogicPLMModeler.doc for modeler >
<if the modeler only contains AsIs package, replace the lines just above, by the sentence "No customization is possible">
[1] | PackageExternalName1 |
[2] | Modeler PLM Package Concepts and Customization Principles |
[3] | UI Mask Concepts and Customization Principles |
[4] | Business Logic Concepts and Customization Principles |
<Each package name in the reference table is an external name, but the links refer to a file whose the name is build with the package's internal name >
Version: 1 [Oct 2008] | Document created |