Custom Objects

In order to manage an ever growing array of objects in Oomnitza, and provide an even greater degree of control over your Oomnitza instance, Oomnitza supports the creation of Custom Objects to manage structured data of any type. Custom Objects live alongside other Objects in Oomnitza, like Assets, Users, and Software, and can be built from the ground up to support your use cases. 

Contents

  1. What is a Custom Object?
  2. Creating Custom Objects
    1. Creating the Custom Object
    2. Customizing the Custom Object
    3. Creating Custom Object Records
  3. Custom Object APIs
  4. Dynamic Dropdowns
  5. Paired Fields

What is a Custom Object?

Oomnitza, at its core, manages objects. Assets in Oomnitza are objects. Users are objects. Software are objects. Contracts are objects.

Custom Objects allow you to manage everything else. From Departments and Cost Centers to Computer Parts and SLAs. Custom Objects provide a place to store other robust pieces of information in a way that can be referenced within other modules in Oomnitza to create complex relationships between objects, and provide a more organized and robust alternatives to dropdown menus. 

mceclip1.png

Creating Custom Objects

Custom Objects are managed through the Oomnitza Settings page, from the Custom Objects Menu. This will take you to a list of all custom objects, or let you select an individual Custom Object Module, in order to create or customize objects of that type.

mceclip0.png

Creating the Custom Object

To create a Custom Object, navigate to the All Custom Objects page, and click the + button in the upper right. You'll then be prompted to name your Custom Object, optionally give it a description, then specify Stand Alone Object or Lookup Object.

Stand Alone Object: Similar to Assets, records created in Standalone Custom Objects represent individual items that don't need to be referenced in other objects or modules.

Lookup Object: Lookup objects act more like Users or Locations, providing the opportunity to add them as a custom lookup on other objects, allowing for relationality.

Typically, you'll want to select Lookup Object, because these can be associated to other objects in your Oomnitza system. 

Once you've given your Custom Object a name and selected an Object type, you can click Save in the lower right, and your new Custom Object will be created. 

Customizing the Custom Object

Once it has been created the information stored in a Custom Object need to be specified by customizing the Custom Object. To do this, select the Custom Objects dropdown from the settings page, and select the Object you wish to customize from the list. 

From here, you'll be taken to a page that resembles the List View in other modules. From this page, you can create individual records within your custom objects. To customize this object, click the "Customization" button in the upper right. 

This will take you to the Customization page for that custom object. From here, you can add new fields using the + button in the upper right.

  • Short Text - Allows the user to enter text up to 256 characters.
  • Long Text - Allows the user to enter text up to 1024 characters.
  • Numeric - Allows for entry of integers up to 20 digits.
  • Decimal - Allows for entry of decimals.
  • Date - Allows for entry of dates, gives a date box when clicked.
  • Checkbox - Allows for a checkbox or boolean field.
  • Users List - Provides a list of users.
  • Location - Provides a list of locations.
  • Custom Object Lookups - Additionally, any "Lookup" type custom objects that you've created can be created as a custom field to allow you to look up that variety of object. These fields are identified by the name of the custom object.

Creating Custom Object Records

Once you've customized your objects to your liking, you can create individual records within that object. These represent the actual instances of your custom object. For example, a record with a Cost Center Custom Object would represent an individual Cost Center.

To create a record, navigate back to the Custom Object list page by clicking the + button in the upper right. You'll then be prompted to define that object using the Custom Fields that you've created. 

Custom Object APIs

To ensure a full range of flexibility, Custom Objects in Oomnitza also include an API for each object, allowing for a wide degree of manipulation of your objects. The following endpoints allow you to respectively access:

  • All Custom Objects
  • Individual Custom Objects
  • All Records for a specific Custom Object
  • Details for a specific Record
https://{instance}.oomnitza.com/api/v3/custom_objects/

https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/

https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/records

https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/records/{custom_object_record_id}

Additionally, the /api/v3/custom_objects/ and /api/v3/custom_objects/{custom_object_id}/records endpoints both support Oomnitza's custom filters, as seen below:

https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/records?filter={field_id} eq '{search_term}'

If you have any questions or need assistance with Oomnitza's Custom Objects API, please feel free to reach out to api_support@oomnitza.com.

Dynamic Dropdowns

Custom Objects also give the powerful ability to create Dynamic Dropdown fields that provide different choices depending on the value set in another field.

Creating the Custom Objects

To create a dynamic dropdown, you'll need two Lookup-type Custom Objects, and one of the Custom Objects needs to have the second Custom Object available as a custom lookup field. Below, we can see an example using Department and Cost Center:

Custom Object 1 will define how the options in the Dynamic Dropdown are determined:

mceclip0.png

Custom Object 2 will be used to define the fields available dynamic dropdown itself.

mceclip2.png

Once your Custom Objects have been successfully created, you'll need to create records in each field. For Fi In the examples above, we have three departments, and six cost centers associated with those cost centers. With the above configuration, we'll be able to configure our Assets so that, when the department is set on the Asset, you'll only be able to select Cost Centers with that Department. 

Creating the Dynamic Dropdown

Now that your custom objects have been created, you're reach to configure the Dynamic Dropdown itself. From the customization page of the Module of your choice (e.g. Assets, Users) click the add button, and create a field for your first Custom Object, selecting the custom object you just created as the data type.

Note: On the Display option page for this field, you should select "Regular."

mceclip3.png

With that created, click add again to create your second Custom Object. This time, select the second Custom Object you created and in the Display Option page and set the Display Option to Filtered Dropdown.  You'll then be prompted to define the field type of the option you wish to filter off of, then select the field name that will be used to determine which fields appear in your filtered dropdown.

mceclip4.png

Once those have been set, your filtered dropdown will have been created.

Paired Fields

Custom Objects also allow for the creation of paired fields, which provide users with the ability to create custom fields that describe other fields, such as units for measurements or denominations for currencies. 

mceclip0.png

Creating a Paired Field

In order to create a paired field, you must first create a lookup custom object that defines the field you wish to create, and populate it with the options would like in your paired dropdown, for example a Units field with kg and lbs as options.

mceclip1.png

Once you've created your custom object and options, navigate to the module you wish to create the paired field in, and select customization. From the customization screen, create your field, for example "Weight" with the desired parameters (such as data type, uniqueness, etc), and save. This field should NOT use the custom object type you created above, as it will serve as the "Base Field," where you enter data.

Once you've saved your base field, create a new field, and when setting a data type, select the previously created Custom Object Type (e.g. "Units). With that selected, navigate to the Display Option tab of the customization page, select "Paired Fields" as the display option, and select the previously created base field as the available field for pairing. 

mceclip2.png

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk