Editing custom properties

About custom properties

A Poetic instance includes publisher-specific properties for:

These properties allow the publisher to add fields and columns that are not part of Poetic's core data set, but that the publisher may need. For example, a publisher may include additional product fields to meet the requirements of their Enterprise Resource Planning (ERP) system.

Poetic allows you to edit information about these properties, including:

For company custom properties, you can also configure the countries for which to display the property.This is configured using the list value maintenance function.

Configuring the countries where company custom properties are used

You can configure company custom properties to only display for companies that are located in specific countries. For example, if you are using a company custom property for something like a tax code, you can restrict the property to only display for companies located in countries where that tax code is used.

Displaying the Filter Custom Properties page

You can edit custom properties from the Filter Custom Properties page. You can get to the list from both the Site Maintenance menu and the Product Configuration menu.

To display the page from the Site Maintenance page:

  1. On the Administration menu, click Site maintenance.
  2. On the Site Maintenance menu, click the Customization tab.
  3. On the Customization tab, click Custom properties.

To display the page from the Product Configuration menu:

  1. On the Administration menu, click Products.
  2. On the Product Configuration menu, click Properties.

Filtering the list of properties

When the Filter Custom Properties page displays, by default it is filtered to only list product properties.

To display a different type of property, in the Custom property type dropdown, select the property type. The property list is updated to display the properties of that type.

Editing a custom property

To edit a custom property, on the Filter Custom Properties page, click the Edit link for the property you want to edit.

The Custom Property Value Maintenance page displays.

Providing information about the property

Configuring the property name and style

Type The type of custom property (entitlement, product, etc.).
Name The name of the custom property. This is used as the name of the list of available values for the property.

You also use the name when specifying a custom property as part of a setting value. For example, the Registry setting ENT_ISV_PROPERTIES_TO_MOVE_ON_ENT_TRANSFER is used to specify entitlement properties to include when entitlements are transferred. The value can be ALL, NONE, or a comma-separated list of the property names.

Pub ID In the Pub ID field, provide a pub ID for the custom property.
Display name In the Display Name field, edit the display name of the property. The display name is used as the field label on the UI.

To localize the display names, each custom property type has an associated list ISV_propertyType_FIELD_NAME:

  • ISV_COMPANY_FIELD_NAME
  • ISV_CONT_FIELD_NAME
  • ISV_CONT_SITE_FIELD_NAME
  • ISV_ENT_FIELD_NAME
  • ISV_ESD_FIELD_NAME
  • ISV_MACHINE_FIELD_NAME
  • ISV_POP_FIELD_NAME
  • ISV_PRODUCT_FIELD_NAME
  • ISV_USER_FIELD_NAME

In each list, the list value code is the property name, and the default description is the display name.

Style From the Style dropdown, select the method used to provide a value for the property.

If users enter a value into the field, then select Short answer.

If users select the value from a dropdown, then select Dropdown. When you select dropdown, the list name is displayed, with a link to configure the available values.

Configuring available values for dropdown properties

If the property style is Dropdown, then you must configure the list of available values. The values are kept in a list with the same name as the custom property.

To configure the values for the property, click Manage Values. The Filter Values form is displayed.

The form includes options to add, edit, and localize the values. These options work in exactly the same way as the option on the regular list values page. See Editing and localizing list values.

Configuring the availability of the property

Active To make the property available for use, check the Active check box.

If the property is not active, it does not display on Poetic pages, and it is not accepted in XML feeds.

Required To make the property required, check the Required check box.

If you make the property required, then that field will be required both when it is displayed on Poetic pages and when data is imported into Poetic via an XML feed.

Can search by To allow users to search using the property, check the Can search by check box.

For example, for product properties, if the Can search by check box is checked, the property is added to the Search Products page.

Allow wild card search Displays only for entitlement and machine custom property types. To allow a wild card search when performing searches that use entitlement or machine custom properties as search criteria, check the Allow wild card search check box.
Allow multiple values (Entitlement extract report only) If checked, allows users to enter multiple custom property values for the Entitlement Extract Report.
Access control Used to determine whether non-Ops Tier users can view company or user custom properties on Poetic pages, or entitlement custom properties on the View Entitlement(Additional Info) page. From the Access control dropdown, select the level of access to provide to users other than system administrators (Ops Tier users).
  • To not display the property at all to non-Ops Tier users, select Do not display.
  • To display the property, but not allow users to edit it, select View only.
  • To allow all users to edit the property value, select View and edit.

If the property is required, but Access is set to View only or Do not display:

  • If the property value is selected from a dropdown, the default value is the list value with the lowest display sequence.
  • If the value is entered into a text field, then the default value is the Custom 2 field for the property in the ISV_propertyType_FIELD_NAME list.

Saving the property changes

When you're finished, click Save.

To propagate the changes throughout the Poetic instance, click Reset cache.