Skip to main content Skip to complementary content
Announcements

Creating user routines

You can create your own routines according to your particular factorization needs.

Procedure

  1. If you need to create a global user routine, right-click Code > Global Routines and select Create routine from the contextual menu.
    You can create folders under the Global Routines node by right-clicking the node and selecting Create folder. The folders can help you organize global user routines.
  2. If you need to create an inner routine within a custom routine jar, right-click the custom routine jar under Code > Custom Routine Jars and select Create routine from the contextual menu.
  3. In the New routine dialog box displayed, fill in the generic properties for the new routine, such as Name, Purpose (optional), and Description (optional).
    The information you fill in the Description field will appear as a tooltip when your mouse pointer is moved over the routine in the Repository tree view.
  4. Click Finish.
    The newly created routine is saved in the Repository tree view. The routine editor opens to reveal a model routine which contains a function sample, by default, comprising descriptive text in blue, followed by the corresponding code.
    Information noteNote: We advise you to add detailed description for each function in the routine. The description should generally include the input and output parameters you would expect to use, as well as the results returned along with an example. This information tends to be useful for collaborative work and the maintenance of the routines.
  5. Modify or replace the function sample with your own code and press Ctrl+S to save the changes. Otherwise, the routine is saved automatically when you close the routine editor.
    Information noteNote: You can copy all or part of the code for a system routine and use it in a user routine by using the Ctrl+C and Ctrl+V commands, then adapt the code according to your needs.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here