OpenBOM™ is a registered Trademark of Newman Cloud, Inc. | © 2022
Best Practices for Administrators
Welcome aboard to the Best Practices User Manual for OpenBOM Administration! Get ready to embark on a journey of optimization and efficiency as we navigate through the ins and outs of OpenBOM administration. We’re here to simplify the complex, empower you with practical insights, and ignite your passion for driving organizational productivity. Let’s dive in and discover how OpenBOM can revolutionize your approach to administration.
Property table changes should be made by the Team administrator as they apply to all users in the Team.
Imagine the Property Table as a digital filing cabinet where we store all the important details about our products. Each piece of information, like a part number, description, material, or cost, has its own labeled drawer in this cabinet. It’s like having a neat and organized storage space for all our product-related data.
A property is a fundamental element in OpenBOM’s data modeling. You can create a property to represent a specific piece of information, like Description, Manufacturer Name, Cost, or Vendor. Once defined, this property can be used across various parts of OpenBOM, such as catalogs, Bills of Materials, Order BOMs, and Purchase Orders.
Properties also makes it super easy to find things quickly. Just like how you’d search for a book in a library using its title or author, properties help us locate specific parts or items in our product database. So, whether it’s finding a part’s supplier or checking its material, properties have got us covered.
To create a new property, follow these steps:
Note: In this instance, we’re referring to the new properties table as “For NPD”
Fig 1 – Create New Property Table
Fig 2 – Add New Property
Here’s a sample list of common properties or attributes along with descriptions for each type typically used in New Product Development (NPD) in the manufacturing industry as
These properties or attributes are essential for capturing various aspects of a product during its development lifecycle, ensuring comprehensive data management and analysis in the manufacturing industry’s NPD processes.
Some properties are predefined and reserved by default:
We highly recommend utilizing the public predefined properties to facilitate various functions.
If a property is already available in the system, you’ll encounter the following error message (as depicted in the image):
Fig 3 – Add Property Error
When adding a new property from Catalog and BOM tables, keep these points in mind:
Public vs. Private: You can create a property name in a Public section of the property definition, making the definition (not the value) available to everyone. You can promote standard properties and enhance data sharing among users. It’s perfectly fine not to use public properties. Whether you use public or private properties, your data remains private until you choose to share it.
For further guidance, refer to the data access administration documentation.
BOM templates play a crucial role in standardizing the structure and layout of Bill of Materials (BOMs). They serve as blueprints, outlining how BOM data is organized and presented. By using templates, users can create, view, and share BOMs consistently across different projects, ensuring clarity and efficiency in data management.
Creating BOMs is streamlined with templates, offering a predefined structure that saves time and ensures logical organization. By using consistent templates across projects, regardless of creators or project specifics, you maintain uniformity in BOM formatting and structure. This promotes efficiency and clarity, enabling NPD teams to focus on adding relevant project details rather than worrying about formatting.
Templates can be accessed conveniently from the Administration Menu within OpenBOM. This centralized location allows users to easily navigate and select the appropriate template for their project requirements.
Fig 4 – Accessing Template
OpenBOM offers two main types of templates:
These templates provide pre-defined structures for common BOMs. Whether it’s a simple assembly or a complex product configuration, standard templates offer ready-made frameworks to streamline BOM creation and management. The Standard Templates are owned by the System and cannot be edited.
Fig 4 – Default and Custom BOM Template
Custom templates are tailored to specific project needs. Users have the flexibility to design templates that align precisely with their unique requirements, incorporating custom fields, layouts, and workflows to optimize BOM management.
By leveraging templates, users can expedite BOM creation, ensure consistency in data presentation, and adapt seamlessly to varying project demands.
Creating BOM Templates: To create BOM templates, just use the “Save Template” command in the BOM interface. For details, check out our BOM Management documentation.
Manage the composition and roles of your team within OpenBOM. Administrators can add or remove team members, assign roles and permissions, and ensure that everyone has the appropriate access to data and features. Additionally, view concurrent sessions to monitor usage (1 of 5 in use).
Fig 5 – Team
As the Team Administrator, you play a crucial role in ensuring the smooth operation of user permissions and access levels within OpenBOM.
Fig 6 – Adding User and Providing Access
By following these steps, you can seamlessly add new users to your team while specifying their permissions and status for effective collaboration and access control.
Note: In this example, the table displays two users. One (uelan@neelsmartec.com) is identified as the Team Admin, while the other member (contact@neelsmartec.com) has been granted ‘edit’ permission, and their status is enabled.
Three options are available for managing users:
Use this option to notify a user via email after they have been added to the team. This ensures they are aware of their access to OpenBOM.
Fig 7 – Send Notification
Click on this option to edit user details such as name, email address, or permission level. Keeping user information up-to-date is important for accurate collaboration.
Fig 8 – Update User
If a user leaves the organization or no longer requires access to OpenBOM, use this option to remove their information from the platform. This helps maintain security and data integrity.
Fig 8 – Delete User
By right-clicking on a username, these options will appear, providing administrators with efficient tools for user management.
Customize company-wide settings and preferences. Access Company Settings to manage options like Google Authenticator for added security, and enable Change Management to control BOM Save Revisions through an approval process. Additionally, manage Company Catalogs to organize and maintain your company’s inventory efficiently.
Fig 9 – Company Menu
By enabling Multi-Factor Authentication (MFA) for all team or company members during sign-in, you add an extra layer of security to OpenBOM. MFA requires users to provide two or more verification factors to authenticate their identity, making it significantly more difficult for unauthorized users to access accounts.
Fig 10 – Enable Multi-Factor Authentication
For Company subscriptions, administrators have the option to enable Change Management. With this feature activated, revisions to BOM will undergo a controlled approval process. This ensures that any changes made to BOMs are carefully reviewed and approved before they are finalized. By implementing Change Management, your team can maintain consistency and accuracy in BOM revisions, ultimately enhancing collaboration and minimizing errors in your projects.
Fig 11 – Enable Change Management Process
Within the Company Catalogs feature, you can access and choose from a list of catalogs available within your organization. When selecting catalogs, OpenBOM automatically searches through the chosen catalogs for duplicate part numbers whenever new parts are added.
Note: In the example provided, two catalogs are selected: “Solidedge Items and Conveyor_Test.”
Fig 12 – Managing Company Catalogs
This functionality helps maintain data integrity by preventing the inadvertent creation of duplicate part numbers within your company’s catalogs. By carefully selecting and managing catalogs, you ensure a streamlined and organized inventory management process.
Customizing views and dashboards is a crucial aspect of effective data management and decision-making within OpenBOM. Administrators play a vital role in configuring and optimizing views and dashboards to meet the needs of their organization.
Views are like custom filters that help you see exactly what you need in your BOM and Catalog. They’re your personal magnifying glass, allowing you to focus on the details that matter most to the NPD team members. Whether you’re managing product data, collaborating with team members, or tracking the progress of your projects, views play a crucial role in organizing and presenting information effectively.
Fig 13 – Views Menu
In the realm of New Product Development, views act as your window into the intricate world of data management. They are like custom-made glasses that allow you to zoom in on specific details while blocking out distractions. By setting up views, you can navigate through complex data effortlessly, making it easier to find what you need without feeling overwhelmed.
Views give you the power to organize information in a way that makes sense to you, saving time and reducing errors. With views, you can collaborate more effectively, keep sensitive data secure, and make smarter decisions based on clear insights. In short, views are your trusted ally for staying organized and productive in your projects.
BOM views allow you to decide who gets to open the chest and see what’s inside. As an administrator, you can create different views for different teams or roles, ensuring that engineers only see engineering-related data, while procurement specialists only see procurement-related data. This helps maintain privacy and security while keeping everyone focused on their specific tasks.
Catalog views work in a similar way to BOM views, allowing you to control who can access which shelves. For example, you can create views that show only approved suppliers to purchasing agents, or restrict access to sensitive materials to only authorized personnel. This ensures that everyone has access to the information they need to do their job effectively, without compromising on security.
Create a view by following the below steps as
Navigate to the View section and click on “Create View”
Fig 14 – Create View
A window will open. Enter a name for your view.
Select the sources you need for your view. You can choose from Bill of Material, Catalog, or both, depending on your business requirements.
Note: In this example, the name is “manufacturing” and the source is “Bill of Materials”
Once you’ve configured your view, simply click on the “Save” button to save your settings.
If you do not need to proceed with creating the view, you can click on the “Cancel” button to exit without saving any changes.
Navigate to the view configuration menu under views
Fig 15 – View Configuration
Choose between “Edit Data” or “Read Only Data” for the view control
Fig 16 – View Configuration Steps
Choose either Public or Private properties to add to the view configuration
Select and apply desired properties from the Available Properties section to the View Configuration Properties table
Use the Clear Property List menu to remove all properties added to the view
Make the view available to all team members
Review the configured view and save any changes made
Three options are available for Created views, enabled by right-clicking
Fig 17 – Modify View Options
These options facilitate easy management and customization of views, ensuring users can efficiently control their view configurations. Customizing views is essential for maximizing the value of OpenBOM and optimizing your NPD processes. With the right views in place, you’ll have the clarity and control you need to drive success in your projects. Views are available both in the BOM and Catalog sources. To know more, visit BOM and Catalog Management documentation.
Effectively configuring and utilizing the Items dashboard for administration purposes is a crucial function in maximizing efficiency and productivity.
Maximize efficiency by optimizing the dashboard’s role and settings for administration. Customize data display and utilize filters for precise navigation. Integrating graph models enhances insights, aiding informed decision-making and fostering collaborative workflows.
Efficient dashboard usage is crucial, as it streamlines navigation, aids decision-making with real-time insights, optimizes workflows, fosters collaboration, ensures transparency, and drives strategic decision-making and innovation through advanced analytics.
Fig 18 – Configuration Settings
In addition to Dashboard filters, users can leverage other configuration options such as Part, Advanced Dashboard, and Items for more tailored filtering and data management.
Fig 19 – Additional Configuration Settings
Note: In this example, the keyword inputted is “stand,” and the result table displays the BOMs with the keyword “stand”
Fig 20 – Main Dashboard Filter
Fig 21 – Part Filter Option
Click ‘Open Filter’ to select a filtering option
You can choose to filter by selecting all catalogs or by making a specific choice
Fig 22 – Part Filter By Catalog
Additionally, refine your search by selecting specific properties’
Click on “Select Properties to Filter”
Window “Properties to Filter” opens
Select the required properties from the available properties and apply
Type in the details in this example property is “Created by” – Type in “Neel SMARTEC”
Result will be filtered accordingly
Fig 23 – Part Filter By Specific Properties
Fig 24 – Part Properties
Selecting the ‘Advanced Dashboard’ option will adjust the dashboard view accordingly
Note: By default, you will see the message ‘No results found that match this search. Try other search terms.’
The primary feature to utilize is the ‘Search’ box.
For example, typing in the keyword ‘Onshape’ will populate the results table with items related to ‘Onshape’
Fig 25 – Advanced Dashboard
In the result table, there are two options available:
Fig 26 – Options – Advanced Dashboard
Choose between Tiles View or Lists View for visualizing items
Fig 27 – Items – Table and Tile Views
Streamline navigation through items by using filtering options based on properties
Fig 28 – Items – Filter by Properties
Gain deeper insights into item relationships and associated BOMs by accessing features like “Where Used”
In this example, the item “Hex socket head cap screw M3x0.50 x 5” is selected, and the “Where Used” feature reveals its connections to “Tach Calibrator,” “Upper Case ASM,” and “Lower Case ASM.”
Utilize Filters: Take advantage of filtering options to quickly find the information you need. Use the search window and other filter configurations like Part, Advanced Dashboard, and Items to streamline navigation.
Fig 29 – Where Part Used
Note: “Open Visualization” lets you view the CAD structure in a neutral format. For more information, check out the BOM and Catalog Management section.
Tailor data visualization and analysis by Default (BOM), Default (Catalog), or by incorporating custom views such as Engineering View or Manufacturing View
Fig 30 – Item by Dashboard and Custom Views
User Defined Commands empower enterprises to streamline their workflow by creating tailored scripts using a simple visual interface. Whether you need to automate data validation, import/export processes, or generate custom reports, User Defined Commands are your go-to solution.
User Defined Commands enable users to create custom scripts without the need for extensive coding knowledge. Instead, you can leverage a straightforward visual interface to define the logic of your scripts. This empowers users of all skill levels to automate complex tasks effortlessly.
Let’s delve into an example to illustrate the concept of User Defined Commands further. Consider an HTTP Method, which is a list comprising POST, PUT, GET, and DELETE methods. This HTTP method comes into play when making a request to an external URL. But what exactly does this entail?
Let’s walk through a simple example to illustrate how you, as an OpenBOM administrator, can use HTTP methods to send Bill of Materials data from OpenBOM to a CSV file stored in Google Drive.
As an administrator, you’d create a User Defined Command in OpenBOM to facilitate this process. The command acts as your script, guiding how BOM data is transferred to the CSV file in Google Drive. By specifying the appropriate HTTP method and parameters, you ensure seamless data transfer between OpenBOM and the CSV file.
This refers to a web address outside of the OpenBOM platform where your script will interact with external systems or services.
These are fixed parameters appended to the URL to provide additional information to the external service. They remain constant throughout the script execution.
These parameters, such as BOM ID, Revision Number, and Email, are dynamically retrieved from the OpenBOM database and incorporated into the URL to tailor each request uniquely.
Similar to query parameters, these parameters, like BOM, Revision, and Email, are fetched from OpenBOM and included in the body of the HTTP request for further customization.
Fig 31 – Create User Defined Commands
For example, you could name it “Export BOM to CSV”.
In this case, select POST since you’re sending data to an external location.
For instance, if you’re sending data to a Google Sheet, provide the URL of the Google Sheet. Ensure to include any necessary static query parameters.
For example, you can include BOM ID, Revision Number, and Email as query parameters.
For instance, include the BOM parameter in the request body. This parameter will contain the actual BOM data to be exported to the CSV file.
Fig 32 – Define User Defined Commands
Fig 33 –User Defined Command Created
Once you’ve created your User Defined Command for exporting BOM data to a CSV file, here’s how you can access and execute it:
For example, in this instance, you’ll see the message “Export BOM to CSV Completed Successfully”
Fig 34 –Execute User Defined Command
Test Before Execution: Before executing a custom command, it’s a good practice to test it, especially if it involves critical data operations. This ensures that the command behaves as expected and avoids unintended consequences.
Custom objects allow you to create personalized data types, tailoring the data model precisely to meet specific needs. They provide flexibility in managing various types of information.
Fig 35 – OpenBOM Data Model with Custom Objects
Custom objects play a crucial role in empowering administrators to customize according to their organization’s business requirements. They facilitate the creation of specialized data structures, ensuring seamless data management across workflows. Moreover, custom objects streamline data organization and enhance processes, enabling users to efficiently manage unique datasets and improve productivity.
Go to Custom Object Menu
Click on “Create Custom Object”
Provide a descriptive name, e.g., “Metal Bracket Custom Object”
Click “Save” to confirm
“Custom Object Successfully Added” confirmation message will appear at the bottom right corner of the screen
Fig 36 – Create Custom Objects
Input details for the custom parts, e.g., “MB001.”
Click “Add Property”
Use “Object Reference” to link to other objects like CAD drawings or manufacturing specifications.
Fill in the required values.
Note: You can add properties in the same window or open a new one.
Fig 37 – Add Custom Part and Properties
Change Management Settings
The entire product management lifecycle in OpenBOM involves several key stages:
These stages ensure comprehensive and controlled management of your product lifecycle.
Fig 38 End to End Change Process
As an administrator, you can customize Change Management Settings in OpenBOM.
Fig 39 Change Management Settings
Fig 40. Change Order Number Setup
Fig 41. Change Order template
Leverage predefined properties like Part Number and Vendor to streamline functions and ensure consistency across records. These properties are designed to enhance collaboration and facilitate efficient data management.
Take advantage of custom views to focus on specific details in your BOM and Catalog. By creating tailored views, you can organize information effectively, save time, and reduce errors in your projects.
Enhance security in OpenBOM by enabling multi-factor authentication for all team or company members. This adds an extra layer of protection against unauthorized access to accounts.
Keep user permissions updated to reflect changes within your organization. Regularly review and adjust permission levels to ensure appropriate access control and collaboration efficiency.
Standardize BOM templates across projects to ensure consistency in data presentation and formatting. By using predefined templates, you save time and maintain uniformity in BOM structures.
Customize BOM templates to align with specific project requirements. Create templates tailored to your unique needs, incorporating custom fields, layouts, and workflows to optimize BOM management.
For company subscriptions, consider enabling change management to control BOM save revisions through an approval process. This ensures that any changes made to BOMs are carefully reviewed and approved before finalization, minimizing errors in projects.
Organize and maintain company catalogs efficiently to prevent the creation of duplicate part numbers. By carefully selecting and managing catalogs, you ensure a streamlined and organized inventory management process.
Adapt the best practices outlined in the manual to suit your unique needs and preferences. Continuously strive for excellence in everything you do to maximize efficiency, productivity, and success in your OpenBOM projects.
To configure property tables in OpenBOM, think of them as digital filing cabinets for your product data. Start by understanding the role of properties—they’re like labels that help describe your products. Creating new properties is easy: just follow the steps provided, like naming your property and choosing its type.
Predefined properties like Part Number, Vendor, and Quantity on Hand are essential for streamlined functions. They enhance collaboration, facilitate data management, and ensure consistency across records.
BOM templates act as blueprints, standardizing the structure and layout of your Bills of Materials. By using templates, you save time, maintain data integrity, and enhance collaboration by ensuring consistency in BOM formatting.
Yes, you can create custom templates tailored to your project needs. Whether it’s a simple assembly or a complex product configuration, custom templates allow you to design frameworks that align precisely with your requirements.
As a team administrator, you play a crucial role in managing user permissions. Follow the provided steps to add users, specify their permission levels, and ensure effective collaboration while maintaining data security.
Congratulations on completing the Best Practices Manual for OpenBOM Administration! By implementing the strategies and techniques outlined in this guide, you are well-equipped to maximize efficiency, productivity, and
success in your OpenBOM projects. Remember to adapt these best practices to suit your unique needs and preferences, and never stop striving for excellence in everything you do.
OpenBOM™ is a registered Trademark of Newman Cloud, Inc. | © 2022