Components

Learn how to create and use components in AssetOS to build reusable elements and complex asset structures.

Overview

Components are reusable building blocks in AssetOS that help you create consistent, structured content. Think of them as templates that can be used across multiple assets to maintain consistency and reduce repetitive work.

Understanding Components

What are Components?

Components are:

• Reusable Elements: Create once, use many times
• Structured Data: Organized information with defined properties
• Consistent Format: Same structure across all instances
• Flexible: Can be customized for different use cases

Why Use Components?

Components help you:

• Save Time: Create templates instead of starting from scratch
• Maintain Consistency: Ensure all similar items have the same structure
• Reduce Errors: Standardized format reduces mistakes
• Scale Efficiently: Easily manage large amounts of similar content

Creating Components

Basic Component Creation

1. Navigate to Components: Click "Components" in the left sidebar
2. Create New: Click "Create New Component"
3. Choose Type: Select the component type you want to create
4. Basic Information:
   • Name: Give your component a descriptive name
   • Description: Explain what this component represents
   • Category: Choose an appropriate category
5. Save: Click "Save" to create the component

Adding Properties

After creating the basic component, add the specific information:

1. Edit Component: Click on your new component to edit it
2. Fill Properties: Enter the relevant information in each field
3. Add Details: Include all necessary data for this component
4. Save: Click "Save" to update the component

Component Types

AssetOS supports various component types:

Type	Description	Example
Product	Product information	Name, price, description, specifications
Person	Contact information	Name, email, phone, role
Location	Address details	Street, city, country, coordinates
Event	Event information	Title, date, location, description
Document	Document metadata	Title, author, version, category

Managing Components

Viewing Components

1. Components List: See all your components in a grid or list view
2. Search: Use the search bar to find specific components
3. Filter: Filter by component type, category, or status
4. Sort: Sort by name, creation date, or last modified

Editing Components

1. Select Component: Click on the component you want to edit
2. Edit Mode: Click "Edit" or the pencil icon
3. Update Information: Change any of the component properties
4. Save: Click "Save" to update the component

Duplicating Components

To create a similar component:

1. Select Component: Click on the component to duplicate
2. Duplicate: Click "Duplicate" or the copy icon
3. Modify: Change the name and adjust properties as needed
4. Save: Create the new component

Deleting Components

If you no longer need a component:

1. Select Component: Click on the component
2. Delete: Click "Delete" in the settings
3. Confirm: Confirm the deletion

Note: Deleting a component will remove it from all assets that use it.

Using Components in Assets

Adding Components to Assets

1. Open Asset: Click on the asset you want to add components to
2. Components Section: Go to the "Components" tab
3. Add Component: Click "Add Component"
4. Select Component: Choose from your existing components
5. Configure: Set up how the component relates to the asset
6. Save: The component is now linked to the asset

Component Relationships

Components can be connected to assets in different ways:

• Primary: Main component for the asset
• Related: Connected but not primary
• Part Of: Component is part of the asset
• Reference: Component references the asset

Managing Component Links

1. View Links: See all components linked to an asset
2. Edit Relationships: Change how components relate to assets
3. Remove Links: Disconnect components from assets
4. Add New: Link additional components

Component Templates

Creating Templates

Templates help you create components quickly:

1. Template Creation: Create a component with common properties
2. Save as Template: Mark it as a template
3. Share: Make it available to your team
4. Use: Create new components from the template

Using Templates

1. Select Template: Choose a template to start with
2. Customize: Modify the properties for your specific needs
3. Save: Create your new component

Template Management

• Organize: Group related templates together
• Update: Keep templates current with best practices
• Archive: Remove outdated templates
• Share: Distribute templates across your organization

Bulk Operations

Bulk Component Creation

Create multiple components at once:

1. Bulk Upload: Click "Bulk Upload" in the Components section
2. Prepare File: Create a spreadsheet with component data
3. Upload: Upload the file to AssetOS
4. Review: Check the preview of components to be created
5. Confirm: Create all components at once

Bulk Component Updates

Update multiple components:

1. Select Components: Choose the components to update
2. Bulk Edit: Click "Bulk Edit"
3. Make Changes: Update properties for all selected components
4. Apply: Save changes to all components

Import/Export

• Export: Download component data for backup or analysis
• Import: Bring in components from other systems
• Format: Use CSV or Excel files for data transfer
• Validation: Check data before importing

Best Practices

Component Design

• Clear Purpose: Each component should have a specific purpose
• Consistent Structure: Use similar properties across related components
• Appropriate Detail: Include enough information without being overwhelming
• Logical Organization: Group related properties together

Naming Conventions

• Descriptive Names: Use names that clearly identify the component
• Consistent Format: Follow a consistent naming pattern
• Avoid Duplicates: Ensure names are unique within your system
• Consider Search: Use terms that will help with finding components

Data Quality

• Complete Information: Fill in all relevant properties
• Accurate Data: Ensure information is current and correct
• Consistent Format: Use consistent formats for dates, numbers, etc.
• Regular Updates: Keep component information current

Organization

• Logical Categories: Group components by type or purpose
• Clear Relationships: Define how components relate to each other
• Efficient Workflow: Design components to support your work processes
• Scalable Structure: Plan for growth and changes

Advanced Features

Component Versioning

Track changes to components:

1. Version History: See all previous versions of a component
2. Compare Versions: Compare different versions side by side
3. Revert Changes: Go back to a previous version if needed
4. Change Tracking: See who made changes and when

Component Analytics

Understand how components are used:

• Usage Statistics: See how often components are used
• Popular Components: Identify most frequently used components
• Trend Analysis: Track usage patterns over time
• Performance Metrics: Monitor component effectiveness

Component Workflows

Automate component processes:

• Approval Workflows: Require approval for component changes
• Review Processes: Set up review cycles for component updates
• Publishing: Control when components are available for use
• Archiving: Automatically archive outdated components

Troubleshooting

Common Issues

Can't Create Component

• Check if you have the necessary permissions
• Ensure the component type is available
• Verify all required fields are filled

Components Not Appearing

• Check if components are active
• Verify search and filter settings
• Look for permission issues

Bulk Upload Errors

• Check file format and structure
• Verify data validation rules
• Ensure all required fields are included

Component Links Broken

• Check if components were deleted
• Verify relationship settings
• Look for permission changes

Getting Help

• In-App Help: Click the help icon (?) for context-sensitive help
• Documentation: Refer to this user guide
• Support: Contact support for technical issues
• Training: Request training on component management

Next Steps

Now that you understand components:

1. Create Your First Component: Start with a simple component type
2. Build Templates: Create templates for common use cases
3. Link to Assets: Connect components to your assets
4. Explore Advanced Features: Learn about versioning and analytics