OpenBOM™ is a registered Trademark of Newman Cloud, Inc. | © 2022
User-Defined Commands
In this article you will learn everything about how create a no-code user-defined commands
OpenBOM user-defined commands will allow you to easily define specific actionable commands in OpenBOM to be tailored to your needs. It will increase the ability of OpenBOM to connect information and processes.
Customization is an important aspect of software development as it allows users to tailor the application to their specific needs and preferences. With customization, users can make changes to the software’s appearance, functionality, and behavior to better align with their business processes, workflows, and objectives. This can improve productivity, streamline operations, and enhance the overall user experience.
Additionally, customization can also help organizations to providing unique and customized solutions that meet their specific requirements. It also allows for better scalability, as the software can evolve to adapt to the changing needs of the organization. Overall, customization is crucial for software to be effective and efficient, as well as meeting the specific needs of the organization and its users
With OpenBOM’s no-code custom commands, users can create custom scripts using a simple visual interface, which can be used to automate tasks such as data validation, data import/export, and custom reporting. These custom commands can be easily triggered by the user with a simple click, saving time and reducing the risk of errors.
Check the following video demonstrating how you can create a new user-defined command and connect it to a web service to pass data. For example, to create a user-defined command to pass BOM revision to the ERP system
Programming User Defined Commands
The following picture demonstrates. you the connection between user-define commands builder and OpenBOM user interface. (Note: at this point, user defined commands are only available in BOM object)
Here is the user-defined command editor:
User defined custom command includes
1. Name. This is your command name and this is how the button will be called.
If you set “BOM Command“ as a name, here is how the button will look like:
2. HTTP Method. This is a list with POST, PUT, GET, DELETE methods. This HTTP method will be used, when a request to an external URL is made.
3. URL. The external URL. It must include http:// | https://
4. Static query params. These are parameters, which will be sent as query parameters in the URL string. They are called static because these parameters are defined by the user. You can put any [key]: value data here. Let’s say, if your external API requires token, you can add static parameter here, with the name token and its value.
5. OpenBOM query parameters. Same as static parameters, these parameters are sent in URL string. The difference is that the value of the parameter comes from OpenBOM. Currently, there are no available options, but at some point, we can use there: bomId, catalogId, rowId, orderId, part number value etc.
6. OpenBOM body parameters. This is available only if HTTP method is POST or PUT. This is body for the request. Here you can pass the data from OpenBOM, such as BOM document, Revision, Catalog etc. You can pass there several options as [key]: value. Values are predefined. Currently, it has only BOM and Revision options.
If you set “BOM Command“ as a name, here is how the button will look like:
2. HTTP Method. This is a list with POST, PUT, GET, DELETE methods. This HTTP method will be used, when a request to an external URL is made.
3. URL. The external URL. It must include http:// | https://
4. Static query params. These are parameters, which will be sent as query parameters in the URL string. They are called static because these parameters are defined by the user. You can put any [key]: value data here. Let’s say, if your external API requires token, you can add static parameter here, with the name token and its value.
5. OpenBOM query parameters. Same as static parameters, these parameters are sent in URL string. The difference is that the value of the parameter comes from OpenBOM. Currently, there are no available options, but at some point, we can use there: bomId, catalogId, rowId, orderId, part number value etc.
6. OpenBOM body parameters. This is available only if HTTP method is POST or PUT. This is body for the request. Here you can pass the data from OpenBOM, such as BOM document, Revision, Catalog etc. You can pass there several options as [key]: value. Values are predefined. Currently, it has only BOM and Revision options.
User defined commands edits to modify commands:
1. Change the order of buttons in the BOM display
2. Edit existing command.
3. Delete command.
If you have any questions about user-defined tools to support at openbom dot com.