The Edit properties dialogs that are available on asset pages and in asset lists were enhanced. Customized dialogs allow users to edit generic and specific asset properties. The dialogs were harmonized with the corresponding asset pages
Target Group
Solution developers
Context
censhare standard workspace
CustomizedEdit propertiesdialogs for Product Information Management and Campaign Management.
TheEdit propertiesdialogs are configured inDialogassets.
Prerequisites
You need intermediate knowledge about the workspace configuration of censhare Web. In particular, you must be familiar with dialog module assets, resource replace variants and the cs-metadata directives.
Introduction
censhare Dedicated solutions introduce an enhanced user interface concept for a better user experience. Asset pages, tabs and widgets were widely harmonized. In any context, users find similar properties and content in the same place.
The enhancedEdit propertiesdialogs provide a better user experience in two ways:
Customized dialogs contain relevant information for the respective asset types.
Dialogs were harmonized with the properties widgets on the respective asset pages.
The enhanced dialogs are aligned with the properties widgets on an asset page and comprise all relevant properties of an asset. This guarantees a better user experience, as users can now select whether to edit asset properties in theEdit propertiesdialog, or in the respective widgets.
The enhanced Edit properties dialogs were introduced for Product Information Management (PIM) and Campaign Management. To use the enhanced dialogs, no further configuration is required.
If necessary, you can customize theEdit propertiesdialogs via resource replace variants. If you want to customize theEdit propertiesdialog for asset types that do not have a custom dialog yet, you can create and configure a new Dialog asset and assign it to the desired asset type.
Key concept
TheEdit propertiesdialogs are configured in a standard HTML dialog asset that is widely used to configure the censhare Web workspace. The configuration is stored in an HTML master file. Optionally, a JavaScript controller can be added.
TheDefault Asset Metadata Dialog(resource key: censhare:metadata.default.asset.template) provides the defaultEdit propertiesdialog. Do not disable or remove this dialog!
To overwrite the defaultEdit propertiesdialog for a specific asset type, a Dialog asset is required with the following settings:
In theResource usageproperty, the valueAsset type metadata dialog definitionmust be set.
In theResource metadataproperty, asource asset filtermust be configured.
In the master file of the dialog asset, the dialog is configured with the censhare metadata directives. The basic usage of the dialog asset is as follows:
The advantage of this configuration is that you can reuse existing dialogs. For example, dialog snippets from properties widgets, that are configured on an asset page, can be reused in theEdit propertiesdialog. The censhare standard workspace uses this configuration whenever possible.
Search dialog definitions
To search for the existing dialogs in your system, execute the following search:
Incenshare Web, start theExpert search.
Enter a search query with the following conditions:
Resource usage = Asset type metadata dialog definition
NOT (Name like Tab*)
Click SEARCH to run the search.
The search result shows allHTML Dialogassets that provide an Edit properties dialog. Each dialog is mapped to a specific asset type, except theDefault Asset Metadata Dialogasset. This dialog is used when no dialog is configured for an asset type.
Create a resource replace variant of a dialog definition
With a resource replace variant, you can easily create a custom variant of anEdit propertiesdialog. To create and configure a resource replace variant, do the following:
Execute the search as described in the previous section, and open the desired dialog in a new asset page.
Click the three dotsto open the asset actions menu, and selectVariants > Resource replace variant.
Open the new dialog asset in a new page.
Go to theAdministrationtab, and edit theGeneric asset and resource properties. Replace the automatically generated resource key.
Do not change theUsagekey and thesource asset filter!
Click OK to close the dialog and save your changes.
Go to theEditortab and enter here the dialog definitions.
Click SAVE to save your changes.
The custom dialog is available immediately. Restarting the censhare Server is not necessary.
Create a dialog definition for a new asset type
If you want to customize theEdit propertiesdialog for a new asset type, do the following:
In censhare Web, create a newModule / Dialogasset.
Enter a name and a resource key.
Select theEnabledandIn cached tablesfields.
In theUsagefield, selectAsset type meta data dialog definition.
In theResource metadatafield, enter an XML snippet with the asset type filter, for which you want to use the Edit properties dialog. You can adapt the following example:
CODE
$body
Click OK to save your changes.
To deploy a new dialog in a production system, you must add it to the system module assets and synchronize them:
Incenshare Web, open theDialogasset that you want to deploy.
Open the Page actions menu ( the three dots), and selectExport > Export module assets.
Go to theDownloaddirectory on your computer and open theExportfolder.
Copy the asset XML file, the HTML master file, and if existing, the JS controller file.
On the censhare Server, paste the copied files into thecenshare-Server/install/system/required/web/metadata-templates-asset-typedirectory.
Open the asset XML file in an XML editor, and check if the HTML storage item and the JS controller storage item (if existing) are referenced correctly. If more storage items (for example: XHTML preview items) are referenced, remove them and save your changes.
Open thecenshare Admin Clientand there, open theServer actionsmenu ().
SelectSynchronize module asset - required.
In the dialog, select therequired/web/metadata-templates-asset-typefield and click OK.
In the report, verify that the dialog was added, and click OK to close the dialog and save your changes.
The new dialog asset is now available in the system.
Result
When users open theEdit propertiesdialog in the action menu of an asset, the respective dialog fields display.
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.