UDO - 3 - File Structure description

ThoughtWorthSharing ​​​​​​​HowTo ​​​​​​​

This article, as part of the serie of article about UDO​​​​​​​, will describe each part of the UDO Procedure file that should be deployed to the server for a new UDO.

Note: this manual way of creating a new UDO (javascript file) is On-Premise only

A. File structure

​​​​​​​
​​​​​​​

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.

It contains 3 main elements:

1. Parameters used in the Body:

a. Navigation Sets declaration: sets of objects categorized by type

  • 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 (different from RSC, cannot be mixed)

​​​​​​​b. Selected occurrence’s navigation set: set of objects the user will select when starting the prodedure

  • SEL_PRD” : for selected EBOM objects
  • SEL_PRCS” : for selected MBOM objects
  • SEL_WK_PL” : for selected Worplans/Operations
  • SEL_PROD_SYS” : for selected General Systems/Operations
  • SEL_RSC” : for selected resources
  • SEL_CPBL_RSC” : for selected Capable resources

​​​​​​​​​​​​​​c. Filter declaration: when using configuration and volume filters

  • "ConfigurationsVal" : type “filter”

2. Class for Primitives: classes that will be used in the Body for navigating/expanding/manipulating the Navigation Set

  • ExpandPrimitives: to expand nodes of an object structure
  • ExpandFrom3DIndexPrimitives: to expand nodes of an object structure based on 3D index information (expand with a 3D volume filter for example)
  • NavigationPrimitives: to navigate in the PPR through the different links
  • AdvancePrimitives: to use advance functions (create 3D Filter and get first upper scope of an EBOM)
  • FilterServices: to filter or remove objects from Navigation Sets

3. NavSets

Indicates which types of Navigation Sets will be populated in the procedure and opened or explored.

Body Section

It contains 2 main elements:

  1. Instructions : Contains the sequences of instructions using the primitives. The primitives will be explained in the next chapter of this document.
  2. Output: end section which defines what which Navigation Set will be opened/explored
  • Important: Instructions in the End Section must remain consistent with the declarations made in the Header Section.