About User-Defined Open and Explore Procedures

Procedures and Primitives

When launching User-Defined Open or User-Defined Explore, you must select a procedure according to the type of completion and opening or exploration you need.

A User-Defined Open procedure uses Javascript. It consists of several steps. At each step, the provided Javascript APIs (known as primitives) are used to, among other actions, expand, navigate, filter PPR objects to finally identify the data that must be opened in the authoring session.

A User-Defined Explore procedure is similar to a User-Defined Open procedure, except that it explores the retrieved PPR objects instead of opening them at the end.

Manufacturing Context Builder provides sample procedures that you can find on the Available Procedures page. You can, however, customize them to better fit your needs or create your own procedures.

For more information, see User-Defined Open and User-Defined Explore Procedures.

Input

As input, all primitives require at least a Navigation Set, and can take an optional Completion Context.

Navigation Set

A Navigation Set contains navigation data for a single modeler.

It represents a set of objects occurrences and connections between objects, such as implement links or fasteners connections.

Completion Context

A Completion Context holds an internal state to navigate through object structures, that is, retrieve objects through connections.

It contains the configuration or volume filter information for each modeler and all required information to make queries in the database.

Header Section

This part of the procedure contains a declaration of the types of Navigation Sets that are used and shared with the command to open data in an authoring session, and a declaration of the classes where primitives and auxiliary instructions are used.

Types of Navigation Sets

The following types are recognized in the primitives and need to be considered as keywords:

PRD for Products
PRCS for MBOM objects
WK_PL for Workplans and Operations
PROD_SYS for General Systems and Operations
RSC for Resources

CPBL_RSC for Capable Resource References

Important:

Even if the CPBL_RSC type contains resources, it is considered as completely different from the RSC type.
Therefore, resources retrieved from the getCapableRescLinkFromProcess primitive and considered as capable resources cannot be merged in the existing resource Navigation Set (RSC). They can be merged only in the capable resource Navigation Set (CPBL_RSC) and vice versa.
The CPBL_RSC type is only used by the getCapableRescLinkFromProcess primitive.

The following types contain the selected occurrences, depending on the procedure:

SEL_PRD
SEL_PRCS
SEL_WK_PL
SEL_PROD_SYS
SEL_RSC
SEL_CPBL_RSC

Classes for Primitives and Instructions

The primitive classes are the following:

var ExpandPrimitives = Java.type ("com.dassault_systemes.completion.service.ExpandPrimitives");
var ExpandFrom3DIndexPrimitives = Java.type ("com.dassault_systemes.pprcompletion.primitives.DELPPRContext3DPrimitive");
var NavigationPrimitives = Java.type ("com.dassault_systemes.completion.service.NavigationPrimitives");
var FilterServices = Java.type ("com.dassault_systemes.completion.service.FilterServices");

Example of Header Section

// JavaScript source code
var params = proc.declareParameters ([{name: "PRD", type: "NavigationSet"},
                                      {name: "PRCS", type: "NavigationSet"},
                                      {name: "PROD_SYS", type: "NavigationSet"},
                                      {name: "WK_PL", type: "NavigationSet"},
                                      {name: "RSC", type: "NavigationSet"},
                                      {name: "CPBL_RSC", type: "NavigationSet"},
                                      {name: "SEL_WK_PL", type: "NavigationSet"},],
                                      {name: "ConfigurationsVal", type: "Filters"}]);

var ExpandPrimitives = Java.type ("com.dassault_systemes.completion.service.ExpandPrimitives");
var ExpandFrom3DIndexPrimitives = Java.type ("com.dassault_systemes.pprcompletion.primitives.DELPPRContext3DPrimitive");
var NavigationPrimitives = Java.type ("com.dassault_systemes.completion.service.NavigationPrimitives");
var FilterServices = Java.type ("com.dassault_systemes.completion.service.FilterServices");

var navSets = [PRD, PRCS, PROD_SYS, WK_PL, RSC, CPBL_RSC];

Note:

The proc.declareParameters statement contains two blocks in square brackets.

The first block contains the following mandatory parameters:

[{name: "PRD", type: "NavigationSet"},
{name: "PRCS", type: "NavigationSet"},
{name: "PROD_SYS", type: "NavigationSet"},
{name: "WK_PL", type: "NavigationSet"},
{name: "RSC", type: "NavigationSet"},
{name: "CPBL_RSC", type: "NavigationSet"},
{name: "SEL_WK_PL", type: "NavigationSet"},]

Important: You must declare all parameters in this block.

The second block contains the following parameter:

{name: "ConfigurationsVal", type: "Filters"}: Required when using the configuration and volume sections of the filters in the procedure.

Important: Volume sections of the filters are taken into account only by the following Primitives: I3DexpandEBOM and I3DRetrieveContext.

var navSets = [PRD, PRCS, PROD_SYS, WK_PL, RSC, CPBL_RSC];: Indicates which types of Navigation Sets will be populated in the procedure and opened or explored. Depending on the procedure, this list may contain fewer types.
Recommendation:
Define all types of Navigation Sets:
- If the procedure needs to evolve to complete other structures. Otherwise, you may need to modify this declaration.
- If the spreadsheet contains structures other than those modified by the procedure before running the PPR User Defined Open or PPR User Defined Explore command. Otherwise, the structures will not be opened or explored if they are not defined in the list.

Body Section

This part of the procedure contains the sequence of instructions using the primitives.

End Section

This part of the procedure contains instructions that provide the Navigation Sets containing the lists of entities to be opened in an authoring session for the different types of PPR data.

outputData.add ("Product", PRD);
outputData.add ("Process", PRCS);
outputData.add ("System", PROD_SYS);
outputData.add ("WorkPlan", WK_PL);
outputData.add ("Resource", RSC);
outputData.add ("Capable Resource", CPBL_RSC);

Note: Instructions in the End Section must remain consistent with the declarations made in the Header Section.

Minimum Procedure Content

The minimum procedure content must be as follows:

// JavaScript source code
var params = proc.declareParameters ([{name: "PRD", type: "NavigationSet"},
                                      {name: "PRCS", type: "NavigationSet"},
                                      {name: "PROD_SYS", type: "NavigationSet"},
                                      {name: "WK_PL", type: "NavigationSet"},
                                      {name: "RSC", type: "NavigationSet"},
                                      {name: "CPBL_RSC", type: "NavigationSet"},
                                      {name: "SEL_WK_PL", type: "NavigationSet"},],
                                     [{ name: "ConfigurationsVal", type: "Filters" }]);

var ExpandPrimitives = Java.type ("com.dassault_systemes.completion.service.ExpandPrimitives");
var ExpandFrom3DIndexPrimitives = Java.type ("com.dassault_systemes.pprcompletion.primitives.DELPPRContext3DPrimitive");
var NavigationPrimitives = Java.type ("com.dassault_systemes.completion.service.NavigationPrimitives");
var FilterServices = Java.type ("com.dassault_systemes.completion.service.FilterServices");

var navSets = [PRD, PRCS, PROD_SYS, WK_PL, RSC, CPBL_RSC];

mql.startTransaction (false);

CompletionProcedure.runFunction (ConfigurationsVal, navSets, function (context, outputData) 
{
   ……
   // Sequence of instructions using primitives
   ……
           
   outputData.add ("Product", PRD);
   outputData.add ("Process", PRCS);
   outputData.add ("System", PROD_SYS);
   outputData.add ("WorkPlan", WK_PL);
   outputData.add ("Resource", RSC);
   outputData.add ("Capable Resource", CPBL_RSC);
});
mql.abortTransaction ();