Introduction to the Catalog
  • Contributors
  • PDF

Introduction to the Catalog

  • PDF

Article summary


        Xyicon Administrators

        Xyicon Users

Use this article to learn about the Catalog in Xyicon.

The Catalog in Xyicon is a useful tool for organizing and managing items within your Xyicon organization. It works as a set of templates that help you create and maintain consistent and structured items, known as xyicons.

The Catalog in Xyicon serves as a library of templates. These templates can be customized to fit your specific business needs. Each template, or catalog item, has its own set of properties and fields that you define when you create it. These fields hold common data that is shared across all Xyicons made from that template, ensuring everything stays uniform and organized.


Why is the Catalog Important?

The Catalog is important because it:

  • Saves time: By providing a set of standard templates, the Catalog reduces the time and effort needed to create and manage xyicons. You can quickly generate new instances with predefined properties and fields, making your workflow more efficient.

  • Ensures consistency: Using catalog items ensures that all xyicon instances follow the same standards and specifications. This consistency is crucial for maintaining data integrity and uniformity across your organization.

  • Allows customization: Even with standardization, the Catalog offers a high degree of customization. You can customize the catalog items with colors, images, and text to meet your unique business needs, making the system adaptable to various use cases.

  • Improves data management: With centralized templates and consistent data fields, managing and updating xyicons becomes easier. Changes made to a catalog item are applied to all associated xyicon instances, ensuring uniform updates.

  • Provides visual cues: Customizable icons and models offer a visual reference that enhances user experience and makes it easier to identify and manage different catalog items.


Key Features of Catalog

  • Type: The catalog Type defines different categories of items that your organization manages. Type gets inherited by the xyicons created from that specific catalog item. Xyicon Administrators can create a clear structure for each catalog item by assigning a unique set of Fields to every Type.

  • Fields: Fields represent the unique attributes or properties associated with a specific catalog Type. They enable users to capture detailed and specific information for each record. When a xyicon instance is created from a catalog item, it inherits the Fields defined in its originating catalog item, ensuring consistency and structure across all instances.

  • Model: The Model can be defined when creating a new catalog item under Item Properties in the Create Catalog Item wizard. This system field is used to track the specific model of a catalog item, and it is shared across all xyicon instances created from that catalog item. Additionally, Xyicon Administrators can allow Fields to be assigned to catalog Models, allowing for detailed customization and accurate data capture for each Model.

  • Icon: Each catalog item can have a visual Icon, which visually represents each catalog item, providing a quick reference. Within the Create Catalog Item wizard, you can select a model and customize it with colors and images. You have the option to choose from standard images, upload custom images, or search Google to create a custom Icon. Further customization options include adjusting the color, size, and adding text as needed.

  • Port template: The Port Template defines the ports of a catalog item and is inherited by xyicon instances created from that catalog item. This feature enables structured relationships by linking xyicons through ports rather than directly. Within the Create Catalog Item wizard, users can create single or multi-level port templates. Once created, these templates apply automatically to all xyicon instances derived from that catalog item, allowing for detailed relationships between xyicons.

    Port Templates provide structured relationships, enhancing clarity and manageability. This ensures consistency, as all xyicon instances inherit the same port structure. Additionally, these improve efficiency by simplifying the creation and management of connections using predefined templates.

  • Creating xyicon instances: You can create xyicon instances from catalog items through either the Xyicons module or the Space Editor. These instances inherit the fields and properties defined in the catalog item, ensuring consistency.


Relationship between Catalog and Xyicons

In Xyicon, catalog items and xyicons work together to help you manage your data effectively.

  • Catalog Items: Think of these as blueprints. They define the structure and properties of the data you need to organize. Catalog items provide the framework for categorizing everything you need to track.

  • Xyicons: These are the real-world instances created from the catalog items. They represent the actual assets or entities with all their unique details. While catalog items define what you are tracking, xyicons focus on the specific items or entities you are dealing with.

While the values in xyicon fields can differ across instances, the catalog fields remain the same for every xyicon created from a given catalog item. Any changes made to the catalog item propagate to all xyicon instances originating from that specific catalog item (e.g., the icon’s color or image). However, modifying a field within a xyicon only impacts that instance and does not affect the originating catalog item or other instances.

Without a Catalog, xyicons wouldn’t exist. This connection ensures that every xyicon is a dynamic representation of its corresponding catalog item, allowing you to visualize, manage, and track your data.


In summary, the Catalog module in Xyicon is a vital tool that enhances efficiency, consistency, and customization, making it an essential part of managing xyicons in your organization.


Was this article helpful?