Breadcrumbs

Creating and Using Macros in Censhare (Macro UI Editor)

Introduction

A Macro in Censhare is a special feature that adds new, derived features to an asset based on existing features. This article explains:

  • where to find the Macro UI Editor

  • how to prepare asset features

  • how to test macro execution using the Preview widget

Where to find the Macro Editor and create a Macro Asset

Use Censhare Web to create a Macro asset and open the Macro UI Editor.

Steps:

  1. Go to Censhare Web.

  2. Create a new Macro asset:

    Create a new Macro Asset.png

  3. Open the Macro asset and go to the Editor tab.

  4. In the Rules Editor window, select User Interface as type of text.

  5. Click Create rule below.

  6. The Rules Editor opens:

    Choose UI Editor.png

    Note that in the screenshot the conditions still needs to be added.

Notes:

  • The Macro UI Editor is available in the Censhare Web. A specific role is likely required. This depends on your system configuration. The Admin role is not mandatory.

  • If the Macro UI Editor is not visible, verify your user role or contact an administrator.

Checklist:

  • Censhare Web access confirmed.

  • Macro asset created.

  • UI Editor is visible.

Prepare asset features to use in the Macro UI Editor

This preparation has two parts:

  1. Create Asset Features in the Censhare Admin-Client

  2. Assign Features to a Product in the Censhare Client

Create Asset Features in the Censhare Admin-Client

Use the Censhare Admin-Client to define features in the Master data that your macro will use.

Steps:

  1. Open the Censhare Admin-Client.

  2. Navigate to the Features table in Master data:

    Navigate to Master Data - Features.png

  3. Create a new feature.

  4. Enter the required fields:

    • ID

    • Name

    • Trait key

    • Property key

    • Type

    • Value type

      Admin-Client-create-new-feature.png

  5. For testing, it is useful to choose Boolean as the first value type in a feature selection.

  6. If you do not want to create a new feature, search for test to find pre-existing test features available in the Censhare Admin-Client:

    Search-for-existing-features.png

Guidance:

  • Use clear, consistent naming so that you can recognize the feature later in the Censhare Client.

  • Start with simple types (boolean) to validate macro behavior quickly.

Checklist:

  • Censhare Admin-Client access confirmed.

  • New feature is created OR existing test feature identified.

  • Value type is set (use boolean for initial testing).

  • Naming and keys are documented for reference.

Assign features to a Product in the Censhare Client

Attach the feature(s) to a Product asset so that they are available to use within the Macro UI Editor.

Steps:

  1. Open the Censhare Client.

  2. Search for a Product asset, for example Team Kit 200 green. If it does not exist in your system, create an own test asset of Product asset type:

    Search-product-assets.png

  3. Right-click the asset and select Edit Metadata.

  4. Go to the Features tab:

    Asset-edit-metadata.png

  5. Click the “+” icon at the bottom.

  6. In the dropdown list, select the feature that you have created in the Censhare Admin-Client:

    Select-created-feature.png

  7. Set an appropriate value for the feature and save. For example, for boolean check the checkbox.

Guidance:

Checklist:

  • Product asset found, for example Team Kit 200 green.

  • Feature added via Features tab.

  • Feature value set and saved.

  • Macro input feature is now available in UI Editor.

Test macro execution with the Preview widget

Use Censhare Web’s Preview widget to test the macro against the Product test asset.

Steps:

  1. In Censhare Web, open the Macro asset.

  2. Add a rule that fits your asset features:

    Add a rule that fits your asset Features.png

  3. Go to the Rule preview widget beside the Rules Editor and click the "+" above Drop product asset in the widget.

  4. Select the Product test asset that you have prepared in Assign Features to a Product in the Censhare Client above, for example Team Kit 200 green:

    Select the Test Product created in Step 2.png

  5. Run/Preview and verify the macro’s derived features by clicking Save for the Macro asset.

  6. In case your rule works, the text should be displayed, else null, for example:

    Check-returns-error.png

What to check:

  • No execution errors.

  • Derived features appear as expected.

  • Required input features are populated.

Checklist:

  • Test Product selected in preview.

  • Macro runs without errors.

  • Derived features are validated.

Add-on: XML Macro definition

Implementation details for macro logic and configuration.

  • XML: Macro definition/configuration:

    <?xml version="1.0" encoding="UTF-8"?>
<filters>
    <filter>
        <conditions>
            <condition feature="test.feature:boolean" op="=" value="true" />
        </conditions>
        <result type="text" value="ThisdisplaysTestText" />
    </filter>
</filters>

Conventions and best practices:

  • Naming conventions for features (e.g., input., derived.)

  • Do not use “cs:” as prefix because this is reserved for Censhare-specific elements.