Search

Managing Assets/Data Objects

Fundamentals

See all articles
Control Lists: How to Standardize Data Efficiently

Overview

When creating asset types in ReadyWorks, it's important to identify and utilize control lists effectively. Control lists are essentially standardized, predefined sets of values that you can assign to specific fields within your asset records. They help maintain data consistency, prevent errors, and make it easier to report on and automate processes related to your assets.

Example

Imagine you're setting up an asset type called "Computer" to track all the workstations in your organization. As you define the various fields you want to include (like computer name, serial number, purchase date, etc.), you'll likely come across some fields where you want users to select from a standard set of options rather than entering free-form text.

For example, you might have a field called "Operating System" to indicate which OS is running on each computer. Without a control list, users could enter values like "Windows 10," "Win10," "Microsoft Windows 10," etc. This inconsistency would make it harder to report on OS versions later and could introduce errors.

Instead, you'd create a control list asset type called "Operating System" and predefine the allowable values, like "Windows 10," "macOS Catalina," "Ubuntu 20.04," etc. Then, in your "Computer" asset type, you'd add a lookup field that references the "Operating System" control list. This way, when users are creating or editing computer records, they'll be able to select the OS from a dropdown list of approved values, ensuring consistency.

You might set up similar control lists for fields like:

  • Computer Status (e.g., "In Use," "In Stock," "Decommissioned")
  • Computer Type (e.g., "Desktop," "Laptop," "Tablet")
  • Department (e.g., "Sales," "Marketing," "Engineering")
  • Location (e.g., "New York Office," "London Office," "Remote")

By using control lists for these types of fields, you make the data input process clearer and more error-proof for your end-users. They don't have to remember the "right" way to enter values; they just select from the predefined options.

Benefits

On the back end, control lists give you a solid foundation for reporting, automation, and integration. You can easily filter and group records by these standardized values, set up rules and workflows based on them, and sync them with other systems without worrying about inconsistent or invalid data.

The key is to identify fields where consistency is important and where there's a finite set of allowable values that aren't likely to change often. You don't want to overuse control lists to the point where they become restrictive or hard to maintain, but judiciously applied, they're a powerful tool for data governance and usability.

Considerations

When you're designing your asset types, think carefully about each field and ask yourself:

  • Is this a field where users should be able to enter any value, or should we limit it to a predefined set of options?
  • Are there existing lists or categories we can use to populate the control list (e.g., department names from HR, standard computer models from IT)?
  • How often are the allowable values likely to change, and what's the process for updating the control list when needed?

By working through these questions and using control lists appropriately, you can create asset types that are intuitive for your users, reliable for reporting and automation, and adaptable to your organization's evolving needs. It's all about striking the right balance between standardization and flexibility, which is key to an efficient, effective asset management system.

See more
Auto Creation of Lookup Values in ReadyWorks
 

In ReadyWorks, lookup values can be automatically generated and populated through data mappings and asset management processes. This functionality is crucial when dealing with large sets of dynamic data, such as location lists, IP addresses, or device attributes. By automating the creation of these lookup values, ReadyWorks simplifies data integration and enables efficient filtering and reporting.


Steps for Auto-Creation of Lookup Values:

  1. Data Mapping to a Lookup Field:

    • In ReadyWorks, when data is mapped to an asset table with lookup fields (e.g., location, IP address), the system can automatically create new entries for lookup values if they do not already exist. This process ensures that each value in the source data has a corresponding entry in the target lookup table.
    • As you define your data mapping, you can map source data fields directly to lookup fields in the target asset type. ReadyWorks will add new values to these lists as part of the mapping process.

    Example: If you map a field such as “Location” from your source data to the “Location” list in ReadyWorks, new location records will be automatically created in the lookup table if they do not already exist.

  2. Enable Auto-Creation:

    • During the data mapping setup, ensure that the configuration allows for the automatic addition of new records. This can typically be toggled when defining the mapping properties. You can set it to automatically add new lookup values as they are encountered in the incoming data.

    Steps:

    • Go to Admin > Configuration > Data Mapping.
    • In your data mapping task, select the field that needs to be mapped to a lookup list.
    • Make sure that the option to “Auto-create new records” (or similar toggle) is enabled to allow ReadyWorks to generate new lookup values.
  3. Data Mapping Execution:

    • Once the data mapping is configured, you can execute the job to start importing data. During this process, ReadyWorks will check if the mapped values exist in the lookup list. If they do not, it will automatically add the new entries.
    • After the data mapping completes, you can verify the newly created lookup values by reviewing the corresponding list under Admin > Configuration > Lists.
  4. Avoiding Duplicates:

    • ReadyWorks uses a unique identification mechanism to prevent the creation of duplicate entries within lookup lists. This ensures that if the same value (e.g., a location or IP address) appears multiple times in the source data, it will only be added once to the lookup list, even if referenced by multiple records.

    Note: You can run a test data mapping with sample data to confirm that no duplicate entries are created in the lookup list.


Best Practices:

  • Testing Data Mapping:
    Before running data mappings on large datasets, it is advisable to run a test job using a subset of your data. This allows you to verify the behavior of auto-creating lookup values and to ensure that there are no unexpected duplicates or errors.

  • Regular Data Mapping Schedules:
    Set up scheduled data mapping jobs (via Cron jobs) to keep your lookup lists updated with the latest data from your source systems. This ensures that lookup fields, such as locations, are always current without manual intervention.

  • Reviewing and Maintaining Lookup Lists:
    Regularly review lookup lists to ensure data integrity. While ReadyWorks prevents duplicates, it’s important to periodically validate that the lists contain all necessary and valid entries to support reporting and other workflows.


Example Scenario:

You are tasked with integrating location data from an external signage system. In the source system, locations are recorded as text strings. By setting up a data mapping job to map these locations to the “Location” lookup field in ReadyWorks, you can automatically generate new location entries. If the data mapping encounters a new location, it will create a corresponding entry in the Location list, which can later be used for filtering and reporting.

Tips and Tricks:
“Whenever you write values to a list, the data mapping will automatically add new records to the list as needed.”


Troubleshooting:

  • If lookup values are not being created as expected, verify that the data mapping configuration allows for the creation of new records.
  • Review the execution logs of the data mapping job to ensure it completed successfully and processed the new data.
  • Ensure that the source data is correctly formatted and that the mapped field corresponds to the correct lookup field in the target asset type.

By automating the creation of lookup values, ReadyWorks streamlines the process of managing large, dynamic datasets, enabling faster workflows and more accurate reporting.

See more

Permissions

See all articles
Restricting Data Access: Understanding Permissions

Introduction:

This document outlines the process of implementing user-based asset visibility controls in ReadyWorks, specifically focusing on creating security groups to restrict user access to specific assets and data within the platform. This feature is particularly useful for organizations looking to implement granular access controls based on user roles or departments, such as limiting users to only view assets that are relevant to their role and/or organization within your company.

 

Key Features:

  1. Security Group Creation: Ability to create and configure security groups with specific asset and user visibility settings.
  2. User-Asset Association: Capability to associate users with specific assets or asset groups using lookup fields like "owner" or "user".
  3. Multi-level Lookup Filtering: Support for filtering assets based on lookup fields, including nested lookups up to three levels deep.
  4. Granular Permissions: Ability to set view, update, and edit controls on assets based on user group membership.
  5. Cross-Asset Type Filtering: Functionality to filter visibility across different asset types based on common lookup fields.

 

Implementation Steps:

  1. Create or identify the target security group.
  2. Add relevant asset types to the security group:
    • Navigate to the security group settings.
    • Under "Assets", add the desired asset types (e.g., "test asset", "user").
    • Set the permission level (e.g., "view") for each asset type.
  3. Configure object-level permissions:
    • Click on the added asset type (e.g., "User").
    • Click the plus sign to add a new object-level permission.
    • Choose the relevant lookup field (e.g., "owner" or "user").
    • Update the security group settings.
  4. Create test assets with different owners/users to verify the configuration.
  5. Create a test user account to validate the security group settings:
    • Ensure the test user is part of the configured security group.
    • Log in as the test user to verify asset visibility.
  6. Add additional lookup fields as needed to refine access controls.

 

Best Practices:

  1. Start with a test environment or create test asset types before implementing in production.
  2. Use descriptive names for security groups to easily identify their purpose.
  3. Implement the principle of least privilege by default, restricting access and then granting additional permissions as needed.
  4. Regularly review and audit security group configurations to ensure they align with organizational needs.
  5. Document all security group configurations and the rationale behind each setting for future reference.
  6. When dealing with complex nested lookups, map out the relationships before implementation to avoid unintended access issues.

 

Troubleshooting Tips:

  1. If users can't see any assets after configuring a security group:
    • Verify that all necessary lookup fields have been added to the security group configuration.
    • Ensure the user is correctly assigned to the security group.
    • Check if the assets have the correct owner/user information set.
  2. For unexpected asset visibility:
    • Review the security group settings to ensure all relevant asset types and lookup fields are correctly configured.
    • Verify that the asset ownership or user assignment is correct.
  3. If changes to security group settings don't seem to take effect:
    • Have the user log out and log back in to refresh their session.
    • Clear browser cache or try accessing from a different browser or incognito mode.
  4. When dealing with multi-select lookup fields:
    • Be aware that the current implementation treats multiple selections as an "AND" condition, not an "OR" condition.
    • Configure security groups accordingly, potentially creating separate groups for different combinations if needed.
  5. For issues with report visibility:
    • Note that report permissions are separate from asset permissions and may need to be configured independently.
    • Ensure that users have the necessary permissions to access both the report and the underlying asset data.

 

Additional Insights:

  • The security model in ReadyWorks is highly flexible but can become complex when dealing with multiple nested lookups or cross-asset type relationships.
  • Consider the impact on performance when implementing extensive lookup-based filtering, especially in environments with large numbers of assets or users.
  • Regular testing and validation of security group configurations is crucial, especially after system updates or changes to asset structures.
  • For multigroup deployments, consider developing a standardized approach to security group creation and management to ensure consistency across the organization.

 

This documentation provides a foundation for implementing and managing user-based asset visibility controls in ReadyWorks. As with any enterprise software platform, it's recommended to work closely with ReadyWorks Priority Customer Support and always conduct thorough testing in a suitable environment before implementing these controls in production.

See more