Customization management

Administration Page Application/Contract Syracuse/Collaboration Class personalizationManagements Representation personalizationManagement

The customization management defines a set of filters on the administration data and allows quick extraction of the data associated with dashboards, vignettes, menu items, and personalized pages. The created format is a JSON format that can be integrated into another Syracuse repository through the import tool.

Information to enter

On the Edit page, the information to be entered in a customization management definition is the following:

Informations section

Code

This mandatory information identifies the personalization definition.

Description

This mandatory information describes the personalization definition.

Locales

Select your regional preferences if necessary.

Dashboards section

Export dashboards

If this check box is selected, the dashboards, associated vignettes, and linked menus will be exported according to the following filters.

Dashboard filter

This filter can be entered only if the Export dashboards check box has been selected. It allows you to define conditions based on different fields for the dashboards. The result of the filter is displayed as an SData condition.

The modification of the filter is done by creating filters on the different properties of the dashboards:

  • Title
  • Description
  • Dashboard name
  • Mobile dashboard check box

Setting a filter is done by clicking the filter icon, selecting an operator, and then entering one or two values depending on the operator.

The available operators are the following:

  • Contains
  • Start with
  • Ends with
  • Greater than or equal to
  • Greater than
  • Less than or equal to
  • Less than
  • Equal to
  • Not equal to

When filters are set on several properties, a logical and is performed on the different conditions.

Dashboard gadget filter

This filter can be entered only if the Export dashboards check box has been selected. It allows you to define conditions based on different fields for the gadgets included in the dashboard. The result of the filter is displayed as an SData condition and the modification of the filter is done by creating filters on the different properties of the gadgets:

  • Code
  • Title
  • Description
  • Applies to all applications check box
  • Application
  • Content
  • Is factorycheck box
  • Factory Owner

The principles for entering conditions are the same as the ones for the dashboards' filters.

Export dashboard if at least one variant matches the filter

When this check box is selected, the dashboard is exported if at least a variant fulfills the extraction conditions. If this check box is cleared, only the dashboards that have all their variants which fulfill the conditions will be extracted.

The principles for entering conditions are the same as the ones for the dashboards' filters.

Pages section

Export pages

If this check box is selected, the pages and gadgets will be exported according to the following filters.

Page filter

This filter can be entered only if the Export pages check box is selected. It allows you to define conditions based on different fields for the pages. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the pages.

The principles for entering conditions are the same as the ones for the dashboards' filters.

Page variants filter

This filter can be entered only if the Export pages check box is selected. It allows you to define conditions based on different fields for the page variants. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the page variants.

The principles for entering conditions are the same as the ones for the dashboards' filters.

Export page if at least one variant matches the filter

When this check box is selected, the page is exported if at least a variant fulfills the extraction conditions. If this check box is cleared, only pages that have all their variants which fulfill the conditions will be extracted.

Export navigation pages

If this check box is selected, the navigation pages, modules and submodules will be exported according to the following filters.

This filter can be entered only if the Export navigation pages check box is selected. It allows you to define conditions based on different fields for the navigation pages. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the Navigation page.

The principles for entering conditions are the same as the ones for the dashboards' filters.

This filter can be entered only if the Export navigation pages check box is selected. It allows you to define conditions based on different fields for the navigation pages modules. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the navigation page modules.

The principles for entering conditions are the same as the ones for the dashboards' filters.

This filter can be entered only if the Export navigation pages check box is selected. It allows you to define conditions based on different fields for the navigation pages sub-modules. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the navigation page sub-modules.

The principles for entering conditions are the same as the ones for the dashboards' filters.

This filter can be entered only if the Export navigation pages check box is selected. It allows you to define conditions based on different fields for the navigation pages menus. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the navigation page menus.

The principles for entering conditions are the same as the ones for the dashboards' filters.

Export navigation page if at least one module or sub-module matches the filter

When this check box is selected, the page is exported if at least a module or sub-module included in the navigation page fulfills the extraction conditions. If this check box is cleared, only navigation pages that have all their modules and sub-modules which fulfill the conditions will be extracted.

Home pages section

Export home pages

If this check box is selected, the home pages will be exported according to the following filters.

Home page filter

This filter can be entered only if the Export home pages check box is selected. It allows you to define conditions based on different fields for the home pages. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the Home page.

Gadget filter

This filter can be entered only if the Export home pages check box is selected. It allows you to define conditions based on different fields for the gadgets of the home pages. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the gadgets.

Export menus

If this check box is selected, the menus will be exported according to the following filters.

This filter can be entered only if the Export home pages check box is selected. It allows you to define conditions based on different fields for the menu items. The result for the filter is displayed as an SData condition, and the modification of the filter is done by creating filters on the different properties of the menu items.

Links available

The export operation is available from the export profile definition. The following links are available:

Export customization

This link triggers the execution of the export. A popup page opens to define the export options:

Target type

This field provides the choice between three different destinations for the export result, and allows you to enter the related information:

  • Direct download triggers the execution for the export and downloads it. The program used to display the result of the export must be selected before the data is visible.
  • Server file creates the result file on the server. A file path must then be entered.
  • Collaboration area creates the result file in the collaboration space of MongoDB. A description as well as a volume must be provided to identify how and where the document should be created.
  • Friend server direct transfer sends the result of the import to a friend server that must be entered.

Beautify output

If this check box is selected, the JSON generated is beautified in order to be easily readable by a human.

Detail

This link leaves the edit mode and takes you back to the view page of your customization.

List of customizations

This link takes you back to the list of customizations page.

Help

Click this link to consult our online documentation for this function.

Schedule customizations export

This link triggers the scheduling for the export. The same information entered for an export is used. An additional field allows you to select an automation to plan scheduled exports.

Appendix: format of the export

The format of the export can be found in the Administration reference Export profiles document.